CHIEFSOFT\ameye
104 lines
2.9 KiB
PHP
104 lines
2.9 KiB
PHP
<?php
|
|
/**
|
|
* @file classes/emailTemplate/maps/Schema.php
|
|
*
|
|
* Copyright (c) 2014-2021 Simon Fraser University
|
|
* Copyright (c) 2000-2021 John Willinsky
|
|
* Distributed under the GNU GPL v3. For full terms see the file docs/COPYING.
|
|
*
|
|
* @class Schema
|
|
*
|
|
* @brief Map email templates to the properties defined in the email template schema
|
|
*/
|
|
|
|
namespace PKP\emailTemplate\maps;
|
|
|
|
use Illuminate\Support\Enumerable;
|
|
use PKP\core\PKPApplication;
|
|
use PKP\emailTemplate\EmailTemplate;
|
|
use PKP\services\PKPSchemaService;
|
|
|
|
class Schema extends \PKP\core\maps\Schema
|
|
{
|
|
/** @copydoc \PKP\core\maps\Schema::$collection */
|
|
public Enumerable $collection;
|
|
|
|
/** @copydoc \PKP\core\maps\Schema::$schema */
|
|
public string $schema = PKPSchemaService::SCHEMA_EMAIL_TEMPLATE;
|
|
|
|
/**
|
|
* Map an email template
|
|
*
|
|
* Includes all properties in the email template schema.
|
|
*/
|
|
public function map(EmailTemplate $item): array
|
|
{
|
|
return $this->mapByProperties($this->getProps(), $item);
|
|
}
|
|
|
|
/**
|
|
* Summarize an email template
|
|
*
|
|
* Includes properties with the apiSummary flag in the email template schema.
|
|
*/
|
|
public function summarize(EmailTemplate $item): array
|
|
{
|
|
return $this->mapByProperties($this->getSummaryProps(), $item);
|
|
}
|
|
|
|
/**
|
|
* Map a collection of email templates
|
|
*
|
|
* @see self::map
|
|
*/
|
|
public function mapMany(Enumerable $collection): Enumerable
|
|
{
|
|
$this->collection = $collection;
|
|
return $collection->map(function ($item) {
|
|
return $this->map($item);
|
|
});
|
|
}
|
|
|
|
/**
|
|
* Summarize a collection of email templates
|
|
*
|
|
* @see self::summarize
|
|
*/
|
|
public function summarizeMany(Enumerable $collection): Enumerable
|
|
{
|
|
$this->collection = $collection;
|
|
return $collection->map(function ($item) {
|
|
return $this->summarize($item);
|
|
});
|
|
}
|
|
|
|
/**
|
|
* Map schema properties of an Announcement to an assoc array
|
|
*/
|
|
protected function mapByProperties(array $props, EmailTemplate $item): array
|
|
{
|
|
$output = [];
|
|
foreach ($props as $prop) {
|
|
switch ($prop) {
|
|
case '_href':
|
|
$output[$prop] = $this->request->getDispatcher()->url(
|
|
$this->request,
|
|
PKPApplication::ROUTE_API,
|
|
$this->context->getData('urlPath'),
|
|
'emailTemplates/' . $item->getData('key')
|
|
);
|
|
break;
|
|
default:
|
|
$output[$prop] = $item->getData($prop);
|
|
break;
|
|
}
|
|
}
|
|
|
|
$output = $this->schemaService->addMissingMultilingualValues($this->schema, $output, $this->context->getSupportedFormLocales());
|
|
|
|
ksort($output);
|
|
|
|
return $this->withExtensions($output, $item);
|
|
}
|
|
}
|