Référence de la classe XoopsModelRead

Graphe d'héritage de XoopsModelRead:

Graphe de collaboration de XoopsModelRead:

Fonctions membres publiques
&	getAll (CriteriaElement $criteria=null, $fields=null, $asObject=true, $id_as_key=true)
&	getObjects (CriteriaElement $criteria=null, $id_as_key=false, $as_object=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)
	convertResultSet ($result, $id_as_key=false, $as_object=true)
Fonctions membres publiques hérités de XoopsModelAbstract
	__construct ($args=null, $handler=null)
	setHandler ($handler)
	setVars ($args)

Membres hérités additionnels
Champs de données hérités de XoopsModelAbstract
	$handler

Description détaillée

Object render handler class.

Auteur

Taiwen Jiang phppp.nosp@m.@use.nosp@m.rs.so.nosp@m.urce.nosp@m.forge.nosp@m..net

XoopsModelAbstract

Documentation des fonctions membres

convertResultSet()

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

Convert a database resultset to a returnable array

Paramètres

object	$result	database resultset
bool	$id_as_key	- should NOT be used with joint keys
bool	$as_object

Renvoie

array

getAll()

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

get all objects matching a condition

Paramètres

CriteriaElement | CriteriaCompo	$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 des appelants de 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

getIds()

& getIds

(

CriteriaElement

$criteria = null

)

get IDs of objects matching a condition

Paramètres

CriteriaElement | CriteriaCompo

$criteria

CriteriaElement to match

Renvoie

array of object IDs

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
	)

retrieve objects from the database

For performance consideration, getAll() is recommended

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

Voici le graphe d'appel pour cette fonction :

---

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

• XoopsCore25-2.5.11-Beta1/htdocs/class/model/read.php