classes/XLite/Model/Region.php line 25

Open in your IDE?
  1. <?php
  3. /**
  4.  * Copyright (c) 2011-present Qualiteam software Ltd. All rights reserved.
  5.  * See https://www.x-cart.com/license-agreement.html for license details.
  6.  */
  8. namespace XLite\Model;
  10. use Doctrine\ORM\Mapping as ORM;
  12. /**
  13.  * Region is a model for grouping states
  14.  *
  15.  * @ORM\Entity
  16.  * @ORM\Table (name="regions",
  17.  *      uniqueConstraints={
  18.  *          @ORM\UniqueConstraint (name="code", columns={"code","country_code"})
  19.  *      },
  20.  *      indexes={
  21.  *          @ORM\Index (name="name", columns={"name"})
  22.  *      }
  23.  * )
  24.  */
  25. class Region extends \XLite\Model\AEntity
  26. {
  27.     /**
  28.      * Region code
  29.      *
  30.      * @var string
  31.      *
  32.      * @ORM\Id
  33.      * @ORM\Column (type="string", length=10)
  34.      */
  35.     protected $code;
  37.     /**
  38.      * Region name
  39.      *
  40.      * @var string
  41.      *
  42.      * @ORM\Column (type="string", length=64)
  43.      */
  44.     protected $name;
  46.     /**
  47.      * Region weight
  48.      *
  49.      * @var integer
  50.      *
  51.      * @ORM\Column (type="integer", nullable=true)
  52.      */
  53.     protected $weight;
  56.     /**
  57.      * Country (relation)
  58.      *
  59.      * @var \XLite\Model\Country
  60.      *
  61.      * @ORM\ManyToOne (targetEntity="XLite\Model\Country", inversedBy="regions", cascade={"merge","detach"})
  62.      * @ORM\JoinColumn (name="country_code", referencedColumnName="code", onDelete="CASCADE")
  63.      */
  64.     protected $country;
  66.     /**
  67.      * States (relation)
  68.      *
  69.      * @var \Doctrine\Common\Collections\ArrayCollection
  70.      *
  71.      * @ORM\OneToMany (targetEntity="XLite\Model\State", mappedBy="region", cascade={"all"})
  72.      * @ORM\OrderBy   ({"state" = "ASC"})
  73.      */
  74.     protected $states;
  76.     /**
  77.      * Set code
  78.      *
  79.      * @param string $code
  80.      * @return Region
  81.      */
  82.     public function setCode($code)
  83.     {
  84.         $this->code = $code;
  85.         return $this;
  86.     }
  88.     /**
  89.      * Get code
  90.      *
  91.      * @return string
  92.      */
  93.     public function getCode()
  94.     {
  95.         return $this->code;
  96.     }
  98.     /**
  99.      * Set name
  100.      *
  101.      * @param string $name
  102.      * @return Region
  103.      */
  104.     public function setName($name)
  105.     {
  106.         $this->name = $name;
  107.         return $this;
  108.     }
  110.     /**
  111.      * Get name
  112.      *
  113.      * @return string
  114.      */
  115.     public function getName()
  116.     {
  117.         return $this->name;
  118.     }
  120.     /**
  121.      * Set weight
  122.      *
  123.      * @param integer $weight
  124.      * @return Region
  125.      */
  126.     public function setWeight($weight)
  127.     {
  128.         $this->weight = $weight;
  129.         return $this;
  130.     }
  132.     /**
  133.      * Get weight
  134.      *
  135.      * @return integer
  136.      */
  137.     public function getWeight()
  138.     {
  139.         return $this->weight;
  140.     }
  142.     /**
  143.      * Set country
  144.      *
  145.      * @param \XLite\Model\Country $country
  146.      * @return Region
  147.      */
  148.     public function setCountry(\XLite\Model\Country $country = null)
  149.     {
  150.         $this->country = $country;
  151.         return $this;
  152.     }
  154.     /**
  155.      * Get country
  156.      *
  157.      * @return \XLite\Model\Country
  158.      */
  159.     public function getCountry()
  160.     {
  161.         return $this->country;
  162.     }
  164.     /**
  165.      * Add states
  166.      *
  167.      * @param \XLite\Model\State $states
  168.      * @return Region
  169.      */
  170.     public function addStates(\XLite\Model\State $states)
  171.     {
  172.         $this->states[] = $states;
  173.         return $this;
  174.     }
  176.     /**
  177.      * Get states
  178.      *
  179.      * @return \Doctrine\Common\Collections\Collection
  180.      */
  181.     public function getStates()
  182.     {
  183.         return $this->states;
  184.     }
  185. }