Référence de la classe XoopsPersistableObjectHandler

Graphe d'héritage de XoopsPersistableObjectHandler:

Graphe de collaboration de XoopsPersistableObjectHandler:

Fonctions membres publiques
	__construct (XoopsDatabase $db=null, $table='', $className='', $keyName='', $identifierName='')
	XoopsPersistableObjectHandler (XoopsDatabase $db=null, $table='', $className='', $keyName='', $identifierName='')
	setHandler ($handler=null, $args=null, $path=null)
	loadHandler ($name, $args=null)
	__call ($name, $args)
	create ($isNew=true)
	get ($id=null, $fields=null)
	insert (XoopsObject $object, $force=true)
	delete (XoopsObject $object, $force=false)
	deleteAll (CriteriaElement $criteria=null, $force=true, $asObject=false)
	updateAll ($fieldname, $fieldvalue, CriteriaElement $criteria=null, $force=false)
&	getObjects (CriteriaElement $criteria=null, $id_as_key=false, $as_object=true)
&	getAll (CriteriaElement $criteria=null, $fields=null, $asObject=true, $id_as_key=true)
	getList (CriteriaElement $criteria=null, $limit=0, $start=0)
&	getIds (CriteriaElement $criteria=null)
&	getByLimit ($limit=0, $start=0, CriteriaElement $criteria=null, $fields=null, $asObject=true)
	getCount (CriteriaElement $criteria=null)
	getCounts (CriteriaElement $criteria=null)
&	getByLink (CriteriaElement $criteria=null, $fields=null, $asObject=true, $field_link=null, $field_object=null)
	getCountByLink (CriteriaElement $criteria=null)
	getCountsByLink (CriteriaElement $criteria=null)
	updateByLink ($data, CriteriaElement $criteria=null)
	deleteByLink (CriteriaElement $criteria=null)
	cleanOrphan ($table_link='', $field_link='', $field_object='')
	synchronization ()
	convertResultSet ($result, $id_as_key=false, $as_object=true)
Fonctions membres publiques hérités de XoopsObjectHandler
	__construct (XoopsDatabase $db)
	XoopsObjectHandler ($db)
	create ()
	get ($int_id)
	insert (XoopsObject $object)
	delete (XoopsObject $object)

Champs de données
	$handler
	$handlers = array('read' => null, 'stats' => null, 'joint' => null, 'write' => null, 'sync' => null)
	$table
	$keyName
	$className
	$identifierName
	$field_link
	$field_object
Champs de données hérités de XoopsObjectHandler
	$db

Documentation des constructeurs et destructeur

__construct()

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

Constructor

Paramètres

null | XoopsDatabase	$db	database connection
string	$table	Name of database table
string	$className	Name of the XoopsObject class this handler manages
string	$keyName	Name of the property holding the key
string	$identifierName	Name of the property holding an identifier name (title, name ...), used on getList()

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

Documentation des fonctions membres

__call()

__call	(		$name,
			$args
	)

Magic method for overloading of delegation

To be enabled in XOOPS 3.0 with PHP 5

@access protected

Paramètres

string	$name	method name
array	$args	arguments

Renvoie

mixed

Voici le graphe d'appel pour cette fonction :

cleanOrphan()

cleanOrphan	(		$table_link = '',
			$field_link = '',
			$field_object = ''
	)

*#- *#+ Methods of sync handler XoopsObjectSync Clean orphan objects against linked objects

Paramètres

string	$table_link	table of linked object for JOIN
string	$field_link	field of linked object for JOIN
string	$field_object	field of current object for JOIN

Renvoie

bool true on success

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

convertResultSet()

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

*#- #+

Obsolète:

Paramètres

	$result
bool	$id_as_key
bool	$as_object

Renvoie

bool

create()

create

(

$isNew = true

)

*#+ Methods of native handler XoopsPersistableObjectHandler create a new object

Paramètres

bool

$isNew

Flag the new objects as new

Renvoie

XoopsObject XoopsObject

Réimplémentée dans ProfileProfileHandler.

delete()

delete	(	XoopsObject	$object,
			$force = false
	)

delete an object from the database

Paramètres

XoopsObject	$object	XoopsObject reference to the object to delete
bool	$force

