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

Open in your IDE?
  1. <?php
  4. namespace Cms\CoreBundle\Entity\OneRoster;
  6. use Cms\CoreBundle\Entity\AbstractOneRosterEntity;
  7. use Doctrine\ORM\Mapping as ORM;
  9. /**
  10.  * @see https://www.imsglobal.org/oneroster-v11-final-specification#_Toc480452011
  11.  *
  12.  * Class OneRosterCourse
  13.  * @package Cms\CoreBundle\Entity\OneRoster
  14.  *
  15.  * @ORM\Entity(
  16.  *     repositoryClass = "Cms\CoreBundle\Doctrine\OneRoster\OneRosterCourseRepository"
  17.  * )
  18.  */
  19. class OneRosterCourse extends AbstractOneRosterEntity
  20. {
  21.     const ONEROSTER_TYPE = 'course';
  22.     const DISCR = 'Course';
  24.     /**
  25.      * @var string|null
  26.      *
  27.      * @ORM\Column(
  28.      *     type = "string",
  29.      *     nullable = false,
  30.      * )
  31.      */
  32.     protected ?string $title = null;
  34.     /**
  35.      * NOTE: this is called school year, but really points to an academic session object
  36.      * IMPORTANT: we had to rename the database column for this due to naming conflicts with other schoolYear value in another object!
  37.      *
  38.      * @var array|array[]|null
  39.      *
  40.      * @ORM\Column(
  41.      *     name = "schoolSession",
  42.      *     type = "json",
  43.      *     nullable = true,
  44.      * )
  45.      */
  46.     protected ?array $schoolYear = null;
  48.     /**
  49.      * @var string|null
  50.      *
  51.      * @ORM\Column(
  52.      *     type = "string",
  53.      *     nullable = true,
  54.      * )
  55.      */
  56.     protected ?string $courseCode;
  58.     /**
  59.      * @see https://ceds.ed.gov/CEDSElementDetails.aspx?TermId=7100
  60.      *
  61.      * @var array|string[]
  62.      *
  63.      * @ORM\Column(
  64.      *     type = "json",
  65.      *     nullable = false,
  66.      * )
  67.      */
  68.     protected array $grades = [];
  70.     /**
  71.      * @var array|array[]
  72.      *
  73.      * @ORM\Column(
  74.      *     type = "json",
  75.      *     nullable = false,
  76.      * )
  77.      */
  78.     protected ?array $org = null;
  80.     /**
  81.      * @return string|null
  82.      */
  83.     public function getTitle(): ?string
  84.     {
  85.         return $this->title;
  86.     }
  88.     /**
  89.      * @param string $value
  90.      * @return $this
  91.      */
  92.     public function setTitle(string $value): self
  93.     {
  94.         $this->title = $value;
  95.         return $this;
  96.     }
  98.     /**
  99.      * @return array|null
  100.      */
  101.     public function getSchoolYear(): ?array
  102.     {
  103.         return $this->schoolYear;
  104.     }
  106.     /**
  107.      * @param array|array[]|null $value
  108.      * @return $this
  109.      */
  110.     public function setSchoolYear(?array $value): self
  111.     {
  112.         $this->schoolYear = ($value) ? $this->parseGuidRef($value) : null;
  113.         return $this;
  114.     }
  116.     /**
  117.      * @return string|null
  118.      */
  119.     public function getCourseCode(): ?string
  120.     {
  121.         return $this->courseCode;
  122.     }
  124.     /**
  125.      * @param string|null $value
  126.      * @return $this
  127.      */
  128.     public function setCourseCode(?string $value): self
  129.     {
  130.         $this->courseCode = $value;
  131.         return $this;
  132.     }
  134.     /**
  135.      * @return array|string[]
  136.      */
  137.     public function getGrades(): array
  138.     {
  139.         return $this->grades;
  140.     }
  142.     /**
  143.      * @param array|string[] $value
  144.      * @return $this
  145.      */
  146.     public function setGrades(array $value): self
  147.     {
  148.         $this->grades = $this->parseArray($value);
  149.         return $this;
  150.     }
  152.     /**
  153.      * @return array|array[]|null
  154.      */
  155.     public function getOrg(): ?array
  156.     {
  157.         return $this->org;
  158.     }
  160.     /**
  161.      * @param array|array[] $value
  162.      * @return $this
  163.      */
  164.     public function setOrg(array $value): self
  165.     {
  166.         $this->org = $this->parseGuidRef($value);
  167.         return $this;
  168.     }
  169. }