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

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
 

Detailed Description

Abstract class for retrieving and modifying subscriptions.

See also
Subscription

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

Member Function Documentation

◆ _fromRow()

SubscriptionDAO::_fromRow (   $row)

Internal function to return a Subscription object from a row.

Parameters
$rowarray
Returns
Subscription

Reimplemented in InstitutionalSubscriptionDAO, and IndividualSubscriptionDAO.

Definition at line 311 of file SubscriptionDAO.inc.php.

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

◆ _generateSearchSQL()

SubscriptionDAO::_generateSearchSQL (   $status = null,
  $searchField = null,
  $searchMatch = null,
  $search = null,
  $dateField = null,
  $dateFrom = null,
  $dateTo = null,
$params 
)
protected

Internal function to generate subscription based search query.

Returns
string

Definition at line 184 of file SubscriptionDAO.inc.php.

References DAO\datetimeToDB().

Referenced by InstitutionalSubscriptionDAO\getByJournalId().

◆ _insertObject()

SubscriptionDAO::_insertObject (   $subscription)

Internal function to insert a new Subscription.

Parameters
$subscriptionSubscription
Returns
int Subscription ID

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().

◆ _renewSubscription()

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

Parameters
$subscriptionSubscription
Returns
boolean

Definition at line 402 of file SubscriptionDAO.inc.php.

References DAORegistry\getDAO(), and updateObject().

Referenced by IndividualSubscriptionDAO\renewSubscription(), and InstitutionalSubscriptionDAO\renewSubscription().

◆ _updateObject()

SubscriptionDAO::_updateObject (   $subscription)

Internal function to update a Subscription.

Parameters
$subscriptionSubscription

Definition at line 365 of file SubscriptionDAO.inc.php.

References DAO\datetimeToDB(), DAO\dateToDB(), and DAO\update().

Referenced by IndividualSubscriptionDAO\updateObject(), and InstitutionalSubscriptionDAO\updateObject().

◆ deleteById()

SubscriptionDAO::deleteById (   $subscriptionId,
  $journalId 
)
abstract

Delete subscription by subscription ID.

Parameters
$subscriptionIdint Subscription ID
$journalIdint Journal ID

Reimplemented in InstitutionalSubscriptionDAO, and IndividualSubscriptionDAO.

◆ deleteByJournalId()

SubscriptionDAO::deleteByJournalId (   $journalId)
abstract

Delete subscriptions by journal ID.

Parameters
$journalIdint
Returns
boolean

Reimplemented in InstitutionalSubscriptionDAO, and IndividualSubscriptionDAO.

◆ deleteByTypeId()

SubscriptionDAO::deleteByTypeId (   $subscriptionTypeId)
abstract

Delete all subscriptions by subscription type ID.

Parameters
$subscriptionTypeIdint
Returns
boolean

Reimplemented in InstitutionalSubscriptionDAO, and IndividualSubscriptionDAO.

◆ deleteByUserId()

SubscriptionDAO::deleteByUserId (   $userId)
abstract

Delete subscriptions by user ID.

Parameters
$userIdint
Returns
boolean

Reimplemented in InstitutionalSubscriptionDAO, and IndividualSubscriptionDAO.

◆ getAll()

SubscriptionDAO::getAll (   $rangeInfo = null)
abstract

Retrieve all subscriptions.

Returns
object DAOResultFactory containing Subscriptions

Reimplemented in InstitutionalSubscriptionDAO, and IndividualSubscriptionDAO.

◆ getByDateEnd()

SubscriptionDAO::getByDateEnd (   $dateEnd,
  $journalId,
  $rangeInfo = null 
)
abstract

Retrieve subscriptions matching a particular end date and journal ID.

Parameters
$dateEndstring (YYYY-MM-DD)
$journalIdint
Returns
object DAOResultFactory containing matching Subscriptions

Reimplemented in InstitutionalSubscriptionDAO, and IndividualSubscriptionDAO.

◆ getById()

SubscriptionDAO::getById (   $subscriptionId)
abstract

Retrieve subscription by subscription ID.

Parameters
$subscriptionIdint
Returns
Subscription

◆ getByJournalId()

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

Retrieve 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 in IndividualSubscriptionDAO, and InstitutionalSubscriptionDAO.

◆ getInsertId()

SubscriptionDAO::getInsertId ( )

Function to get the ID of the last inserted subscription.

Returns
int

Definition at line 105 of file SubscriptionDAO.inc.php.

References DAO\_getInsertId().

Referenced by _insertObject().

◆ getStatusCount()

SubscriptionDAO::getStatusCount (   $status)
abstract

Return number of subscriptions with given status.

Parameters
statusint
Returns
int

◆ getStatusOptions()

static SubscriptionDAO::getStatusOptions ( )
static

Retrieve subscription status options as associative array.

Returns
array

Definition at line 54 of file SubscriptionDAO.inc.php.

Referenced by SubscriptionForm\__construct().

◆ getSubscriptionJournalId()

SubscriptionDAO::getSubscriptionJournalId (   $subscriptionId)

Retrieve subscription journal ID by subscription ID.

Parameters
$subscriptionIdint
Returns
int

Definition at line 39 of file SubscriptionDAO.inc.php.

References DAO\retrieve().

◆ insertObject()

SubscriptionDAO::insertObject (   $subscription)
abstract

Insert a subscription.

Parameters
$subscriptionSubscription

Reimplemented in InstitutionalSubscriptionDAO, and IndividualSubscriptionDAO.

◆ newDataObject()

SubscriptionDAO::newDataObject ( )
abstract

Generator function to create object.

Returns
Subscription

Reimplemented in InstitutionalSubscriptionDAO, and IndividualSubscriptionDAO.

Referenced by _fromRow().

◆ renewSubscription()

SubscriptionDAO::renewSubscription (   $subscription)
abstract

Function to renew a subscription by dateEnd + duration of subscription type if the subscription is expired, renew to current date + duration

Parameters
$subscriptionSubscription
Returns
boolean

Reimplemented in InstitutionalSubscriptionDAO, and IndividualSubscriptionDAO.

◆ subscriptionExists()

SubscriptionDAO::subscriptionExists (   $subscriptionId)
abstract

Check if subscription exists for a given subscriptionId.

Parameters
$subscriptionIdint
Returns
boolean

Reimplemented in IndividualSubscriptionDAO.

◆ subscriptionExistsByUser()

SubscriptionDAO::subscriptionExistsByUser (   $subscriptionId,
  $userId 
)
abstract

Check if subscription exists given a user.

Parameters
$subscriptionIdint
$userIdint
Returns
boolean

Reimplemented in InstitutionalSubscriptionDAO, and IndividualSubscriptionDAO.

◆ subscriptionExistsByUserForJournal()

SubscriptionDAO::subscriptionExistsByUserForJournal (   $userId,
  $journalId 
)
abstract

Check if subscription exists given a user and journal.

Parameters
$subscriptionIdint
$userIdint
Returns
boolean

Reimplemented in InstitutionalSubscriptionDAO, and IndividualSubscriptionDAO.

◆ updateObject()

SubscriptionDAO::updateObject (   $subscription)
abstract

Update existing subscription.

Parameters
$subscriptionSubscription
Returns
boolean

Reimplemented in InstitutionalSubscriptionDAO, and IndividualSubscriptionDAO.

Referenced by _renewSubscription().


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