Renvoie

bool FALSE if failed.

Réimplémentée dans ProfileFieldHandler, et ProfileRegstepHandler.

Voici le graphe d'appel pour cette fonction :

deleteAll()

deleteAll	(	CriteriaElement	$criteria = null,
			$force = true,
			$asObject = false
	)

delete all objects matching the conditions

Paramètres

CriteriaElement	$criteria	CriteriaElement with conditions to meet
bool	$force	force to delete
bool	$asObject	delete in object way: instantiate all objects and delete one by one

Renvoie

bool

Voici le graphe d'appel pour cette fonction :

deleteByLink()

deleteByLink

(

CriteriaElement

$criteria = null

)

Delete objects matching a condition against linked objects

Paramètres

CriteriaElement

$criteria

CriteriaElement to match

Renvoie

int count of objects

Voici le graphe d'appel pour cette fonction :

get()

get	(		$id = null,
			$fields = null
	)

Load a XoopsObject object from the database

@access protected

Paramètres

mixed	$id	ID
array	$fields	fields to fetch

Renvoie

XoopsObject XoopsObject

Réimplémentée dans ProfileProfileHandler.

Voici le graphe d'appel pour cette fonction :

getAll()

& getAll	(	CriteriaElement	$criteria = null,
			$fields = null,
			$asObject = true,
			$id_as_key = true
	)

get all objects matching a condition

Paramètres

CriteriaElement	$criteria	CriteriaElement to match
array	$fields	variables to fetch
bool	$asObject	flag indicating as object, otherwise as array
bool	$id_as_key	use the ID as key for the array

Renvoie

array of objects/array XoopsObject

Voici le graphe d'appel pour cette fonction :

getByLimit()

& getByLimit	(		$limit = 0,
			$start = 0,
		CriteriaElement	$criteria = null,
			$fields = null,
			$asObject = true
	)

get a limited list of objects matching a condition

CriteriaCompo

Paramètres

int	$limit	Max number of objects to fetch
int	$start	Which record to start at
CriteriaElement	$criteria	CriteriaElement to match
array	$fields	variables to fetch
bool	$asObject	flag indicating as object, otherwise as array

Renvoie

array of objects XoopsObject

Voici le graphe d'appel pour cette fonction :

getByLink()

& getByLink	(	CriteriaElement	$criteria = null,
			$fields = null,
			$asObject = true,
			$field_link = null,
			$field_object = null
	)

*#- *#+ Methods of joint handler XoopsObjectJoint get a list of objects matching a condition joint with another related object

Paramètres

CriteriaElement	$criteria	CriteriaElement to match
array	$fields	variables to fetch
bool	$asObject	flag indicating as object, otherwise as array
string	$field_link	field of linked object for JOIN
string	$field_object	field of current object for JOIN

Renvoie

array of objects XoopsObject

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

getCount()

getCount

(

CriteriaElement

$criteria = null

)

*#- *#+ Methods of stats handler XoopsObjectStats count objects matching a condition

Paramètres

CriteriaElement

$criteria

CriteriaElement to match

Renvoie

int count of objects

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

getCountByLink()

getCountByLink

(

CriteriaElement

$criteria = null

)

Count of objects matching a condition

Paramètres

CriteriaElement

$criteria

CriteriaElement to match

Renvoie

int count of objects

Voici le graphe d'appel pour cette fonction :

getCounts()

getCounts

(

CriteriaElement

$criteria = null

)

Get counts of objects matching a condition

Paramètres

CriteriaElement

$criteria

CriteriaElement to match

Renvoie

array of counts

Voici le graphe d'appel pour cette fonction :

getCountsByLink()

getCountsByLink

(

CriteriaElement

$criteria = null

)

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

Paramètres

CriteriaElement

$criteria

CriteriaElement to match

Renvoie

int count of objects

Voici le graphe d'appel pour cette fonction :

getIds()

& getIds

(

CriteriaElement

$criteria = null

)

get IDs of objects matching a condition

Paramètres

CriteriaElement

$criteria

CriteriaElement to match

Renvoie

array of object IDs

Voici le graphe d'appel pour cette fonction :

getList()

