Open Journal Systems  2.4.3
 All Classes Namespaces Functions Variables Groups Pages
SubscriptionTypeDAO Class Reference
Inheritance diagram for SubscriptionTypeDAO:
DAO

Public Member Functions

_returnSubscriptionTypeFromRow (&$row)
 
 deleteSubscriptionType (&$subscriptionType)
 
 deleteSubscriptionTypeById ($typeId)
 
 deleteSubscriptionTypesByJournal ($journalId)
 
 getInsertSubscriptionTypeId ()
 
 getLocaleFieldNames ()
 
getSubscriptionType ($typeId)
 
 getSubscriptionTypeDisablePublicDisplay ($typeId)
 
 getSubscriptionTypeInstitutional ($typeId)
 
 getSubscriptionTypeJournalId ($typeId)
 
 getSubscriptionTypeMembership ($typeId)
 
 getSubscriptionTypeName ($typeId)
 
 getSubscriptionTypeNonExpiring ($typeId)
 
getSubscriptionTypesByInstitutional ($journalId, $institutional=false, $disablePublicDisplay=null, $rangeInfo=null)
 
getSubscriptionTypesByJournalId ($journalId, $rangeInfo=null)
 
 insertSubscriptionType (&$subscriptionType)
 
 resequenceSubscriptionTypes ($journalId)
 
 subscriptionTypeExistsByTypeId ($typeId, $journalId)
 
 subscriptionTypesExistByInstitutional ($journalId, $institutional=false)
 
 updateLocaleFields (&$subscriptionType)
 
 updateSubscriptionType (&$subscriptionType)
 
- Public Member Functions inherited from DAO
 concat ()
 
 convertFromDB ($value, $type)
 
 convertToDB ($value, &$type)
 
 DAO ($dataSource=null, $callHooks=true)
 
 dateFromDB ($d)
 
 datetimeFromDB ($dt)
 
 datetimeToDB ($dt)
 
 dateToDB ($d)
 
 flushCache ()
 
 formatDateToDB ($date, $defaultNumWeeks=null, $acceptPastDate=true)
 
 getAffectedRows ()
 
 getDataChangedEvent ($elementId=null, $parentElementId=null)
 
