src/Entity/JournalVolume.php line 87

  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;
  23. use App\Entity\Trait\IdTrait,
  24.     App\Entity\Trait\UuidTrait,
  25.     App\Entity\Trait\OrdStatTrait,
  26.     App\Entity\Trait\TimestampableTrait,
  27.     App\Entity\Trait\TranslatableTrait,
  28.     App\Entity\Trait\Languages\LanguageableChildTrait,
  29.     App\Entity\Trait\ArchivedTrait,
  30.     App\Entity\Trait\EditorialGroupableTrait,
  31.     App\Entity\Trait\ImportIdTrait,
  32.     App\Entity\Interface\TranslatableInterface,
  33.     App\Entity\Interface\OrdStatableInterface,
  34.     App\Entity\Interface\LanguageableChildInterface,
  35.     App\Entity\Interface\ArchivableInterface,
  36.     App\Entity\Interface\EditorialGroupableInterface,
  37.     App\Entity\Interface\CloneableInterface;
  39. use App\Attribute\Sanitizeable,
  40.     App\Enum\JournalDateFormat,
  41.     App\Enum\JournalLicence,
  42.     App\Enum\AuthorProperty,
  43.     App\Doctrine\DBAL\Types\AuthorPropertiesType,
  44.     App\Repository\JournalVolumeRepository,
  45.     App\Security\Voter\ArchivableVoter,
  46.     App\Lib\Actions,
  47.     App\DTO\CloneDTO,
  48.     App\StateProcessor\CloneProcessor,
  49.     App\Security\Voter\CloneVoter,
  50.     App\Filter\IriFilter;
  52. use App\Util\ClassUtils;
  54. #[ApiResource(
  55.     description: 'Journal volumes',
  56.     normalizationContext: ['groups' => [
  57.         'read',
  58.         'read:' . self::class,
  59.         'read:' . self::class . 'Translation'
  60.     ]],
  61.     denormalizationContext: ['groups' => ['write']],
  62.     security: 'is_granted("' . Journal::class . '")',
  63.     order: ['ord' => 'desc'],
  64.     operations: [
  65.         new GetCollection(),
  66.         new Post(
  67.             uriTemplate: '/journal_volumes/clone',
  68.             input: CloneDTO::class,
  69.             processor: CloneProcessor::class,
  70.             security: 'is_granted("' . Actions::CLONE .'")',
  71.             securityMessage: CloneVoter::MESSAGE
  72.         ),
  73.         new Post(denormalizationContext: ['groups' => ['write',  'post']]),
  74.         new Get(),
  75.         new Put(),
  76.         new Delete(
  77.             securityPostDenormalize: 'is_granted("' . Actions::DELETE . '", object)',
  78.             securityPostDenormalizeMessage: ArchivableVoter::MESSAGE
  79.         ),
  80.     ],
  81.     extraProperties: ['standard_put' => false],
  82. )]
  83. #[ApiFilter(IriFilter::class, properties: ['parent'])]
  84. #[ApiFilter(BooleanFilter::class, properties: ['isArchived', 'stat'])]
  85. #[ApiFilter(OrderFilter::class, properties: ['ord'])]
  86. #[ORM\Entity(repositoryClass: JournalVolumeRepository::class)]
  87. class JournalVolume implements
  88.     TranslatableInterface,
  89.     OrdStatableInterface,
  90.     LanguageableChildInterface,
  91.     EditorialGroupableInterface,
  92.     ArchivableInterface,
  93.     CloneableInterface
  94. {
  95.     use IdTrait,
  96.         UuidTrait,
  97.         OrdStatTrait,
  98.         TimestampableTrait,
  99.         TranslatableTrait,
  100.         LanguageableChildTrait,
  101.         ArchivedTrait,
  102.         EditorialGroupableTrait,
  103.         ImportIdTrait;
  105.     #[ApiProperty(description: 'Parent', readableLink: false, writableLink: false)]
  106.     #[Groups(['read', 'post'])]
  107.     #[ORM\ManyToOne(targetEntity: Journal::class, inversedBy: 'volumes')]
  108.     #[ORM\JoinColumn(onDelete: 'cascade', nullable: false)]
  109.     private Journal $parent;
  111.     #[ApiProperty(description: 'Planned numbers amount')]
  112.     #[Groups(['read:' . self::class, 'write'])]
  113.     #[Assert\Positive]
  114.     #[ORM\Column(type: Types::INTEGER, options: ['default' => 1])]
  115.     private int $plannedNumbersAmount = 1;
  117.     #[ApiProperty(description: 'Published at')]
  118.     #[Groups(['read:' . self::class, 'write'])]
  119.     #[ORM\Column(type: Types::DATE_IMMUTABLE, nullable: true)]
  120.     private ?\DateTimeImmutable $publishedAt = null;
  122.     #[ApiProperty(description: 'Is published at visible')]
  123.     #[Groups(['read:' . self::class, 'write'])]
  124.     #[ORM\Column(type: Types::BOOLEAN, options: ['default' => false])]
  125.     private bool $isPublishedAtVisible = false;
  127.     #[ApiProperty(description: 'Published at format', writableLink: false)]
  128.     #[Groups(['read:' . self::class, 'write'])]
  129.     #[ORM\Column(
  130.         type: Types::STRING,
  131.         enumType: JournalDateFormat::class,
  132.         length: 255,
  133.         options: ['default' => JournalDateFormat::COMPLETE]
  134.     )]
  135.     private JournalDateFormat $publishedAtFormat = JournalDateFormat::COMPLETE;
  137.     #[ApiProperty(description: 'DOI')]
  138.     #[Groups(['read:' . self::class, 'write'])]
  139.     #[ORM\Column(type: Types::STRING, length: 255, nullable: true)]
  140.     private ?string $doi = null;
  142.     #[ApiProperty(description: 'Is DOI visible')]
  143.     #[Groups(['read:' . self::class, 'write'])]
  144.     #[ORM\Column(type: Types::BOOLEAN, options: ['default' => false])]
  145.     private bool $isDoiVisible = false;
  147.     #[ApiProperty(description: 'Licence', writableLink: false)]
  148.     #[Groups(['read:' . self::class, 'write'])]
  149.     #[ORM\Column(
  150.         type: Types::STRING,
  151.         enumType: JournalLicence::class,
  152.         length: 255,
  153.         options: ['default' => JournalLicence::CC_BY]
  154.     )]
  155.     private JournalLicence $licence = JournalLicence::CC_BY;
  157.     #[ApiProperty(description: 'Is licence visible')]
  158.     #[Groups(['read:' . self::class, 'write'])]
  159.     #[ORM\Column(type: Types::BOOLEAN, options: ['default' => false])]
  160.     private bool $isLicenceVisible = false;
  162.     #[ApiProperty(description: 'Funding number')]
  163.     #[Groups(['read:' . self::class, 'write'])]
  164.     #[ORM\Column(type: Types::STRING, length: 255, nullable: true)]
  165.     private ?string $fundingNumber = null;
  167.     #[ApiProperty(description: 'Additional info')]
  168.     #[Groups(['read:' . self::class, 'write'])]
  169.     #[Sanitizeable]
  170.     #[ORM\Column(type: Types::TEXT, nullable: true)]
  171.     private ?string $additionalInfo = null;
  173.     #[ApiProperty(description: 'Meta link')]
  174.     #[Groups(['read:' . self::class, 'write'])]
  175.     #[ORM\Column(type: Types::STRING, length: 255, nullable: true)]
  176.     private ?string $metaLink = null;
  178.     #[ApiProperty(description: 'Visible editorial group member properties', writableLink: false)]
  179.     #[Groups(['read:' . self::class, 'write'])]
  180.     #[Assert\Choice(callback: [AuthorProperty::class, 'cases'], multiple: true)]
  181.     #[Assert\Unique]
  182.     #[Assert\Count(min: 1)]
  183.     #[ORM\Column(type: AuthorPropertiesType::NAME)]
  184.     private array $visibleEditorialGroupMemberProperties = [
  185.         AuthorProperty::PREFIX,
  186.         AuthorProperty::NAME,
  187.         AuthorProperty::SURNAME,
  188.         AuthorProperty::AFFILIATION
  189.     ];
  191.     #[ApiProperty(description: 'Issues', writableLink: false)]
  192.     #[Groups(['read:' . self::class])]
  193.     #[ORM\OneToMany(targetEntity: JournalIssue::class, mappedBy: 'volume', cascade: ['persist'])]
  194.     #[ORM\OrderBy(['ord' => 'desc'])]
  195.     private Collection $issues;
  197.     #[ApiProperty(description: 'Import link')]
  198.     #[Groups(['read:' . self::class, 'write'])]
  199.     #[ORM\Column(type: Types::STRING, length: 255, nullable: true)]
  200.     private ?string $importLink = null;
  202.     #[ApiProperty(description: 'Import link en')]
  203.     #[Groups(['read:' . self::class, 'write'])]
  204.     #[ORM\Column(type: Types::STRING, length: 255, nullable: true)]
  205.     private ?string $importLinkEn = null;
  207.     public function __construct(Journal $parent)
  208.     {
  209.         $this->setUuid();
  211.         $this->parent = $parent;
  213.         $this->translations = new ArrayCollection();
  214.         $this->issues = new ArrayCollection();
  215.         $this->editorialGroups = new ArrayCollection();
  217.         foreach ($this->parent->getLanguages() as $lang) {
  218.             new JournalVolumeTranslation($this, $lang);
  219.         }
  221.         foreach($this->parent->getEditorialGroups() as $editorialGroup) {
  222.             $copied = JournalVolumeEditorialGroup::constructFrom(parent: $this, template: $editorialGroup);
  223.             $this->addEditorialGroup($copied);
  224.         }
  226.         $this->visibleEditorialGroupMemberProperties = $parent->getView()->getVisibleEditorialGroupMemberProperties();
  228.         $this->licence = $parent->getData()->getLicence();
  230.         $this->createdAt = new \DateTimeImmutable();
  231.         $this->updatedAt = new \DateTimeImmutable();
  233.         $parent->addVolume($this);
  234.     }
  236.     public function getParent(): Journal
  237.     {
  238.         return $this->parent;
  239.     }
  241.     public function getPlannedNumbersAmount(): int
  242.     {
  243.         return $this->plannedNumbersAmount;
  244.     }
  246.     public function setPlannedNumbersAmount(int $plannedNumbersAmount): self
  247.     {
  248.         $this->plannedNumbersAmount = $plannedNumbersAmount;
  250.         return $this;
  251.     }
  253.     #[Groups(['read:' . self::class])]
  254.     public function getNumbersRatio(): string
  255.     {
  256.         $issues = count($this->issues);
  258.         return "{$issues}/{$this->plannedNumbersAmount}";
  259.     }
  261.     public function getPublishedAt(): ?\DateTimeImmutable
  262.     {
  263.         return $this->publishedAt;
  264.     }
  266.     public function setPublishedAt(?\DateTimeImmutable $publishedAt): self
  267.     {
  268.         $this->publishedAt = $publishedAt;
  270.         return $this;
  271.     }
  273.     public function getIsPublishedAtVisible(): bool
  274.     {
  275.         return $this->isPublishedAtVisible;
  276.     }
  278.     public function setIsPublishedAtVisible(bool $isPublishedAtVisible): self
  279.     {
  280.         $this->isPublishedAtVisible = $isPublishedAtVisible;
  282.         return $this;
  283.     }
  285.     public function getPublishedAtFormat(): JournalDateFormat
  286.     {
  287.         return $this->publishedAtFormat;
  288.     }
  290.     public function setPublishedAtFormat(JournalDateFormat $publishedAtFormat): self
  291.     {
  292.         $this->publishedAtFormat = $publishedAtFormat;
  294.         return $this;
  295.     }
  297.     public function getDoi(): ?string
  298.     {
  299.         return $this->doi;
  300.     }
  302.     public function setDoi(?string $doi): self
  303.     {
  304.         $this->doi = $doi;
  306.         return $this;
  307.     }
  309.     public function getIsDoiVisible(): bool
  310.     {
  311.         return $this->isDoiVisible;
  312.     }
  314.     public function setIsDoiVisible(bool $isDoiVisible): self
  315.     {
  316.         $this->isDoiVisible = $isDoiVisible;
  318.         return $this;
  319.     }
  321.     public function getLicence(): JournalLicence
  322.     {
  323.         return $this->licence;
  324.     }
  326.     public function setLicence(JournalLicence $licence): self
  327.     {
  328.         $this->licence = $licence;
  330.         return $this;
  331.     }
  333.     public function getIsLicenceVisible(): bool
  334.     {
  335.         return $this->isLicenceVisible;
  336.     }
  338.     public function setIsLicenceVisible(bool $isLicenceVisible): self
  339.     {
  340.         $this->isLicenceVisible = $isLicenceVisible;
  342.         return $this;
  343.     }
  345.     public function getFundingNumber(): ?string
  346.     {
  347.         return $this->fundingNumber;
  348.     }
  350.     public function setFundingNumber(?string $fundingNumber): self
  351.     {
  352.         $this->fundingNumber = $fundingNumber;
  354.         return $this;
  355.     }
  357.     public function getAdditionalInfo(): ?string
  358.     {
  359.         return $this->additionalInfo;
  360.     }
  362.     public function setAdditionalInfo(?string $additionalInfo): self
  363.     {
  364.         $this->additionalInfo = $additionalInfo;
  366.         return $this;
  367.     }
  369.     public function getMetaLink(): ?string
  370.     {
  371.         return $this->metaLink;
  372.     }
  374.     public function setMetaLink(?string $metaLink): self
  375.     {
  376.         $this->metaLink = $metaLink;
  378.         return $this;
  379.     }
  381.     public function getVisibleEditorialGroupMemberProperties(): array
  382.     {
  383.         return $this->visibleEditorialGroupMemberProperties;
  384.     }
  386.     public function setVisibleEditorialGroupMemberProperties(array $visibleEditorialGroupMemberProperties): self
  387.     {
  388.         $this->visibleEditorialGroupMemberProperties = $visibleEditorialGroupMemberProperties;
  390.         return $this;
  391.     }
  393.     /**
  394.      * @return Collection|JournalIssue[]
  395.      */
  396.     public function getIssues(): Collection
  397.     {
  398.         return $this->issues;
  399.     }
  401.     public function addIssue(JournalIssue $issue): self
  402.     {
  403.         if ($this->issues->contains($issue)) {
  404.             return $this;
  405.         }
  407.         $this->issues[] = $issue;
  409.         return $this;
  410.     }
  412.     public function removeIssue(JournalIssue $issue): self
  413.     {
  414.         $this->issues->removeElement($issue);
  416.         return $this;
  417.     }
  419.     public function resetIssues(): self
  420.     {
  421.         $this->issues = new ArrayCollection();
  423.         return $this;
  424.     }
  426.     public function clone(): self
  427.     {
  428.         $clone = clone $this;
  430.         $clone->id = null;
  431.         $clone->setUuid();
  433.         $clone->ord = 0;
  434.         $clone->stat = false;
  435.         $clone->importId = null;
  437.         ClassUtils::cloneCollection($this, $clone, 'translations');
  438.         $clone->synchronizeTranslations();
  440.         $nativeLanguage = $clone->parent->getNativeLanguage();
  441.         $nativeTranslation = $clone->getTranslation($nativeLanguage);
  442.         $nativeTranslation->setTitle($nativeTranslation->getTitle() . ' [KOPIA]');
  444.         ClassUtils::cloneCollection($this, $clone, 'editorialGroups');
  446.         $clone->resetIssues();
  448.         foreach ($this->getIssues() as $issue) {
  449.             $clone->addIssue(
  450.                 $issue->clone(
  451.                     $clone->parent
  452.                 )
  453.             );
  454.         }
  456.         $clone->createdAt = new \DateTimeImmutable();
  457.         $clone->updatedAt = new \DateTimeImmutable();
  459.         return $clone;
  460.     }
  462.     public function getImportLink(): ?string
  463.     {
  464.         return $this->importLink;
  465.     }
  467.     public function setImportLink(?string $importLink): self
  468.     {
  469.         $this->importLink = $importLink;
  471.         return $this;
  472.     }
  474.     public function getImportLinkEn(): ?string
  475.     {
  476.         return $this->importLinkEn;
  477.     }
  479.     public function setImportLinkEn(?string $importLinkEn): self
  480.     {
  481.         $this->importLinkEn = $importLinkEn;
  483.         return $this;
  484.     }
  485. }