design_area.inc

<?php
require_once SQ_INCLUDE_PATH.'/asset.inc';

class Design_Area extends Asset
{


    function __construct($assetid=0)
    {
        $this->_ser_attrs = TRUE; // we have serialise type vars
        parent::__construct($assetid);

    }//end constructor


    protected function _preCreateCheck(Array &$link)
    {
        if (!parent::_preCreateCheck($link)) return FALSE;

        $id_name = trim($this->attr('id_name'));
        if ($id_name == '') {
            trigger_localised_error('CORE0187', E_USER_WARNING, $GLOBALS['SQ_SYSTEM']->am->getTypeInfo($this->type(), 'name'));
            return FALSE;
        }

        return TRUE;

    }//end _preCreateCheck()


    public function _updated($update_parents=TRUE)
    {
        // don't update the parent asset when this asset is updated as it starts a recusion
        // that takes way too long
        return parent::_updated(FALSE);

    }//end _updated()


    public function lockTypes()
    {
        $lock_types = parent::lockTypes();
        $lock_types['parsing'] = $lock_types['all'];
        return $lock_types;

    }//end lockTypes()


    protected function _getName($short_name=FALSE)
    {
        $name = $this->attr('id_name');
        // if the attribute is empty, let the parent take care of setting the name
        if ($name == '') $name = parent::_getName($short_name);

        return $name;

    }//end _getName()


    public function processBackend(Backend_Outputter $o, Array &$link)
    {
        if (parent::processBackend($o, $link)) {
            $designs = $this->getDesigns();
            for ($i = 0, $max = count($designs); $i < $max; $i++) {
                $designs[$i]->generateDesignFile(FALSE);
            }//end for

            return TRUE;

        } else {

            return FALSE;

        }//end if

    }//end processBackend()


    public function &getDesigns()
    {
        $links = $GLOBALS['SQ_SYSTEM']->am->getLinks($this->id, SQ_LINK_TYPE_3, 'design', FALSE, 'minor');
        $designs = Array();
        foreach ($links as $link) {
            $designs[] = $GLOBALS['SQ_SYSTEM']->am->getAsset($link['majorid'], $link['major_type_code'], TRUE);
        }
        return $designs;

    }//end getDesigns()


    public function getVarReferences()
    {
        $var_refs = Array();
        foreach ($this->vars['var_references']['value'] as $var_name => $info) {
            if (!isset($var_refs[$info['id_name']])) {
                $var_refs[$info['id_name']] = Array();
            }
            $var_refs[$info['id_name']][] = $info['var'];
        }//end foreach

        return $var_refs;

    }//end getVarReferences()


    public function setVarReferenceValues(Array $var_ref_values)
    {
        if (!isset($this->_tmp['var_reference_values'])) {
            $this->_tmp['var_reference_values'] = Array();
        }
        foreach ($this->vars['var_references']['value'] as $var_name => $info) {
            if (isset($var_ref_values[$info['id_name']][$info['var']])) {
                $this->_tmp['var_reference_values'][$var_name] = $var_ref_values[$info['id_name']][$info['var']];
            }
        }//end foreach

    }//end setVarReferenceValues()


    public function attr($name)
    {
        if (isset($this->_tmp['var_reference_values'][$name])) {
            return $this->_tmp['var_reference_values'][$name];
        } else {
            return parent::attr($name);
        }

    }//end attr()


    public function getProtectedAttrs()
    {
        return $GLOBALS['SQ_SYSTEM']->am->getAssetTypeAttributes('design_area', Array('name'));

    }//end getProtectedAttrs()


//--        PARSE FILE GENERATION        --//


    public function printVar($var, Array $args)
    {
        echo $this->_escapeVar($this->attr($var), $args);

    }//end printVar()


    protected function _escapeVar($value, Array $args)
    {
        if (empty($args['escape']) || strtolower($args['escape']) == 'no') {
            return $value;
        } else {
            return 'addslashes('.$value.')';
        }

    }//end _escapeVar()


    protected function _safeStringLiteral($string)
    {
        return var_export((string)$string, TRUE);

    }//end _safeStringLiteral()


    protected function _canBeCached()
    {
        return TRUE;

    }//end _canBeCached()


    protected function _canInit()
    {
        return TRUE;

    }//end _canInit()


