classes/XLite/Model/Role.php line 11

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.  * Role
  14.  *
  15.  * @ORM\Entity
  16.  * @ORM\Table  (name="roles")
  17.  */
  18. class Role extends \XLite\Model\Base\I18n
  19. {
  20.     /**
  21.      * ID
  22.      *
  23.      * @var integer
  24.      *
  25.      * @ORM\Id
  26.      * @ORM\GeneratedValue (strategy="AUTO")
  27.      * @ORM\Column         (type="integer", options={ "unsigned": true })
  28.      */
  29.     protected $id;
  31.     /**
  32.      * Permissions
  33.      *
  34.      * @var \Doctrine\Common\Collections\Collection
  35.      *
  36.      * @ORM\ManyToMany (targetEntity="XLite\Model\Role\Permission", mappedBy="roles", cascade={"merge","detach","persist"})
  37.      */
  38.     protected $permissions;
  40.     /**
  41.      * Profiles
  42.      *
  43.      * @var \Doctrine\Common\Collections\Collection
  44.      *
  45.      * @ORM\ManyToMany (targetEntity="XLite\Model\Profile", inversedBy="roles")
  46.      * @ORM\JoinTable (
  47.      *      name="profile_roles",
  48.      *      joinColumns={@ORM\JoinColumn (name="role_id", referencedColumnName="id", onDelete="CASCADE")},
  49.      *      inverseJoinColumns={@ORM\JoinColumn (name="profile_id", referencedColumnName="profile_id", onDelete="CASCADE")}
  50.      * )
  51.      */
  52.     protected $profiles;
  54.     /**
  55.      * @var \Doctrine\Common\Collections\Collection
  56.      *
  57.      * @ORM\OneToMany (targetEntity="XLite\Model\RoleTranslation", mappedBy="owner", cascade={"all"})
  58.      */
  59.     protected $translations;
  61.     /**
  62.      * Constructor
  63.      *
  64.      * @param array $data Entity properties OPTIONAL
  65.      */
  66.     public function __construct(array $data = [])
  67.     {
  68.         $this->permissions = new \Doctrine\Common\Collections\ArrayCollection();
  69.         $this->profiles    = new \Doctrine\Common\Collections\ArrayCollection();
  71.         parent::__construct($data);
  72.     }
  74.     /**
  75.      * Get public name
  76.      *
  77.      * @return string
  78.      */
  79.     public function getPublicName()
  80.     {
  81.         return $this->getName();
  82.     }
  84.     /**
  85.      * Check - specified permission is allowed or not
  86.      *
  87.      * @param string $code Permission code
  88.      *
  89.      * @return boolean
  90.      */
  91.     public function isPermissionAllowed($code)
  92.     {
  93.         $result = false;
  95.         foreach ($this->getPermissions() as $permission) {
  96.             if ($permission->isAllowed($code)) {
  97.                 $result = true;
  99.                 break;
  100.             }
  101.         }
  103.         return $result;
  104.     }
  106.     /**
  107.      * Check - specified permission (only one from list) is allowed
  108.      *
  109.      * @param string|array $code Permission code(s)
  110.      *
  111.      * @return boolean
  112.      */
  113.     public function isPermissionAllowedOr($code)
  114.     {
  115.         $result = false;
  117.         $list = [];
  118.         foreach (func_get_args() as $code) {
  119.             if (is_array($code)) {
  120.                 foreach ($code as $permissionCode) {
  121.                     $list[] = $permissionCode;
  122.                 }
  123.             } else {
  124.                 $list[] = $code;
  125.             }
  126.         }
  128.         foreach ($list as $code) {
  129.             if ($this->isPermissionAllowed($code)) {
  130.                 $result = true;
  132.                 break;
  133.             }
  134.         }
  136.         return $result;
  137.     }
  139.     /**
  140.      * Get id
  141.      *
  142.      * @return integer
  143.      */
  144.     public function getId()
  145.     {
  146.         return $this->id;
  147.     }
  149.     /**
  150.      * Add permissions
  151.      *
  152.      * @param \XLite\Model\Role\Permission $permissions
  153.      * @return Role
  154.      */
  155.     public function addPermissions(\XLite\Model\Role\Permission $permissions)
  156.     {
  157.         $this->permissions[] = $permissions;
  158.         return $this;
  159.     }
  161.     /**
  162.      * Get permissions
  163.      *
  164.      * @return \Doctrine\Common\Collections\Collection
  165.      */
  166.     public function getPermissions()
  167.     {
  168.         return $this->permissions;
  169.     }
  171.     /**
  172.      * Add profiles
  173.      *
  174.      * @param \XLite\Model\Profile $profiles
  175.      * @return Role
  176.      */
  177.     public function addProfiles(\XLite\Model\Profile $profiles)
  178.     {
  179.         $this->profiles[] = $profiles;
  180.         return $this;
  181.     }
  183.     /**
  184.      * Get profiles
  185.      *
  186.      * @return \Doctrine\Common\Collections\Collection
  187.      */
  188.     public function getProfiles()
  189.     {
  190.         return $this->profiles;
  191.     }
  192. }