getDataSource ()
 
 getDirectionMapping ($direction)
 
 getDriver ()
 
 getInsertId ($table= '', $id= '', $callHooks=true)
 
 getType ($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

- Public Attributes inherited from DAO
 $_dataSource
 

Detailed Description

Operations for retrieving and modifying SubscriptionType objects.

See Also
SubscriptionType

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

Member Function Documentation

& SubscriptionTypeDAO::_returnSubscriptionTypeFromRow ( $row)

Internal function to return a SubscriptionType object from a row.

Parameters
$rowarray
Returns
SubscriptionType

Definition at line 183 of file SubscriptionTypeDAO.inc.php.

References HookRegistry\call().

Referenced by getSubscriptionType().

SubscriptionTypeDAO::deleteSubscriptionType ( $subscriptionType)

Delete a subscription type.

Parameters
$subscriptionTypeSubscriptionType
Returns
boolean

Definition at line 295 of file SubscriptionTypeDAO.inc.php.

References deleteSubscriptionTypeById().

SubscriptionTypeDAO::deleteSubscriptionTypeById (   $typeId)

Delete a subscription type by ID. Note that all subscriptions with this type ID are also deleted.

Parameters
$typeIdint
Returns
boolean

Definition at line 305 of file SubscriptionTypeDAO.inc.php.

References DAORegistry\getDAO(), getSubscriptionTypeInstitutional(), and DAO\update().

Referenced by deleteSubscriptionType(), and deleteSubscriptionTypesByJournal().

SubscriptionTypeDAO::deleteSubscriptionTypesByJournal (   $journalId)

Delete subscription types by journal ID. Note that all subscriptions with corresponding types are also deleted.

Parameters
$journalIdint
Returns
boolean

Definition at line 335 of file SubscriptionTypeDAO.inc.php.

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

SubscriptionTypeDAO::getInsertSubscriptionTypeId ( )

Get the ID of the last inserted subscription type.

Returns
int

Definition at line 445 of file SubscriptionTypeDAO.inc.php.

References DAO\getInsertId().

Referenced by insertSubscriptionType().

SubscriptionTypeDAO::getLocaleFieldNames ( )

Get the list of field names for which localized data is used.

Returns
array

Definition at line 208 of file SubscriptionTypeDAO.inc.php.

& SubscriptionTypeDAO::getSubscriptionType (   $typeId)

Retrieve a subscription type by ID.

Parameters
$typeIdint
Returns
SubscriptionType

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

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

SubscriptionTypeDAO::getSubscriptionTypeDisablePublicDisplay (   $typeId)

Retrieve public display flag by ID.

Parameters
$typeIdint
Returns
int

Definition at line 140 of file SubscriptionTypeDAO.inc.php.

References DAO\retrieve().

SubscriptionTypeDAO::getSubscriptionTypeInstitutional (   $typeId)

Retrieve institutional flag by ID.

Parameters
$typeIdint
Returns
int

Definition at line 86 of file SubscriptionTypeDAO.inc.php.

References DAO\retrieve().

Referenced by deleteSubscriptionTypeById().

SubscriptionTypeDAO::getSubscriptionTypeJournalId (   $typeId)

Retrieve subscription type journal ID by ID.

Parameters
$typeIdint
Returns
int

Definition at line 46 of file SubscriptionTypeDAO.inc.php.

References DAO\retrieve().

SubscriptionTypeDAO::getSubscriptionTypeMembership (   $typeId)

Retrieve membership flag by ID.

Parameters
$typeIdint
Returns
int

Definition at line 104 of file SubscriptionTypeDAO.inc.php.

References DAO\retrieve().

SubscriptionTypeDAO::getSubscriptionTypeName (   $typeId)

Retrieve subscription type name by ID.

Parameters
$typeIdint
Returns
string

Definition at line 64 of file SubscriptionTypeDAO.inc.php.

References AppLocale\getLocale(), AppLocale\getPrimaryLocale(), and DAO\retrieve().

SubscriptionTypeDAO::getSubscriptionTypeNonExpiring (   $typeId)

Retrieve nonExpiring flag by ID.

Parameters
$typeIdint
Returns
int

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

References DAO\retrieve().

& SubscriptionTypeDAO::getSubscriptionTypesByInstitutional (   $journalId,
  $institutional = false,
  $disablePublicDisplay = null,
  $rangeInfo = null 
)

Retrieve subscription types matching a particular journal ID and institutional flag.

Parameters
$journalIdint
$institutionalbool
$disablePublicDisplaybool
Returns
object DAOResultFactory containing matching SubscriptionTypes

Definition at line 382 of file SubscriptionTypeDAO.inc.php.

References DAO\retrieveRange().

& SubscriptionTypeDAO::getSubscriptionTypesByJournalId (   $journalId,
  $rangeInfo = null 
)

Retrieve subscription types matching a particular journal ID.

Parameters
$journalIdint
Returns
object DAOResultFactory containing matching SubscriptionTypes

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

References DAO\retrieveRange().

SubscriptionTypeDAO::insertSubscriptionType ( $subscriptionType)

Insert a new SubscriptionType.

Parameters
$subscriptionTypeSubscriptionType
Returns
boolean

Definition at line 227 of file SubscriptionTypeDAO.inc.php.

References getInsertSubscriptionTypeId(), DAO\update(), and updateLocaleFields().

SubscriptionTypeDAO::resequenceSubscriptionTypes (   $journalId)

Sequentially renumber subscription types in their sequence order.

Definition at line 452 of file SubscriptionTypeDAO.inc.php.

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

SubscriptionTypeDAO::subscriptionTypeExistsByTypeId (   $typeId,
  $journalId 
)

Check if a subscription type exists with the given type id for a journal.

Parameters
$typeIdint
$journalIdint
Returns
boolean

Definition at line 159 of file SubscriptionTypeDAO.inc.php.

References DAO\retrieve().

SubscriptionTypeDAO::subscriptionTypesExistByInstitutional (   $journalId,
  $institutional = false 
)

Check if at least one subscription type exists for a given journal by institutional flag.

Parameters
$journalIdint
$institutionalbool
Returns
boolean

Definition at line 418 of file SubscriptionTypeDAO.inc.php.

References DAO\retrieve().

SubscriptionTypeDAO::updateLocaleFields ( $subscriptionType)

Update the localized settings for this object

Parameters
$subscriptionTypeobject

Definition at line 216 of file SubscriptionTypeDAO.inc.php.

References DAO\updateDataObjectSettings().

Referenced by insertSubscriptionType(), and updateSubscriptionType().

SubscriptionTypeDAO::updateSubscriptionType ( $subscriptionType)

Update an existing subscription type.

Parameters
$subscriptionTypeSubscriptionType
Returns
boolean

Definition at line 257 of file SubscriptionTypeDAO.inc.php.

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


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