    public function printInitCode()
    {
        $design =& $GLOBALS['DESIGN_BEING_GENERATED'];
        $instance_id = '_'.$this->id.'_'.$design->id;
        if ($this->attr('cache') && $this->_canBeCached()) {
            echo '
            <?php
                $cm = $GLOBALS[\'SQ_SYSTEM\']->am->getSystemAsset(\'cache_manager\');
                $asset_contents'.$instance_id.' = $cm->loadFromCache('.$this->id.', \''.$this->type().'\', \''.$design->id.'\', !'.$this->attr('cache_globally').');

                if ($asset_contents'.$instance_id.' === FALSE) {
            ?>
            ';
        }
        $this->_printInitCode();

        if ($this->attr('cache') && $this->_canBeCached()) {
            echo '
            <?php
                }
            ?>
            ';
        }

    }//end printInitCode()


    protected function _printInitCode()
    {

    }//end _printInitCode()


    public function printPaintingCode()
    {
        if (!array_get_index($this->_tmp, 'ready_to_paint')) {
            return;
        }
        $design =& $GLOBALS['DESIGN_BEING_GENERATED'];
        $instance_id = '_'.$this->id.'_'.$design->id;
        if ($this->attr('cache') && $this->_canBeCached()) {
            echo '
            <?php
                if ($asset_contents'.$instance_id.' === FALSE) {
                    ob_start();
            ?>
            ';
        }

        $this->_printPaintingCode();

        if ($this->attr('cache') && $this->_canBeCached()) {
            echo '
            <?php
                    $asset_contents'.$instance_id.' = ob_get_contents();
                    ob_end_clean();
                    $cm = $GLOBALS[\'SQ_SYSTEM\']->am->getSystemAsset(\'cache_manager\');
                    $cm->saveToCache('.$this->id.', \''.$this->type().'\', \''.$design->id.'\', $asset_contents'.$instance_id.', !'.$this->attr('cache_globally').');
                }
                echo $asset_contents'.$instance_id.';
            ?>
            ';
        }

    }//end printPaintingCode()


    protected function _printPaintingCode()
    {
        $contents = $this->attr('contents');
        $current_element = NULL;

        // remove any leading or trailing whitespace elements from the contents
        // first, the leaders
        if (count($contents) > 0) {
            $current_element = array_shift($contents);
            while(($current_element['_type'] == 'HTML') && (trim($current_element['contents']) == '')) {
                if (count($contents) == 0) {
                    $current_element = NULL;
                    break;
                }
                $current_element = array_shift($contents);
            }
        }

        if (!is_null($current_element)) {
            array_unshift($contents, $current_element);
        }

        // now the trailers...
        if (count($contents) > 0) {
            $current_element = array_pop($contents);
            while(($current_element['_type'] == 'HTML') && (trim($current_element['contents']) == '')) {
                if (count($contents) == 0) {
                    $current_element = NULL;
                    break;
                }
                $current_element = array_pop($contents);
            }
        }

        if (!is_null($current_element)) {
            array_push($contents, $current_element);
        }

        // Now print out what we have left
        foreach ($contents as $item) {
            $this->_printContentItemCode($item);
        }

    }//end _printPaintingCode()


    protected function _printContentItemCode(Array $item)
    {
        if ($item['_type'] == 'HTML') {
            // just some HTML content to echo out
            echo $item['contents'];
        } else if ($item['_type'] == 'TAG') {
            if ($item['operation'] == 'print') {
                $design =& $GLOBALS['DESIGN_BEING_GENERATED'];
                if (empty($item['attributes']['id_name'])) {
                    $args = $item['attributes'];
                    unset($args['id_name']);
                    unset($args['var']);
                    $this->printVar($item['attributes']['var'], $args);
                } else {
                    if ($item['attributes']['id_name'] == '__global__') {
                        // printing a global var
                        $args = $item['attributes'];
                        unset($args['id_name']);
                        unset($args['var']);
                        $design->printVar($item['attributes']['var'], $args);
                    } else {
                        // referencing another design area (which should already have been defined)
                        $da = $design->getDesignArea($item['attributes']['id_name']);
                        if (is_null($da)) {
                            trigger_localised_error('CORE0153', E_USER_NOTICE, $item['attributes']['id_name']);
                        } else {
                            if (isset($item['attributes']['var'])) {
                                // printing a particular var from the design area
                                $args = $item['attributes'];
                                unset($args['id_name']);
                                unset($args['var']);
                                $da->printVar($item['attributes']['var'], $args);
                            } else {
                                // printing the whole other design area
                                $da->printPaintingCode();
                            }
                        }
                    }
                }
            }//end if operation
        }//end if type = TAG

    }//end _printContentItemCode()


    public function printAreaCode()
    {
        if ($this->_canInit()) {
            $this->printInitCode();
            $this->_tmp['ready_to_paint'] = TRUE;
            if ($this->attr('print')) $this->printPaintingCode();
        }

    }//end printAreaCode()


}//end class
?>