FooterCategoryDAO Class Reference [Press]

Operations for retrieving and modifying FooterCategory objects. More...

List of all members.

Public Member Functions
	_fromRow (&$row)
	categoryExistsByPath ($path, $pressId=null)
	deleteById ($categoryId, $pressId=null)
	deleteByPressId ($pressId)
	deleteObject (&$category)
	FooterCategoryDAO ()
&	getById ($categoryId, $pressId=null)
&	getByPath ($path, $pressId)
&	getByPressId ($pressId, $rangeInfo=null)
&	getCountByPressId ($pressId)
	getInsertFooterCategoryId ()
	getLocaleFieldNames ()
&	getNotEmptyByPressId ($pressId, $rangeInfo=null)
	insertObject (&$category)
	newDataObject ()
	updateLocaleFields (&$category)
	updateObject ($category)

---

Detailed Description

Operations for retrieving and modifying FooterCategory objects.

See also:

FooterCategory

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

---

Member Function Documentation

FooterCategoryDAO._fromRow

(

&$

row

)

Internal function to return a FooterCategory object from a row.

Parameters:

$row

array

Returns:

FooterCategory

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

References newDataObject().

Referenced by getById(), and getByPath().

FooterCategoryDAO.categoryExistsByPath	(	$	path,
		$	pressId = null
	)

Check if a category exists with a specified path.

Parameters:

	string	$path the path for the category
	int	$pressId the press context (optional)

Returns:

boolean

Definition at line 85 of file FooterCategoryDAO.inc.php.

FooterCategoryDAO.deleteById	(	$	categoryId,
		$	pressId = null
	)

Delete a category by ID.

Parameters:

	$categoryId	int
	$pressId	int optional

Definition at line 208 of file FooterCategoryDAO.inc.php.

Referenced by deleteObject().

FooterCategoryDAO.deleteByPressId

(

$

pressId

)

Delete category by press ID NOTE: This does not delete dependent entries. It is intended to be called only when deleting a press.

Parameters:

$pressId

int

Definition at line 237 of file FooterCategoryDAO.inc.php.

References deleteObject(), and getByPressId().

FooterCategoryDAO.deleteObject

(

&$

category

)

Delete a category.

Parameters:

$category

FooterCategory

Definition at line 196 of file FooterCategoryDAO.inc.php.

References deleteById().

Referenced by deleteByPressId().

FooterCategoryDAO.FooterCategoryDAO

(

)

Constructor

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

& FooterCategoryDAO.getById	(	$	categoryId,
		$	pressId = null
	)

Retrieve a category by ID.

Parameters:

	$categoryId	int
	$pressId	int optional

Returns:

FooterCategory

Definition at line 33 of file FooterCategoryDAO.inc.php.

References _fromRow().

& FooterCategoryDAO.getByPath	(	$	path,
		$	pressId
	)

Retrieve a category by path.

Parameters:

	$path	string
	$pressId	int

Returns:

FooterCategory

Definition at line 62 of file FooterCategoryDAO.inc.php.

References _fromRow().

& FooterCategoryDAO.getByPressId	(	$	pressId,
		$	rangeInfo = null
	)

Retrieve all categories for a press.

Returns:

DAOResultFactory containing FooterCategory ordered by sequence

Definition at line 249 of file FooterCategoryDAO.inc.php.

Referenced by deleteByPressId().

& FooterCategoryDAO.getCountByPressId

(

$

pressId

)

Retrieve the number of categories for a press.

Returns:

int

Definition at line 281 of file FooterCategoryDAO.inc.php.

FooterCategoryDAO.getInsertFooterCategoryId

(

)

Get the ID of the last inserted category.

Returns:

int

Definition at line 300 of file FooterCategoryDAO.inc.php.

Referenced by insertObject().

FooterCategoryDAO.getLocaleFieldNames

(

)

Get the list of fields for which data can be localized.

Returns:

array

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

& FooterCategoryDAO.getNotEmptyByPressId	(	$	pressId,
		$	rangeInfo = null
	)

Retrieve all categories for a press that have links.

Returns:

DAOResultFactory containing FooterCategory ordered by sequence

Definition at line 265 of file FooterCategoryDAO.inc.php.

FooterCategoryDAO.insertObject

(

&$

category

)

Insert a new category.

Parameters:

$category

FooterCategory

Returns:

int ID of the inserted category.

Definition at line 155 of file FooterCategoryDAO.inc.php.

References getInsertFooterCategoryId(), and updateLocaleFields().

FooterCategoryDAO.newDataObject

(

)

Construct a new data object corresponding to this DAO.

Returns:

FooterCategory

Definition at line 106 of file FooterCategoryDAO.inc.php.

Referenced by _fromRow().

FooterCategoryDAO.updateLocaleFields

(

&$

category

)

Update the localized fields for this table

Parameters:

$category

object

Definition at line 141 of file FooterCategoryDAO.inc.php.

Referenced by insertObject(), and updateObject().

FooterCategoryDAO.updateObject

(

$

category

)

Update an existing category.

Parameters:

$category

FooterCategory

Definition at line 176 of file FooterCategoryDAO.inc.php.

References updateLocaleFields().

---

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

• classes/press/FooterCategoryDAO.inc.php