Class cApiClient

Class cApiClient, client item

cGenericDb

Item

cApiClient

Package: Core\GenericDB\Model
Copyright: four for business AG <www.4fb.de>
License: http://www.contenido.org/license/LIZENZ.txt
Author: Marco Jahn
Located at classes/contenido/class.client.php

Methods summary
`public`	# `__construct( mixed $id = false )` Constructor function. Constructor function. Parameters `$id` `mixed` $id [optional] Specifies the ID of item to load Throws `cInvalidArgumentException` If table name or primary key is not set Overrides `Item::__construct()`
`public mixed`	# `__get( string $name )` Magic getter method for deprecated idclient variable. Magic getter method for deprecated idclient variable. Parameters `$name` `string` $name only works for "idclient" Returns `mixed` Overrides `cItemBaseAbstract::__get()`
`public`	# `__set( string $name, mixed $value )` Magic setter method for deprecated idclient variable Magic setter method for deprecated idclient variable Parameters `$name` `string` $name only works for "idclient" `$value` `mixed` $value Value to set Overrides `cItemBaseAbstract::__set()`
`public static cApiClient`	# `getInstance( integer $client = false )` Static accessor to the singleton instance. Static accessor to the singleton instance. Deprecated [2015-05-21] This method is no longer supported (no replacement) Parameters `$client` `integer` $client [optional] Returns `cApiClient` Reference to the singleton instance. Todo There is no need since caching is available at GenericDB level
`public boolean`	# `loadByPrimaryKey( integer $idKey )` Load dataset by primary key Load dataset by primary key Parameters `$idKey` `integer` $idKey Returns `boolean` Overrides `Item::loadByPrimaryKey()`
`public boolean`	# `setProperty( mixed $type, mixed $name, mixed $value, mixed $idproperty = 0 )` Set client property Set client property Parameters `$type` `mixed` $type Type of the data to store (arbitary data) `$name` `mixed` $name Entry name `$value` `mixed` $value Value `$idproperty` `mixed` $idproperty [optional] Returns `boolean` Todo should return return value as overwritten method Overrides `Item::setProperty()`
`public mixed`	# `getProperty( mixed $type, mixed $name, integer $client = 0 )` Get client property Get client property Parameters `$type` `mixed` $type Type of the data to get `$name` `mixed` $name Entry name `$client` `integer` $client [optional] Client id (not used, it's declared because of PHP strict warnings) Returns `mixed` Value Overrides `Item::getProperty()`
`public boolean`	# `deleteProperty( integer $idProp, string $p2 = "", integer $client = 0 )` Delete client property Delete client property Parameters `$idProp` `integer` $idProp Id of property `$p2` `string` $p2 [optional] Not used, is here to prevent PHP Strict warnings `$client` `integer` $client [optional] Client id (not used, it's declared because of PHP strict warnings) Returns `boolean` Overrides `Item::deleteProperty()`
`public array`	# `getPropertiesByType( mixed $type )` Get client properties by type Get client properties by type Parameters `$type` `mixed` $type Type of the data to get Returns `array` Assoziative array
`public array\|false`	# `getProperties( )` Get all client properties Get all client properties Returns `array\|false` array Todo return value should be the same as getPropertiesByType(), e.g. an empty array instead of false
`public boolean`	# `hasLanguages( )` Check if client has at least one language Check if client has at least one language Returns `boolean`
`public boolean`	# `setField( string $name, mixed $value, boolean $bSafe = true )` Userdefined setter for client fields. Userdefined setter for client fields. Parameters `$name` `string` $name `$value` `mixed` $value `$bSafe` `boolean` $bSafe [optional] Flag to run defined inFilter on passed value Returns `boolean` Todo should return return value of overloaded method Overrides `Item::setField()`
`protected cApiPropertyCollection`	# `_getPropertiesCollectionInstance( integer $client = 0 )` Lazy instantiation and return of properties object Lazy instantiation and return of properties object Parameters `$client` `integer` $client [optional] Client id (not used, it's declared because of PHP strict warnings) Returns `cApiPropertyCollection` Overrides `cItemBaseAbstract::_getPropertiesCollectionInstance()`

Methods inherited from Item
`_inFilter(), _loadByWhereClause(), _onLoad(), _resetItem(), _setMetaObject(), deletePropertyById(), get(), getField(), getMetaObject(), loadBy(), loadByMany(), loadByRecordSet(), outFilter(), set(), setFilters(), store(), toArray(), toObject()`

Methods inherited from cItemBaseAbstract
`_getSecondDBInstance(), _setLoaded(), _setPrimaryKeyName(), escape(), getPrimaryKeyName(), isLoaded()`

Methods inherited from cGenericDb
`_executeCallbacks(), register(), unregister()`

Constants inherited from cGenericDb
`CREATE_BEFORE, CREATE_FAILURE, CREATE_SUCCESS, DELETE_BEFORE, DELETE_FAILURE, DELETE_SUCCESS, STORE_BEFORE, STORE_FAILURE, STORE_SUCCESS`

Properties summary
`private integer`	`$idclient`		# Setting of client ID (deprecated) Setting of client ID (deprecated) Deprecated [2014-12-03] Class variable idclient is deprecated
`protected cApiPropertyCollection`	`$_oPropertyCollection`		# Property collection instance Property collection instance

Properties inherited from Item
`$_arrInFilters, $_arrOutFilters, $_lastSQL, $_metaObject, $modifiedValues, $oldPrimaryKey, $values`

Properties inherited from cItemBaseAbstract
`$_className, $_loaded, $_oCache, $_primaryKeyName, $_settings, $db, $lasterror, $properties, $secondDb, $table`

Packages

Classes

Class cApiClient

Parameters

Throws

Overrides

Parameters

Returns

Overrides

Parameters

Overrides

Deprecated

Parameters

Returns

Todo

Parameters

Returns

Overrides

Parameters

Returns

Todo

Overrides

Parameters

Returns

Overrides

Parameters

Returns

Overrides

Parameters

Returns

Returns

Todo

Returns

Parameters

Returns

Todo

Overrides

Parameters

Returns

Overrides

Deprecated