l10n_server-2.x-dev/l10n_server/src/Entity/L10nServerRelease.php
l10n_server/src/Entity/L10nServerRelease.php
<?php
declare(strict_types=1);
namespace Drupal\l10n_server\Entity;
use Drupal\Core\Entity\ContentEntityBase;
use Drupal\Core\Entity\EntityStorageInterface;
use Drupal\Core\Entity\EntityTypeInterface;
use Drupal\Core\Field\BaseFieldDefinition;
/**
* Defines the release entity class.
*
* @ContentEntityType(
* id = "l10n_server_release",
* label = @Translation("Release"),
* label_collection = @Translation("Releases"),
* label_singular = @Translation("release"),
* label_plural = @Translation("releases"),
* label_count = @PluralTranslation(
* singular = "@count releases",
* plural = "@count releases",
* ),
* handlers = {
* "list_builder" = "Drupal\l10n_server\Entity\ListBuilder\L10nServerReleaseListBuilder",
* "storage" = "Drupal\l10n_server\Entity\Storage\L10nServerReleaseStorage",
* "storage_schema" = "Drupal\l10n_server\Entity\L10nServerReleaseStorageSchema",
* "views_data" = "Drupal\views\EntityViewsData",
* "access" = "Drupal\l10n_server\Entity\AccessControlHandler\L10nServerReleaseAccessControlHandler",
* "form" = {
* "add" = "Drupal\l10n_server\Form\L10nServerReleaseForm",
* "edit" = "Drupal\l10n_server\Form\L10nServerReleaseForm",
* "delete" = "Drupal\Core\Entity\ContentEntityDeleteForm",
* },
* "route_provider" = {
* "html" = "Drupal\Core\Entity\Routing\AdminHtmlRouteProvider",
* }
* },
* base_table = "l10n_server_release",
* admin_permission = "administer l10n server release",
* entity_keys = {
* "id" = "rid",
* "label" = "title",
* "uuid" = "uuid",
* },
* links = {
* "collection" = "/admin/localization/releases",
* "add-form" = "/release/add",
* "canonical" = "/release/{l10n_server_release}",
* "edit-form" = "/release/{l10n_server_release}/edit",
* "delete-form" = "/release/{l10n_server_release}/delete",
* },
* )
*/
class L10nServerRelease extends ContentEntityBase implements L10nServerReleaseInterface {
/**
* {@inheritdoc}
*/
public function postSave(EntityStorageInterface $storage, $update = TRUE) {
parent::postSave($storage, $update);
if ($update) {
return;
}
// Queue release to be parsed.
$queue = \Drupal::queue('l10n_server_parser');
if ($queue->createItem($this)) {
// Add timestamp to avoid queueing item more than once.
$this->setQueuedTime(\Drupal::time()->getRequestTime());
$this->save();
}
}
/**
* {@inheritdoc}
*/
public static function baseFieldDefinitions(EntityTypeInterface $entity_type): array {
$fields = parent::baseFieldDefinitions($entity_type);
$fields['title'] = BaseFieldDefinition::create('string')
->setLabel(t('Title'))
->setRequired(TRUE)
->setSetting('max_length', 288)
->setDisplayOptions('form', [
'type' => 'string_textfield',
'weight' => 0,
])
->setDisplayConfigurable('form', TRUE)
->setDisplayOptions('view', [
'label' => 'hidden',
'type' => 'string',
'weight' => 0,
])
->setDisplayConfigurable('view', TRUE);
$fields['pid'] = BaseFieldDefinition::create('entity_reference')
->setLabel(t('Project'))
->setRequired(TRUE)
->setDescription(t('Reference to the {l10n_server_project}.pid of the parent project.'))
->setSetting('target_type', 'l10n_server_project')
->setDisplayOptions('form', [
'type' => 'string_textfield',
'weight' => 0,
])
->setDisplayConfigurable('form', TRUE)
->setDisplayOptions('view', [
'label' => 'above',
'type' => 'string',
'weight' => 0,
])
->setDisplayConfigurable('view', TRUE);
$fields['version'] = BaseFieldDefinition::create('string')
->setLabel(t('Version'))
->setDescription('Version of the release.')
->setSetting('max_length', 32)
->setDisplayOptions('form', [
'type' => 'string_textfield',
'weight' => 0,
])
->setDisplayConfigurable('form', TRUE)
->setDisplayOptions('view', [
'label' => 'above',
'type' => 'string',
'weight' => 0,
])
->setDisplayConfigurable('view', TRUE);
$fields['download_link'] = BaseFieldDefinition::create('string')
->setLabel(t('Download'))
->setDescription('Link to download this release.')
->setDisplayOptions('view', [
'label' => 'above',
'type' => 'string',
'weight' => 0,
])
->setDisplayConfigurable('view', TRUE)
->setDisplayOptions('form', [
'type' => 'text_textfield',
'weight' => 0,
])
->setDisplayConfigurable('form', TRUE);
$fields['file_hash'] = BaseFieldDefinition::create('string')
->setLabel(t('File hash'))
->setDescription('Hash of file for easy identification of changed files')
->setSetting('max_length', 32)
->setDisplayOptions('form', [
'type' => 'string_textfield',
'weight' => 0,
])
->setDisplayConfigurable('form', TRUE)
->setDisplayOptions('view', [
'label' => 'above',
'type' => 'string',
'weight' => 0,
])
->setDisplayConfigurable('view', TRUE);
$fields['file_date'] = BaseFieldDefinition::create('timestamp')
->setLabel(t('File date'))
->setDescription(t('Unix timestamp with release file date. Used to identify file changes.'))
->setDefaultValue(0)
->setDisplayOptions('view', [
'label' => 'above',
'type' => 'timestamp',
'weight' => 0,
])
->setDisplayConfigurable('form', TRUE)
->setDisplayOptions('form', [
'type' => 'datetime_timestamp',
'weight' => 0,
])
->setDisplayConfigurable('view', TRUE);
$fields['last_parsed'] = BaseFieldDefinition::create('timestamp')
->setLabel(t('Last parsed'))
->setDescription(t('Release weight used for sorting. Lower weights float up to the top.'))
->setDefaultValue(0)
->setDisplayOptions('view', [
'label' => 'above',
'type' => 'timestamp',
'weight' => 0,
])
->setDisplayConfigurable('form', TRUE)
->setDisplayOptions('form', [
'type' => 'datetime_timestamp',
'weight' => 0,
])
->setDisplayConfigurable('view', TRUE);
$fields['queued'] = BaseFieldDefinition::create('timestamp')
->setLabel(t('Queued'))
->setDescription(t('Time when this release was queued for refresh, 0 if not queued.'))
->setDefaultValue(0)
->setDisplayOptions('view', [
'label' => 'above',
'type' => 'timestamp',
'weight' => 0,
])
->setDisplayConfigurable('form', TRUE)
->setDisplayOptions('form', [
'type' => 'datetime_timestamp',
'weight' => 0,
])
->setDisplayConfigurable('view', TRUE);
$fields['sid_count'] = BaseFieldDefinition::create('integer')
->setLabel(t('Strings'))
->setDescription(t('Count of source strings in this project release.'))
->setDefaultValue(0)
->setDisplayOptions('view', [
'label' => 'above',
'type' => 'number_integer',
'weight' => 0,
])
->setDisplayOptions('form', [
'type' => 'number',
'weight' => 10,
]);
$fields['lid_count'] = BaseFieldDefinition::create('integer')
->setLabel(t('Lines'))
->setDescription(t('Count of lines in this project release.'))
->setDefaultValue(0)
->setDisplayOptions('view', [
'label' => 'above',
'type' => 'number_integer',
'weight' => 0,
])
->setDisplayOptions('form', [
'type' => 'number',
'weight' => 10,
]);
$fields['fid_count'] = BaseFieldDefinition::create('integer')
->setLabel(t('Files'))
->setDescription(t('Count of files in this project release.'))
->setDefaultValue(0)
->setDisplayOptions('view', [
'label' => 'above',
'type' => 'number_integer',
'weight' => 0,
])
->setDisplayOptions('form', [
'type' => 'number',
'weight' => 10,
]);
$fields['eid_count'] = BaseFieldDefinition::create('integer')
->setLabel(t('Warnings'))
->setDescription(t('Count of warnings parsing this project release.'))
->setDefaultValue(0)
->setDisplayOptions('view', [
'label' => 'above',
'type' => 'number_integer',
'weight' => 0,
])
->setDisplayOptions('form', [
'type' => 'number',
'weight' => 10,
]);
$fields['weight'] = BaseFieldDefinition::create('integer')
->setLabel(t('Weight'))
->setDescription(t('Project weight used for sorting. Lower weights float up to the top.'))
->setDefaultValue(0);
return $fields;
}
/**
* {@inheritdoc}
*/
public function getTitle(): string {
return $this->get('title')->first()?->getValue()['value'] ?? '';
}
/**
* {@inheritdoc}
*/
public function setTitle(string $title): self {
$this->set('title', $title);
return $this;
}
/**
* {@inheritdoc}
*/
public function getProjectId(): ?int {
return (!$this->get('pid')->isEmpty())
? (int) $this->get('pid')->first()?->getValue()['target_id']
: NULL;
}
/**
* {@inheritdoc}
*/
public function setProjectId(int $pid): self {
$this->set('pid', $pid);
return $this;
}
/**
* {@inheritdoc}
*/
public function getProject(): L10nServerProjectInterface {
return $this->pid->entity;
}
/**
* {@inheritdoc}
*/
public function setProject(L10nServerProjectInterface $project): self {
$this->set('pid', $project->id());
return $this;
}
/**
* {@inheritdoc}
*/
public function getVersion(): ?string {
return $this->get('version')->first()?->getValue()['value'];
}
/**
* {@inheritdoc}
*/
public function setVersion(string $version): self {
$this->set('version', $version);
return $this;
}
/**
* {@inheritdoc}
*/
public function getDownloadLink(): ?string {
return $this->get('download_link')->first()?->getValue()['value'];
}
/**
* {@inheritdoc}
*/
public function setDownloadLink(string $link): self {
$this->set('download_link', $link);
return $this;
}
/**
* {@inheritdoc}
*/
public function getFileHash(): ?string {
return $this->get('file_hash')->first()?->getValue()['value'];
}
/**
* {@inheritdoc}
*/
public function setFileHash(string $hash): L10nServerReleaseInterface {
$this->set('file_hash', $hash);
return $this;
}
/**
* {@inheritdoc}
*/
public function getFileDate(): ?int {
if ($this->get('file_date')->isEmpty()) {
return NULL;
}
return (int) $this->get('file_date')->first()->getValue()['value'];
}
/**
* {@inheritdoc}
*/
public function setFileDate(int $timestamp): self {
$this->set('file_date', $timestamp);
return $this;
}
/**
* {@inheritdoc}
*/
public function getLastParsed(): int {
return (int) ($this->get('last_parsed')->first()?->getValue()['value'] ?? 0);
}
/**
* {@inheritdoc}
*/
public function setLastParsed(int $timestamp): self {
$this->set('last_parsed', $timestamp);
return $this;
}
/**
* {@inheritdoc}
*/
public function getQueuedTime(): int {
return (int) ($this->get('queued')->first()?->getValue()['value'] ?? 0);
}
/**
* {@inheritdoc}
*/
public function setQueuedTime(int $timestamp): self {
$this->set('queued', $timestamp);
return $this;
}
/**
* {@inheritdoc}
*/
public function getSourceStringCount(): int {
return (int) ($this->get('sid_count')->first()?->getValue()['value'] ?? 0);
}
/**
* {@inheritdoc}
*/
public function setSourceStringCount(int $count): self {
$this->set('sid_count', $count);
return $this;
}
/**
* {@inheritdoc}
*/
public function getLineCount(): int {
return (int) ($this->get('lid_count')->first()?->getValue()['value'] ?? 0);
}
/**
* {@inheritdoc}
*/
public function setLineCount(int $count): self {
$this->set('lid_count', $count);
return $this;
}
/**
* {@inheritdoc}
*/
public function getFileCount(): int {
return (int) ($this->get('fid_count')->first()?->getValue()['value'] ?? 0);
}
/**
* {@inheritdoc}
*/
public function setFileCount(int $count): self {
$this->set('fid_count', $count);
return $this;
}
/**
* {@inheritdoc}
*/
public function getErrorCount(): int {
return (int) ($this->get('eid_count')->first()?->getValue()['value'] ?? 0);
}
/**
* {@inheritdoc}
*/
public function setErrorCount(int $count): self {
$this->set('eid_count', $count);
return $this;
}
/**
* {@inheritdoc}
*/
public function getWeight(): int {
return (int) ($this->get('weight')->first()?->getValue()['value'] ?? 0);
}
/**
* {@inheritdoc}
*/
public function setWeight(int $weight): L10nServerReleaseInterface {
$this->set('weight', $weight);
return $this;
}
/**
* {@inheritdoc}
*/
public function getBranchFromVersion(): string {
// Set branch to everything before the last dot, and append an x. For
// example, 6.1, 6.2, 6.x-dev, 6.0-beta1 all become 6.x. 8.7.13 becomes
// 8.7.x. 6.x-1.0-beta1 becomes 6.x-1.x. 2.1.0-rc1 becomes 2.1.x.
return preg_replace('#\.[^.]*$#', '.x', $this->getVersion());
}
/**
* {@inheritdoc}
*/
public function getCoreFromVersion(): string {
// Stupid hack for drupal core.
if ($this->getProject()->getUri() === 'drupal') {
// Major version is the first component before the .
$major = explode('.', $this->getBranchFromVersion())[0];
if ($major >= 8) {
// In D8 & later, start removing “API compatibility” part of the
// path.
return 'all';
}
else {
return $major . '.x';
}
}
else {
// Modules are like: 6.x-1.0, 6.x-1.x-dev, 6.x-1.0-beta1, 2.0.0, 5.x-dev,
// 2.1.x-dev, 2.1.0-rc1. If there is a core API compatibility component,
// split it off. version here is the main version number, without the
// -{extra} component, like -beta1 or -rc1.
preg_match('#^(?:(?<core>(?:4\.0|4\.1|4\.2|4\.3|4\.4|4\.5|4\.6|4\.7|5|6|7|8|9)\.x)-)?(?<version>[0-9.x]*)(?:-.*)?$#', $this->label(), $match);
return $match['core'] ?: 'all';
}
}
}
