CONTENIDO 4.8.18 » \cApiUser

Methods

Class Item Class for database based items

author	Timo A. Hummel <Timo.Hummel@4fb.de>
version	0.1
copyright	four for business 2003

Methods

Constructor Function

Item(string $table, string $primaryKey, $lifetime)

Inherited

inherited_from	\Item::Item()

Parameters

$table

string

The table to use as information source

$primaryKey

string

The primary key to use

$lifetime

Filters the passed data using the functions defines in the _arrInFilters array.

_inFilter(mixed $data) : mixed

Inherited

see	\setFilters
access	private
inherited_from	\Item::_inFilter()

Parameters

$data

mixed

Data to filter

Returns

mixedFiltered data

_onLoad ()

_onLoad() : \none

Inherited

Function which is called whenever an item is loaded. Inherited classes should override this function if desired.

inherited_from	\Item::_onLoad()

Returns

\none

Filters the passed data using the functions defines in the _arrOutFilters array.

_outFilter(mixed $data) : mixed

Inherited

see	\setFilters
access	private
inherited_from	\Item::_outFilter()

Parameters

$data

mixed

Data to filter

Returns

mixedFiltered data

_setMetaObject()

_setMetaObject($objectname)

Inherited

inherited_from	\Item::_setMetaObject()

Parameters

$objectname

cApiUser()

cApiUser($iduser)

Parameters

$iduser

deleteProperty ($type, $name) Deletes a custom property

deleteProperty(string $type, string $name)

Inherited

inherited_from	\Item::deleteProperty()

Parameters

$type

string

Specifies the type

$name

string

Specifies the name

deleteUserProperty($type, $name) Deletes a user property from the table

deleteUserProperty(string $type, string $name)

Parameters

$type

string

type Specifies the type (class, category etc) for the property to retrieve

$name

string

name Specifies the name of the property to retrieve

get($field) Wrapper for getField (less to type)

get(string $field) : mixed

Inherited

inherited_from	\Item::get()

Parameters

$field

string

Specifies the field to retrieve

Returns

mixedValue of the field

getField($field) Gets the value of a specific field

getField(string $field) : mixed

Inherited

inherited_from	\Item::getField()

Parameters

$field

string

Specifies the field to retrieve

Returns

mixedValue of the field

getMetaObject()

getMetaObject()

Inherited

inherited_from	\Item::getMetaObject()

getProperty ($type, $name) Sets a custom property

getProperty(string $type, string $name) : boolean

Inherited

inherited_from	\Item::getProperty()

Parameters

$type

string

Specifies the type

$name

string

Specifies the name

Returns

booleanValue of the given property

getUserProperties() Retrieves all available properties of the user

getUserProperties()

getUserPropertiesByType($type) Stores the modified user object to the database

getUserPropertiesByType(string $sType, boolean $bGroup) : array

Parameters

$sType

string

sType Specifies the type (class, category etc) for the property to retrieve

$bGroup

boolean

bGroup Specifies if this function should recursively search in groups

Returns

arrayThe value of the retrieved property

getUserProperty($type, $name) Stores the modified user object to the database

getUserProperty(string $type, string $name, boolean $group) : string

Parameters

$type

string

type Specifies the type (class, category etc) for the property to retrieve

$name

string

name Specifies the name of the property to retrieve

$group

boolean

group Specifies if this function should recursively search in groups

Returns

stringThe value of the retrieved property

loadBy ($field, $value) Loads an item by colum/field from the database

loadBy(string $field, string $value, bool $bSafe) : bool

Inherited

inherited_from	\Item::loadBy()

Parameters

$field

string

Specifies the field

$value

string

Specifies the value

$bSafe

bool

use inFilter or not

Returns

boolTrue if the load was successful

loadByPrimaryKey ($value) Loads an item by ID from the database

loadByPrimaryKey(string $value) : bool

Inherited

inherited_from	\Item::loadByPrimaryKey()

Parameters

$value

string

Specifies the primary key value

Returns

boolTrue if the load was successful

set($field, $value) Shortcut to setField

set(string $field, string $value, $safe)

Inherited

inherited_from	\Item::set()

Parameters

$field

string

Specifies the field to set

$value

string

Specifies the value to set

$safe

setField($field, $value) Sets the value of a specific field

setField(string $field, string $value, boolean $safe)

Inherited

inherited_from	\Item::setField()

Parameters

$field

string

Specifies the field to set

$value

string

Specifies the value to set

$safe

boolean

Speficies if we should translate characters

Define the filter functions used when data is being stored or retrieved from the database.

setFilters(array $arrInFilters, array $arrOutFilters) : void

Inherited

Examples:

$obj->setFilters(array('addslashes'), array('stripslashes')); $obj->setFilters(array('htmlencode', 'addslashes'), array('stripslashes', 'htmlencode'));

inherited_from	\Item::setFilters()

Parameters

$arrInFilters

array

inFilters array with function names

$arrOutFilters

array

outFilters array with function names

setProperty ($type, $name, $value) Sets a custom property

setProperty(string $type, string $name, string $value)

Inherited

inherited_from	\Item::setProperty()

Parameters

$type

string

Specifies the type

$name

string

Specifies the name

$value

string

Specifies the value

setUserProperty($type, $name, $value) Stores a property to the database

setUserProperty(string $type, string $name, string $value)

Parameters

$type

string

type Specifies the type (class, category etc) for the property to retrieve

$name

string

name Specifies the name of the property to retrieve

$value

string

value Specifies the value to insert

store() Stores the modified user object to the database

store()

Inherited

inherited_from	\Item::store()

Properties

$_arrInFilters : array

Inherited

access	private
inherited_from	\Item::$$_arrInFilters

$_arrOutFilters : array

Inherited

access	private
inherited_from	\Item::$$_arrOutFilters

$_metaObject

Inherited

inherited_from	\Item::$$_metaObject

$cache : array

Inherited

access	private
inherited_from	\Item::$$cache

$db : object

Inherited

access	private
inherited_from	\Item::$$db

$lasterror : string

Inherited

access	private
inherited_from	\Item::$$lasterror

Lifetime in seconds

$lifetime : int

Inherited

access	private
inherited_from	\Item::$$lifetime

$modifiedValues : array

Inherited

access	private
inherited_from	\Item::$$modifiedValues

$oldPrimaryKey : string

Inherited

access	private
inherited_from	\Item::$$oldPrimaryKey

$primaryKey : object

Inherited

access	private
inherited_from	\Item::$$primaryKey

PropertyCollection object

$properties : object

Inherited

access	private
inherited_from	\Item::$$properties

$table : string

Inherited

access	private
inherited_from	\Item::$$table

$values : array

Inherited

access	private
inherited_from	\Item::$$values

$virgin : boolean

Inherited

If true, the object is virgin and no operations on it except load-Functions are allowed.

access	private
inherited_from	\Item::$$virgin