Class XoopsPersistableObjectHandler

`extends`	`XoopsObjectHandler`


					
	public

__construct(
	null|XoopsDatabase $db = null,
	string $table = '',
	string $className = '',
	string $keyName = '',
	string $identifierName = '',
)

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()

Overriden by

#


					
	public

XoopsPersistableObjectHandler(
	null|XoopsDatabase $db = null,
	string $table = '',
	string $className = '',
	string $keyName = '',
	string $identifierName = '',
)

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

loadHandler(string $name, mixed $args = null): XoopsModelAbstract

Load predefined handler

Parameters

`$name`	handler name
`$args`	args

Returns

of handler {@link XoopsModelAbstract}

#


					
	public

__call(string $name, array $args): mixed

Magic method for overloading of delegation

To be enabled in XOOPS 3.0 with PHP 5

Parameters

`$name`	method name
`$args`	arguments

#


					
	public

create(bool $isNew = true): XoopsObject

create a new object

Parameters

$isNew

Flag the new objects as new

Returns

{@link XoopsObject}

Overrides

XoopsObjectHandler::create()

Overriden by

ProfileProfileHandler::create()

#


					
	public

get(mixed $id = null, array|null $fields = null): XoopsObject|null

Load a {@link XoopsObject} object from the database

Parameters

`$id`	ID
`$fields`	fields to fetch

Returns

{@link XoopsObject}

Overrides

XoopsObjectHandler::get()

#


					
	public

insert(XoopsObject $object, bool $force = true): mixed

insert an object into the database

Parameters

`$object`	{@link XoopsObject} reference to object
`$force`	flag to force the query execution despite security settings

Returns

object ID

Overrides

XoopsObjectHandler::insert()

Overriden by

#


					
	public

delete(XoopsObject $object, bool $force = false): bool

delete an object from the database

Parameters

$object

{@link XoopsObject} reference to the object to delete

Returns

FALSE if failed.

Overrides

XoopsObjectHandler::delete()

Overriden by

#


					
	public

deleteAll(CriteriaElement|null $criteria = null, bool $force = true, bool $asObject = false): bool|int

delete all objects matching the conditions

Parameters

`$criteria`	{@link CriteriaElement} with conditions to meet
`$force`	force to delete
`$asObject`	delete in object way: instantiate all objects and delete one by one

#


					
	public

updateAll(string $fieldname, mixed $fieldvalue, CriteriaElement|null $criteria = null, bool $force = false): bool

Change a field for objects with a certain criteria

Parameters

`$fieldname`	Name of the field
`$fieldvalue`	Value to write
`$criteria`	{@link CriteriaElement}
`$force`	force to query

#


					
	public
					
					&

getObjects(CriteriaElement|null $criteria = null, bool $id_as_key = false, bool $as_object = true): array

Retrieve objects from the database

Parameters

`$criteria`	{@link CriteriaElement} conditions to be met
`$id_as_key`	use the ID as key for the array
`$as_object`	return an array of objects

Overriden by

SystemBlockHandler::getObjects()

#


					
	public
					
					&

getAll(
	CriteriaElement|null $criteria = null,
	array|null $fields = null,
	bool $asObject = true,
	bool $id_as_key = true,
): array

get all objects matching a condition

Parameters

`$criteria`	{@link 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

of objects/array {@link XoopsObject}

#


					
	public

getList(CriteriaElement|null $criteria = null, int $limit = 0, int $start = 0): array

Retrieve a list of objects data

Parameters

`$criteria`	{@link CriteriaElement} conditions to be met
`$limit`	Max number of objects to fetch
`$start`	Which record to start at

#


					
	public
					
					&

getIds(CriteriaElement|null $criteria = null): array

get IDs of objects matching a condition

Parameters

$criteria

{@link CriteriaElement} to match

Returns

of object IDs

#


					
	public
					
					&

getByLimit(
	int $limit = 0,
	int $start = 0,
	CriteriaElement|null $criteria = null,
	array|null $fields = null,
	bool $asObject = true,
): array

get a limited list of objects matching a condition

{@link CriteriaCompo}

Parameters

`$limit`	Max number of objects to fetch
`$start`	Which record to start at
`$criteria`	{@link CriteriaElement} to match
`$fields`	variables to fetch
`$asObject`	flag indicating as object, otherwise as array

Returns

of objects {@link XoopsObject}

#


					
	public

getCount(CriteriaElement|null $criteria = null): int

count objects matching a condition

Parameters

$criteria

{@link CriteriaElement} to match

Returns

count of objects

#


					
	public

getCounts(CriteriaElement|null $criteria = null): array

Get counts of objects matching a condition

Parameters

$criteria

{@link CriteriaElement} to match

Returns

of counts

#


					
	public
					
					&

getByLink(
	CriteriaElement|null $criteria = null,
	array|null $fields = null,
	bool $asObject = true,
	string|null $field_link = null,
	string|null $field_object = null,
): array

get a list of objects matching a condition joint with another related object

Parameters

`$criteria`	{@link 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

of objects {@link XoopsObject}

#


					
	public

getCountByLink(CriteriaElement|null $criteria = null): int

Count of objects matching a condition

Parameters

$criteria

{@link CriteriaElement} to match

Returns

count of objects

#


					
	public

getCountsByLink(CriteriaElement|null $criteria = null): int

array of count of objects matching a condition of, groupby linked object keyname

Parameters

$criteria

{@link CriteriaElement} to match

Returns

count of objects

#


					
	public

updateByLink(array $data, CriteriaElement|null $criteria = null): int

update objects matching a condition against linked objects

Parameters

`$data`	array of key => value
`$criteria`	{@link CriteriaElement} to match

Returns

count of objects

#


					
	public

deleteByLink(CriteriaElement|null $criteria = null): int|null

Delete objects matching a condition against linked objects

Parameters

$criteria

{@link CriteriaElement} to match

Returns

count of objects

#


					
	public

cleanOrphan(string $table_link = '', string $field_link = '', string $field_object = ''): bool

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

true on success

#


					
	public

synchronization(): bool

Synchronizing objects

Returns

true on success

#


					
	public

convertResultSet($result, $id_as_key = false, $as_object = true)

*#@-

#

Properties
`public`		`$table_link`	#
`public`		`$handler` static protected static protected	#
`public`		`$handlers = ['read' => null, 'stats' => null, 'joint' => null, 'write' => null, 'sync' => null]` static protected static protected	#
`public`	`string`	`$table`	#
`public`	`string`	`$keyName`	#
`public`	`string`	`$className`	#
`public`	`string`	`$identifierName`	#
`public`	`string`	`$field_link`	#
`public`	`string`	`$field_object`	#

Namespaces

Classes

Interfaces

Exceptions

Functions

Class XoopsPersistableObjectHandler

Parameters

Overrides

Overriden by

Deprecated

Parameters

Parameters

Returns

Parameters

Parameters

Returns

Overrides

Overriden by

Parameters

Returns

Overrides

Parameters

Returns

Overrides

Overriden by

Parameters

Returns

Overrides

Overriden by

Parameters

Parameters

Parameters

Overriden by

Parameters

Returns

Parameters

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns