src/Pumukit/SchemaBundle/Document/Series.php line 21

Open in your IDE?
  1. <?php
  3. declare(strict_types=1);
  5. namespace Pumukit\SchemaBundle\Document;
  7. use ApiPlatform\Core\Annotation\ApiResource;
  8. use Doctrine\ODM\MongoDB\Mapping\Annotations as MongoDB;
  9. use JMS\Serializer\Annotation as Serializer;
  11. /**
  12.  * @MongoDB\Document(repositoryClass="Pumukit\SchemaBundle\Repository\SeriesRepository")
  13.  *
  14.  * @MongoDB\Index(name="text_index", keys={"textindex.text"="text", "secondarytextindex.text"="text"}, options={"language_override"="indexlanguage", "default_language"="none", "weights"={"textindex.text"=10, "secondarytextindex.text"=1}})
  15.  *
  16.  * @ApiResource(
  17.  *       collectionOperations={"get"={"method"="GET", "access_control"="is_granted('ROLE_ACCESS_API')"}},
  18.  *       itemOperations={"get"={"method"="GET", "access_control"="is_granted('ROLE_ACCESS_API')"}}
  19.  *   )
  20.  */
  21. class Series
  22. {
  23.     use Traits\Keywords;
  24.     use Traits\Properties;
  25.     use Traits\HeadAndTail;
  26.     use Traits\Pic {
  27.         Traits\Pic::__construct as private __PicConstruct;
  28.     }
  30.     public const TYPE_SERIES = 0;
  31.     public const TYPE_PLAYLIST = 1;
  33.     public const SORT_MANUAL = 0;
  34.     public const SORT_PUB_ASC = 1;
  35.     public const SORT_PUB_DES = 2;
  36.     public const SORT_REC_DES = 3;
  37.     public const SORT_REC_ASC = 4;
  38.     public const SORT_ALPHAB = 5;
  40.     public static $sortCriteria = [
  41.         self::SORT_MANUAL => ['rank' => 'asc'],
  42.         self::SORT_PUB_ASC => ['public_date' => 'asc'],
  43.         self::SORT_PUB_DES => ['public_date' => 'des'],
  44.         self::SORT_REC_DES => ['record_date' => 'des'],
  45.         self::SORT_REC_ASC => ['record_date' => 'asc'],
  46.         self::SORT_ALPHAB => ['title.es' => 'asc'],
  47.     ];
  49.     public static $sortText = [
  50.         self::SORT_MANUAL => 'manual',
  51.         self::SORT_PUB_ASC => 'publication date ascending',
  52.         self::SORT_PUB_DES => 'publication date descending',
  53.         self::SORT_REC_DES => 'recording date descending',
  54.         self::SORT_REC_ASC => 'recording date ascending',
  55.         self::SORT_ALPHAB => 'title',
  56.     ];
  58.     /**
  59.      * @MongoDB\Id
  60.      */
  61.     protected $id;
  63.     /**
  64.      * @MongoDB\Field(type="int")
  65.      *
  66.      * @MongoDB\UniqueIndex()
  67.      */
  68.     private $numerical_id;
  70.     /**
  71.      * @MongoDB\Field(type="string")
  72.      *
  73.      * @MongoDB\Index
  74.      */
  75.     private $secret;
  77.     /**
  78.      * @MongoDB\Field(type="int")
  79.      *
  80.      * @MongoDB\Index
  81.      */
  82.     private $type;
  84.     /**
  85.      * @MongoDB\Field(type="int")
  86.      */
  87.     private $sorting = self::SORT_MANUAL;
  89.     /**
  90.      * @MongoDB\ReferenceOne(targetDocument=SeriesType::class, inversedBy="series", storeAs="id", cascade={"persist"})
  91.      */
  92.     private $series_type;
  94.     /**
  95.      * @MongoDB\ReferenceOne(targetDocument=SeriesStyle::class, inversedBy="series", storeAs="id", cascade={"persist"})
  96.      */
  97.     private $series_style;
  99.     /**
  100.      * @MongoDB\EmbedOne(targetDocument=Playlist::class)
  101.      *
  102.      * @Serializer\Exclude
  103.      */
  104.     private $playlist;
  106.     /**
  107.      * @MongoDB\Field(type="bool")
  108.      */
  109.     private $announce = false;
  111.     /**
  112.      * When series is hide and we access to the series with the mmobj->getSeries(),
  113.      * it creates a pseudo series with default values (the WebTV filter dont permit to access hide series),
  114.      * and we want to force that the series will be hide.
  115.      *
  116.      * @MongoDB\Field(type="bool")
  117.      *
  118.      * @MongoDB\Index
  119.      */
  120.     private $hide = false;
  122.     /**
  123.      * @MongoDB\Field(type="date")
  124.      *
  125.      * @MongoDB\Index
  126.      */
  127.     private $public_date;
  129.     /**
  130.      * @MongoDB\Field(type="raw")
  131.      */
  132.     private $title = ['en' => ''];
  134.     /**
  135.      * @MongoDB\Field(type="raw")
  136.      */
  137.     private $subtitle = ['en' => ''];
  139.     /**
  140.      * @MongoDB\Field(type="raw")
  141.      */
  142.     private $description = ['en' => ''];
  144.     /**
  145.      * @MongoDB\Field(type="string")
  146.      */
  147.     private $comments;
  149.     /**
  150.      * @MongoDB\Field(type="raw")
  151.      */
  152.     private $header = ['en' => ''];
  154.     /**
  155.      * @MongoDB\Field(type="raw")
  156.      */
  157.     private $footer = ['en' => ''];
  159.     /**
  160.      * @MongoDB\Field(type="raw")
  161.      */
  162.     private $line2 = ['en' => ''];
  164.     /**
  165.      * @MongoDB\Field(type="raw")
  166.      */
  167.     private $textindex = [];
  169.     /**
  170.      * @MongoDB\Field(type="raw")
  171.      */
  172.     private $secondarytextindex = [];
  174.     /**
  175.      * Used locale to override Translation listener`s locale this is not a mapped field of entity metadata, just a simple property.
  176.      */
  177.     private $locale = 'en';
  179.     public function __construct()
  180.     {
  181.         $this->secret = base_convert(sha1(uniqid((string) random_int(0, mt_getrandmax()), true)), 16, 36);
  182.         $this->playlist = new Playlist();
  183.         $this->__PicConstruct();
  184.     }
  186.     public function __toString(): string
  187.     {
  188.         return $this->getTitle();
  189.     }
  191.     public function isCollection(): bool
  192.     {
  193.         return true;
  194.     }
  196.     public function getId()
  197.     {
  198.         return $this->id;
  199.     }
  201.     public function getNumericalID()
  202.     {
  203.         return $this->numerical_id;
  204.     }
  206.     public function setNumericalID($numericalID)
  207.     {
  208.         return $this->numerical_id = $numericalID;
  209.     }
  211.     public function getSecret(): string
  212.     {
  213.         return $this->secret;
  214.     }
  216.     public function resetSecret(): string
  217.     {
  218.         $this->secret = base_convert(sha1(uniqid((string) random_int(0, mt_getrandmax()), true)), 16, 36);
  220.         return $this->secret;
  221.     }
  223.     public function getType()
  224.     {
  225.         return $this->type;
  226.     }
  228.     public function setType($type)
  229.     {
  230.         return $this->type = $type;
  231.     }
  233.     public function isPlaylist(): bool
  234.     {
  235.         return self::TYPE_PLAYLIST === $this->type;
  236.     }
  238.     public function getSorting(): int
  239.     {
  240.         return $this->sorting;
  241.     }
  243.     public function getSortingCriteria(): array
  244.     {
  245.         return self::$sortCriteria[$this->sorting] ?? self::$sortCriteria[0];
  246.     }
  248.     public function setSorting($sorting)
  249.     {
  250.         return $this->sorting = $sorting;
  251.     }
  253.     public function setSeriesType(SeriesType $series_type): void
  254.     {
  255.         $this->series_type = $series_type;
  256.     }
  258.     public function getSeriesType()
  259.     {
  260.         return $this->series_type;
  261.     }
  263.     public function setSeriesStyle(SeriesStyle $series_style = null): void
  264.     {
  265.         $this->series_style = $series_style;
  266.     }
  268.     public function getSeriesStyle()
  269.     {
  270.         return $this->series_style;
  271.     }
  273.     public function setPlaylist(Playlist $playlist): void
  274.     {
  275.         $this->playlist = $playlist;
  276.     }
  278.     public function getPlaylist(): Playlist
  279.     {
  280.         return $this->playlist;
  281.     }
  283.     public function setAnnounce($announce): void
  284.     {
  285.         $this->announce = $announce;
  286.     }
  288.     public function getAnnounce(): bool
  289.     {
  290.         return $this->announce;
  291.     }
  293.     public function isAnnounce(): bool
  294.     {
  295.         return $this->announce;
  296.     }
  298.     public function setHide($hide): void
  299.     {
  300.         $this->hide = $hide;
  301.     }
  303.     public function getHide(): bool
  304.     {
  305.         return $this->hide;
  306.     }
  308.     public function isHide(): bool
  309.     {
  310.         return true === $this->hide;
  311.     }
  313.     public function setPublicDate($public_date): void
  314.     {
  315.         $this->public_date = $public_date;
  316.     }
  318.     public function getPublicDate()
  319.     {
  320.         return $this->public_date;
  321.     }
  323.     public function setTitle($title, $locale = null): void
  324.     {
  325.         if (null === $locale) {
  326.             $locale = $this->locale;
  327.         }
  328.         $this->title[$locale] = $title;
  329.     }
  331.     public function getTitle($locale = null): string
  332.     {
  333.         if (null === $locale) {
  334.             $locale = $this->locale;
  335.         }
  337.         return $this->title[$locale] ?? '';
  338.     }
  340.     public function setI18nTitle(array $title): void
  341.     {
  342.         $this->title = $title;
  343.     }
  345.     public function getI18nTitle(): array
  346.     {
  347.         return $this->title;
  348.     }
  350.     public function setSubtitle($subtitle, $locale = null): void
  351.     {
  352.         if (null === $locale) {
  353.             $locale = $this->locale;
  354.         }
  355.         $this->subtitle[$locale] = $subtitle;
  356.     }
  358.     public function getSubtitle($locale = null): string
  359.     {
  360.         if (null === $locale) {
  361.             $locale = $this->locale;
  362.         }
  364.         return $this->subtitle[$locale] ?? '';
  365.     }
  367.     public function setI18nSubtitle(array $subtitle): void
  368.     {
  369.         $this->subtitle = $subtitle;
  370.     }
  372.     public function getI18nSubtitle(): array
  373.     {
  374.         return $this->subtitle;
  375.     }
  377.     public function setDescription($description, $locale = null): void
  378.     {
  379.         if (null === $locale) {
  380.             $locale = $this->locale;
  381.         }
  382.         $this->description[$locale] = $description;
  383.     }
  385.     public function getDescription($locale = null): string
  386.     {
  387.         if (null === $locale) {
  388.             $locale = $this->locale;
  389.         }
  391.         return $this->description[$locale] ?? '';
  392.     }
  394.     public function setComments($comments): void
  395.     {
  396.         $this->comments = $comments;
  397.     }
  399.     public function getComments()
  400.     {
  401.         return $this->comments;
  402.     }
  404.     public function setI18nDescription(array $description): void
  405.     {
  406.         $this->description = $description;
  407.     }
  409.     public function getI18nDescription(): array
  410.     {
  411.         return $this->description;
  412.     }
  414.     public function setHeader($header, $locale = null): void
  415.     {
  416.         if (null === $locale) {
  417.             $locale = $this->locale;
  418.         }
  419.         $this->header[$locale] = $header;
  420.     }
  422.     public function getHeader($locale = null): string
  423.     {
  424.         if (null === $locale) {
  425.             $locale = $this->locale;
  426.         }
  428.         return $this->header[$locale] ?? '';
  429.     }
  431.     public function setI18nHeader(array $header): void
  432.     {
  433.         $this->header = $header;
  434.     }
  436.     public function getI18nHeader(): array
  437.     {
  438.         return $this->header;
  439.     }
  441.     public function setFooter($footer, $locale = null): void
  442.     {
  443.         if (null === $locale) {
  444.             $locale = $this->locale;
  445.         }
  446.         $this->footer[$locale] = $footer;
  447.     }
  449.     public function getFooter($locale = null): string
  450.     {
  451.         if (null === $locale) {
  452.             $locale = $this->locale;
  453.         }
  455.         return $this->footer[$locale] ?? '';
  456.     }
  458.     public function setI18nFooter(array $footer): void
  459.     {
  460.         $this->footer = $footer;
  461.     }
  463.     public function getI18nFooter(): array
  464.     {
  465.         return $this->footer;
  466.     }
  468.     public function setCopyright($copyright): void
  469.     {
  470.         $this->setProperty('copyright', $copyright);
  471.     }
  473.     /**
  474.      * @deprecated Dont use this method, use getProperty('copyright')
  475.      */
  476.     public function getCopyright()
  477.     {
  478.         return $this->getProperty('copyright');
  479.     }
  481.     /**
  482.      * @deprecated  Dont use this method, use setProperty('license', $license)
  483.      *
  484.      * @param mixed $license
  485.      */
  486.     public function setLicense($license): void
  487.     {
  488.         $this->setProperty('license', $license);
  489.     }
  491.     /**
  492.      * @deprecated Dont use this method, use getProperty('license')
  493.      */
  494.     public function getLicense()
  495.     {
  496.         return $this->getProperty('license');
  497.     }
  499.     public function setLine2($line2, $locale = null): void
  500.     {
  501.         if (null === $locale) {
  502.             $locale = $this->locale;
  503.         }
  504.         $this->line2[$locale] = $line2;
  505.     }
  507.     public function getLine2($locale = null): string
  508.     {
  509.         if (null === $locale) {
  510.             $locale = $this->locale;
  511.         }
  513.         return $this->line2[$locale] ?? '';
  514.     }
  516.     public function setI18nLine2(array $line2): void
  517.     {
  518.         $this->line2 = $line2;
  519.     }
  521.     public function getI18nLine2(): array
  522.     {
  523.         return $this->line2;
  524.     }
  526.     public function setLocale($locale): void
  527.     {
  528.         $this->locale = $locale;
  529.     }
  531.     public function getLocale(): string
  532.     {
  533.         return $this->locale;
  534.     }
  536.     public function setTextIndex($textindex): void
  537.     {
  538.         $this->textindex = $textindex;
  539.     }
  541.     public function getTextIndex(): array
  542.     {
  543.         return $this->textindex;
  544.     }
  546.     public function setSecondaryTextIndex($secondarytextindex): void
  547.     {
  548.         $this->secondarytextindex = $secondarytextindex;
  549.     }
  551.     public function getSecondaryTextIndex(): array
  552.     {
  553.         return $this->secondarytextindex;
  554.     }
  555. }