src/Entity/JournalVolume.php line 91

  1. <?php
  2. namespace App\Entity;
  4. use Doctrine\ORM\Mapping as ORM,
  5.     Doctrine\DBAL\Types\Types,
  6.     Doctrine\Common\Collections\Collection,
  7.     Doctrine\Common\Collections\ArrayCollection;
  9. use Symfony\Component\Serializer\Annotation\Groups,
  10.     Symfony\Component\Validator\Constraints as Assert;
  12. use ApiPlatform\Metadata\ApiResource,
  13.     ApiPlatform\Metadata\ApiProperty,
  14.     ApiPlatform\Metadata\Get,
  15.     ApiPlatform\Metadata\GetCollection,
  16.     ApiPlatform\Metadata\Post,
  17.     ApiPlatform\Metadata\Put,
  18.     ApiPlatform\Metadata\Delete,
  19.     ApiPlatform\Metadata\ApiFilter,
  20.     ApiPlatform\Doctrine\Orm\Filter\OrderFilter,
  21.     ApiPlatform\Doctrine\Orm\Filter\BooleanFilter;
  22. use ApiPlatform\Doctrine\Orm\Filter\SearchFilter;
  24. use App\Entity\Trait\IdTrait,
  25.     App\Entity\Trait\UuidTrait,
  26.     App\Entity\Trait\OrdStatTrait,
  27.     App\Entity\Trait\TimestampableTrait,
  28.     App\Entity\Trait\TranslatableTrait,
  29.     App\Entity\Trait\Languages\LanguageableChildTrait,
  30.     App\Entity\Trait\ArchivedTrait,
  31.     App\Entity\Trait\EditorialGroupableTrait,
  32.     App\Entity\Trait\ImportIdTrait,
  33.     App\Entity\Interface\TranslatableInterface,
  34.     App\Entity\Interface\OrdStatableInterface,
  35.     App\Entity\Interface\LanguageableChildInterface,
  36.     App\Entity\Interface\ArchivableInterface,
  37.     App\Entity\Interface\EditorialGroupableInterface,
  38.     App\Entity\Interface\CloneableInterface;
  40. use App\Attribute\Sanitizeable,
  41.     App\Enum\JournalDateFormat,
  42.     App\Enum\JournalLicence,
  43.     App\Enum\AuthorProperty,
  44.     App\Doctrine\DBAL\Types\AuthorPropertiesType,
  45.     App\Repository\JournalVolumeRepository,
  46.     App\Security\Voter\ArchivableVoter,
  47.     App\Lib\Actions,
  48.     App\DTO\CloneDTO,
  49.     App\StateProcessor\CloneProcessor,
  50.     App\Security\Voter\CloneVoter,
  51.     App\Filter\IriFilter;
  53. use App\Util\ClassUtils;
  55. #[ApiResource(
  56.     description: 'Journal volumes',
  57.     normalizationContext: ['groups' => [
  58.         'read',
  59.         'read:' . self::class,
  60.         'read:' . self::class . 'Translation'
  61.     ]],
  62.     denormalizationContext: ['groups' => ['write']],
  63.     security: 'is_granted("' . Journal::class . '")',
  64.     order: ['ord' => 'desc'],
  65.     operations: [
  66.         new GetCollection(),
  67.         new Post(
  68.             uriTemplate: '/journal_volumes/clone',
  69.             input: CloneDTO::class,
  70.             processor: CloneProcessor::class,
  71.             security: 'is_granted("' . Actions::CLONE .'")',
  72.             securityMessage: CloneVoter::MESSAGE
  73.         ),
  74.         new Post(denormalizationContext: ['groups' => ['write',  'post']]),
  75.         new Get(),
  76.         new Put(),
  77.         new Delete(
  78.             securityPostDenormalize: 'is_granted("' . Actions::DELETE . '", object)',
  79.             securityPostDenormalizeMessage: ArchivableVoter::MESSAGE
  80.         ),
  81.     ],
  82.     extraProperties: ['standard_put' => false],
  83. )]
  84. #[ApiFilter(IriFilter::class, properties: ['parent'])]
  85. #[ApiFilter(SearchFilter::class, properties: [
  86.     'translations.title' => 'partial',
  87. ])]
  88. #[ApiFilter(BooleanFilter::class, properties: ['isArchived', 'stat'])]
  89. #[ApiFilter(OrderFilter::class, properties: ['ord'])]
  90. #[ORM\Entity(repositoryClass: JournalVolumeRepository::class)]
  91. class JournalVolume implements
  92.     TranslatableInterface,
  93.     OrdStatableInterface,
  94.     LanguageableChildInterface,
  95.     EditorialGroupableInterface,
  96.     ArchivableInterface,
  97.     CloneableInterface
  98. {
  99.     use IdTrait,
  100.         UuidTrait,
  101.         OrdStatTrait,
  102.         TimestampableTrait,
  103.         TranslatableTrait,
  104.         LanguageableChildTrait,
  105.         ArchivedTrait,
  106.         EditorialGroupableTrait,
  107.         ImportIdTrait;
  109.     #[ApiProperty(description: 'Parent', readableLink: false, writableLink: false)]
  110.     #[Groups(['read', 'post'])]
  111.     #[ORM\ManyToOne(targetEntity: Journal::class, inversedBy: 'volumes')]
  112.     #[ORM\JoinColumn(onDelete: 'cascade', nullable: false)]
  113.     private Journal $parent;
  115.     #[ApiProperty(description: 'Planned numbers amount')]
  116.     #[Groups(['read:' . self::class, 'write'])]
  117.     #[Assert\Positive]
  118.     #[ORM\Column(type: Types::INTEGER, options: ['default' => 1])]
  119.     private int $plannedNumbersAmount = 1;
  121.     #[ApiProperty(description: 'Published at')]
  122.     #[Groups(['read:' . self::class, 'write'])]
  123.     #[ORM\Column(type: Types::DATE_IMMUTABLE, nullable: true)]
  124.     private ?\DateTimeImmutable $publishedAt = null;
  126.     #[ApiProperty(description: 'Is published at visible')]
  127.     #[Groups(['read:' . self::class, 'write'])]
  128.     #[ORM\Column(type: Types::BOOLEAN, options: ['default' => false])]
  129.     private bool $isPublishedAtVisible = false;
  131.     #[ApiProperty(description: 'Published at format', writableLink: false)]
  132.     #[Groups(['read:' . self::class, 'write'])]
  133.     #[ORM\Column(
  134.         type: Types::STRING,
  135.         enumType: JournalDateFormat::class,
  136.         length: 255,
  137.         options: ['default' => JournalDateFormat::COMPLETE]
  138.     )]
  139.     private JournalDateFormat $publishedAtFormat = JournalDateFormat::COMPLETE;
  141.     #[ApiProperty(description: 'DOI')]
  142.     #[Groups(['read:' . self::class, 'write'])]
  143.     #[ORM\Column(type: Types::STRING, length: 255, nullable: true)]
  144.     private ?string $doi = null;
  146.     #[ApiProperty(description: 'Is DOI visible')]
  147.     #[Groups(['read:' . self::class, 'write'])]
  148.     #[ORM\Column(type: Types::BOOLEAN, options: ['default' => false])]
  149.     private bool $isDoiVisible = false;
  151.     #[ApiProperty(description: 'Licence', writableLink: false)]
  152.     #[Groups(['read:' . self::class, 'write'])]
  153.     #[ORM\Column(
  154.         type: Types::STRING,
  155.         enumType: JournalLicence::class,
  156.         length: 255,
  157.         options: ['default' => JournalLicence::CC_BY]
  158.     )]
  159.     private JournalLicence $licence = JournalLicence::CC_BY;
  161.     #[ApiProperty(description: 'Is licence visible')]
  162.     #[Groups(['read:' . self::class, 'write'])]
  163.     #[ORM\Column(type: Types::BOOLEAN, options: ['default' => false])]
  164.     private bool $isLicenceVisible = false;
  166.     #[ApiProperty(description: 'Funding number')]
  167.     #[Groups(['read:' . self::class, 'write'])]
  168.     #[ORM\Column(type: Types::STRING, length: 255, nullable: true)]
  169.     private ?string $fundingNumber = null;
  171.     #[ApiProperty(description: 'Additional info')]
  172.     #[Groups(['read:' . self::class, 'write'])]
  173.     #[Sanitizeable]
  174.     #[ORM\Column(type: Types::TEXT, nullable: true)]
  175.     private ?string $additionalInfo = null;
  177.     #[ApiProperty(description: 'Meta link')]
  178.     #[Groups(['read:' . self::class, 'write'])]
  179.     #[ORM\Column(type: Types::STRING, length: 255, nullable: true)]
  180.     private ?string $metaLink = null;
  182.     #[ApiProperty(description: 'Visible editorial group member properties', writableLink: false)]
  183.     #[Groups(['read:' . self::class, 'write'])]
  184.     #[Assert\Choice(callback: [AuthorProperty::class, 'cases'], multiple: true)]
  185.     #[Assert\Unique]
  186.     #[Assert\Count(min: 1)]
  187.     #[ORM\Column(type: AuthorPropertiesType::NAME)]
  188.     private array $visibleEditorialGroupMemberProperties = [
  189.         AuthorProperty::PREFIX,
  190.         AuthorProperty::NAME,
  191.         AuthorProperty::SURNAME,
  192.         AuthorProperty::AFFILIATION
  193.     ];
  195.     #[ApiProperty(description: 'Issues', writableLink: false, fetchEager: false)]
  196.     #[Groups(['read:' . self::class])]
  197.     #[ORM\OneToMany(targetEntity: JournalIssue::class, mappedBy: 'volume', cascade: ['persist'])]
  198.     #[ORM\OrderBy(['ord' => 'desc'])]
  199.     private Collection $issues;
  201.     #[ApiProperty(description: 'Import link')]
  202.     #[Groups(['read:' . self::class, 'write'])]
  203.     #[ORM\Column(type: Types::STRING, length: 255, nullable: true)]
  204.     private ?string $importLink = null;
  206.     #[ApiProperty(description: 'Import link en')]
  207.     #[Groups(['read:' . self::class, 'write'])]
  208.     #[ORM\Column(type: Types::STRING, length: 255, nullable: true)]
  209.     private ?string $importLinkEn = null;
  211.     public function __construct(Journal $parent)
  212.     {
  213.         $this->setUuid();
  215.         $this->parent = $parent;
  217.         $this->translations = new ArrayCollection();
  218.         $this->issues = new ArrayCollection();
  219.         $this->editorialGroups = new ArrayCollection();
  221.         foreach ($this->parent->getLanguages() as $lang) {
  222.             new JournalVolumeTranslation($this, $lang);
  223.         }
  225.         foreach($this->parent->getEditorialGroups() as $editorialGroup) {
  226.             $copied = JournalVolumeEditorialGroup::constructFrom(parent: $this, template: $editorialGroup);
  227.             $this->addEditorialGroup($copied);
  228.         }
  230.         $this->visibleEditorialGroupMemberProperties = $parent->getView()->getVisibleEditorialGroupMemberProperties();
  232.         $this->licence = $parent->getData()->getLicence();
  234.         $this->createdAt = new \DateTimeImmutable();
  235.         $this->updatedAt = new \DateTimeImmutable();
  237.         $this->stat = false;
  239.         $parent->addVolume($this);
  240.     }
  242.     public function getParent(): Journal
  243.     {
  244.         return $this->parent;
  245.     }
  247.     #[Groups(['read:' . self::class])]
  248.     public function getNativeTitle(): ?string
  249.     {
  250.         $nativeLang = $this->getParentNativeLanguage();
  252.         return $this->readTranslation($nativeLang, 'title');
  253.     }
  255.     public function getPlannedNumbersAmount(): int
  256.     {
  257.         return $this->plannedNumbersAmount;
  258.     }
  260.     public function setPlannedNumbersAmount(int $plannedNumbersAmount): self
  261.     {
  262.         $this->plannedNumbersAmount = $plannedNumbersAmount;
  264.         return $this;
  265.     }
  267.     #[Groups(['read:' . self::class])]
  268.     public function getNumbersRatio(): string
  269.     {
  270.         $issues = count($this->issues);
  272.         return "{$issues}/{$this->plannedNumbersAmount}";
  273.     }
  275.     public function getPublishedAt(): ?\DateTimeImmutable
  276.     {
  277.         return $this->publishedAt;
  278.     }
  280.     public function setPublishedAt(?\DateTimeImmutable $publishedAt): self
  281.     {
  282.         $this->publishedAt = $publishedAt;
  284.         return $this;
  285.     }
  287.     public function getIsPublishedAtVisible(): bool
  288.     {
  289.         return $this->isPublishedAtVisible;
  290.     }
  292.     public function setIsPublishedAtVisible(bool $isPublishedAtVisible): self
  293.     {
  294.         $this->isPublishedAtVisible = $isPublishedAtVisible;
  296.         return $this;
  297.     }
  299.     public function getPublishedAtFormat(): JournalDateFormat
  300.     {
  301.         return $this->publishedAtFormat;
  302.     }
  304.     public function setPublishedAtFormat(JournalDateFormat $publishedAtFormat): self
  305.     {
  306.         $this->publishedAtFormat = $publishedAtFormat;
  308.         return $this;
  309.     }
  311.     public function getDoi(): ?string
  312.     {
  313.         return $this->doi;
  314.     }
  316.     public function setDoi(?string $doi): self
  317.     {
  318.         $this->doi = $doi;
  320.         return $this;
  321.     }
  323.     public function getIsDoiVisible(): bool
  324.     {
  325.         return $this->isDoiVisible;
  326.     }
  328.     public function setIsDoiVisible(bool $isDoiVisible): self
  329.     {
  330.         $this->isDoiVisible = $isDoiVisible;
  332.         return $this;
  333.     }
  335.     public function getLicence(): JournalLicence
  336.     {
  337.         return $this->licence;
  338.     }
  340.     public function setLicence(JournalLicence $licence): self
  341.     {
  342.         $this->licence = $licence;
  344.         return $this;
  345.     }
  347.     public function getIsLicenceVisible(): bool
  348.     {
  349.         return $this->isLicenceVisible;
  350.     }
  352.     public function setIsLicenceVisible(bool $isLicenceVisible): self
  353.     {
  354.         $this->isLicenceVisible = $isLicenceVisible;
  356.         return $this;
  357.     }
  359.     public function getFundingNumber(): ?string
  360.     {
  361.         return $this->fundingNumber;
  362.     }
  364.     public function setFundingNumber(?string $fundingNumber): self
  365.     {
  366.         $this->fundingNumber = $fundingNumber;
  368.         return $this;
  369.     }
  371.     public function getAdditionalInfo(): ?string
  372.     {
  373.         return $this->additionalInfo;
  374.     }
  376.     public function setAdditionalInfo(?string $additionalInfo): self
  377.     {
  378.         $this->additionalInfo = $additionalInfo;
  380.         return $this;
  381.     }
  383.     public function getMetaLink(): ?string
  384.     {
  385.         return $this->metaLink;
  386.     }
  388.     public function setMetaLink(?string $metaLink): self
  389.     {
  390.         $this->metaLink = $metaLink;
  392.         return $this;
  393.     }
  395.     public function getVisibleEditorialGroupMemberProperties(): array
  396.     {
  397.         return $this->visibleEditorialGroupMemberProperties;
  398.     }
  400.     public function setVisibleEditorialGroupMemberProperties(array $visibleEditorialGroupMemberProperties): self
  401.     {
  402.         $this->visibleEditorialGroupMemberProperties = $visibleEditorialGroupMemberProperties;
  404.         return $this;
  405.     }
  407.     /**
  408.      * @return Collection|JournalIssue[]
  409.      */
  410.     public function getIssues(): Collection
  411.     {
  412.         return $this->issues;
  413.     }
  415.     public function addIssue(JournalIssue $issue): self
  416.     {
  417.         if ($this->issues->contains($issue)) {
  418.             return $this;
  419.         }
  421.         $this->issues[] = $issue;
  423.         return $this;
  424.     }
  426.     public function removeIssue(JournalIssue $issue): self
  427.     {
  428.         $this->issues->removeElement($issue);
  430.         return $this;
  431.     }
  433.     public function resetIssues(): self
  434.     {
  435.         $this->issues = new ArrayCollection();
  437.         return $this;
  438.     }
  440.     #[Groups(['read:' . self::class])]
  441.     public function getJournalSlug(): ?string
  442.     {
  443.         return $this->parent->getSlug();
  444.     }
  446.     public function clone(): self
  447.     {
  448.         $clone = clone $this;
  450.         $clone->id = null;
  451.         $clone->setUuid();
  453.         $clone->ord = 0;
  454.         $clone->stat = false;
  455.         $clone->importId = null;
  457.         ClassUtils::cloneCollection($this, $clone, 'translations');
  458.         $clone->synchronizeTranslations();
  460.         $nativeLanguage = $clone->parent->getNativeLanguage();
  461.         $nativeTranslation = $clone->getTranslation($nativeLanguage);
  462.         $nativeTranslation->setTitle($nativeTranslation->getTitle() . ' [KOPIA]');
  464.         ClassUtils::cloneCollection($this, $clone, 'editorialGroups');
  466.         $clone->resetIssues();
  468.         foreach ($this->getIssues() as $issue) {
  469.             $clone->addIssue(
  470.                 $issue->clone(
  471.                     $clone->parent
  472.                 )
  473.             );
  474.         }
  476.         $clone->createdAt = new \DateTimeImmutable();
  477.         $clone->updatedAt = new \DateTimeImmutable();
  479.         return $clone;
  480.     }
  482.     public function getImportLink(): ?string
  483.     {
  484.         return $this->importLink;
  485.     }
  487.     public function setImportLink(?string $importLink): self
  488.     {
  489.         $this->importLink = $importLink;
  491.         return $this;
  492.     }
  494.     public function getImportLinkEn(): ?string
  495.     {
  496.         return $this->importLinkEn;
  497.     }
  499.     public function setImportLinkEn(?string $importLinkEn): self
  500.     {
  501.         $this->importLinkEn = $importLinkEn;
  503.         return $this;
  504.     }
  505. }