getList	(	CriteriaElement	$criteria = null,
			$limit = 0,
			$start = 0
	)

Retrieve a list of objects data

Paramètres

CriteriaElement	$criteria	CriteriaElement conditions to be met
int	$limit	Max number of objects to fetch
int	$start	Which record to start at

Renvoie

array

Voici le graphe d'appel pour cette fonction :

getObjects()

& getObjects	(	CriteriaElement	$criteria = null,
			$id_as_key = false,
			$as_object = true
	)

*#- *#+ Methods of read handler XoopsObjectRead Retrieve objects from the database

Paramètres

CriteriaElement	$criteria	CriteriaElement conditions to be met
bool	$id_as_key	use the ID as key for the array
bool	$as_object	return an array of objects

Renvoie

array

Réimplémentée dans SystemBlockHandler.

Voici le graphe d'appel pour cette fonction :

insert()

insert	(	XoopsObject	$object,
			$force = true
	)

*#- *#+ Methods of write handler XoopsObjectWrite insert an object into the database

Paramètres

XoopsObject	$object	XoopsObject reference to object
bool	$force	flag to force the query execution despite security settings

Renvoie

mixed object ID

Réimplémentée dans ArtObjectHandler, SystemBlockHandler, ProfileFieldHandler, et ProfileProfileHandler.

Voici le graphe d'appel pour cette fonction :

loadHandler()

loadHandler	(		$name,
			$args = null
	)

Load predefined handler

@access protected

Paramètres

string	$name	handler name
mixed	$args	args

Renvoie

XoopsModelAbstract of handler XoopsModelAbstract

// Following code just kept as placeholder for PHP5 if (!isset(self::$handlers[$name])) { self::$handlers[$name] = XoopsModelFactory::loadHandler($this, $name, $args); } else { self::$handlers[$name]->setHandler($this); self::$handlers[$name]->setVars($args); }

return self::$handlers[$name];

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

setHandler()

setHandler	(		$handler = null,
			$args = null,
			$path = null
	)

Set custom handler

@access protected

Paramètres

null | string	$handler
null	$args
string	$path	path to class

Voici le graphe d'appel pour cette fonction :

synchronization()

synchronization

(

)

Synchronizing objects

Renvoie

bool true on success

Voici le graphe d'appel pour cette fonction :

updateAll()

updateAll	(		$fieldname,
			$fieldvalue,
		CriteriaElement	$criteria = null,
			$force = false
	)

Change a field for objects with a certain criteria

Paramètres

string	$fieldname	Name of the field
mixed	$fieldvalue	Value to write
CriteriaElement	$criteria	CriteriaElement
bool	$force	force to query

Renvoie

bool

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

updateByLink()

updateByLink	(		$data,
		CriteriaElement	$criteria = null
	)

update objects matching a condition against linked objects

Paramètres

array	$data	array of key => value
CriteriaElement	$criteria	CriteriaElement to match

Renvoie

int count of objects

Voici le graphe d'appel pour cette fonction :

XoopsPersistableObjectHandler()

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

PHP 4 style constructor compatibility shim

Paramètres

null | XoopsDatabase	$db	database connection
string	$table	Name of database table
string	$className	Name of the XoopsObject class this handler manages
string	$keyName	Name of the property holding the key
string	$identifierName	Name of the property holding an identifier name (title, name ...), used on getList()

Obsolète:

all callers should be using parent::__construct()

Voici le graphe d'appel pour cette fonction :

Documentation des champs

$className

$className

$field_link

$field_link

$field_object

$field_object

$handler

$handler

holds reference to custom extended object handler

var object

@access private static protected

$handlers

$handlers = array('read' => null, 'stats' => null, 'joint' => null, 'write' => null, 'sync' => null)

holds reference to predefined extended object handlers: read, stats, joint, write, sync

The handlers hold methods for different purposes, which could be all put together inside of current class. However, load codes only if they are necessary, thus they are now split out.

var array of objects

@access private static protected

$identifierName

$identifierName

$keyName

$keyName

$table

$table

---

La documentation de cette classe a été générée à partir du fichier suivant :

• XoopsCore25-2.5.11-Beta1/htdocs/kernel/object.php