Open Journal Systems  3.3.0
InstitutionalSubscriptionDAO Class Reference
Inheritance diagram for InstitutionalSubscriptionDAO:
SubscriptionDAO DAO

Public Member Functions

 _deleteSubscriptionIPRanges ($subscriptionId)
 
 _fromRow ($row)
 
 _insertSubscriptionIPRanges ($subscriptionId, $ipRanges)
 
 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)
 
 getByInstitutionName ($institutionName, $journalId, $exactMatch=true, $rangeInfo=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, $rangeInfo=null)
 
 getStatusCount ($journalId, $status=null)
 
 getSubscribedUserCount ($journalId)
 
 insertObject ($institutionalSubscription)
 
 isValidInstitutionalSubscription ($domain, $IP, $journalId, $check=SUBSCRIPTION_DATE_BOTH, $checkDate=null)
 
 newDataObject ()
 
 renewSubscription ($institutionalSubscription)
 
 subscriptionExists ($subscriptionId, $journalId=null)
 
 subscriptionExistsByInstitutionName ($institutionName, $journalId, $exactMatch=true)
 
 subscriptionExistsByUser ($subscriptionId, $userId)
 
 subscriptionExistsByUserForJournal ($userId, $journalId)
 
 updateObject ($institutionalSubscription)
 
- Public Member Functions inherited from SubscriptionDAO
 _insertObject ($subscription)
 
 _renewSubscription ($subscription)
 
 _updateObject ($subscription)
 
 getById ($subscriptionId)
 
 getInsertId ()
 
 getStatusCount ($status)
 
 getSubscriptionJournalId ($subscriptionId)
 
 subscriptionExists ($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='')
 

Detailed Description

Operations for retrieving and modifying InstitutionalSubscription objects.

See also
InstitutionalSubscription

Definition at line 25 of file InstitutionalSubscriptionDAO.inc.php.

Member Function Documentation

◆ _deleteSubscriptionIPRanges()

InstitutionalSubscriptionDAO::_deleteSubscriptionIPRanges (   $subscriptionId)

Internal function to delete subscription ip ranges by subscription ID.

Parameters
$subscriptionIdint
Returns
boolean

Definition at line 785 of file InstitutionalSubscriptionDAO.inc.php.

References DAO\update().

Referenced by deleteById(), and updateObject().

◆ _fromRow()

InstitutionalSubscriptionDAO::_fromRow (   $row)

Internal function to return an InstitutionalSubscription object from a row.

Parameters
$rowarray
Returns
InstitutionalSubscription

Reimplemented from SubscriptionDAO.

Definition at line 664 of file InstitutionalSubscriptionDAO.inc.php.

References HookRegistry\call(), and DAO\retrieve().

Referenced by getById().

◆ _insertSubscriptionIPRanges()

InstitutionalSubscriptionDAO::_insertSubscriptionIPRanges (   $subscriptionId,
  $ipRanges 
)

Internal function to insert institutional subscription IP ranges.

Parameters
$subscriptionIdint
$ipRangesarray
Returns
boolean

Definition at line 700 of file InstitutionalSubscriptionDAO.inc.php.

References DAO\update().

Referenced by insertObject(), and updateObject().

◆ deleteById()

InstitutionalSubscriptionDAO::deleteById (   $subscriptionId,
  $journalId = null 
)

Delete an institutional subscription by subscription ID.

Parameters
$subscriptionIdint

Reimplemented from SubscriptionDAO.

Definition at line 314 of file InstitutionalSubscriptionDAO.inc.php.

References _deleteSubscriptionIPRanges(), subscriptionExists(), and DAO\update().

Referenced by deleteByJournalId(), deleteByTypeId(), deleteByUserId(), and deleteByUserIdForJournal().

◆ deleteByJournalId()

InstitutionalSubscriptionDAO::deleteByJournalId (   $journalId)

Delete institutional subscriptions by journal ID.

Parameters
$journalIdint

Reimplemented from SubscriptionDAO.

Definition at line 326 of file InstitutionalSubscriptionDAO.inc.php.

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

◆ deleteByTypeId()

InstitutionalSubscriptionDAO::deleteByTypeId (   $subscriptionTypeId)

Delete all institutional subscriptions by subscription type ID.

Parameters
$subscriptionTypeIdint Subscription type ID

Reimplemented from SubscriptionDAO.

Definition at line 388 of file InstitutionalSubscriptionDAO.inc.php.

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

◆ deleteByUserId()

InstitutionalSubscriptionDAO::deleteByUserId (   $userId)

