Inheritance diagram for NavigationMenuItemDAO:

Public Member Functions
	_fromRow ($row, $dataObject=false)

	deleteByContextId ($contextId)

	deleteById ($navigationMenuItemId)

	deleteObject ($navigationMenuItem)

	deleteSettingsByLocale ($locale)

	getAdditionalFieldNames ()

	getByContextId ($contextId)

	getById ($navigationMenuItemId)

	getByMenuId ($menuId)

	getByPath ($contextId, $path)

	getByType ($type, $contextId=null)

	getByTypeAndTitleLocaleKey ($contextId, $menuItemType, $menuItemTitleLocaleKey)

	getInsertId ()

	getLocaleFieldNames ()

	getSetting ($navigationMenuItemId, $name, $locale=null)

	insertObject ($navigationMenuItem)

	installNodeSettings ($contextId, $node, $navigationMenuId=null, $navigationMenuItemParentId=null, $seq=0, $checkChildren=false)

	installSettings ($contextId, $filename)

	newDataObject ()

	portStaticPage ($staticPage)

	unCacheRelatedNavigationMenus ($id)

	updateLocaleFields ($navigationMenuItem)

	updateObject ($navigationMenuItem)

	updateSetting ($navigationMenuItemId, $name, $value, $type=null, $isLocalized=false)

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)

	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 NavigationMenuItem objects. NMI = NavigationMenuItem.

See also: NavigationMenuItem

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

Member Function Documentation

◆ _fromRow()

NavigationMenuItemDAO::_fromRow	(	$row,
		$dataObject = `false`
	)

Internal function to return a NavigationMenuItem object from a row.

Parameters

$row array

Returns: NavigationMenuItem

Definition at line 174 of file NavigationMenuItemDAO.inc.php.

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

Referenced by getById(), getByPath(), and getByTypeAndTitleLocaleKey().

◆ deleteByContextId()

NavigationMenuItemDAO::deleteByContextId ( $contextId )

Delete NavigationMenuItems by contextId.

Parameters

$contextId int

Definition at line 276 of file NavigationMenuItemDAO.inc.php.

References deleteObject(), and getByContextId().

◆ deleteById()

NavigationMenuItemDAO::deleteById ( $navigationMenuItemId )

Delete a NavigationMenuItem by navigationMenuItem ID.

Parameters

$navigationMenuItemId int

Returns: boolean

Definition at line 262 of file NavigationMenuItemDAO.inc.php.

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

Referenced by deleteObject().

◆ deleteObject()

NavigationMenuItemDAO::deleteObject ( $navigationMenuItem )

Delete a NavigationMenuItem.

Parameters

$navigationMenuItem NavigationMenuItem

Returns: boolean

Definition at line 253 of file NavigationMenuItemDAO.inc.php.

References deleteById().

Referenced by deleteByContextId().

◆ deleteSettingsByLocale()

NavigationMenuItemDAO::deleteSettingsByLocale ( $locale )

Remove all settings associated with a locale

Parameters

$locale

Definition at line 471 of file NavigationMenuItemDAO.inc.php.

References DAO\update().

◆ getAdditionalFieldNames()

NavigationMenuItemDAO::getAdditionalFieldNames ( )

Get a list of additional field names to store in this DAO. This can be used to extend the table with virtual "columns", typically using the ..._settings table.

Returns: array List of strings representing field names.

Reimplemented from DAO.

Definition at line 157 of file NavigationMenuItemDAO.inc.php.

◆ getByContextId()

NavigationMenuItemDAO::getByContextId ( $contextId )

Retrieve a navigation menu items by context Id.

Parameters

$contextId int Context Id

Returns: NavigationMenu

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

References DAO\retrieve().

Referenced by deleteByContextId().

◆ getById()

NavigationMenuItemDAO::getById ( $navigationMenuItemId )

Retrieve a navigation menu item by ID.

Parameters

$navigationMenuItemId int

Returns: NavigationMenuItem

Definition at line 26 of file NavigationMenuItemDAO.inc.php.

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

◆ getByMenuId()

NavigationMenuItemDAO::getByMenuId ( $menuId )

Retrieve items by menu id

Parameters

$menuId int

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

References DAO\retrieve().

◆ getByPath()

NavigationMenuItemDAO::getByPath	(	$contextId,
		$path
	)

Retrieve a navigation menu item by path.

Parameters

$contextId	int Context Id
$path	string

Returns: NavigationMenuItem

Definition at line 47 of file NavigationMenuItemDAO.inc.php.

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

Referenced by portStaticPage().

◆ getByType()

NavigationMenuItemDAO::getByType	(	$type,
		$contextId = `null`
	)

Retrieve the menu items with the specified type.

Parameters

$type	int NMI_TYPE_...
$contextId	int

Returns: DAOResultFactory containing matching NavigationMenuItems

Definition at line 133 of file NavigationMenuItemDAO.inc.php.

References DAO\retrieve().

◆ getByTypeAndTitleLocaleKey()

NavigationMenuItemDAO::getByTypeAndTitleLocaleKey	(	$contextId,
		$menuItemType,
		$menuItemTitleLocaleKey
	)

Retrieve items by menuItemType and setting_name = titleLocaleKey

Parameters

$contextId	int
$menuItemType	string
$menuItemTitleLocaleKey	string

Definition at line 101 of file NavigationMenuItemDAO.inc.php.

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

Referenced by installNodeSettings().

◆ getInsertId()

NavigationMenuItemDAO::getInsertId ( )

Get the ID of the last inserted navigation menu item.

Returns: int

Definition at line 288 of file NavigationMenuItemDAO.inc.php.

References DAO\_getInsertId().

Referenced by insertObject().

◆ getLocaleFieldNames()

NavigationMenuItemDAO::getLocaleFieldNames ( )

Get the list of localized field names for this table

Returns: array

Reimplemented from DAO.

Definition at line 150 of file NavigationMenuItemDAO.inc.php.

◆ getSetting()

NavigationMenuItemDAO::getSetting	(	$navigationMenuItemId,
		$name,
		$locale = `null`
	)

Retrieve a context setting value.

Parameters

$userGroupId	int
$name	string
$locale	string optional

Returns: mixed

Definition at line 437 of file NavigationMenuItemDAO.inc.php.

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

◆ insertObject()

NavigationMenuItemDAO::insertObject ( $navigationMenuItem )

Insert a new NavigationMenuItem.

Parameters

$navigationMenuItem NavigationMenuItem

Returns: int

Definition at line 201 of file NavigationMenuItemDAO.inc.php.

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

Referenced by installNodeSettings(), and portStaticPage().

◆ installNodeSettings()

NavigationMenuItemDAO::installNodeSettings	(	$contextId,
		$node,
		$navigationMenuId = `null`,
		$navigationMenuItemParentId = `null`,
		$seq = `0`,
		$checkChildren = `false`
	)