Open Journal Systems
3.3.0
|
Public Member Functions | |
_fromRow ($row) | |
_insertObject ($subscription) | |
_renewSubscription ($subscription) | |
_updateObject ($subscription) | |
deleteById ($subscriptionId, $journalId) | |
deleteByJournalId ($journalId) | |
deleteByTypeId ($subscriptionTypeId) | |
deleteByUserId ($userId) | |
getAll ($rangeInfo=null) | |
getByDateEnd ($dateEnd, $journalId, $rangeInfo=null) | |
getById ($subscriptionId) | |
getByJournalId ($journalId, $status=null, $searchField=null, $searchMatch=null, $search=null, $dateField=null, $dateFrom=null, $dateTo=null, $rangeInfo=null) | |
getInsertId () | |
getStatusCount ($status) | |
getSubscriptionJournalId ($subscriptionId) | |
insertObject ($subscription) | |
newDataObject () | |
renewSubscription ($subscription) | |
subscriptionExists ($subscriptionId) | |
subscriptionExistsByUser ($subscriptionId, $userId) | |
subscriptionExistsByUserForJournal ($userId, $journalId) | |
updateObject ($subscription) | |
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) | |
Static Public Member Functions | |
static | getStatusOptions () |
Static Public Member Functions inherited from DAO | |
static | getDataChangedEvent ($elementId=null, $parentElementId=null, $content='') |
Protected Member Functions | |
_generateSearchSQL ($status=null, $searchField=null, $searchMatch=null, $search=null, $dateField=null, $dateFrom=null, $dateTo=null, &$params) | |
Protected Member Functions inherited from DAO | |
_getInsertId ($table='', $id='') | |
Additional Inherited Members | |
Data Fields inherited from DAO | |
$_dataSource | |
Abstract class for retrieving and modifying subscriptions.
Definition at line 25 of file SubscriptionDAO.inc.php.
SubscriptionDAO::_fromRow | ( | $row | ) |
Internal function to return a Subscription object from a row.
$row | array |
Reimplemented in InstitutionalSubscriptionDAO, and IndividualSubscriptionDAO.
Definition at line 311 of file SubscriptionDAO.inc.php.
References HookRegistry\call(), DAO\dateFromDB(), and newDataObject().
|
protected |
Internal function to generate subscription based search query.
Definition at line 184 of file SubscriptionDAO.inc.php.
References DAO\datetimeToDB().
Referenced by InstitutionalSubscriptionDAO\getByJournalId().
SubscriptionDAO::_insertObject | ( | $subscription | ) |
Internal function to insert a new Subscription.
$subscription | Subscription |
Definition at line 334 of file SubscriptionDAO.inc.php.
References DAO\datetimeToDB(), DAO\dateToDB(), getInsertId(), and DAO\update().
Referenced by IndividualSubscriptionDAO\insertObject(), and InstitutionalSubscriptionDAO\insertObject().
SubscriptionDAO::_renewSubscription | ( | $subscription | ) |
Internal function to renew a subscription by dateEnd + duration of subscription type if the subscription is expired, renew to current date + duration
$subscription | Subscription |
Definition at line 402 of file SubscriptionDAO.inc.php.
References DAORegistry\getDAO(), and updateObject().
Referenced by IndividualSubscriptionDAO\renewSubscription(), and InstitutionalSubscriptionDAO\renewSubscription().
SubscriptionDAO::_updateObject | ( | $subscription | ) |
Internal function to update a Subscription.
$subscription | Subscription |
Definition at line 365 of file SubscriptionDAO.inc.php.
References DAO\datetimeToDB(), DAO\dateToDB(), and DAO\update().
Referenced by IndividualSubscriptionDAO\updateObject(), and InstitutionalSubscriptionDAO\updateObject().
|
abstract |
Delete subscription by subscription ID.
$subscriptionId | int Subscription ID |
$journalId | int Journal ID |
Reimplemented in InstitutionalSubscriptionDAO, and IndividualSubscriptionDAO.
|
abstract |
Delete subscriptions by journal ID.
$journalId | int |
Reimplemented in InstitutionalSubscriptionDAO, and IndividualSubscriptionDAO.
|
abstract |
Delete all subscriptions by subscription type ID.
$subscriptionTypeId | int |
Reimplemented in InstitutionalSubscriptionDAO, and IndividualSubscriptionDAO.
|
abstract |
Delete subscriptions by user ID.
$userId | int |
Reimplemented in InstitutionalSubscriptionDAO, and IndividualSubscriptionDAO.
|
abstract |
Retrieve all subscriptions.
Reimplemented in InstitutionalSubscriptionDAO, and IndividualSubscriptionDAO.
|
abstract |
Retrieve subscriptions matching a particular end date and journal ID.
$dateEnd | string (YYYY-MM-DD) |
$journalId | int |
Reimplemented in InstitutionalSubscriptionDAO, and IndividualSubscriptionDAO.
|
abstract |
|
abstract |
Retrieve subscriptions matching a particular journal ID.
$journalId | int |
$status | int |
$searchField | int |
$searchMatch | string "is" or "contains" or "startsWith" |
$search | String to look in $searchField for |
$dateField | int |
$dateFrom | String date to search from |
$dateTo | String date to search to |
Reimplemented in IndividualSubscriptionDAO, and InstitutionalSubscriptionDAO.
SubscriptionDAO::getInsertId | ( | ) |
Function to get the ID of the last inserted subscription.
Definition at line 105 of file SubscriptionDAO.inc.php.
References DAO\_getInsertId().
Referenced by _insertObject().
|
abstract |
Return number of subscriptions with given status.
status | int |
|
static |
Retrieve subscription status options as associative array.
Definition at line 54 of file SubscriptionDAO.inc.php.
Referenced by SubscriptionForm\__construct().
SubscriptionDAO::getSubscriptionJournalId | ( | $subscriptionId | ) |
Retrieve subscription journal ID by subscription ID.
$subscriptionId | int |
Definition at line 39 of file SubscriptionDAO.inc.php.
References DAO\retrieve().
|
abstract |
Insert a subscription.
$subscription | Subscription |
Reimplemented in InstitutionalSubscriptionDAO, and IndividualSubscriptionDAO.
|
abstract |
Generator function to create object.
Reimplemented in InstitutionalSubscriptionDAO, and IndividualSubscriptionDAO.
Referenced by _fromRow().
|
abstract |
Function to renew a subscription by dateEnd + duration of subscription type if the subscription is expired, renew to current date + duration
$subscription | Subscription |
Reimplemented in InstitutionalSubscriptionDAO, and IndividualSubscriptionDAO.
|
abstract |
Check if subscription exists for a given subscriptionId.
$subscriptionId | int |
Reimplemented in IndividualSubscriptionDAO.
|
abstract |
Check if subscription exists given a user.
$subscriptionId | int |
$userId | int |
Reimplemented in InstitutionalSubscriptionDAO, and IndividualSubscriptionDAO.
|
abstract |
Check if subscription exists given a user and journal.
$subscriptionId | int |
$userId | int |
Reimplemented in InstitutionalSubscriptionDAO, and IndividualSubscriptionDAO.
|
abstract |
Update existing subscription.
$subscription | Subscription |
Reimplemented in InstitutionalSubscriptionDAO, and IndividualSubscriptionDAO.
Referenced by _renewSubscription().