Delete institutional subscriptions by user ID.

Parameters
$userIdint

Reimplemented from SubscriptionDAO.

Definition at line 349 of file InstitutionalSubscriptionDAO.inc.php.

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

◆ deleteByUserIdForJournal()

InstitutionalSubscriptionDAO::deleteByUserIdForJournal (   $userId,
  $journalId 
)

Delete institutional subscriptions by user ID and journal ID.

Parameters
$userIdint User ID
$journalIdint Journal ID

Definition at line 367 of file InstitutionalSubscriptionDAO.inc.php.

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

◆ getAll()

InstitutionalSubscriptionDAO::getAll (   $rangeInfo = null)

Retrieve all institutional subscriptions.

Returns
object DAOResultFactory containing InstitutionalSubscriptions

Reimplemented from SubscriptionDAO.

Definition at line 406 of file InstitutionalSubscriptionDAO.inc.php.

References DAO\retrieveRange().

◆ getByDateEnd()

InstitutionalSubscriptionDAO::getByDateEnd (   $dateEnd,
  $journalId,
  $rangeInfo = null 
)

Retrieve active institutional subscriptions matching a particular end date and journal ID.

Parameters
$dateEnddate (YYYY-MM-DD)
$journalIdint
Returns
object DAOResultFactory containing matching InstitutionalSubscriptions

Reimplemented from SubscriptionDAO.

Definition at line 615 of file InstitutionalSubscriptionDAO.inc.php.

References DAO\retrieveRange().

◆ getById()

InstitutionalSubscriptionDAO::getById (   $subscriptionId,
  $journalId = null 
)

Retrieve an institutional subscription by subscription ID.

Parameters
$subscriptionIdint Subscription ID
$journalIdint Journal ID
Returns
InstitutionalSubscription

Definition at line 32 of file InstitutionalSubscriptionDAO.inc.php.

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

◆ getByInstitutionName()

InstitutionalSubscriptionDAO::getByInstitutionName (   $institutionName,
  $journalId,
  $exactMatch = true,
  $rangeInfo = null 
)

Retrieve institutional subscriptions by institution name.

Parameters
$institutionNamestring Institution name
$journalIdint Journal ID
$exactMatchboolean True iff the match on institution name should be exact
$rangeInfoRangeInfo
Returns
object DAOResultFactory containing matching InstitutionalSubscriptions

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

References DAO\retrieveRange().

◆ getByJournalId()

InstitutionalSubscriptionDAO::getByJournalId (   $journalId,
  $status = null,
  $searchField = null,
  $searchMatch = null,
  $search = null,
  $dateField = null,
  $dateFrom = null,
  $dateTo = null,
  $rangeInfo = null 
)

Retrieve institutional subscriptions matching a particular journal ID.

Parameters
$journalIdint
$statusint
$searchFieldint
$searchMatchstring "is" or "contains" or "startsWith"
$searchString to look in $searchField for
$dateFieldint
$dateFromString date to search from
$dateToString date to search to
Returns
object DAOResultFactory containing matching Subscriptions

Reimplemented from SubscriptionDAO.

Definition at line 432 of file InstitutionalSubscriptionDAO.inc.php.

References SubscriptionDAO\_generateSearchSQL(), DAORegistry\getDAO(), and DAO\retrieveRange().

◆ getByUserId()

InstitutionalSubscriptionDAO::getByUserId (   $userId,
  $rangeInfo = null 
)

Retrieve institutional subscriptions by user ID.

Parameters
$userIdint
Returns
object DAOResultFactory containing matching InstitutionalSubscriptions

Definition at line 60 of file InstitutionalSubscriptionDAO.inc.php.

References DAO\retrieveRange().

◆ getByUserIdForJournal()

InstitutionalSubscriptionDAO::getByUserIdForJournal (   $userId,
  $journalId,
  $rangeInfo = null 
)

Retrieve institutional subscriptions by user ID and journal ID.

Parameters
$userIdint
$journalIdint
$rangeInfoRangeInfo
Returns
object DAOResultFactory containing matching InstitutionalSubscriptions

Definition at line 81 of file InstitutionalSubscriptionDAO.inc.php.

References DAO\retrieveRange().

◆ getStatusCount()

InstitutionalSubscriptionDAO::getStatusCount (   $journalId,
  $status = null 
)

Return number of institutional subscriptions with given status for journal.

Parameters
statusint
Returns
int

Definition at line 131 of file InstitutionalSubscriptionDAO.inc.php.

References DAO\retrieve().

Referenced by getSubscribedUserCount().

