JApplicationHelper/addClientInfo: Difference between revisions
From Joomla! Documentation
m clean up |
m preparing for archive only |
||
| Line 56: | Line 56: | ||
===Examples=== | ===Examples=== | ||
=== Code Examples === | |||
<dpl> | <dpl> | ||
noresultsheader=\n | noresultsheader=\n | ||
category=addClientInfo | category=addClientInfo | ||
category=JApplicationHelper | category=JApplicationHelper | ||
namespace=CodeExample | |||
category=MethodExample | category=MethodExample | ||
include=* | include=* | ||
Latest revision as of 01:18, 25 March 2017
Description
Adds information for a client.
<! removed transcluded page call, red link never existed >
Syntax
static addClientInfo($client)
| Parameter Name | Default Value | Description |
|---|---|---|
| $client | A client identifier either an array or object |
Returns
boolean True if the information is added. False on error
Defined in
libraries/joomla/application/helper.php
Importing
jimport( 'joomla.application.helper' );
Source Body
public static function addClientInfo($client)
{
if (is_array($client)) {
$client = (object) $client;
}
if (!is_object($client)) {
return false;
}
$info = &self::getClientInfo();
if (!isset($client->id)) {
$client->id = count($info);
}
$info[$client->id] = clone $client;
return true;
}
<! removed transcluded page call, red link never existed >
Examples
Code Examples