API16

API16:JApplicationHelper/addClientInfo

From Joomla! Documentation

Revision as of 22:35, 22 March 2010 by Doxiki (talk | contribs) (New page: ===Description=== Adds information for a client. <span class="editsection" style="font-size:76%;"> <nowiki>[</nowiki>Edit Descripton<n...)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

Description

Adds information for a client.

[Edit Descripton]

Template:Description:JApplicationHelper/addClientInfo

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;
}

[Edit See Also] Template:SeeAlso:JApplicationHelper/addClientInfo

Examples

<CodeExamplesForm />