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

Documentation generated on Thu, 06 Oct 2011 20:54:40 +0200 by phpDocumentor 1.4.1