src/Cms/CoreBundle/Entity/OneRoster/OneRosterAcademicSession.php line 19

Open in your IDE?
  1. <?php
  3. namespace Cms\CoreBundle\Entity\OneRoster;
  5. use Cms\CoreBundle\Entity\AbstractOneRosterEntity;
  6. use DateTime;
  7. use Doctrine\ORM\Mapping as ORM;
  9. /**
  10.  * @see https://www.imsglobal.org/oneroster-v11-final-specification#_Toc480452009
  11.  *
  12.  * Class OneRosterAcademicSession
  13.  * @package Cms\CoreBundle\Entity\OneRoster
  14.  *
  15.  * @ORM\Entity(
  16.  *     repositoryClass = "Cms\CoreBundle\Doctrine\OneRoster\OneRosterAcademicSessionRepository"
  17.  * )
  18.  */
  19. class OneRosterAcademicSession extends AbstractOneRosterEntity
  20. {
  21.     const ONEROSTER_TYPE = 'academicSession';
  22.     const DISCR = 'AcademicSession';
  24.     /**
  25.      * @var string|null
  26.      *
  27.      * @ORM\Column(
  28.      *     type = "string",
  29.      *     nullable = false,
  30.      * )
  31.      */
  32.     protected ?string $title = null;
  34.     /**
  35.      * @var DateTime|null
  36.      *
  37.      * @ORM\Column(
  38.      *     type = "datetime",
  39.      *     nullable = false,
  40.      * )
  41.      */
  42.     protected ?DateTime $startDate = null;
  44.     /**
  45.      * @var DateTime|null
  46.      *
  47.      * @ORM\Column(
  48.      *     type = "datetime",
  49.      *     nullable = false,
  50.      * )
  51.      */
  52.     protected ?DateTime $endDate = null;
  54.     /**
  55.      * @see https://www.imsglobal.org/oneroster-v11-final-specification#_Toc480452027
  56.      *
  57.      * @var string|null
  58.      *
  59.      * @ORM\Column(
  60.      *     type = "string",
  61.      *     nullable = false,
  62.      * )
  63.      */
  64.     protected ?string $type = null;
  66.     /**
  67.      * @var array|null
  68.      *
  69.      * @ORM\Column(
  70.      *     type = "json",
  71.      *     nullable = true,
  72.      * )
  73.      */
  74.     protected ?array $parent = null;
  76.     /**
  77.      * @var array|array[]
  78.      *
  79.      * @ORM\Column(
  80.      *     type = "json",
  81.      *     nullable = false,
  82.      * )
  83.      */
  84.     protected array $children = [];
  86.     /**
  87.      * @var int|null
  88.      *
  89.      * @ORM\Column(
  90.      *     type = "integer",
  91.      *     nullable = false,
  92.      * )
  93.      */
  94.     protected ?int $schoolYear = null;
  96.     /**
  97.      * @return string|null
  98.      */
  99.     public function getTitle(): ?string
  100.     {
  101.         return $this->title;
  102.     }
  104.     /**
  105.      * @param string $value
  106.      * @return $this
  107.      */
  108.     public function setTitle(string $value): self
  109.     {
  110.         $this->title = $value;
  111.         return $this;
  112.     }
  114.     /**
  115.      * @return DateTime|null
  116.      */
  117.     public function getStartDate(): ?DateTime
  118.     {
  119.         return $this->startDate;
  120.     }
  122.     /**
  123.      * @param string|DateTime $value
  124.      * @return $this
  125.      */
  126.     public function setStartDate($value): self
  127.     {
  128.         $this->startDate = $this->parseDate($value);
  129.         return $this;
  130.     }
  133.     /**
  134.      * @return DateTime|null
  135.      */
  136.     public function getEndDate(): ?DateTime
  137.     {
  138.         return $this->endDate;
  139.     }
  141.     /**
  142.      * @param string|DateTime $value
  143.      * @return $this
  144.      */
  145.     public function setEndDate($value): self
  146.     {
  147.         $this->endDate = $this->parseDate($value);
  148.         return $this;
  149.     }
  151.     /**
  152.      * @return string|null
  153.      */
  154.     public function getType(): ?string
  155.     {
  156.         return $this->type;
  157.     }
  159.     /**
  160.      * @param string $value
  161.      * @return $this
  162.      */
  163.     public function setType(string $value): self
  164.     {
  165.         $this->type = $value;
  166.         return $this;
  167.     }
  169.     /**
  170.      * @return array|null
  171.      */
  172.     public function getParent(): ?array
  173.     {
  174.         return $this->parent;
  175.     }
  177.     /**
  178.      * @param array|null $value
  179.      * @return $this
  180.      */
  181.     public function setParent(?array $value): self
  182.     {
  183.         $this->parent = ($value) ? $this->parseGuidRef($value) : null;
  184.         return $this;
  185.     }
  187.     /**
  188.      * @return array|array[]
  189.      */
  190.     public function getChildren(): array
  191.     {
  192.         return $this->children;
  193.     }
  195.     /**
  196.      * @param array|array[]|null $value
  197.      * @return $this
  198.      */
  199.     public function setChildren(?array $value): self
  200.     {
  201.         $this->parseGuidRefs($value ?? []);
  202.         return $this;
  203.     }
  205.     /**
  206.      * @return int|null
  207.      */
  208.     public function getSchoolYear(): ?int
  209.     {
  210.         return $this->schoolYear;
  211.     }
  213.     /**
  214.      * @param int $value
  215.      * @return $this
  216.      */
  217.     public function setSchoolYear(int $value): self
  218.     {
  219.         $this->schoolYear = $value;
  220.         return $this;
  221.     }
  222. }