Open Monograph Press  3.3.0
SalesRightsDAO Class Reference
Inheritance diagram for SalesRightsDAO:
DAO

Public Member Functions

 __construct ()
 
 _fromRow ($row, $callHooks=true)
 
 deleteById ($entryId)
 
 deleteObject ($salesRights)
 
 getById ($salesRightsId, $publicationId=null)
 
 getByPublicationFormatId ($publicationFormatId)
 
 getInsertId ()
 
 getROWByPublicationFormatId ($publicationFormatId)
 
 insertObject ($salesRights)
 
 newDataObject ()
 
 updateObject ($salesRights)
 
- 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 ()
 
 getLocaleFieldNames ()
 
 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 SalesRights objects.

See also
SalesRights

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

Constructor & Destructor Documentation

◆ __construct()

SalesRightsDAO::__construct ( )

Constructor

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

Member Function Documentation

◆ _fromRow()

SalesRightsDAO::_fromRow (   $row,
  $callHooks = true 
)

Internal function to return a SalesRights object from a row.

Parameters
$rowarray
$callHooksboolean
Returns
SalesRights

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

References HookRegistry\call(), and newDataObject().

Referenced by getById(), and getROWByPublicationFormatId().

◆ deleteById()

SalesRightsDAO::deleteById (   $entryId)

delete a sales rights entry by id.

Parameters
$entryIdint

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

References DAO\update().

Referenced by deleteObject().

◆ deleteObject()

SalesRightsDAO::deleteObject (   $salesRights)

Delete a sales rights entry by id.

Parameters
$salesRightsSalesRights

Definition at line 173 of file SalesRightsDAO.inc.php.

References deleteById().

◆ getById()

SalesRightsDAO::getById (   $salesRightsId,
  $publicationId = null 
)

Retrieve a sales rights entry by type id.

Parameters
$salesRightsIdint
$publicationIdoptional int
Returns
SalesRights

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

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

◆ getByPublicationFormatId()

SalesRightsDAO::getByPublicationFormatId (   $publicationFormatId)

Retrieve all sales rights for a publication format

Parameters
$publicationFormatIdint
Returns
DAOResultFactory containing matching sales rights.

Definition at line 61 of file SalesRightsDAO.inc.php.

References DAO\retrieveRange().

◆ getInsertId()

SalesRightsDAO::getInsertId ( )

Get the ID of the last inserted sales rights entry.

Returns
int

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

References DAO\_getInsertId().

Referenced by insertObject().

◆ getROWByPublicationFormatId()

SalesRightsDAO::getROWByPublicationFormatId (   $publicationFormatId)

Retrieve the specific Sales Rights instance for which ROW is set to true. There should only be one per format.

Parameters
$publicationFormatIdint
Returns
SalesRights

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

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

◆ insertObject()

SalesRightsDAO::insertObject (   $salesRights)

Insert a new sales rights entry.

Parameters
$salesRightsSalesRights

Definition at line 122 of file SalesRightsDAO.inc.php.

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

◆ newDataObject()

SalesRightsDAO::newDataObject ( )

Construct a new data object corresponding to this DAO.

Returns
SalesRights

Definition at line 91 of file SalesRightsDAO.inc.php.

Referenced by _fromRow().

◆ updateObject()

SalesRightsDAO::updateObject (   $salesRights)

Update an existing sales rights entry.

Parameters
$salesRightsSalesRights

Definition at line 147 of file SalesRightsDAO.inc.php.

References DAO\update().


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