XoopsModelWrite Class Reference

Inheritance diagram for XoopsModelWrite:

Collaboration diagram for XoopsModelWrite:

Public Member Functions
	cleanVars (&$object)
	insert (&$object, $force=true)
	delete (&$object, $force=false)
	deleteAll (CriteriaElement $criteria=null, $force=true, $asObject=false)
	updateAll ($fieldname, $fieldvalue, CriteriaElement $criteria=null, $force=false)
Public Member Functions inherited from XoopsModelAbstract
	__construct ($args=null, $handler=null)
	setHandler ($handler)
	setVars ($args)

Additional Inherited Members
Data Fields inherited from XoopsModelAbstract
	$handler

Detailed Description

Object write handler class.

Author

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

Simon Roberts simon.nosp@m.@xoo.nosp@m.ps.or.nosp@m.g

XoopsModelAbstract

Member Function Documentation

cleanVars()

cleanVars

(

&

$object

)

Clean values of all variables of the object for storage. also add slashes and quote string wherever needed

CleanVars only contains changed and cleaned variables Reference is used for PHP4 compliance

Parameters

$object

Returns

bool true if successful @access public

Here is the call graph for this function:

Here is the caller graph for this function:

delete()

delete	(	&	$object,
			$force = false
	)

delete an object from the database

Parameters

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

Returns

bool FALSE if failed.

deleteAll()

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

delete all objects matching the conditions

Parameters

CriteriaElement | CriteriaCompo	$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

Returns

bool|int

insert()

insert	(	&	$object,
			$force = true
	)

insert an object into the database

Parameters

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

Returns

mixed object ID

Here is the call graph for this function:

updateAll()

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

Change a field for objects with a certain criteria

Parameters

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

Returns

bool

---

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

• C:/xoops2511b2/htdocs/class/model/write.php