data_source_record_set.inc

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


class Data_Source_Record_Set extends Asset
{

    protected $_data_sourceid = 0;


    function __construct($data_sourceid=0, Array $data=Array())
    {
        $this->_ser_attrs = TRUE;
        $this->_loadVars();

        if (!$data_sourceid || empty($data)) {
            return;
        }

        $data_source = $GLOBALS['SQ_SYSTEM']->am->getAsset($data_sourceid);
        if (is_null($data_source)) return;

        $this->_data_sourceid = $data_sourceid;

        // set general object properties
        $this->id = $data_source->id.':'.$data['shadow_asset_id'];
        unset($data['shadow_asset_id']);


        $this->status = $data_source->status;
        $this->version = '0.1';

        foreach ($data as $key => $value) {
            $this->vars[$key] = $value;
        }
        // if the name has keywords in it then we get the string with replacements
        if (!empty($data['shadow_asset_name'])) {
            $this->name = $this->replaceKeywordsInString($data['shadow_asset_name']);
        } else {
            if (isset($data['title'])) {
                $this->name = $data['title'];
            } else {
                $this->name = 'Data Source Record Set '.$this->id;
            }
        }
        $this->short_name = $this->name;

    }//end constructor


    public function _getAllowedLinks()
    {
        return Array();

    }//end _getAllowedLinks()


    protected function _getName($short_name=FALSE)
    {
        return $this->name;

    }//end _getName()


    public function getAvailableKeywords()
    {
        $keywords = Array();
        if (empty($this->vars)) {
            $keywords = parent::getAvailableKeywords();
            return $keywords;
        }
        $columns = array_keys($this->vars);
        $keywords['asset_assetid'] = translate('record_set_id');
        $keywords['asset_version'] = translate('record_set_version');
        $keywords['asset_status'] = translate('record_set_status');
        $keywords['asset_name'] = translate('record_set_name');
        $keywords['asset_short_name'] = translate('record_set_short_name');
        $keywords['asset_data_source_id'] = translate('data_source_id');

        $attr_string = translate('record_set_attribute');
        foreach ($columns as $column) {
            $keywords['data_source_record_set_'.$column] = $attr_string.' : '.$column;
            $keywords['ds__'.$column] = $attr_string.' : '.$column;
        }
        return $keywords;

    }//end getAvailableKeywords()


    public function getKeywordReplacement($keyword)
    {   
        $replacement = NULL;
        
        // Remove any modifiers from keyword
        $full_keyword = $keyword;
        $keyword = parse_keyword($keyword, $modifiers);
        $contextid = extract_context_modifier($modifiers);

        if ($contextid !== NULL) {
            // If we were able to extract a context ID to change to, and it's
            // different to our current one, then change and then reload a copy
            // of the asset in that context (as we would need to do anyway)

            if ((int)$contextid !== $GLOBALS['SQ_SYSTEM']->getContextId()) {
                $GLOBALS['SQ_SYSTEM']->changeContext($contextid);
                $contexted_asset = $GLOBALS['SQ_SYSTEM']->am->getAsset($this->id);

                // Get the keyword without any modifiers
                $replacement = $contexted_asset->getKeywordReplacement($keyword);

                // Then apply the ones we had remaining, then return it
                apply_keyword_modifiers($replacement, $modifiers, Array('assetid' => $contexted_asset->id));
                
                unset($contexted_asset);
                $GLOBALS['SQ_SYSTEM']->restoreContext();
                return $replacement;

            }//end if contextid is not the currently active context

        }//end if contextid is not NULL
        

        if (strpos($keyword, 'data_source_record_set_') !== FALSE) {
            $keyword = substr($keyword, strlen('data_source_record_set_'));
            $replacement = array_get_index($this->vars, $keyword, '');
        } else if (strpos($keyword, 'ds__') !== FALSE) {
            // this does the same thing as 'data_source_record_set_' but is much shorter
            $keyword = substr($keyword, strlen('ds__'));
            $replacement = array_get_index($this->vars, $keyword, '');
        } else if (strpos($keyword, 'asset_') !== FALSE) {
            $key = substr($keyword, strlen('asset_'));

            switch ($key) {
                case 'name':
                case 'short_name':
                    $replacement = $this->name;
                break;

                case 'assetid':
                    $replacement = $this->id;
                break;

                case 'version':
                    $replacement = $this->version;
                break;

                case 'status':
                    $replacement = $this->status;
                break;

                case 'data_source_id':
                    $replacement = $this->_data_sourceid;
                break;

                default:
                    // Full keyword not wanted here, since modifiers still
                    // applied afterward
                    $replacement = parent::getKeywordReplacement($keyword);
                break;
            }
        } 
        
        if (count($modifiers) > 0) {
            apply_keyword_modifiers($replacement, $modifiers, Array('assetid' => $this->id));
        }
        
        return $replacement;

    }//end getKeywordReplacement()


    public function readAccess($assetids=Array())
    {
        $parent = $this->_getBridge();
        if (!is_null($parent)) {
            $result = $parent->readAccess($assetids);
            $GLOBALS['SQ_SYSTEM']->am->forgetAsset($parent);
            return $result;
        }

        return FALSE;

    }//end readAccess()


    public function writeAccess($lock_type='', $assetids=Array(), $only_workflow=TRUE)
    {
        $parent = $this->_getBridge();
        if (!is_null($parent)) {
            $result = $parent->writeAccess($lock_type, $assetids, $only_workflow);
            $GLOBALS['SQ_SYSTEM']->am->forgetAsset($parent);
            return $result;
        }

        return FALSE;

    }//end writeAccess()


    protected function _getBridge()
    {
        list($bridgeid, $childid) = explode(':', $this->id);
        $asset = $GLOBALS['SQ_SYSTEM']->am->getAsset($bridgeid);
        return $asset;

    }//end _getBridge()


}//end class

?>