classes/XLite/Model/ZoneElement.php line 23

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.  * ZoneElement model
  14.  *
  15.  * @ORM\Entity
  16.  * @ORM\Table (name="zone_elements",
  17.  *      indexes={
  18.  *          @ORM\Index (name="type_value", columns={"element_type","element_value"}),
  19.  *          @ORM\Index (name="id_type", columns={"zone_id","element_type"})
  20.  *      }
  21.  * )
  22.  */
  23. class ZoneElement extends \XLite\Model\AEntity
  24. {
  25.     /*
  26.      * Zone element types
  27.      */
  28.     public const ZONE_ELEMENT_COUNTRY = 'C';
  29.     public const ZONE_ELEMENT_STATE   = 'S';
  30.     public const ZONE_ELEMENT_TOWN    = 'T';
  31.     public const ZONE_ELEMENT_ZIPCODE = 'Z';
  32.     public const ZONE_ELEMENT_ADDRESS = 'A';
  34.     /**
  35.      * Unique zone element Id
  36.      *
  37.      * @var integer
  38.      *
  39.      * @ORM\Id
  40.      * @ORM\GeneratedValue (strategy="AUTO")
  41.      * @ORM\Column (type="integer", length=11, nullable=false)
  42.      */
  43.     protected $element_id;
  45.     /**
  46.      * Zone element value, e.g. 'US', 'US_NY', 'New Y%' etc
  47.      *
  48.      * @var string
  49.      *
  50.      * @ORM\Column (type="string", length=255)
  51.      */
  52.     protected $element_value;
  54.     /**
  55.      * Element type
  56.      *
  57.      * @var string
  58.      *
  59.      * @ORM\Column (type="string", options={ "fixed": true }, length=1)
  60.      */
  61.     protected $element_type;
  63.     /**
  64.      * Zone (relation)
  65.      *
  66.      * @var \XLite\Model\Zone
  67.      *
  68.      * @ORM\ManyToOne (targetEntity="XLite\Model\Zone", inversedBy="zone_elements")
  69.      * @ORM\JoinColumn (name="zone_id", referencedColumnName="zone_id", onDelete="CASCADE")
  70.      */
  71.     protected $zone;
  73.     /**
  74.      * getElementTypesData
  75.      *
  76.      * @return array
  77.      */
  78.     public static function getElementTypesData()
  79.     {
  80.         return [
  81.             static::ZONE_ELEMENT_COUNTRY => [
  82.                 'field'      => 'country',   // Address field name
  83.                 'weight'     => 0x01,        // Element weight
  84.                 'funcSuffix' => 'Countries', // Suffix for functions name: getZone<Suffix>, checkZone<Suffix>
  85.                 'required'   => true,        // Required property: if true then entire zone declined if this element does bot match
  86.             ],
  87.             static::ZONE_ELEMENT_STATE   => [
  88.                 'field'      => 'state',
  89.                 'weight'     => 0x02,
  90.                 'funcSuffix' => 'States',
  91.                 'required'   => true,
  92.             ],
  93.             static::ZONE_ELEMENT_ZIPCODE => [
  94.                 'field'      => 'zipcode',
  95.                 'weight'     => 0x08,
  96.                 'funcSuffix' => 'ZipCodes',
  97.                 'required'   => true,
  98.             ],
  99.             static::ZONE_ELEMENT_TOWN    => [
  100.                 'field'      => 'city',
  101.                 'weight'     => 0x10,
  102.                 'funcSuffix' => 'Cities',
  103.                 'required'   => true,
  104.             ],
  105.             static::ZONE_ELEMENT_ADDRESS => [
  106.                 'field'      => 'address',
  107.                 'weight'     => 0x20,
  108.                 'funcSuffix' => 'Addresses',
  109.                 'required'   => false,
  110.             ]
  111.         ];
  112.     }
  114.     /**
  115.      * Get element_id
  116.      *
  117.      * @return integer
  118.      */
  119.     public function getElementId()
  120.     {
  121.         return $this->element_id;
  122.     }
  124.     /**
  125.      * Set element_value
  126.      *
  127.      * @param string $elementValue
  128.      * @return ZoneElement
  129.      */
  130.     public function setElementValue($elementValue)
  131.     {
  132.         $this->element_value = $elementValue;
  133.         return $this;
  134.     }
  136.     /**
  137.      * Get element_value
  138.      *
  139.      * @return string
  140.      */
  141.     public function getElementValue()
  142.     {
  143.         return $this->element_value;
  144.     }
  146.     /**
  147.      * Set element_type
  148.      *
  149.      * @param string $elementType
  150.      * @return ZoneElement
  151.      */
  152.     public function setElementType($elementType)
  153.     {
  154.         $this->element_type = $elementType;
  155.         return $this;
  156.     }
  158.     /**
  159.      * Get element_type
  160.      *
  161.      * @return string
  162.      */
  163.     public function getElementType()
  164.     {
  165.         return $this->element_type;
  166.     }
  168.     /**
  169.      * Set zone
  170.      *
  171.      * @param \XLite\Model\Zone $zone
  172.      * @return ZoneElement
  173.      */
  174.     public function setZone(\XLite\Model\Zone $zone = null)
  175.     {
  176.         $this->zone = $zone;
  177.         return $this;
  178.     }
  180.     /**
  181.      * Get zone
  182.      *
  183.      * @return \XLite\Model\Zone
  184.      */
  185.     public function getZone()
  186.     {
  187.         return $this->zone;
  188.     }
  189. }