ViewsDAO Class Reference

Inheritance diagram for ViewsDAO:

Public Member Functions
	deleteViews ($assocType, $assocId)
	getLastViewDate ($assocType, $assocId, $userId=null)
	moveViews ($assocType, $oldAssocId, $newAssocId)
	recordView ($assocType, $assocId, $userId)
Public Member Functions inherited from DAO
	__construct ($dataSource=null, $callHooks=true)
	concat ()
	convertFromDB ($value, $type)
	convertToDB ($value, &$type)
	dateFromDB ($d)
	datetimeFromDB ($dt)
	datetimeToDB ($dt)
	dateToDB ($d)
	flushCache ()
	formatDateToDB ($date, $defaultNumWeeks=null, $acceptPastDate=true)
	getAdditionalFieldNames ()
	getAffectedRows ()
	getDataObjectSettings ($tableName, $idFieldName, $idFieldValue, $dataObject)
	getDataSource ()
	getDirectionMapping ($direction)
	getDriver ()
	getLocaleFieldNames ()
	getType ($value)
	handleError ($dataSource, $sql)
	nullOrInt ($value)
	replace ($table, $arrFields, $keyCols)
&	retrieve ($sql, $params=false, $callHooks=true)
&	retrieveCached ($sql, $params=false, $secsToCache=3600, $callHooks=true)
&	retrieveLimit ($sql, $params=false, $numRows=false, $offset=false, $callHooks=true)
&	retrieveRange ($sql, $params=false, $dbResultRange=null, $callHooks=true)
	setCacheDir ()
	setDataSource ($dataSource)
	update ($sql, $params=false, $callHooks=true, $dieOnError=true)
	updateDataObjectSettings ($tableName, $dataObject, $idArray)

Additional Inherited Members
Static Public Member Functions inherited from DAO
static	getDataChangedEvent ($elementId=null, $parentElementId=null, $content='')
Data Fields inherited from DAO
	$_dataSource
Protected Member Functions inherited from DAO
	_getInsertId ($table='', $id='')

Detailed Description

Class for keeping track of item views.

Definition at line 20 of file ViewsDAO.inc.php.

Member Function Documentation

deleteViews()

ViewsDAO::deleteViews	(		$assocType,
			$assocId
	)

Delete views of an assoc object.

Parameters

$assocType	integer One of the ASSOC_TYPE_* constants.
$assocId	string

Definition at line 81 of file ViewsDAO.inc.php.

References DAO\update().

getLastViewDate()

ViewsDAO::getLastViewDate	(		$assocType,
			$assocId,
			$userId = null
	)

Get the timestamp of the last view.

Parameters

$assocType	integer
$assocId	string
$userId	integer

Returns

string|boolean Datetime of last view. False if no view found.

Definition at line 49 of file ViewsDAO.inc.php.

References DAO\retrieve().

moveViews()

ViewsDAO::moveViews	(		$assocType,
			$oldAssocId,
			$newAssocId
	)

Move views from one assoc object to another.

Parameters

$assocType	integer One of the ASSOC_TYPE_* constants.
$oldAssocId	string
$newAssocId	string

Definition at line 69 of file ViewsDAO.inc.php.

References DAO\update().

recordView()

ViewsDAO::recordView	(		$assocType,
			$assocId,
			$userId
	)

Mark an item as viewed.

Parameters

$assocType	integer The associated type for the item being marked.
$assocId	string The id of the object being marked.
$userId	integer The id of the user viewing the item.

Returns

int RECORD_VIEW_RESULT_...

Definition at line 29 of file ViewsDAO.inc.php.

References DAO\replace().

---

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

• ViewsDAO.inc.php