Open Journal Systems
3.3.0
|
Public Member Functions | |
_fromRow ($row) | |
deleteById ($subscriptionId, $journalId=null) | |
deleteByJournalId ($journalId) | |
deleteByTypeId ($subscriptionTypeId) | |
deleteByUserId ($userId) | |
deleteByUserIdForJournal ($userId, $journalId) | |
getAll ($rangeInfo=null) | |
getByDateEnd ($dateEnd, $journalId, $rangeInfo=null) | |
getById ($subscriptionId, $journalId=null) | |
getByJournalId ($journalId, $status=null, $searchField=null, $searchMatch=null, $search=null, $dateField=null, $dateFrom=null, $dateTo=null, $rangeInfo=null) | |
getByUserId ($userId, $rangeInfo=null) | |
getByUserIdForJournal ($userId, $journalId) | |
getStatusCount ($journalId, $status=null) | |
getSubscribedUserCount ($journalId) | |
insertObject ($individualSubscription) | |
isValidIndividualSubscription ($userId, $journalId, $check=SUBSCRIPTION_DATE_BOTH, $checkDate=null) | |
newDataObject () | |
renewSubscription ($individualSubscription) | |
subscriptionExists ($subscriptionId) | |
subscriptionExistsByUser ($subscriptionId, $userId) | |
subscriptionExistsByUserForJournal ($userId, $journalId) | |
updateObject ($individualSubscription) | |
Public Member Functions inherited from SubscriptionDAO | |
_insertObject ($subscription) | |
_renewSubscription ($subscription) | |
_updateObject ($subscription) | |
getById ($subscriptionId) | |
getInsertId () | |
getStatusCount ($status) | |
getSubscriptionJournalId ($subscriptionId) | |
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 SubscriptionDAO | |
static | getStatusOptions () |
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 SubscriptionDAO | |
_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='') | |
Operations for retrieving and modifying IndividualSubscription objects.
Definition at line 20 of file IndividualSubscriptionDAO.inc.php.
IndividualSubscriptionDAO::_fromRow | ( | $row | ) |
Internal function to return an IndividualSubscription object from a row.
$row | array |
Reimplemented from SubscriptionDAO.
Definition at line 230 of file IndividualSubscriptionDAO.inc.php.
References HookRegistry\call().
Referenced by getById(), and getByUserIdForJournal().
IndividualSubscriptionDAO::deleteById | ( | $subscriptionId, | |
$journalId = null |
|||
) |
Delete an individual subscription by subscription ID.
$subscriptionId | int |
$journalId | int |
Reimplemented from SubscriptionDAO.
Definition at line 259 of file IndividualSubscriptionDAO.inc.php.
References DAO\update().
Referenced by deleteByJournalId(), deleteByTypeId(), deleteByUserId(), and deleteByUserIdForJournal().
IndividualSubscriptionDAO::deleteByJournalId | ( | $journalId | ) |
Delete individual subscriptions by journal ID.
$journalId | int |
Reimplemented from SubscriptionDAO.
Definition at line 275 of file IndividualSubscriptionDAO.inc.php.
References deleteById(), and DAO\retrieve().
IndividualSubscriptionDAO::deleteByTypeId | ( | $subscriptionTypeId | ) |
Delete all individual subscriptions by subscription type ID.
$subscriptionTypeId | int |
Reimplemented from SubscriptionDAO.
Definition at line 370 of file IndividualSubscriptionDAO.inc.php.
References deleteById(), and DAO\retrieve().
IndividualSubscriptionDAO::deleteByUserId | ( | $userId | ) |
Delete individual subscriptions by user ID.
$userId | int |
Reimplemented from SubscriptionDAO.
Definition at line 305 of file IndividualSubscriptionDAO.inc.php.
References deleteById(), and DAO\retrieve().
IndividualSubscriptionDAO::deleteByUserIdForJournal | ( | $userId, | |
$journalId | |||
) |
Delete individual subscription by user ID and journal ID.
$userId | int |
$journalId | int |
Definition at line 336 of file IndividualSubscriptionDAO.inc.php.
References deleteById(), and DAO\retrieve().
IndividualSubscriptionDAO::getAll | ( | $rangeInfo = null | ) |
Retrieve all individual subscriptions.
$rangeInfo | DBResultRange |
Reimplemented from SubscriptionDAO.
Definition at line 400 of file IndividualSubscriptionDAO.inc.php.
References DAORegistry\getDAO(), and DAO\retrieveRange().
IndividualSubscriptionDAO::getByDateEnd | ( | $dateEnd, | |
$journalId, | |||
$rangeInfo = null |
|||
) |
Retrieve active individual subscriptions matching a particular end date and journal ID.
$dateEnd | string (YYYY-MM-DD) |
$journalId | int |
$rangeInfo | DBResultRange |
Reimplemented from SubscriptionDAO.
Definition at line 517 of file IndividualSubscriptionDAO.inc.php.
References DAORegistry\getDAO(), and DAO\retrieveRange().
IndividualSubscriptionDAO::getById | ( | $subscriptionId, | |
$journalId = null |
|||
) |
Retrieve an individual subscription by subscription ID.
$subscriptionId | int Subscription ID |
$journalId | int Optional journal ID |
Definition at line 27 of file IndividualSubscriptionDAO.inc.php.
References _fromRow(), and DAO\retrieve().
IndividualSubscriptionDAO::getByJournalId | ( | $journalId, | |
$status = null , |
|||
$searchField = null , |
|||
$searchMatch = null , |
|||
$search = null , |
|||
$dateField = null , |
|||
$dateFrom = null , |
|||
$dateTo = null , |
|||
$rangeInfo = null |
|||
) |
Retrieve individual 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 from SubscriptionDAO.
Definition at line 434 of file IndividualSubscriptionDAO.inc.php.
References DAORegistry\getDAO(), and DAO\retrieveRange().
IndividualSubscriptionDAO::getByUserId | ( | $userId, | |
$rangeInfo = null |
|||
) |
Retrieve individual subscriptions by user ID.
$userId | int |
$rangeInfo | DBResultRange |
Definition at line 86 of file IndividualSubscriptionDAO.inc.php.
References DAO\retrieveRange().
IndividualSubscriptionDAO::getByUserIdForJournal | ( | $userId, | |
$journalId | |||
) |
Retrieve individual subscription by user ID for journal.
$userId | int |
$journalId | int |
Definition at line 55 of file IndividualSubscriptionDAO.inc.php.
References _fromRow(), and DAO\retrieveRange().
IndividualSubscriptionDAO::getStatusCount | ( | $journalId, | |
$status = null |
|||
) |
Return number of individual subscriptions with given status for journal.
$journalId | int |
$status | int |
Definition at line 108 of file IndividualSubscriptionDAO.inc.php.
References DAO\retrieve().
Referenced by getSubscribedUserCount().
IndividualSubscriptionDAO::getSubscribedUserCount | ( | $journalId | ) |
Get the number of individual subscriptions for a particular journal.
$journalId | int |
Definition at line 134 of file IndividualSubscriptionDAO.inc.php.
References getStatusCount().
IndividualSubscriptionDAO::insertObject | ( | $individualSubscription | ) |
Insert a new individual subscription.
$individualSubscription | IndividualSubscription |
Reimplemented from SubscriptionDAO.
Definition at line 242 of file IndividualSubscriptionDAO.inc.php.
References SubscriptionDAO\_insertObject().
IndividualSubscriptionDAO::isValidIndividualSubscription | ( | $userId, | |
$journalId, | |||
$check = SUBSCRIPTION_DATE_BOTH , |
|||
$checkDate = null |
|||
) |
Check whether user with ID has a valid individual subscription for a given journal.
$userId | int |
$journalId | int |
$check | int Check using either start date, end date, or both (default) |
$checkDate | date (YYYY-MM-DD) Use this date instead of current date |
Definition at line 462 of file IndividualSubscriptionDAO.inc.php.
References DAO\dateToDB(), Core\getCurrentDate(), and DAO\retrieve().
IndividualSubscriptionDAO::newDataObject | ( | ) |
Generator function to create object.
Reimplemented from SubscriptionDAO.
Definition at line 221 of file IndividualSubscriptionDAO.inc.php.
IndividualSubscriptionDAO::renewSubscription | ( | $individualSubscription | ) |
Renew an individual subscription by dateEnd + duration of subscription type if the individual subscription is expired, renew to current date + duration
$individualSubscription | IndividualSubscription |
Reimplemented from SubscriptionDAO.
Definition at line 555 of file IndividualSubscriptionDAO.inc.php.
References SubscriptionDAO\_renewSubscription().
IndividualSubscriptionDAO::subscriptionExists | ( | $subscriptionId | ) |
Check if an individual subscription exists for a given subscriptionId.
$subscriptionId | int |
Reimplemented from SubscriptionDAO.
Definition at line 143 of file IndividualSubscriptionDAO.inc.php.
References DAO\retrieve().
IndividualSubscriptionDAO::subscriptionExistsByUser | ( | $subscriptionId, | |
$userId | |||
) |
Check if an individual subscription exists for a given user.
$subscriptionId | int |
$userId | int |
Reimplemented from SubscriptionDAO.
Definition at line 167 of file IndividualSubscriptionDAO.inc.php.
References DAO\retrieve().
IndividualSubscriptionDAO::subscriptionExistsByUserForJournal | ( | $userId, | |
$journalId | |||
) |
Check if an individual subscription exists for a given user and journal.
$userId | int |
$journalId | int |
Reimplemented from SubscriptionDAO.
Definition at line 195 of file IndividualSubscriptionDAO.inc.php.
References DAO\retrieve().
IndividualSubscriptionDAO::updateObject | ( | $individualSubscription | ) |
Update an existing individual subscription.
$individualSubscription | IndividualSubscription |
Reimplemented from SubscriptionDAO.
Definition at line 250 of file IndividualSubscriptionDAO.inc.php.
References SubscriptionDAO\_updateObject().