◆ getSubscribedUserCount()

InstitutionalSubscriptionDAO::getSubscribedUserCount (   $journalId)

Get the number of institutional subscriptions for a particular journal.

Parameters
$journalIdint
Returns
int

Definition at line 153 of file InstitutionalSubscriptionDAO.inc.php.

References getStatusCount().

◆ insertObject()

InstitutionalSubscriptionDAO::insertObject (   $institutionalSubscription)

Insert a new institutional subscription.

Parameters
$institutionalSubscriptionInstitutionalSubscription
Returns
int

Reimplemented from SubscriptionDAO.

Definition at line 260 of file InstitutionalSubscriptionDAO.inc.php.

References SubscriptionDAO\_insertObject(), _insertSubscriptionIPRanges(), and DAO\update().

◆ isValidInstitutionalSubscription()

InstitutionalSubscriptionDAO::isValidInstitutionalSubscription (   $domain,
  $IP,
  $journalId,
  $check = SUBSCRIPTION_DATE_BOTH,
  $checkDate = null 
)

Check whether there is a valid institutional subscription for a given journal.

Parameters
$domainstring
$IPstring
$journalIdint
$checkint Test using either start date, end date, or both (default)
$checkDatedate (YYYY-MM-DD) Use this date instead of current date
Returns
int

Definition at line 509 of file InstitutionalSubscriptionDAO.inc.php.

References DAO\dateToDB(), Core\getCurrentDate(), and DAO\retrieve().

◆ newDataObject()

InstitutionalSubscriptionDAO::newDataObject ( )

Generator function to create object.

Returns
InstitutionalSubscription

Reimplemented from SubscriptionDAO.

Definition at line 655 of file InstitutionalSubscriptionDAO.inc.php.

◆ renewSubscription()

InstitutionalSubscriptionDAO::renewSubscription (   $institutionalSubscription)

Renew an institutional subscription by dateEnd + duration of subscription type if the institutional subscription is expired, renew to current date + duration

Parameters
$institutionalSubscriptionInstitutionalSubscription
Returns
boolean

Reimplemented from SubscriptionDAO.

Definition at line 647 of file InstitutionalSubscriptionDAO.inc.php.

References SubscriptionDAO\_renewSubscription().

◆ subscriptionExists()

InstitutionalSubscriptionDAO::subscriptionExists (   $subscriptionId,
  $journalId = null 
)

Check if an institutional subscription exists for a given subscriptionId.

Parameters
$subscriptionIdint Subscription ID
$journalIdint Optional journal ID
Returns
boolean

Definition at line 163 of file InstitutionalSubscriptionDAO.inc.php.

References DAO\retrieve().

Referenced by deleteById().

◆ subscriptionExistsByInstitutionName()

InstitutionalSubscriptionDAO::subscriptionExistsByInstitutionName (   $institutionName,
  $journalId,
  $exactMatch = true 
)

Check if an institutional subscription exists for a given institution name and journal.

Parameters
$institutionNamestring
$journalIdint
$exactMatchboolean
Returns
boolean

Definition at line 235 of file InstitutionalSubscriptionDAO.inc.php.

References DAO\retrieve().

◆ subscriptionExistsByUser()

InstitutionalSubscriptionDAO::subscriptionExistsByUser (   $subscriptionId,
  $userId 
)

Check if an institutional subscription exists for a given user.

Parameters
$subscriptionIdint Subscription ID
$userIdint User ID
Returns
boolean

Reimplemented from SubscriptionDAO.

Definition at line 186 of file InstitutionalSubscriptionDAO.inc.php.

References DAO\retrieve().

◆ subscriptionExistsByUserForJournal()

InstitutionalSubscriptionDAO::subscriptionExistsByUserForJournal (   $userId,
  $journalId 
)

Check if an institutional subscription exists for a given user and journal.

Parameters
$userIdint
$journalIdint
Returns
boolean

Reimplemented from SubscriptionDAO.

Definition at line 210 of file InstitutionalSubscriptionDAO.inc.php.

References DAO\retrieve().

◆ updateObject()

InstitutionalSubscriptionDAO::updateObject (   $institutionalSubscription)

Update an existing institutional subscription.

Parameters
$institutionalSubscriptionInstitutionalSubscription
Returns
boolean

Reimplemented from SubscriptionDAO.

Definition at line 289 of file InstitutionalSubscriptionDAO.inc.php.

References _deleteSubscriptionIPRanges(), _insertSubscriptionIPRanges(), SubscriptionDAO\_updateObject(), and DAO\update().


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