src/Package/Admin/Tools/AdminState/AdminState.php line 85

Open in your IDE?
  1. <?php
  2. namespace App\Package\Admin\Tools\AdminState;
  4. use App\Package\Admin\Main\EntityInterface\{ AdminModuleInterface, AdminActionInterface };
  5. use App\Package\Core\EntityInterface\SimpleEntityInterface;
  6. use App\Package\Toolkit\ApplicationMode\ApplicationMode,
  7.     App\Package\Admin\Tools\AdminUtil\AdminUtil,
  8.     App\Package\Admin\Tools\ObjectUtil\ObjectUtil,
  9.     App\Package\Admin\Tools\UrlUtil\UrlUtil,
  10.     App\Package\Toolkit\Exception\NotFoundException\NotFoundException;
  11.     
  12. /**
  13.  * AdminState
  14.  * 
  15.  * Holds:
  16.  * - current module
  17.  * - current action
  18.  * - current object
  19.  * - current object id
  20.  * - current object parent id
  21.  * - current object parent is self
  22.  * - current query string
  23.  * 
  24.  * @author     Daniel Balowski <d.balowski@openform.pl> (_creator)
  25.  * @copyright  Openform
  26.  * @since      03.2019
  27.  */
  28. class AdminState
  29. {
  30.     /**
  31.      * @var AdminModuleInterface
  32.      */
  33.     protected $currentModule;
  35.     /**
  36.      * @var AdminActionInterface
  37.      */
  38.     protected $currentAction;
  40.     /**
  41.      * @var string
  42.      */
  43.     protected $currentObjectPackage;
  45.     /**
  46.      * @var string
  47.      */
  48.     protected $currentObjectEntityName;
  50.     /**
  51.      * @var SimpleEntityInterface
  52.      */
  53.     protected $currentObject;
  54.   
  55.     /**
  56.      * @var int
  57.      */
  58.     protected $currentObjectId;
  60.     /**
  61.      * @var int
  62.      */
  63.     protected $currentObjectParentId;
  65.     /**
  66.      * @var boolean
  67.      */
  68.     protected $currentObjectParentIsSelf;
  70.     /**
  71.      * @var mixed[]
  72.      */
  73.     protected $currentQueryArgs;
  75.     
  76.     /**
  77.      * @param ApplicationMode  $applicationMode
  78.      * @param AdminUtil        $adminUtil
  79.      * @param ObjectUtil       $objectUtil
  80.      * @param UrlUtil          $urlUtil
  81.      * 
  82.      * @throws NotFoundException    if currentObjectId is not null and currentObject is null
  83.      *                              (object does not exist)
  84.      */
  85.     public function __construct(
  86.         ApplicationMode $applicationMode, 
  87.         AdminUtil  $adminUtil, 
  88.         ObjectUtil $objectUtil, 
  89.         UrlUtil    $urlUtil
  90.     ) {
  91.         if ($applicationMode->getCurrentMode() === 'admin') {
  92.             $this->currentModule = $adminUtil->fetchCurrentAdminModule();
  93.             $this->currentAction = $adminUtil->fetchCurrentAdminAction();
  94.             $this->currentObjectPackage = 
  95.                 $this->currentModule ?
  96.                 (
  97.                     $this->currentModule->getEntityName() && $this->currentModule->getEntityPackage() ?
  98.                     $this->currentModule->getEntityPackage() :
  99.                     $this->currentModule->getPackage()
  100.                 ) :
  101.                 null;
  102.             $this->currentObjectEntityName = 
  103.                 $this->currentModule ?
  104.                 (
  105.                     $this->currentModule->getEntityName() && $this->currentModule->getEntityPackage() ?
  106.                     $this->currentModule->getEntityName() :
  107.                     $this->currentModule->getName()
  108.                 ) :
  109.                 null;
  110.             $this->currentObjectId = $objectUtil->getCurrentObjectId();
  111.             $this->currentObject   = 
  112.                 $this->currentModule && $this->currentObjectId ?
  113.                 (
  114.                     $this->currentModule->getEntityName() && $this->currentModule->getEntityPackage() ?
  115.                     $objectUtil->fetchObjectByPackageColonEntityName(
  116.                         $this->currentObjectPackage . ':' . $this->currentObjectEntityName, 
  117.                         $this->currentObjectId
  118.                     ) :
  119.                     $objectUtil->fetchObject($this->currentModule, $this->currentObjectId)
  120.                 ) :
  121.                 null;
  123.             if ($this->currentObjectId && ! $this->currentObject) {
  124.                 throw new NotFoundException(
  125.                     ' >> 404 Object, package: ' . $this->currentObjectPackage . ', '
  126.                     . ' entity: ' . $this->currentObjectEntityName . ', id: ' . $this->currentObjectId  
  127.                 );
  128.             }
  130.             $this->currentQueryArgs = $urlUtil->getQueryArgs();
  132.             $this->currentObjectParentId = 
  133.                 array_key_exists('pid', $this->currentQueryArgs) ? 
  134.                 $this->currentQueryArgs[ 'pid' ] : 
  135.                 null;
  136.             $this->currentObjectParentIsSelf = 
  137.                 array_key_exists('pself', $this->currentQueryArgs) ? 
  138.                 true : 
  139.                 false;
  140.         }
  141.     }
  143.     
  144.     /**
  145.      * Gets current admin module
  146.      * 
  147.      * @return AdminModuleInterface|null
  148.      */
  149.     public function getCurrentModule() : ? AdminModuleInterface
  150.     {
  151.         return $this->currentModule;
  152.     }
  154.     /**
  155.      * Gets current admin action
  156.      * 
  157.      * @return AdminActionInterface|null
  158.      */
  159.     public function getCurrentAction() : ? AdminActionInterface
  160.     {
  161.         return $this->currentAction;
  162.     }
  164.     /**
  165.      * Gets current object package name
  166.      *
  167.      * @return string|null
  168.      */
  169.     public function getCurrentObjectPackage() : ? string
  170.     {
  171.         return $this->currentObjectPackage;
  172.     }
  174.     /**
  175.      * Gets current object entity name
  176.      *
  177.      * @return string|null
  178.      */
  179.     public function getCurrentObjectEntityName() : ? string
  180.     {
  181.         return $this->currentObjectEntityName;
  182.     }
  184.     /**
  185.      * Gets current object id
  186.      * 
  187.      * @return integer|null
  188.      */
  189.     public function getCurrentObjectId() : ? int
  190.     {
  191.         return $this->currentObjectId;
  192.     }
  194.     /**
  195.      * Gets current object
  196.      * 
  197.      * @return SimpleEntityInterface|null
  198.      */
  199.     public function getCurrentObject() : ? SimpleEntityInterface
  200.     {
  201.         return $this->currentObject;
  202.     }
  204.     /**
  205.      * Gets current object parent id
  206.      *
  207.      * @return integer|null
  208.      */
  209.     public function getCurrentObjectParentId() : ? int
  210.     {
  211.         return $this->currentObjectParentId;
  212.     }
  214.     /**
  215.      * Gets current object parent is self
  216.      *
  217.      * @return boolean
  218.      */
  219.     public function getCurrentObjectParentIsSelf() : bool
  220.     {
  221.         return $this->currentObjectParentIsSelf;
  222.     }
  224.     /**
  225.      * Gets current query args array
  226.      * 
  227.      * @return array|null
  228.      */
  229.     public function getCurrentQueryArgs() : ? array
  230.     {
  231.         return $this->currentQueryArgs;
  232.     }
  233. }