src/Cms/CoreBundle/Entity/OneRoster/OneRosterEnrollment.php line 20

Open in your IDE?
  1. <?php
  4. namespace Cms\CoreBundle\Entity\OneRoster;
  6. use Cms\CoreBundle\Entity\AbstractOneRosterEntity;
  7. use DateTime;
  8. use Doctrine\ORM\Mapping as ORM;
  10. /**
  11.  * @see https://www.imsglobal.org/oneroster-v11-final-specification#_Toc480452013
  12.  *
  13.  * Class OneRosterEnrollment
  14.  * @package Cms\CoreBundle\Entity\OneRoster
  15.  *
  16.  * @ORM\Entity(
  17.  *     repositoryClass = "Cms\CoreBundle\Doctrine\OneRoster\OneRosterEnrollmentRepository"
  18.  * )
  19.  */
  20. class OneRosterEnrollment extends AbstractOneRosterEntity
  21. {
  22.     const ONEROSTER_TYPE = 'enrollment';
  23.     const DISCR = 'Enrollment';
  25.     /**
  26.      * @var array|array[]|null
  27.      *
  28.      * @ORM\Column(
  29.      *     type = "json",
  30.      *     nullable = false,
  31.      * )
  32.      */
  33.     protected ?array $user = null;
  35.     /**
  36.      * @var array|array[]|null
  37.      *
  38.      * @ORM\Column(
  39.      *     type = "json",
  40.      *     nullable = false,
  41.      * )
  42.      */
  43.     protected ?array $class = null;
  45.     /**
  46.      * @var array|array[]|null
  47.      *
  48.      * @ORM\Column(
  49.      *     type = "json",
  50.      *     nullable = false,
  51.      * )
  52.      */
  53.     protected ?array $school = null;
  55.     /**
  56.      * @see https://www.imsglobal.org/oneroster-v11-final-specification#_Toc480452025
  57.      *
  58.      * @var string|null
  59.      *
  60.      * @ORM\Column(
  61.      *     type = "string",
  62.      *     nullable = false,
  63.      * )
  64.      */
  65.     protected ?string $role = null;
  67.     /**
  68.      * NOTE: the field must be given here with the backticks because it is a reserved word in mysql
  69.      *
  70.      * @var bool
  71.      *
  72.      * @ORM\Column(
  73.      *     name = "`primary`",
  74.      *     type = "boolean",
  75.      *     nullable = false,
  76.      *     options = {
  77.      *         "default" = false,
  78.      *     },
  79.      * )
  80.      */
  81.     protected bool $primary = false;
  83.     /**
  84.      * @var DateTime|null
  85.      *
  86.      * @ORM\Column(
  87.      *     type = "datetime",
  88.      *     nullable = true,
  89.      * )
  90.      */
  91.     protected ?DateTime $beginDate = null;
  93.     /**
  94.      * @var DateTime|null
  95.      *
  96.      * @ORM\Column(
  97.      *     type = "datetime",
  98.      *     nullable = true,
  99.      * )
  100.      */
  101.     protected ?DateTime $endDate = null;
  103.     /**
  104.      * @return array|array[]|null
  105.      */
  106.     public function getUser(): ?array
  107.     {
  108.         return $this->user;
  109.     }
  111.     /**
  112.      * @param array|array[] $value
  113.      * @return $this
  114.      */
  115.     public function setUser(array $value): self
  116.     {
  117.         $this->user = $this->parseGuidRef($value);
  118.         return $this;
  119.     }
  121.     /**
  122.      * @return array|array[]|null
  123.      */
  124.     public function getClass(): ?array
  125.     {
  126.         return $this->class;
  127.     }
  129.     /**
  130.      * @param array|array[] $value
  131.      * @return $this
  132.      */
  133.     public function setClass(array $value): self
  134.     {
  135.         $this->class = $this->parseGuidRef($value);
  136.         return $this;
  137.     }
  139.     /**
  140.      * @return array|array[]|null
  141.      */
  142.     public function getSchool(): ?array
  143.     {
  144.         return $this->school;
  145.     }
  147.     /**
  148.      * @param array|array[] $value
  149.      * @return $this
  150.      */
  151.     public function setSchool(array $value): self
  152.     {
  153.         $this->school = $this->parseGuidRef($value);
  154.         return $this;
  155.     }
  157.     /**
  158.      * @return string|null
  159.      */
  160.     public function getRole(): ?string
  161.     {
  162.         return $this->role;
  163.     }
  165.     /**
  166.      * @param string $value
  167.      * @return $this
  168.      */
  169.     public function setRole(string $value): self
  170.     {
  171.         $this->role = $value;
  172.         return $this;
  173.     }
  175.     /**
  176.      * @return bool
  177.      */
  178.     public function isPrimary(): bool
  179.     {
  180.         return $this->primary;
  181.     }
  183.     /**
  184.      * @param bool $value
  185.      * @return $this
  186.      */
  187.     public function setPrimary(bool $value): self
  188.     {
  189.         $this->primary = $value;
  190.         return $this;
  191.     }
  193.     /**
  194.      * @return DateTime|null
  195.      */
  196.     public function getBeginDate(): ?DateTime
  197.     {
  198.         return $this->beginDate;
  199.     }
  201.     /**
  202.      * @param DateTime|string|null $value
  203.      * @return $this
  204.      */
  205.     public function setBeginDate($value): self
  206.     {
  207.         $this->beginDate = ($value) ? $this->parseDate($value) : null;
  208.         return $this;
  209.     }
  211.     /**
  212.      * @return DateTime|null
  213.      */
  214.     public function getEndDate(): ?DateTime
  215.     {
  216.         return $this->endDate;
  217.     }
  219.     /**
  220.      * @param DateTime|string|null $value
  221.      * @return $this
  222.      */
  223.     public function setEndDate($value): self
  224.     {
  225.         $this->endDate = ($value) ? $this->parseDate($value) : null;
  226.         return $this;
  227.     }
  228. }