Class XoopsPersistableObjectHandler

Persistable Object Handler class.

XoopsPersistableObjectHandler

Direct known subclasses

ArtObjectHandler, PmMessageHandler, SystemBlockHandler, SystemBlockLinkModuleHandler, SystemGroupHandler, SystemsmiliesHandler, SystemuserrankHandler, XoopsCacheModelHandler, XoopsUserHandler, ProfileCategoryHandler, ProfileFieldHandler, ProfileProfileHandler, ProfileRegstepHandler, ProfileVisibilityHandler, SystemBannerclientHandler, SystemBannerfinishHandler, SystemBannerHandler

Indirect known subclasses

SystemUsersHandler

Package: kernel
Copyright: (c) 2000-2016 XOOPS Project (www.xoops.org)
License: GPL 2 (http://www.gnu.org/licenses/gpl-2.0.html)
Author: Taiwen Jiang phppp@users.sourceforge.net
Author: Jan Keller Pedersen mithrandir@xoops.org
Located at ernel/object.php

Methods summary
`public`	# `__construct( XoopsDatabase $db = null, string $table = '', string $className = '', string $keyName = '', string $identifierName = '' )` Constructor Constructor Parameters `$db` database connection `$table` Name of database table `$className` Name of the XoopsObject class this handler manages `$keyName` Name of the property holding the key `$identifierName` Name of the property holding an identifier name (title, name ...), used on getList() Overrides `XoopsObjectHandler::__construct()`
`public`	# `XoopsPersistableObjectHandler( XoopsDatabase $db = null, string $table = '', string $className = '', string $keyName = '', string $identifierName = '' )` PHP 4 style constructor compatibility shim PHP 4 style constructor compatibility shim Deprecated all callers should be using parent::__construct() Parameters `$db` database connection `$table` Name of database table `$className` Name of the XoopsObject class this handler manages `$keyName` Name of the property holding the key `$identifierName` Name of the property holding an identifier name (title, name ...), used on getList()
`public object`	# `setHandler( null\|string $handler = null, null $args = null, string $path = null )` Set custom handler Set custom handler Parameters `$handler` `$args` `$path` path to class Returns object of handler
`public XoopsModelAbstract`	# `loadHandler( string $name, mixed $args = null )` Load predefined handler Load predefined handler Parameters `$name` handler name `$args` args Returns `XoopsModelAbstract` of handler `XoopsModelAbstract`
`public mixed`	# `__call( string $name, array $args )` Magic method for overloading of delegation Magic method for overloading of delegation To be enabled in XOOPS 3.0 with PHP 5 Parameters `$name` method name `$args` arguments Returns mixed
`public XoopsObject`	# `create( boolean $isNew = true )` create a new object create a new object Parameters `$isNew` Flag the new objects as new Returns `XoopsObject` `XoopsObject` Overrides `XoopsObjectHandler::create()`
`public XoopsObject`	# `get( mixed $id = null, array $fields = null )` Load a `XoopsObject` object from the database Load a `XoopsObject` object from the database Parameters `$id` ID `$fields` fields to fetch Returns `XoopsObject` `XoopsObject` Overrides `XoopsObjectHandler::get()`
`public mixed`	# `insert( XoopsObject $object, boolean $force = true )` insert an object into the database insert an object into the database Parameters `$object` `XoopsObject` reference to object `$force` flag to force the query execution despite security settings Returns mixed object ID Overrides `XoopsObjectHandler::insert()`
`public boolean`	# `delete( XoopsObject $object, boolean $force = false )` delete an object from the database delete an object from the database Parameters `$object` `XoopsObject` reference to the object to delete `$force` Returns boolean FALSE if failed. Overrides `XoopsObjectHandler::delete()`
`public boolean`	# `deleteAll( CriteriaElement $criteria = null, boolean $force = true, boolean $asObject = false )` delete all objects matching the conditions delete all objects matching the conditions Parameters `$criteria` `CriteriaElement` with conditions to meet `$force` force to delete `$asObject` delete in object way: instantiate all objects and delete one by one Returns boolean
`public boolean`	# `updateAll( string $fieldname, mixed $fieldvalue, CriteriaElement $criteria = null, boolean $force = false )` Change a field for objects with a certain criteria Change a field for objects with a certain criteria Parameters `$fieldname` Name of the field `$fieldvalue` Value to write `$criteria` `CriteriaElement` `$force` force to query Returns boolean
`public array &`	# `getObjects( CriteriaElement $criteria = null, boolean $id_as_key = false, boolean $as_object = true )` Retrieve objects from the database Retrieve objects from the database Parameters `$criteria` `CriteriaElement` conditions to be met `$id_as_key` use the ID as key for the array `$as_object` return an array of objects Returns array
`public array &`	# `getAll( CriteriaElement $criteria = null, array $fields = null, boolean $asObject = true, boolean $id_as_key = true )` get all objects matching a condition get all objects matching a condition Parameters `$criteria` `CriteriaElement` to match `$fields` variables to fetch `$asObject` flag indicating as object, otherwise as array `$id_as_key` use the ID as key for the array Returns array of objects/array `XoopsObject`
`public array`	# `getList( CriteriaElement $criteria = null, integer $limit = 0, integer $start = 0 )` Retrieve a list of objects data Retrieve a list of objects data Parameters `$criteria` `CriteriaElement` conditions to be met `$limit` Max number of objects to fetch `$start` Which record to start at Returns array
`public array &`	# `getIds( CriteriaElement $criteria = null )` get IDs of objects matching a condition get IDs of objects matching a condition Parameters `$criteria` `CriteriaElement` to match Returns array of object IDs
`public array &`	# `getByLimit( integer $limit = 0, integer $start = 0, CriteriaElement $criteria = null, array $fields = null, boolean $asObject = true )` get a limited list of objects matching a condition get a limited list of objects matching a condition `CriteriaCompo` Parameters `$limit` Max number of objects to fetch `$start` Which record to start at `$criteria` `CriteriaElement` to match `$fields` variables to fetch `$asObject` flag indicating as object, otherwise as array Returns array of objects `XoopsObject`
`public integer`	# `getCount( CriteriaElement $criteria = null )` count objects matching a condition count objects matching a condition Parameters `$criteria` `CriteriaElement` to match Returns integer count of objects
`public array`	# `getCounts( CriteriaElement $criteria = null )` Get counts of objects matching a condition Get counts of objects matching a condition Parameters `$criteria` `CriteriaElement` to match Returns array of counts
`public array &`	# `getByLink( CriteriaElement $criteria = null, array $fields = null, boolean $asObject = true, string $field_link = null, string $field_object = null )` get a list of objects matching a condition joint with another related object get a list of objects matching a condition joint with another related object Parameters `$criteria` `CriteriaElement` to match `$fields` variables to fetch `$asObject` flag indicating as object, otherwise as array `$field_link` field of linked object for JOIN `$field_object` field of current object for JOIN Returns array of objects `XoopsObject`
`public integer`	# `getCountByLink( CriteriaElement $criteria = null )` Count of objects matching a condition Count of objects matching a condition Parameters `$criteria` `CriteriaElement` to match Returns integer count of objects
`public integer`	# `getCountsByLink( CriteriaElement $criteria = null )` array of count of objects matching a condition of, groupby linked object keyname array of count of objects matching a condition of, groupby linked object keyname Parameters `$criteria` `CriteriaElement` to match Returns integer count of objects
`public integer`	# `updateByLink( array $data, CriteriaElement $criteria = null )` update objects matching a condition against linked objects update objects matching a condition against linked objects Parameters `$data` array of key => value `$criteria` `CriteriaElement` to match Returns integer count of objects
`public integer`	# `deleteByLink( CriteriaElement $criteria = null )` Delete objects matching a condition against linked objects Delete objects matching a condition against linked objects Parameters `$criteria` `CriteriaElement` to match Returns integer count of objects
`public boolean`	# `cleanOrphan( string $table_link = '', string $field_link = '', string $field_object = '' )` Clean orphan objects against linked objects Clean orphan objects against linked objects Parameters `$table_link` table of linked object for JOIN `$field_link` field of linked object for JOIN `$field_object` field of current object for JOIN Returns boolean true on success
`public boolean`	# `synchronization( )` Synchronizing objects Synchronizing objects Returns boolean true on success
`public boolean`	# `convertResultSet( $result, boolean $id_as_key = false, boolean $as_object = true )` Deprecated Parameters `$result` `$id_as_key` `$as_object` Returns boolean

Methods inherited from XoopsObjectHandler
`XoopsObjectHandler()`

Properties summary
`public`	`$handler` static protected static protected	#
`public array`	`$handlers` static protected static protected	# `array('read' => null, 'stats' => null, 'joint' => null, 'write' => null, 'sync' => null)`
`public string`	`$table` Information about the class, the handler is managing Information about the class, the handler is managing	#
`public string`	`$keyName`	#
`public string`	`$className`	#
`public string`	`$identifierName`	#
`public string`	`$field_link`	#
`public string`	`$field_object`	#

Properties inherited from XoopsObjectHandler
`$db`

Namespaces

Classes

Interfaces

Exceptions

Functions

Class XoopsPersistableObjectHandler

Direct known subclasses

Indirect known subclasses

Parameters

Overrides

Deprecated

Parameters

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Overrides

Parameters

Returns

Overrides

Parameters

Returns

Overrides

Parameters

Returns

Overrides

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Deprecated

Parameters

Returns