CHIEFSOFT\ameye
393 lines
12 KiB
PHP
393 lines
12 KiB
PHP
<?php
|
|
|
|
/**
|
|
* @file classes/subscription/SubscriptionTypeDAO.php
|
|
*
|
|
* Copyright (c) 2014-2021 Simon Fraser University
|
|
* Copyright (c) 2003-2021 John Willinsky
|
|
* Distributed under the GNU GPL v3. For full terms see the file docs/COPYING.
|
|
*
|
|
* @class SubscriptionTypeDAO
|
|
*
|
|
* @ingroup subscription
|
|
*
|
|
* @see SubscriptionType
|
|
*
|
|
* @brief Operations for retrieving and modifying SubscriptionType objects.
|
|
*/
|
|
|
|
namespace APP\subscription;
|
|
|
|
use Illuminate\Support\Facades\DB;
|
|
use PKP\db\DAORegistry;
|
|
use PKP\db\DAOResultFactory;
|
|
use PKP\db\DBResultRange;
|
|
use PKP\facades\Locale;
|
|
use PKP\plugins\Hook;
|
|
|
|
class SubscriptionTypeDAO extends \PKP\db\DAO
|
|
{
|
|
/**
|
|
* Create a new subscription type.
|
|
*
|
|
* @return SubscriptionType
|
|
*/
|
|
public function newDataObject()
|
|
{
|
|
return new SubscriptionType();
|
|
}
|
|
|
|
/**
|
|
* Retrieve a subscription type by ID.
|
|
*
|
|
* @param int $typeId
|
|
* @param int $journalId optional
|
|
*
|
|
* @return ?SubscriptionType
|
|
*/
|
|
public function getById($typeId, $journalId = null)
|
|
{
|
|
$params = [(int) $typeId];
|
|
if ($journalId) {
|
|
$params[] = (int) $journalId;
|
|
}
|
|
|
|
$result = $this->retrieve(
|
|
'SELECT * FROM subscription_types WHERE type_id = ?' .
|
|
($journalId ? ' AND journal_id = ?' : ''),
|
|
$params
|
|
);
|
|
$row = $result->current();
|
|
return $row ? $this->_fromRow((array) $row) : null;
|
|
}
|
|
|
|
/**
|
|
* Retrieve subscription type name by ID.
|
|
*
|
|
* @param int $typeId
|
|
*
|
|
* @return string?
|
|
*/
|
|
public function getSubscriptionTypeName($typeId)
|
|
{
|
|
$result = $this->retrieve(
|
|
'SELECT COALESCE(l.setting_value, p.setting_value) as subscription_type_name FROM subscription_type_settings l LEFT JOIN subscription_type_settings p ON (p.type_id = ? AND p.setting_name = ? AND p.locale = ?) WHERE l.type_id = ? AND l.setting_name = ? AND l.locale = ?',
|
|
[
|
|
(int) $typeId, 'name', Locale::getLocale(),
|
|
(int) $typeId, 'name', Locale::getPrimaryLocale()
|
|
]
|
|
);
|
|
$row = $result->current();
|
|
return $row ? $row->subscription_type_name : null;
|
|
}
|
|
|
|
/**
|
|
* Retrieve institutional flag by ID.
|
|
*
|
|
* @param int $typeId
|
|
*
|
|
* @return bool
|
|
*/
|
|
public function getSubscriptionTypeInstitutional($typeId)
|
|
{
|
|
$result = $this->retrieve(
|
|
'SELECT institutional FROM subscription_types WHERE type_id = ?',
|
|
[(int) $typeId]
|
|
);
|
|
$row = $result->current();
|
|
return $row ? (bool) $row->institutional : false;
|
|
}
|
|
|
|
/**
|
|
* Retrieve membership flag by ID.
|
|
*
|
|
* @param int $typeId
|
|
*
|
|
* @return bool
|
|
*/
|
|
public function getSubscriptionTypeMembership($typeId)
|
|
{
|
|
$result = $this->retrieve(
|
|
'SELECT membership FROM subscription_types WHERE type_id = ?',
|
|
[(int) $typeId]
|
|
);
|
|
$row = $result->current();
|
|
return $row ? (bool) $row->membership : false;
|
|
}
|
|
|
|
/**
|
|
* Retrieve public display flag by ID.
|
|
*
|
|
* @param int $typeId
|
|
*
|
|
* @return bool
|
|
*/
|
|
public function getSubscriptionTypeDisablePublicDisplay($typeId)
|
|
{
|
|
$result = $this->retrieve(
|
|
'SELECT disable_public_display FROM subscription_types WHERE type_id = ?',
|
|
[(int) $typeId]
|
|
);
|
|
$row = $result->current();
|
|
return $row ? (bool) $row->disable_public_display : false;
|
|
}
|
|
|
|
/**
|
|
* Check if a subscription type exists with the given type id for a journal.
|
|
*
|
|
* @param int $typeId
|
|
* @param int $journalId
|
|
*
|
|
* @return bool
|
|
*/
|
|
public function subscriptionTypeExistsByTypeId($typeId, $journalId)
|
|
{
|
|
$result = $this->retrieve(
|
|
'SELECT COUNT(*) AS row_count
|
|
FROM subscription_types
|
|
WHERE type_id = ?
|
|
AND journal_id = ?',
|
|
[(int) $typeId, (int) $journalId]
|
|
);
|
|
$row = $result->current();
|
|
return $row ? (bool) $row->row_count : false;
|
|
}
|
|
|
|
/**
|
|
* Internal function to return a SubscriptionType object from a row.
|
|
*
|
|
* @param array $row
|
|
*
|
|
* @return SubscriptionType
|
|
*/
|
|
public function _fromRow($row)
|
|
{
|
|
$subscriptionType = $this->newDataObject();
|
|
$subscriptionType->setId($row['type_id']);
|
|
$subscriptionType->setJournalId($row['journal_id']);
|
|
$subscriptionType->setCost($row['cost']);
|
|
$subscriptionType->setCurrencyCodeAlpha($row['currency_code_alpha']);
|
|
$subscriptionType->setDuration($row['duration']);
|
|
$subscriptionType->setFormat($row['format']);
|
|
$subscriptionType->setInstitutional($row['institutional']);
|
|
$subscriptionType->setMembership($row['membership']);
|
|
$subscriptionType->setDisablePublicDisplay($row['disable_public_display']);
|
|
$subscriptionType->setSequence($row['seq']);
|
|
|
|
$this->getDataObjectSettings('subscription_type_settings', 'type_id', $row['type_id'], $subscriptionType);
|
|
|
|
Hook::call('SubscriptionTypeDAO::_fromRow', [&$subscriptionType, &$row]);
|
|
|
|
return $subscriptionType;
|
|
}
|
|
|
|
/**
|
|
* Get the list of field names for which localized data is used.
|
|
*
|
|
* @return array
|
|
*/
|
|
public function getLocaleFieldNames()
|
|
{
|
|
return ['name', 'description'];
|
|
}
|
|
|
|
/**
|
|
* Update the localized settings for this object
|
|
*
|
|
* @param object $subscriptionType
|
|
*/
|
|
public function updateLocaleFields($subscriptionType)
|
|
{
|
|
$this->updateDataObjectSettings('subscription_type_settings', $subscriptionType, [
|
|
'type_id' => $subscriptionType->getId()
|
|
]);
|
|
}
|
|
|
|
/**
|
|
* Insert a new SubscriptionType.
|
|
*
|
|
* @param SubscriptionType $subscriptionType
|
|
*
|
|
* @return int Inserted subscription type ID
|
|
*/
|
|
public function insertObject($subscriptionType)
|
|
{
|
|
$this->update(
|
|
'INSERT INTO subscription_types
|
|
(journal_id, cost, currency_code_alpha, duration, format, institutional, membership, disable_public_display, seq)
|
|
VALUES
|
|
(?, ?, ?, ?, ?, ?, ?, ?, ?)',
|
|
[
|
|
(int) $subscriptionType->getJournalId(),
|
|
(float) $subscriptionType->getCost(),
|
|
$subscriptionType->getCurrencyCodeAlpha(),
|
|
$subscriptionType->getDuration(),
|
|
$subscriptionType->getFormat(),
|
|
(int) $subscriptionType->getInstitutional(),
|
|
$subscriptionType->getMembership(),
|
|
(int) $subscriptionType->getDisablePublicDisplay(),
|
|
(float) $subscriptionType->getSequence(),
|
|
]
|
|
);
|
|
|
|
$subscriptionType->setId($this->getInsertId());
|
|
$this->updateLocaleFields($subscriptionType);
|
|
return $subscriptionType->getId();
|
|
}
|
|
|
|
/**
|
|
* Update an existing subscription type.
|
|
*
|
|
* @param SubscriptionType $subscriptionType
|
|
*/
|
|
public function updateObject($subscriptionType)
|
|
{
|
|
$this->update(
|
|
'UPDATE subscription_types
|
|
SET
|
|
journal_id = ?,
|
|
cost = ?,
|
|
currency_code_alpha = ?,
|
|
duration = ?,
|
|
format = ?,
|
|
institutional = ?,
|
|
membership = ?,
|
|
disable_public_display = ?,
|
|
seq = ?
|
|
WHERE type_id = ?',
|
|
[
|
|
(int) $subscriptionType->getJournalId(),
|
|
$subscriptionType->getCost(),
|
|
$subscriptionType->getCurrencyCodeAlpha(),
|
|
$subscriptionType->getDuration(),
|
|
$subscriptionType->getFormat(),
|
|
(int) $subscriptionType->getInstitutional(),
|
|
$subscriptionType->getMembership(),
|
|
(int) $subscriptionType->getDisablePublicDisplay(),
|
|
(float) $subscriptionType->getSequence(),
|
|
(int) $subscriptionType->getId(),
|
|
]
|
|
);
|
|
$this->updateLocaleFields($subscriptionType);
|
|
}
|
|
|
|
/**
|
|
* Delete a subscription type by ID. Note that all subscriptions with this
|
|
* type ID are also deleted.
|
|
*
|
|
* @param int $typeId Subscription type ID
|
|
* @param int $journalId Optional journal ID
|
|
*/
|
|
public function deleteById($typeId, $journalId = null)
|
|
{
|
|
$subscriptionType = $this->getById($typeId, $journalId);
|
|
if ($subscriptionType) {
|
|
/** @var InstitutionalSubscriptionDAO|IndividualSubscriptionDAO */
|
|
$subscriptionDao = DAORegistry::getDAO($subscriptionType->getInstitutional() ? 'InstitutionalSubscriptionDAO' : 'IndividualSubscriptionDAO');
|
|
$subscriptionDao->deleteById($typeId);
|
|
$this->update('DELETE FROM subscription_types WHERE type_id = ?', [(int) $typeId]);
|
|
$this->update('DELETE FROM subscription_type_settings WHERE type_id = ?', [(int) $typeId]);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Delete subscription types by journal ID. Note that all subscriptions with
|
|
* corresponding types are also deleted.
|
|
*
|
|
* @param int $journalId
|
|
*/
|
|
public function deleteByJournal($journalId)
|
|
{
|
|
$result = $this->retrieve(
|
|
'SELECT type_id
|
|
FROM subscription_types
|
|
WHERE journal_id = ?',
|
|
[(int) $journalId]
|
|
);
|
|
foreach ($result as $row) {
|
|
$typeId = $row->type_id;
|
|
$this->deleteById($typeId);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Retrieve subscription types matching a particular journal ID.
|
|
*
|
|
* @param int $journalId
|
|
* @param ?DBResultRange $rangeInfo
|
|
*
|
|
* @return DAOResultFactory<SubscriptionType> Object containing matching SubscriptionTypes
|
|
*/
|
|
public function getByJournalId($journalId, $rangeInfo = null)
|
|
{
|
|
$result = $this->retrieveRange(
|
|
$sql = 'SELECT * FROM subscription_types WHERE journal_id = ? ORDER BY seq',
|
|
$params = [(int) $journalId],
|
|
$rangeInfo
|
|
);
|
|
return new DAOResultFactory($result, $this, '_fromRow', [], $sql, $params, $rangeInfo); // Counted in subscription type grid paging
|
|
}
|
|
|
|
/**
|
|
* Retrieve subscription types matching a particular journal ID and institutional flag.
|
|
*
|
|
* @param int $journalId
|
|
* @param bool $institutional
|
|
* @param bool|null $disablePublicDisplay
|
|
* @param ?DBResultRange $rangeInfo
|
|
*
|
|
* @return DAOResultFactory<SubscriptionType> Object containing matching SubscriptionTypes
|
|
*/
|
|
public function getByInstitutional($journalId, $institutional = false, $disablePublicDisplay = null, $rangeInfo = null)
|
|
{
|
|
$result = $this->retrieveRange(
|
|
'SELECT *
|
|
FROM subscription_types
|
|
WHERE journal_id = ?
|
|
AND institutional = ?
|
|
' . ($disablePublicDisplay === true ? 'AND disable_public_display = 1' : '') . '
|
|
' . ($disablePublicDisplay === false ? 'AND disable_public_display = 0' : '') . '
|
|
ORDER BY seq',
|
|
[(int) $journalId, (int) $institutional],
|
|
$rangeInfo
|
|
);
|
|
|
|
return new DAOResultFactory($result, $this, '_fromRow');
|
|
}
|
|
|
|
/**
|
|
* Check if at least one subscription type exists for a given journal by institutional flag.
|
|
*
|
|
* @param int $journalId
|
|
* @param bool $institutional
|
|
*
|
|
* @return bool
|
|
*/
|
|
public function subscriptionTypesExistByInstitutional($journalId, $institutional = false)
|
|
{
|
|
$result = DB::table('subscription_types')
|
|
->where('journal_id', (int) $journalId)
|
|
->where('institutional', (int) $institutional)
|
|
->first();
|
|
|
|
return is_null($result) ? false : true;
|
|
}
|
|
|
|
/**
|
|
* Sequentially renumber subscription types in their sequence order.
|
|
*/
|
|
public function resequenceSubscriptionTypes($journalId)
|
|
{
|
|
$result = $this->retrieve('SELECT type_id FROM subscription_types WHERE journal_id = ? ORDER BY seq', [(int) $journalId]);
|
|
|
|
for ($i = 1; $row = $result->current(); $i++) {
|
|
$this->update('UPDATE subscription_types SET seq = ? WHERE type_id = ?', [(int) $i, (int) $row->type_id]);
|
|
$result->next();
|
|
}
|
|
}
|
|
}
|
|
|
|
if (!PKP_STRICT_MODE) {
|
|
class_alias('\APP\subscription\SubscriptionTypeDAO', '\SubscriptionTypeDAO');
|
|
}
|