Open Monograph Press: NavigationMenuDAO Class Reference

Open Monograph Press 3.3.0

Inheritance diagram for NavigationMenuDAO:

Public Member Functions
	_cacheMiss ($cache, $id)

	_fromRow ($row)

	deleteByContextId ($contextId)

	deleteById ($navigationMenuId)

	deleteObject ($navigationMenu)

	getByArea ($contextId, $areaName)

	getByContextId ($contextId)

	getById ($navigationMenuId, $contextId=null)

	getByTitle ($contextId, $title)

	getCache ($id)

	getInsertId ()

	getLocaleFieldNames ()

	insertObject ($navigationMenu)

	installSettings ($contextId, $filename)

	navigationMenuExistsByTitle ($contextId, $title)

	newDataObject ()

	unCache ($id)

	updateObject ($navigationMenu)

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 NavigationMenu objects.

See also: NavigationMenu

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

Member Function Documentation

◆ _cacheMiss()

NavigationMenuDAO::_cacheMiss	(		$cache,
			$id
	)

Callback for a cache miss.

Parameters

$cache	Cache
$id	string

Returns: mixed

Definition at line 347 of file NavigationMenuDAO.inc.php.

References PKPServices\get(), and DAORegistry\getDAO().

◆ _fromRow()

NavigationMenuDAO::_fromRow ( $row )

Internal function to return an NavigationMenu object from a row.

Parameters

$row array

Returns: NavigationMenu

Definition at line 143 of file NavigationMenuDAO.inc.php.

References newDataObject().

Referenced by getById(), and getByTitle().

◆ deleteByContextId()

NavigationMenuDAO::deleteByContextId ( $contextId )

Delete NavigationMenus by contextId.

Parameters

$contextId int

Definition at line 226 of file NavigationMenuDAO.inc.php.

References deleteObject(), and getByContextId().

◆ deleteById()

NavigationMenuDAO::deleteById ( $navigationMenuId )

Delete a NavigationMenu.

Parameters

$navigationMenuId int

Definition at line 213 of file NavigationMenuDAO.inc.php.

References DAORegistry\getDAO(), unCache(), and DAO\update().

Referenced by deleteObject().

◆ deleteObject()

NavigationMenuDAO::deleteObject ( $navigationMenu )

Delete a NavigationMenu.

Parameters

$navigationMenu NavigationMenu

Returns: boolean

Definition at line 205 of file NavigationMenuDAO.inc.php.

References deleteById().

Referenced by deleteByContextId().

◆ getByArea()

NavigationMenuDAO::getByArea	(		$contextId,
			$areaName
	)

Retrieve a navigation menu by navigation menu area.

Parameters

$contextId	int Context Id
$areaName	string Template Area name

Returns: NavigationMenu

Definition at line 73 of file NavigationMenuDAO.inc.php.

References DAO\retrieve().

Referenced by installSettings().

◆ getByContextId()

NavigationMenuDAO::getByContextId ( $contextId )

Retrieve a navigation menu by context Id.

Parameters

$contextId int Context Id

Returns: NavigationMenu

Definition at line 57 of file NavigationMenuDAO.inc.php.

References DAO\retrieve().

Referenced by deleteByContextId().

◆ getById()

NavigationMenuDAO::getById	(		$navigationMenuId,
			$contextId = `null`
	)

Retrieve a navigation menu by navigation menu ID.

Parameters

$navigationMenuId	int navigation menu ID
$contextId	int Context Id

Returns: NavigationMenu

Definition at line 35 of file NavigationMenuDAO.inc.php.

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

◆ getByTitle()

NavigationMenuDAO::getByTitle	(		$contextId,
			$title
	)

Retrieve a navigation menu by title

Parameters

$contextId	int Context Id
$title	string

Returns: NavigationMenu

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

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

Referenced by installSettings().

◆ getCache()

NavigationMenuDAO::getCache ( $id )

Get the settings cache for a given ID

Parameters

$id

Returns: array|null (Null indicates caching disabled)

Definition at line 326 of file NavigationMenuDAO.inc.php.

References CacheManager\getManager().

Referenced by unCache().

◆ getInsertId()

NavigationMenuDAO::getInsertId ( )

Get the ID of the last inserted NavigationMenu

Returns: int

Definition at line 238 of file NavigationMenuDAO.inc.php.

References DAO\_getInsertId().

Referenced by insertObject().

◆ getLocaleFieldNames()

NavigationMenuDAO::getLocaleFieldNames ( )

Get the locale field names.

Returns: array

Reimplemented from DAO.

Definition at line 134 of file NavigationMenuDAO.inc.php.

◆ insertObject()

NavigationMenuDAO::insertObject ( $navigationMenu )

Insert a new NavigationMenu.

Parameters

$navigationMenu NavigationMenu

Returns: int

Definition at line 158 of file NavigationMenuDAO.inc.php.

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

Referenced by installSettings().

◆ installSettings()

NavigationMenuDAO::installSettings	(		$contextId,
			$filename
	)

Load the XML file and move the settings to the DB

Parameters

$contextId
$filename

Returns: boolean true === success

Definition at line 248 of file NavigationMenuDAO.inc.php.

References getByArea(), getByTitle(), DAORegistry\getDAO(), insertObject(), navigationMenuExistsByTitle(), newDataObject(), and updateObject().

◆ navigationMenuExistsByTitle()

NavigationMenuDAO::navigationMenuExistsByTitle	(		$contextId,
			$title
	)

Check if a navigationMenu exists with the given title.

Parameters

$contextId	int
$title	int

Returns: boolean True if a NM exists by that title

Definition at line 113 of file NavigationMenuDAO.inc.php.

References DAO\retrieve().

Referenced by installSettings().

◆ newDataObject()

NavigationMenuDAO::newDataObject ( )

Generate a new data object.

Returns: NavigationMenu

Definition at line 25 of file NavigationMenuDAO.inc.php.

Referenced by _fromRow(), and installSettings().

◆ unCache()

NavigationMenuDAO::unCache ( $id )

unCache the NM with id

Parameters

int $id

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

References getCache().

Referenced by deleteById(), and updateObject().

◆ updateObject()

NavigationMenuDAO::updateObject ( $navigationMenu )

Update an existing NavigationMenu

Parameters

NavigationMenu $navigationMenu

Returns: boolean

Definition at line 180 of file NavigationMenuDAO.inc.php.

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

Referenced by installSettings().

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

NavigationMenuDAO.inc.php

NavigationMenuDAO
Generated on Fri Aug 28 2020 14:54:06 for Open Monograph Press by 1.8.17