Xoops\Core\Kernel\Model\Joint Class Reference

Inheritance diagram for Xoops\Core\Kernel\Model\Joint:

Public Member Functions
	deleteByLink (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 (array $data, CriteriaElement $criteria=null)
Public Member Functions inherited from Xoops\Core\Kernel\XoopsModelAbstract
	setHandler (XoopsPersistableObjectHandler $handler)
	setVars ($args)

Private Member Functions
	validateLinks ()

Additional Inherited Members
Protected Attributes inherited from Xoops\Core\Kernel\XoopsModelAbstract
	$handler

Detailed Description

Definition at line 42 of file Joint.php.

Member Function Documentation

Xoops\Core\Kernel\Model\Joint::deleteByLink

(

CriteriaElement

$criteria = null

)

Delete objects matching a condition against linked objects

Parameters

CriteriaElement | null

$criteria

CriteriaElement to match

Returns

false|int count of objects

Todo:

DELETE ... LEFT JOIN is not portable Note Alain91 : multi tables delete is not allowed in Doctrine

Definition at line 254 of file Joint.php.

References $criteria, $sql, and Xoops\Core\Kernel\Model\Joint\validateLinks().

Here is the call graph for this function:

Xoops\Core\Kernel\Model\Joint::getByLink	(	CriteriaElement	$criteria = null,
			$fields = null,
			$asObject = true,
			$field_link = null,
			$field_object = null
	)

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

Parameters

CriteriaElement | null	$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; deprecated, for backward compat
string	$field_object	field of current object for JOIN; deprecated, for backward compat

Returns

false|array of objects XoopsObject

Definition at line 72 of file Joint.php.

References $criteria, $result, and Xoops\Core\Kernel\Model\Joint\validateLinks().

Here is the call graph for this function:

Xoops\Core\Kernel\Model\Joint::getCountByLink

(

CriteriaElement

$criteria = null

)

Count of objects matching a condition

Parameters

CriteriaElement | null

$criteria

CriteriaElement to match

Returns

false|int count of objects

Definition at line 144 of file Joint.php.

References $criteria, $result, and Xoops\Core\Kernel\Model\Joint\validateLinks().

Here is the call graph for this function:

Xoops\Core\Kernel\Model\Joint::getCountsByLink

(

CriteriaElement

$criteria = null

)

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

Parameters

CriteriaElement

$criteria

CriteriaElement to match

Returns

false|int count of objects

Definition at line 177 of file Joint.php.

References $count, $criteria, $id, $result, and Xoops\Core\Kernel\Model\Joint\validateLinks().

Here is the call graph for this function:

Xoops\Core\Kernel\Model\Joint::updateByLink	(	array	$data,
		CriteriaElement	$criteria = null
	)

update objects matching a condition against linked objects

Parameters

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

Returns

false|int count of objects

Todo:

UPDATE ... LEFT JOIN is not portable Note Alain91 : multi tables update is not allowed in Doctrine

Definition at line 221 of file Joint.php.

References $criteria, $sql, and Xoops\Core\Kernel\Model\Joint\validateLinks().

Here is the call graph for this function:

Xoops\Core\Kernel\Model\Joint::validateLinks ( )

private

Validate information for the linkship

Returns

bool

Definition at line 49 of file Joint.php.

Referenced by Xoops\Core\Kernel\Model\Joint\deleteByLink(), Xoops\Core\Kernel\Model\Joint\getByLink(), Xoops\Core\Kernel\Model\Joint\getCountByLink(), Xoops\Core\Kernel\Model\Joint\getCountsByLink(), and Xoops\Core\Kernel\Model\Joint\updateByLink().

Here is the caller graph for this function:

---

The documentation for this class was generated from the following file:

• C:/usr64/htdocs/xoops_lib/Xoops/Core/Kernel/Model/Joint.php