system/modules/pct_customelements/PCT/CustomElements/Core/Controller.php line 100

Open in your IDE?
  1. <?php
  3. /**
  4.  * Contao Open Source CMS
  5.  * 
  6.  * Copyright (C) 2005-2013 Leo Feyer
  7.  * 
  8.  * @copyright    Tim Gatzky 2016
  9.  * @author        Tim Gatzky <info@tim-gatzky.de>
  10.  * @package        pct_customelements
  11.  * @subpackage    pct_customelements_plugin_customcatalog
  12.  */
  14. /**
  15.  * Namespace
  16.  */
  17. namespace PCT\CustomElements\Core;
  19. /**
  20.  * Imports
  21.  */
  22. use \PCT\CustomElements\Plugins\CustomCatalog\Helper\QueryBuilder as QueryBuilder;
  24. /**
  25.  * Class file
  26.  * Controller
  27.  * Provide general methods to access any object or modify it
  28.  */
  29. abstract class Controller
  30. {
  31.     /**
  32.      * Data array
  33.      * @var array
  34.      */
  35.     protected $arrData = array();
  36.     
  37.     /**
  38.      * Custom modified array
  39.      * @var array
  40.      */
  41.     protected $arrModified = array();
  42.     
  43.     /**
  44.      * Reference object
  45.      * @var object
  46.      */
  47.     protected $objOrigin = null;
  48.     
  49.     /**
  50.      * Model object
  51.      * @var object
  52.      */
  53.     protected $objModel;
  55.     /**    
  56.      * The Session object
  57.      */
  58.     protected $Session = null;
  59.     
  60.     
  61.     /**
  62.      * Getters
  63.      * @param string
  64.      * @return mixed
  65.      */
  66.     public function get($strKey)
  67.     {
  68.         if( \property_exists($this,$strKey) )
  69.         {
  70.             return $this->{$strKey};
  71.         }
  72.         else if(isset($this->arrData[$strKey]))
  73.         {
  74.             return $this->arrData[$strKey];
  75.         }
  76.         else{}
  77.     }
  78.     
  79.     
  80.     /**
  81.      * Setters
  82.      * @param string
  83.      * @param mixed
  84.      */
  85.     public function set($strKey, $varValue)
  86.     {
  87.         if(array_key_exists($strKey, $this->arrData))
  88.         {
  89.             $this->arrData[$strKey] = $varValue;
  90.             return;
  91.         }
  92.         $this->{$strKey} = $varValue;
  93.     }
  95.     
  96.     /**
  97.      * Set data array
  98.      * @param array
  99.      */
  100.     public function setData($arrData, $blnDirectAccessible=true)
  101.     {
  102.         if(!is_array($arrData))
  103.         {
  104.             return;
  105.         }
  106.         
  107.         $this->arrData = $arrData;
  108.         
  109.         // make object accessible
  110.         if($blnDirectAccessible)
  111.         {
  112.             foreach($arrData as $k => $v)
  113.             {
  114.                 $this->{$k} = $v;
  115.             }
  116.         }
  117.     }
  118.     
  119.     
  120.     /**
  121.      * Return the data array
  122.      * @param array
  123.      */
  124.     public function getData()
  125.     {
  126.         return $this->arrData;
  127.     }
  128.     
  129.     
  130.     /**
  131.      * Return the modified array
  132.      * @return array
  133.      */
  134.     public function getModified()
  135.     {
  136.         return $this->get('arrModified');
  137.     }
  138.     
  139.     
  140.     /**
  141.      * Set a variable or flag to be modified
  142.      * @param string
  143.      */
  144.     public function setModified($strKey)
  145.     {
  146.         $arrModified = $this->getModified();
  147.         $arrModified[$strKey] = true;
  148.         $this->set('arrModified',$arrModified);
  149.     }
  150.     
  151.     
  152.     /**
  153.      * Return true/false if a key is set
  154.      * @param string
  155.      * @return boolean
  156.      */
  157.     protected function isModified($strKey)
  158.     {
  159.         $arrModified = $this->getModified();
  160.         if(array_key_exists($strKey, $arrModified))
  161.         {
  162.             return true;
  163.         }
  164.         return false;
  165.     }
  166.     
  167.     
  168.     /**
  169.      * Add a new flag to the modfied array
  170.      * @param string
  171.      */
  172.     public function markAsModified($strKey)
  173.     {
  174.         $this->setModified($strKey);
  175.     }
  177.     
  178.     /**
  179.      * Return the table of the customcatalog
  180.      * @return string
  181.      */
  182.     public function getTable()
  183.     {
  184.         return ($this->get('mode') == 'new' ? $this->get('tableName') : $this->get('existingTable') );
  185.     }
  186.     
  187.     
  188.     /**
  189.      * Set a model
  190.      * @param object
  191.      */
  192.     public function setModel($objModel)
  193.     {
  194.         $this->objModel = $objModel;
  195.     }
  196.     
  197.     
  198.     /**
  199.      * Return the model
  200.      * @return object
  201.      */
  202.     public function getModel()
  203.     {
  204.         return $this->objModel;
  205.     }
  206.     
  208.     /**
  209.      * Set the orgin
  210.      * @param object Origin
  211.      */
  212.     public function setOrigin($objOrigin)
  213.     {
  214.         $this->set('objOrigin',$objOrigin);
  215.     }
  216.     
  217.     
  218.     /**
  219.      * Get the reference model object
  220.      * @return object
  221.      */
  222.     public function getOrigin()
  223.     {
  224.         return $this->get('objOrigin');
  225.     }
  227. }