Inheritance diagram for SpotlightDAO:

Public Member Functions
	__construct ()

	_fromRow ($row)

	deleteByAssoc ($assocType, $assocId)

	deleteById ($spotlightId)

	deleteByTypeId ($typeId)

	deleteObject ($spotlight)

	getByAssoc ($assocType, $assocId, $rangeInfo=null)

	getById ($spotlightId)

	getByPressId ($pressId, $rangeInfo=null)

	getInsertId ()

	getLocaleFieldNames ()

	getMostRecentSpotlightByAssoc ($assocType, $assocId)

	getNumSpotlightsByAssoc ($assocType, $assocId, $rangeInfo=null)

	getRandomByPressId ($pressId, $quantity=1)

	getSpotlightAssocId ($spotlightId)

	getSpotlightAssocType ($spotlightId)

	insertObject ($spotlight)

	newDataObject ()

	updateLocaleFields (&$spotlight)

	updateObject ($spotlight)

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 ()

	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

Operations for retrieving and modifying Spotlight objects.

See also: Spotlight

Definition at line 19 of file SpotlightDAO.inc.php.

Constructor & Destructor Documentation

◆ __construct()

SpotlightDAO::__construct ( )

Constructor

Definition at line 23 of file SpotlightDAO.inc.php.

Member Function Documentation

◆ _fromRow()

SpotlightDAO::_fromRow ( $row )

Internal function to return an Spotlight object from a row.

Parameters

$row array

Returns: Spotlight

Definition at line 99 of file SpotlightDAO.inc.php.

References DAO\getDataObjectSettings(), and newDataObject().

Referenced by getById(), and getMostRecentSpotlightByAssoc().

◆ deleteByAssoc()

SpotlightDAO::deleteByAssoc	(	$assocType,
		$assocId
	)

Delete spotlights by Assoc ID

Parameters

$assocType	int
$assocId	int

Definition at line 203 of file SpotlightDAO.inc.php.

References deleteById().

◆ deleteById()

SpotlightDAO::deleteById ( $spotlightId )

Delete an spotlight by spotlight ID.

Parameters

$spotlightId int

Returns: boolean

Definition at line 181 of file SpotlightDAO.inc.php.

References DAO\update().

Referenced by deleteByAssoc(), and deleteObject().

◆ deleteByTypeId()

SpotlightDAO::deleteByTypeId ( $typeId )

Delete spotlights by spotlight type ID.

Parameters

$typeId int

Returns: boolean

Definition at line 191 of file SpotlightDAO.inc.php.

References deleteObject().

◆ deleteObject()

SpotlightDAO::deleteObject ( $spotlight )

Delete a spotlight.

Parameters

$spotlight Spotlight

Returns: boolean

Definition at line 172 of file SpotlightDAO.inc.php.

References deleteById().

Referenced by deleteByTypeId().

◆ getByAssoc()

SpotlightDAO::getByAssoc	(	$assocType,
		$assocId,
		$rangeInfo = `null`
	)

Retrieve an array of spotlights matching a particular assoc ID.

Parameters

$assocType	int
$assocId	int

Returns: object DAOResultFactory containing matching Spotlights

Definition at line 279 of file SpotlightDAO.inc.php.

References DAO\retrieveRange().

◆ getById()

SpotlightDAO::getById ( $spotlightId )

Retrieve a spotlight by spotlight ID.

Parameters

$spotlightId int

Returns: Spotlight

Definition at line 32 of file SpotlightDAO.inc.php.

References _fromRow(), and DAO\retrieve().

◆ getByPressId()

SpotlightDAO::getByPressId	(	$pressId,
		$rangeInfo = `null`
	)

Retrieve an array of spotlights matching a press id.

Parameters

$pressId int

Returns: array Array containing matching Spotlights

Definition at line 216 of file SpotlightDAO.inc.php.

References DAO\retrieveRange().

Referenced by getRandomByPressId().

◆ getInsertId()

