Source for file class.acContentBlockBase.php

Documentation is available at class.acContentBlockBase.php

  1. <?php
  2. /**
  3.  * Class definition and methods for AdvancedContent contentblock types.<br />
  4.  * All block types needs to inherit and extend this class!
  5.  *
  6.  * @license GPL
  7.  * @author Georg Busch (NaN)
  8.  * @copyright 2010-2011 Georg Busch (NaN)
  9.  * @version 0.9
  10.  */
  11. class acContentBlockBase
  12. {
  13.     private   $_block_properties = array('active' => true); // we shouldn't be here if the the block is not active
  14.     
  15.     /**
  16.      * @access protected
  17.      * @var object - the content object instance that creates the contentblock
  18.      */
  19.     protected $content_obj;
  20.     
  21.     /**
  22.      * Constructor<br />
  23.      * Required for all subclasses<br />
  24.      * should be called from each subclass as the very first
  25.      * @param object &$content_obj - the content object instance that creates the contentblock
  26.      * @param array $params - the parameters of that contentblock
  27.      */
  28.     function __construct(&$content_obj, &$params = array())
  29.     {
  30.         $this->content_obj = $content_obj;
  31.         $AdvancedContent   =& cms_utils::get_module('AdvancedContent');
  32.         
  33.         $this->_block_properties['smarty']           = isset($params['smarty']) ? $params['smarty'] : false;
  34.         $this->_block_properties['editor_groups']    = isset($params['editor_groups']) ? $params['editor_groups'] : '';
  35.         $this->_block_properties['editor_users']     = isset($params['editor_users']) ? $params['editor_users'] : '';
  36.         $this->_block_properties['type']             = isset($params['block_type']) ? $params['block_type'] : '';
  37.         
  38.         $this->_block_properties['name']             = isset($params['block']) ? $params['block'] : 'content_en';
  39.         $this->_block_properties['id']               = preg_replace('/-+/','_', munge_string_to_url($this->_block_properties['name']));
  40.         $this->_block_properties['label']            = isset($params['label']) ? $params['label'] : ucwords($this->_block_properties['name']);
  41.         $this->_block_properties['translate_labels'] = (isset($params['translate_labels']) && $this->content_obj->IsTrue($params['translate_labels']));
  42.         $this->_block_properties['translate_values'] = (isset($params['translate_values']) && $this->content_obj->IsTrue($params['translate_values']));
  43.         $this->_block_properties['required']         = (isset($params['required']) && $this->content_obj->IsTrue($params['required']));
  44.         $this->_block_properties['default']          = isset($params['default']) ? $params['default'] : '';
  45.         $this->_block_properties['style']            = isset($params['style']) ? $params['style'] : ''; # deprecated
  46.         $this->_block_properties['page_tab']         = isset($params['page_tab']) ? $params['page_tab'] : 'main';
  47.         $this->_block_properties['block_tab']        = isset($params['block_tab']) ? $params['block_tab'] : '';
  48.         $this->_block_properties['block_group']      = isset($params['block_group']) ? $params['block_group'] : '';
  49.         $this->_block_properties['allow_none']       = !(isset($params['allow_none']) && $this->content_obj->IsFalse($params['allow_none']));
  50.         $this->_block_properties['description']      = isset($params['description']) ? $params['description'] : '';
  51.         
  52.         $this->_block_properties['no_collapse'] = (isset($params['no_collapse']) && $this->content_obj->IsTrue($params['no_collapse']));
  53.         $this->_block_properties['collapsible'] = !$this->_block_properties['no_collapse'];
  54.         if(!$this->_block_properties['collapsible'])
  55.         {
  56.             $this->_block_properties['collapse'] = false;
  57.         }
  58.         else
  59.         {
  60.             $this->_block_properties['collapse'] = isset($params['collapse']) ? !$this->content_obj->IsFalse($params['collapse']) : $AdvancedContent->GetPreference('collapse_block_default', true);
  61.         }
  62.         
  63.         $this->_block_properties['feu_access'] = isset($params['feu_access']) ? $params['feu_access'] : ''; 
  64.         $this->_block_properties['feu_action'] = (isset($params['feu_action']) && $this->content_obj->IsTrue($params['feu_action']));
  65.         $this->_block_properties['feu_hide']   = (isset($params['feu_hide']) && $this->content_obj->IsTrue($params['feu_hide']));
  66.         
  67.         #$this->_block_properties['inherit'] = (isset($params['inherit']) && $this->content_obj->IsTrue($params['inherit']));
  68.     }
  69.     
  70.     /**
  71.      * Sets the value of a property. If not exists it will be created.
  72.      * @param string $name - the name of the property
  73.      * @param string $value - the value of the property
  74.      */
  75.     public final function SetBlockProperty($name, $value = '')
  76.     {
  77.         $this->_block_properties[strtolower($name)] = $value;
  78.     }
  79.     
  80.     /**
  81.      * Returns the value of a property
  82.      * @param string $name - the name of the property
  83.      * @param string $default - the default value of the property if not exists
  84.      * @return mixed - usually this will be a string
  85.      */
  86.     public final function GetBlockProperty($name, $default = '')
  87.     {
  88.         $name = strtolower($name);
  89.         if(isset($this->_block_properties[$name]))
  90.         {
  91.             return $this->_block_properties[$name];
  92.         }
  93.         return $default;
  94.     }
  95.     
  96.     /**
  97.      * Returns all valid properties of that block
  98.      * @return array - array(propname => propvalue)
  99.      */
  100.     public final function GetBlockProperties()
  101.     {
  102.         return $this->_block_properties;
  103.     }
  104.     
  105.     /**
  106.      * Defines additional properties of the blocktype that needs to be stored "outside" the block.<br />
  107.      * @return array - array(propname => propvalue)
  108.      */
  109.     public function GetBlockTypeProperties($access = 'backend')
  110.     {
  111.         return array();
  112.     }
  113.     
  114.     /**
  115.      * Gets the html output of the block in backend<br />
  116.      * This method is required needs to be overwritten.
  117.      * @return string 
  118.      */
  119.     public function GetBlockInput()
  120.     {
  121.         $AdvancedContent =& cms_utils::get_module('AdvancedContent');
  122.         return $AdvancedContent->lang('invalid_blocktype', $this->GetBlockProperty('name'));
  123.     }
  124.     
  125.     /**
  126.      * Gets the html that needs to be inserted in the head section for this blocktype when editing a page;<br />
  127.      * can be useful to add css or js
  128.      * @return string 
  129.      */
  130.     public function GetHeaderHTML()
  131.     {
  132.         return;
  133.     }
  134.     
  135.     /**
  136.      * Displays the help text for this blocktype<br />
  137.      * Helptext will be displayed in modulehelp
  138.      * @return string 
  139.      */
  140.     public function GetHelp()
  141.     {
  142.         return;
  143.     }
  144.     
  145.     /**
  146.      * Displays the changelog text for this blocktype<br />
  147.      * Changelog will be displayed in modules changelog
  148.      * @return string 
  149.      */
  150.     public function GetChangeLog()
  151.     {
  152.         return;
  153.     }
  154.     
  155.     /**
  156.      * Function for the subclass to parse out data for it's parameters.<br />
  157.      * Needs to be overwritten if the blocktype provides a special kind of data that needs to be processed before storing it.
  158.      * @param array &$params - the parameters that are passed when the form is submitted
  159.      * @param bool $editing - a flag to determine if the page is created or edited
  160.      * @return string 
  161.      */
  162.     public function FillBlockParams(&$params, $editing = false)
  163.     {
  164.         return isset($params[$this->GetBlockProperty('id')]) ? $params[$this->GetBlockProperty('id')] : '';
  165.     }
  166.     
  167.     /**
  168.      * Function for the subclass to perform the blocks output
  169.      * Needs to be overwritten if the blocktype provides a special kind of data that needs to be processed before displaying it in frontend.
  170.      * @return string 
  171.      */
  172.     public function ShowBlock()
  173.     {
  174.         return $this->content_obj->GetPropertyValue($this->GetBlockProperty('id'));
  175.     }
  176. }
  177. ?>

Documentation generated on Wed, 05 Oct 2011 18:23:02 +0200 by phpDocumentor 1.4.1