Open Journal Systems: SubscriptionTypeDAO Class Reference

Open Journal Systems 3.3.0

Inheritance diagram for SubscriptionTypeDAO:

Public Member Functions
	_fromRow ($row)

	deleteById ($typeId, $journalId=null)

	deleteByJournal ($journalId)

	getById ($typeId, $journalId=null)

	getByInstitutional ($journalId, $institutional=false, $disablePublicDisplay=null, $rangeInfo=null)

	getByJournalId ($journalId, $rangeInfo=null)

	getInsertId ()

	getLocaleFieldNames ()

	getSubscriptionTypeDisablePublicDisplay ($typeId)

	getSubscriptionTypeInstitutional ($typeId)

	getSubscriptionTypeMembership ($typeId)

	getSubscriptionTypeName ($typeId)

	insertObject ($subscriptionType)

	newDataObject ()

	resequenceSubscriptionTypes ($journalId)

	subscriptionTypeExistsByTypeId ($typeId, $journalId)

	subscriptionTypesExistByInstitutional ($journalId, $institutional=false)

	updateLocaleFields ($subscriptionType)

	updateObject ($subscriptionType)

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

	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 DAO
static	getDataChangedEvent ($elementId=null, $parentElementId=null, $content='')

Data Fields inherited from DAO
	$_dataSource

Protected Member Functions inherited from DAO
	_getInsertId ($table='', $id='')

Detailed Description

Operations for retrieving and modifying SubscriptionType objects.

See also: SubscriptionType

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

Member Function Documentation

◆ _fromRow()

SubscriptionTypeDAO::_fromRow ( $row )

Internal function to return a SubscriptionType object from a row.

Parameters

$row array

Returns: SubscriptionType

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

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

Referenced by getById().

◆ deleteById()

SubscriptionTypeDAO::deleteById	(		$typeId,
			$journalId = `null`
	)

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

Parameters

$typeId	int Subscription type ID
$journalId	int Optional journal ID

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

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

◆ deleteByJournal()

SubscriptionTypeDAO::deleteByJournal ( $journalId )

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

Parameters

$journalId int

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

References DAO\retrieve().

◆ getById()

SubscriptionTypeDAO::getById	(		$typeId,
			$journalId = `null`
	)

Retrieve a subscription type by ID.

Parameters

$typeId	int
$journalId	int optional

Returns: SubscriptionType

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

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

Referenced by deleteById().

◆ getByInstitutional()

SubscriptionTypeDAO::getByInstitutional	(		$journalId,
			$institutional = `false`,
			$disablePublicDisplay = `null`,
			$rangeInfo = `null`
	)

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

Parameters

$journalId	int
$institutional	bool
$disablePublicDisplay	bool\|null

Returns: object DAOResultFactory containing matching SubscriptionTypes

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

References DAO\retrieveRange().

◆ getByJournalId()

SubscriptionTypeDAO::getByJournalId	(		$journalId,
			$rangeInfo = `null`
	)

Retrieve subscription types matching a particular journal ID.

Parameters

$journalId int

Returns: object DAOResultFactory containing matching SubscriptionTypes

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

References DAO\retrieveRange().

◆ getInsertId()

SubscriptionTypeDAO::getInsertId ( )

Get the ID of the last inserted subscription type.

Returns: int

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

References DAO\_getInsertId().

Referenced by insertObject().

◆ getLocaleFieldNames()

SubscriptionTypeDAO::getLocaleFieldNames ( )

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

Returns: array

Reimplemented from DAO.

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

◆ getSubscriptionTypeDisablePublicDisplay()

SubscriptionTypeDAO::getSubscriptionTypeDisablePublicDisplay ( $typeId )

Retrieve public display flag by ID.

Parameters

$typeId int

Returns: int

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

References DAO\retrieve().

◆ getSubscriptionTypeInstitutional()

SubscriptionTypeDAO::getSubscriptionTypeInstitutional ( $typeId )

Retrieve institutional flag by ID.

Parameters

$typeId int

Returns: int

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

References DAO\retrieve().

◆ getSubscriptionTypeMembership()

SubscriptionTypeDAO::getSubscriptionTypeMembership ( $typeId )

Retrieve membership flag by ID.

Parameters

$typeId int

Returns: int

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

References DAO\retrieve().

◆ getSubscriptionTypeName()

SubscriptionTypeDAO::getSubscriptionTypeName ( $typeId )

Retrieve subscription type name by ID.

Parameters

$typeId int

Returns: string

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

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

◆ insertObject()

SubscriptionTypeDAO::insertObject ( $subscriptionType )

Insert a new SubscriptionType.

Parameters

$subscriptionType SubscriptionType

Returns: int Inserted subscription type ID

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

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

◆ newDataObject()

SubscriptionTypeDAO::newDataObject ( )

Create a new subscription type.

Returns: SubscriptionType

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

Referenced by _fromRow().

◆ resequenceSubscriptionTypes()

SubscriptionTypeDAO::resequenceSubscriptionTypes ( $journalId )

Sequentially renumber subscription types in their sequence order.

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

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

◆ subscriptionTypeExistsByTypeId()

SubscriptionTypeDAO::subscriptionTypeExistsByTypeId	(		$typeId,
			$journalId
	)

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

Parameters

$typeId	int
$journalId	int

Returns: boolean

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

References DAO\retrieve().

◆ subscriptionTypesExistByInstitutional()

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

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

Parameters

$journalId	int
$institutional	bool

Returns: boolean

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

References DAO\retrieve().

◆ updateLocaleFields()

SubscriptionTypeDAO::updateLocaleFields ( $subscriptionType )

Update the localized settings for this object

Parameters

$subscriptionType object

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

References DAO\updateDataObjectSettings().

Referenced by insertObject(), and updateObject().

◆ updateObject()

SubscriptionTypeDAO::updateObject ( $subscriptionType )

Update an existing subscription type.

Parameters

$subscriptionType SubscriptionType

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

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

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

SubscriptionTypeDAO.inc.php

SubscriptionTypeDAO
Generated on Fri Aug 28 2020 14:54:08 for Open Journal Systems by 1.8.17