vendor/sulu/sulu/src/Sulu/Bundle/MediaBundle/Entity/FileVersion.php line 27

Open in your IDE?
  1. <?php
  3. /*
  4. * This file is part of Sulu.
  5. *
  6. * (c) Sulu GmbH
  7. *
  8. * This source file is subject to the MIT license that is bundled
  9. * with this source code in the file LICENSE.
  10. */
  12. namespace Sulu\Bundle\MediaBundle\Entity;
  14. use Doctrine\Common\Collections\ArrayCollection;
  15. use Doctrine\Common\Collections\Collection as DoctrineCollection;
  16. use JMS\Serializer\Annotation\Exclude;
  17. use Sulu\Bundle\AudienceTargetingBundle\Entity\TargetGroupInterface;
  18. use Sulu\Bundle\CategoryBundle\Entity\CategoryInterface;
  19. use Sulu\Bundle\TagBundle\Tag\TagInterface;
  20. use Sulu\Component\Persistence\Model\AuditableInterface;
  21. use Sulu\Component\Persistence\Model\AuditableTrait;
  22. use Symfony\Component\Mime\MimeTypes;
  24. /**
  25. * FileVersion.
  26. */
  27. class FileVersion implements AuditableInterface
  28. {
  29. use AuditableTrait;
  31. /**
  32. * @var string
  33. */
  34. private $name;
  36. /**
  37. * @var int
  38. */
  39. private $version;
  41. /**
  42. * @var int
  43. */
  44. private $subVersion = 0;
  46. /**
  47. * @var int
  48. */
  49. private $size;
  51. /**
  52. * @var string|null
  53. */
  54. private $mimeType;
  56. /**
  57. * @var string|null
  58. */
  59. private $storageOptions;
  61. /**
  62. * @var int
  63. */
  64. private $downloadCounter = 0;
  66. /**
  67. * @var int
  68. */
  69. private $id;
  71. /**
  72. * @var DoctrineCollection<int, FileVersionContentLanguage>
  73. */
  74. private $contentLanguages;
  76. /**
  77. * @var DoctrineCollection<int, FileVersionPublishLanguage>
  78. */
  79. private $publishLanguages;
  81. /**
  82. * @var DoctrineCollection<int, FileVersionMeta>
  83. */
  84. private $meta;
  86. /**
  87. * @var DoctrineCollection<string, FormatOptions>
  88. */
  89. private $formatOptions;
  91. /**
  92. * @var File
  93. */
  94. #[Exclude]
  95. private $file;
  97. /**
  98. * @var DoctrineCollection<int, TagInterface>
  99. */
  100. private $tags;
  102. /**
  103. * @var FileVersionMeta
  104. */
  105. private $defaultMeta;
  107. /**
  108. * @var string|null
  109. */
  110. private $properties = '{}';
  112. /**
  113. * @var DoctrineCollection<int, CategoryInterface>
  114. */
  115. private $categories;
  117. /**
  118. * @var DoctrineCollection<int, TargetGroupInterface>
  119. */
  120. private $targetGroups;
  122. /**
  123. * @var int|null
  124. */
  125. private $focusPointX;
  127. /**
  128. * @var int|null
  129. */
  130. private $focusPointY;
  132. private string $origin = 'unknown';
  134. private bool $aiDisclosureDisabled = false;
  136. private string $aiDisclosureIconVariant = 'auto';
  138. /**
  139. * Constructor.
  140. */
  141. public function __construct()
  142. {
  143. $this->contentLanguages = new ArrayCollection();
  144. $this->publishLanguages = new ArrayCollection();
  145. $this->meta = new ArrayCollection();
  146. $this->formatOptions = new ArrayCollection();
  147. $this->tags = new ArrayCollection();
  148. $this->categories = new ArrayCollection();
  149. $this->targetGroups = new ArrayCollection();
  150. }
  152. /**
  153. * Set name.
  154. *
  155. * @param string $name
  156. *
  157. * @return FileVersion
  158. */
  159. public function setName($name)
  160. {
  161. $this->name = $name;
  163. return $this;
  164. }
  166. /**
  167. * Get name.
  168. *
  169. * @return string
  170. */
  171. public function getName()
  172. {
  173. return $this->name;
  174. }
  176. /**
  177. * Set version.
  178. *
  179. * @param int $version
  180. *
  181. * @return FileVersion
  182. */
  183. public function setVersion($version)
  184. {
  185. $this->version = $version;
  187. return $this;
  188. }
  190. /**
  191. * Get version.
  192. *
  193. * @return int
  194. */
  195. public function getVersion()
  196. {
  197. return $this->version;
  198. }
  200. /**
  201. * Increases the subversion. Required for cache busting on certain operations which change the image without
  202. * creating a new file version.
  203. *
  204. * @return FileVersion
  205. */
  206. public function increaseSubVersion()
  207. {
  208. ++$this->subVersion;
  210. return $this;
  211. }
  213. /**
  214. * Get subVersion.
  215. *
  216. * @return int
  217. */
  218. public function getSubVersion()
  219. {
  220. return $this->subVersion;
  221. }
  223. /**
  224. * Set size.
  225. *
  226. * @param int $size
  227. *
  228. * @return FileVersion
  229. */
  230. public function setSize($size)
  231. {
  232. $this->size = $size;
  234. return $this;
  235. }
  237. /**
  238. * Get size.
  239. *
  240. * @return int
  241. */
  242. public function getSize()
  243. {
  244. return $this->size;
  245. }
  247. /**
  248. * Set mimeType.
  249. *
  250. * @param string $mimeType
  251. *
  252. * @return FileVersion
  253. */
  254. public function setMimeType($mimeType)
  255. {
  256. $this->mimeType = $mimeType;
  258. return $this;
  259. }
  261. /**
  262. * Get mimeType.
  263. *
  264. * @return string|null
  265. */
  266. public function getMimeType()
  267. {
  268. return $this->mimeType;
  269. }
  271. /**
  272. * Get extension.
  273. *
  274. * @return null|string
  275. */
  276. public function getExtension()
  277. {
  278. $pathInfo = \pathinfo($this->getName());
  279. $extension = MimeTypes::getDefault()->getExtensions($this->getMimeType() ?? '')[0] ?? null;
  280. if ($extension) {
  281. return $extension;
  282. } elseif (isset($pathInfo['extension'])) {
  283. return $pathInfo['extension'];
  284. }
  286. return null;
  287. }
  289. /**
  290. * @param array<string, string|null> $storageOptions
  291. *
  292. * @return FileVersion
  293. */
  294. public function setStorageOptions(array $storageOptions)
  295. {
  296. $serializedText = \json_encode($storageOptions);
  297. if (false === $serializedText) {
  298. return $this;
  299. }
  301. $this->storageOptions = $serializedText;
  303. return $this;
  304. }
  306. /**
  307. * @return array<string, string|null>
  308. */
  309. public function getStorageOptions(): array
  310. {
  311. /** @var array<string, string|null>|false $storageOptions */
  312. $storageOptions = \json_decode($this->storageOptions ?? '', true);
  313. if (!$storageOptions) {
  314. return [];
  315. }
  317. return $storageOptions;
  318. }
  320. /**
  321. * Set downloadCounter.
  322. *
  323. * @param int $downloadCounter
  324. *
  325. * @return FileVersion
  326. */
  327. public function setDownloadCounter($downloadCounter)
  328. {
  329. $this->downloadCounter = $downloadCounter;
  331. return $this;
  332. }
  334. /**
  335. * Get downloadCounter.
  336. *
  337. * @return int
  338. */
  339. public function getDownloadCounter()
  340. {
  341. return $this->downloadCounter;
  342. }
  344. /**
  345. * Get id.
  346. *
  347. * @return int
  348. */
  349. public function getId()
  350. {
  351. return $this->id;
  352. }
  354. /**
  355. * Add contentLanguages.
  356. *
  357. * @return FileVersion
  358. */
  359. public function addContentLanguage(FileVersionContentLanguage $contentLanguages)
  360. {
  361. $this->contentLanguages[] = $contentLanguages;
  363. return $this;
  364. }
  366. /**
  367. * Remove contentLanguages.
  368. */
  369. public function removeContentLanguage(FileVersionContentLanguage $contentLanguages)
  370. {
  371. $this->contentLanguages->removeElement($contentLanguages);
  372. }
  374. /**
  375. * Get contentLanguages.
  376. *
  377. * @return DoctrineCollection<int, FileVersionContentLanguage>
  378. */
  379. public function getContentLanguages()
  380. {
  381. return $this->contentLanguages;
  382. }
  384. /**
  385. * Add publishLanguages.
  386. *
  387. * @return FileVersion
  388. */
  389. public function addPublishLanguage(FileVersionPublishLanguage $publishLanguages)
  390. {
  391. $this->publishLanguages[] = $publishLanguages;
  393. return $this;
  394. }
  396. /**
  397. * Remove publishLanguages.
  398. */
  399. public function removePublishLanguage(FileVersionPublishLanguage $publishLanguages)
  400. {
  401. $this->publishLanguages->removeElement($publishLanguages);
  402. }
  404. /**
  405. * Get publishLanguages.
  406. *
  407. * @return DoctrineCollection<int, FileVersionPublishLanguage>
  408. */
  409. public function getPublishLanguages()
  410. {
  411. return $this->publishLanguages;
  412. }
  414. /**
  415. * Add meta.
  416. *
  417. * @return FileVersion
  418. */
  419. public function addMeta(FileVersionMeta $meta)
  420. {
  421. $this->meta[] = $meta;
  423. return $this;
  424. }
  426. /**
  427. * Remove meta.
  428. */
  429. public function removeMeta(FileVersionMeta $meta)
  430. {
  431. $this->meta->removeElement($meta);
  432. }
  434. /**
  435. * Get meta.
  436. *
  437. * @return DoctrineCollection<int, FileVersionMeta>
  438. */
  439. public function getMeta()
  440. {
  441. return $this->meta;
  442. }
  444. /**
  445. * Adds a format-options entity to the file-version.
  446. *
  447. * @return FileVersion
  448. */
  449. public function addFormatOptions(FormatOptions $formatOptions)
  450. {
  451. $this->formatOptions[$formatOptions->getFormatKey()] = $formatOptions;
  453. return $this;
  454. }
  456. /**
  457. * Get formatOptions.
  458. *
  459. * @return DoctrineCollection<string, FormatOptions>
  460. */
  461. public function getFormatOptions()
  462. {
  463. return $this->formatOptions;
  464. }
  466. /**
  467. * Set file.
  468. *
  469. * @return FileVersion
  470. */
  471. public function setFile(?File $file = null)
  472. {
  473. $this->file = $file;
  475. return $this;
  476. }
  478. /**
  479. * Get file.
  480. *
  481. * @return File
  482. */
  483. public function getFile()
  484. {
  485. return $this->file;
  486. }
  488. /**
  489. * Add tags.
  490. *
  491. * @return FileVersion
  492. */
  493. public function addTag(TagInterface $tags)
  494. {
  495. $this->tags[] = $tags;
  497. return $this;
  498. }
  500. /**
  501. * Remove tags.
  502. */
  503. public function removeTag(TagInterface $tags)
  504. {
  505. $this->tags->removeElement($tags);
  506. }
  508. /**
  509. * Remove all tags.
  510. */
  511. public function removeTags()
  512. {
  513. foreach ($this->tags as $tag) {
  514. $this->tags->removeElement($tag);
  515. }
  516. }
  518. /**
  519. * Get tags.
  520. *
  521. * @return DoctrineCollection<int, TagInterface>
  522. */
  523. public function getTags()
  524. {
  525. return $this->tags;
  526. }
  528. /**
  529. * Set defaultMeta.
  530. *
  531. * @return FileVersion
  532. */
  533. public function setDefaultMeta(?FileVersionMeta $defaultMeta = null)
  534. {
  535. $this->defaultMeta = $defaultMeta;
  537. return $this;
  538. }
  540. /**
  541. * Get defaultMeta.
  542. *
  543. * @return FileVersionMeta|null
  544. */
  545. public function getDefaultMeta()
  546. {
  547. return $this->defaultMeta;
  548. }
  550. /**
  551. * don't clone id to create a new entities.
  552. */
  553. public function __clone()
  554. {
  555. if ($this->id) {
  556. $this->id = null;
  557. /** @var FileVersionMeta[] $newMetaList */
  558. $newMetaList = [];
  559. $defaultMetaLocale = $this->getDefaultMeta()?->getLocale();
  560. /** @var FileVersionContentLanguage[] $newContentLanguageList */
  561. $newContentLanguageList = [];
  562. /** @var FileVersionPublishLanguage[] $newPublishLanguageList */
  563. $newPublishLanguageList = [];
  564. /** @var FormatOptions[] $newFormatOptionsArray */
  565. $newFormatOptionsArray = [];
  567. foreach ($this->meta as $meta) {
  568. /* @var FileVersionMeta $meta */
  569. $newMetaList[] = clone $meta;
  570. }
  572. $this->meta->clear(); // @phpstan-ignore-line disallowed.method it saved to call here as it a none persisted entity
  573. foreach ($newMetaList as $newMeta) {
  574. $newMeta->setFileVersion($this);
  575. $this->addMeta($newMeta);
  577. if ($newMeta->getLocale() === $defaultMetaLocale) {
  578. $this->setDefaultMeta($newMeta);
  579. }
  580. }
  582. foreach ($this->contentLanguages as $contentLanguage) {
  583. /* @var FileVersionContentLanguage $contentLanguage */
  584. $newContentLanguageList[] = clone $contentLanguage;
  585. }
  587. $this->contentLanguages->clear(); // @phpstan-ignore-line disallowed.method it saved to call here as it a none persisted entity
  588. foreach ($newContentLanguageList as $newContentLanguage) {
  589. $newContentLanguage->setFileVersion($this);
  590. $this->addContentLanguage($newContentLanguage);
  591. }
  593. foreach ($this->publishLanguages as $publishLanguage) {
  594. /* @var FileVersionPublishLanguage $publishLanguage */
  595. $newPublishLanguageList[] = clone $publishLanguage;
  596. }
  598. $this->publishLanguages->clear(); // @phpstan-ignore-line disallowed.method it saved to call here as it a none persisted entity
  599. foreach ($newPublishLanguageList as $newPublishLanguage) {
  600. $newPublishLanguage->setFileVersion($this);
  601. $this->addPublishLanguage($newPublishLanguage);
  602. }
  604. foreach ($this->formatOptions as $formatOptions) {
  605. /* @var FormatOptions $formatOptions */
  606. $newFormatOptionsArray[] = clone $formatOptions;
  607. }
  609. $this->formatOptions->clear(); // @phpstan-ignore-line disallowed.method it saved to call here as it a none persisted entity
  610. foreach ($newFormatOptionsArray as $newFormatOptions) {
  611. $newFormatOptions->setFileVersion($this);
  612. $this->addFormatOptions($newFormatOptions);
  613. }
  614. }
  615. }
  617. /**
  618. * Is active.
  619. *
  620. * @return bool
  621. */
  622. public function isActive()
  623. {
  624. return $this->version === $this->file->getVersion();
  625. }
  627. /**
  628. * @return mixed
  629. */
  630. public function getProperties()
  631. {
  632. return \json_decode($this->properties ?? '', true);
  633. }
  635. /**
  636. * @return self
  637. */
  638. public function setProperties(array $properties)
  639. {
  640. $serializedText = \json_encode($properties);
  641. if (false === $serializedText) {
  642. return $this;
  643. }
  644. $this->properties = $serializedText;
  646. return $this;
  647. }
  649. /**
  650. * Add categories.
  651. *
  652. * @return self
  653. */
  654. public function addCategory(CategoryInterface $categories)
  655. {
  656. $this->categories[] = $categories;
  658. return $this;
  659. }
  661. /**
  662. * Remove categories.
  663. */
  664. public function removeCategories()
  665. {
  666. foreach ($this->categories as $category) {
  667. $this->categories->removeElement($category);
  668. }
  669. }
  671. /**
  672. * Get categories.
  673. *
  674. * @return DoctrineCollection<int, CategoryInterface>
  675. */
  676. public function getCategories()
  677. {
  678. return $this->categories;
  679. }
  681. /**
  682. * Add a target group.
  683. */
  684. public function addTargetGroup(TargetGroupInterface $targetGroup)
  685. {
  686. $this->getTargetGroups()[] = $targetGroup;
  687. }
  689. /**
  690. * Remove all target groups.
  691. */
  692. public function removeTargetGroups()
  693. {
  694. foreach ($this->getTargetGroups() as $targetGroup) {
  695. $this->getTargetGroups()->removeElement($targetGroup);
  696. }
  697. }
  699. /**
  700. * @return DoctrineCollection<int, TargetGroupInterface>
  701. */
  702. public function getTargetGroups()
  703. {
  704. // Lazy initialization needed because targetGroups is not mapped in Doctrine
  705. // (AudienceTargetingBundle is optional). Doctrine won't initialize this
  706. // collection when loading entities from the database.
  707. if (!isset($this->targetGroups)) { // @phpstan-ignore-line isset.initializedProperty
  708. $this->targetGroups = new ArrayCollection();
  709. }
  711. return $this->targetGroups;
  712. }
  714. /**
  715. * Returns the x coordinate of the focus point.
  716. *
  717. * @return int|null
  718. */
  719. public function getFocusPointX()
  720. {
  721. return $this->focusPointX;
  722. }
  724. /**
  725. * Sets the x coordinate of the focus point.
  726. *
  727. * @param int $focusPointX
  728. */
  729. public function setFocusPointX($focusPointX)
  730. {
  731. $this->focusPointX = $focusPointX;
  732. }
  734. /**
  735. * Returns the y coordinate of the focus point.
  736. *
  737. * @return int|null
  738. */
  739. public function getFocusPointY()
  740. {
  741. return $this->focusPointY;
  742. }
  744. /**
  745. * Sets the y coordinate of the focus point.
  746. *
  747. * @param int $focusPointY
  748. */
  749. public function setFocusPointY($focusPointY)
  750. {
  751. $this->focusPointY = $focusPointY;
  752. }
  754. public function getOrigin(): string
  755. {
  756. return $this->origin;
  757. }
  759. /**
  760. * @return $this
  761. */
  762. public function setOrigin(string $origin): self
  763. {
  764. $this->origin = $origin;
  766. return $this;
  767. }
  769. public function getAiDisclosureDisabled(): bool
  770. {
  771. return $this->aiDisclosureDisabled;
  772. }
  774. /**
  775. * @return $this
  776. */
  777. public function setAiDisclosureDisabled(bool $aiDisclosureDisabled): self
  778. {
  779. $this->aiDisclosureDisabled = $aiDisclosureDisabled;
  781. return $this;
  782. }
  784. public function getAiDisclosureIconVariant(): string
  785. {
  786. return $this->aiDisclosureIconVariant;
  787. }
  789. /**
  790. * @return $this
  791. */
  792. public function setAiDisclosureIconVariant(string $aiDisclosureIconVariant): self
  793. {
  794. $this->aiDisclosureIconVariant = $aiDisclosureIconVariant;
  796. return $this;
  797. }
  798. }