PressDAO Class Reference [Press]

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

List of all members.

Public Member Functions
&	_fromRow (&$row)
	deleteById ($pressId)
	getById ($pressId)
&	getByPath ($path)
&	getEnabledPresses ()
	getInsertPressId ()
	getNames ()
&	getPressByPath ($path)
&	getPresses ($rangeInfo=null)
	insertObject (&$press)
	newDataObject ()
	PressDAO ()
	pressExistsByPath ($path)
	resequencePresses ()
	updateObject (&$press)

---

Detailed Description

Operations for retrieving and modifying Press objects.

See also:

Press

Definition at line 17 of file PressDAO.inc.php.

---

Member Function Documentation

& PressDAO._fromRow

(

&$

row

)

Internal function to return a Press object from a row.

Parameters:

$row

array

Returns:

Press

Definition at line 71 of file PressDAO.inc.php.

References newDataObject().

Referenced by getById(), and getByPath().

PressDAO.deleteById

(

$

pressId

)

Delete a press by ID, INCLUDING ALL DEPENDENT ITEMS.

Parameters:

$pressId

int

Definition at line 215 of file PressDAO.inc.php.

PressDAO.getById

(

$

pressId

)

Retrieve a press by press ID.

Parameters:

$pressId

int

Returns:

Press

Definition at line 30 of file PressDAO.inc.php.

References _fromRow().

& PressDAO.getByPath

(

$

path

)

Retrieve a press by path.

Parameters:

$path

string

Returns:

Press

Definition at line 117 of file PressDAO.inc.php.

References _fromRow().

Referenced by getPressByPath().

& PressDAO.getEnabledPresses

(

)

Retrieve all enabled presses

Returns:

array Presses ordered by sequence

Definition at line 194 of file PressDAO.inc.php.

PressDAO.getInsertPressId

(

)

Get the ID of the last inserted press.

Returns:

int

Definition at line 207 of file PressDAO.inc.php.

Referenced by insertObject().

PressDAO.getNames

(

)

Retrieve the IDs and names of all presses in an associative array.

Returns:

array

Definition at line 45 of file PressDAO.inc.php.

References getPresses().

& PressDAO.getPressByPath

(

$

path

)

Retrieve a press by path. (Required by PKPPageRouter; should eventually be removed in favour of getByPath.)

See also:

PressDAO.getByPath

Definition at line 107 of file PressDAO.inc.php.

References getByPath().

& PressDAO.getPresses

(

$

rangeInfo = null

)

Retrieve all presses.

Returns:

DAOResultFactory containing matching presses

Definition at line 135 of file PressDAO.inc.php.

Referenced by getNames().

PressDAO.insertObject

(

&$

press

)

Insert a new press.

Parameters:

$press

Press

Definition at line 149 of file PressDAO.inc.php.

References getInsertPressId().

PressDAO.newDataObject

(

)

Construct a new data object corresponding to this DAO.

Returns:

Press

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

Referenced by _fromRow().

PressDAO.PressDAO

(

)

Constructor

Definition at line 21 of file PressDAO.inc.php.

PressDAO.pressExistsByPath

(

$

path

)

Check if a press exists with a specified path.

Parameters:

$path

the path for the press

Returns:

boolean

Definition at line 89 of file PressDAO.inc.php.

PressDAO.resequencePresses

(

)

Sequentially renumber each press according to their sequence order.

Definition at line 257 of file PressDAO.inc.php.

PressDAO.updateObject

(

&$

press

)

Update an existing press.

Parameters:

$press

Press

Definition at line 171 of file PressDAO.inc.php.

---

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

• classes/press/PressDAO.inc.php