SpotlightDAO::getInsertId ( )

Get the ID of the last inserted spotlight.

Returns: int

Definition at line 338 of file SpotlightDAO.inc.php.

References DAO\_getInsertId().

Referenced by insertObject().

◆ getLocaleFieldNames()

SpotlightDAO::getLocaleFieldNames ( )

Get the list of localized field names for this table

Returns: array

Reimplemented from DAO.

Definition at line 82 of file SpotlightDAO.inc.php.

◆ getMostRecentSpotlightByAssoc()

SpotlightDAO::getMostRecentSpotlightByAssoc	(	$assocType,
		$assocId
	)

Retrieve most recent spotlight by Assoc ID.

Parameters

$assocType int

Returns: Spotlight

Definition at line 316 of file SpotlightDAO.inc.php.

References _fromRow(), and DAO\retrieve().

◆ getNumSpotlightsByAssoc()

SpotlightDAO::getNumSpotlightsByAssoc	(	$assocType,
		$assocId,
		$rangeInfo = `null`
	)

Retrieve an array of numSpotlights spotlights matching a particular Assoc ID.

Parameters

$assocType int

Returns: object DAOResultFactory containing matching Spotlights

Definition at line 297 of file SpotlightDAO.inc.php.

References DAO\retrieveRange().

◆ getRandomByPressId()

SpotlightDAO::getRandomByPressId	(	$pressId,
		$quantity = `1`
	)

Retrieve a random spotlight matching a press id.

Parameters

$pressId	int
$quantity	int (optional) If more than one is needed, specify here.

Returns: array or null

Definition at line 247 of file SpotlightDAO.inc.php.

References getByPressId().

◆ getSpotlightAssocId()

SpotlightDAO::getSpotlightAssocId ( $spotlightId )

Retrieve spotlight Assoc ID by spotlight ID.

Parameters

$spotlightId int

Returns: int

Definition at line 51 of file SpotlightDAO.inc.php.

References DAO\retrieve().

◆ getSpotlightAssocType()

SpotlightDAO::getSpotlightAssocType ( $spotlightId )

Retrieve spotlight Assoc ID by spotlight ID.

Parameters

$spotlightId int

Returns: int

Definition at line 67 of file SpotlightDAO.inc.php.

References DAO\retrieve().

◆ insertObject()

SpotlightDAO::insertObject ( $spotlight )

Insert a new Spotlight.

Parameters

$spotlight Spotlight

Returns: int

Definition at line 126 of file SpotlightDAO.inc.php.

References getInsertId(), DAO\update(), and updateLocaleFields().

◆ newDataObject()

SpotlightDAO::newDataObject ( )

Get a new data object.

Returns: DataObject

Definition at line 90 of file SpotlightDAO.inc.php.

Referenced by _fromRow().

◆ updateLocaleFields()

SpotlightDAO::updateLocaleFields ( & $spotlight )

Update the settings for this object

Parameters

$spotlight object

Definition at line 115 of file SpotlightDAO.inc.php.

References DAO\updateDataObjectSettings().

Referenced by insertObject(), and updateObject().

◆ updateObject()

SpotlightDAO::updateObject ( $spotlight )

Update an existing spotlight.

Parameters

$spotlight Spotlight

Returns: boolean

Definition at line 148 of file SpotlightDAO.inc.php.

References DAO\update(), and updateLocaleFields().

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

SpotlightDAO.inc.php

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _fromRow()

◆ deleteByAssoc()

◆ deleteById()

◆ deleteByTypeId()

◆ deleteObject()

◆ getByAssoc()

◆ getById()

◆ getByPressId()

◆ getInsertId()

◆ getLocaleFieldNames()

◆ getMostRecentSpotlightByAssoc()

◆ getNumSpotlightsByAssoc()

◆ getRandomByPressId()

◆ getSpotlightAssocId()

◆ getSpotlightAssocType()

◆ insertObject()

◆ newDataObject()

◆ updateLocaleFields()

◆ updateObject()