metadata_field.inc

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

class Metadata_Field extends Asset
{


    function __construct($assetid=0)
    {
        $this->_ser_attrs = TRUE;
        parent::__construct($assetid);

    }//end constructor


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

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

        return TRUE;

    }//end _preCreateCheck()


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

    }//end _getName()


    public function _getAllowedLinks()
    {
        return Array(
                SQ_LINK_TYPE_1  => Array(),
                SQ_LINK_TYPE_2  => Array(),
                SQ_LINK_TYPE_3  => Array(),
                SQ_LINK_NOTICE  => Array(),
               );

    }//end _getAllowedLinks()


    public function getDefaultValue()
    {
        $mm = $GLOBALS['SQ_SYSTEM']->getMetadataManager();
        return $mm->getMetadataFieldDefaultValue($this->id);

    }//end getDefaultValue()


    public function getMetadataValue(Asset $asset, $value_str)
    {
        require_once SQ_FUDGE_PATH.'/general/text.inc';
        $mm = $GLOBALS['SQ_SYSTEM']->getMetadataManager();

        // get the default value
        if (is_null($value_str)) {
            $value_str = $this->getDefaultValue();
        }

        // if there are no components that we know about and we are not being displayed on the frontend,
        // then just unescape the value string and return that
        if (!$this->attr('value_components') && $this->attr('frontend') == 'hide') {
            Metadata_Field::decodeValueString($value_str, $value='', $components=Array());
            return $value;
        }

        $used_keywords = retrieve_keywords_replacements($value_str, '.');

        $used_keywords = $mm->generateKeywordReplacements($asset, $used_keywords, FALSE);

        return replace_keywords($value_str, $used_keywords);

    }//end getMetadataValue()


    public static function encodeValueString($value, $components)
    {
        // NOTE: need to have the 4 slashes == 2 slashes in regex == 1 slash literal being matched/printed
        $regex   = '/([;=\\\\])/';
        $replace = '\\\\$1';

        $str = preg_replace($regex, $replace, $value);
        foreach ($components as $k => $v) {
            $str .= '; '.preg_replace($regex, $replace, $k).'='.preg_replace($regex, $replace, $v);
        }// end foreach

        if (!empty($components)) $str .= ';';
        return $str;

    }//end encodeValueString()


    public static function decodeValueString($str, &$value, &$components)
    {

        // First escape % characters
        $str = str_replace('%', '%'.ord('%').'%', $str);
        // Next change \ escaped characters to ^d^ where d is the character's ascii code
        $str = preg_replace('/\\\\([;=\\\\])/e', '"%".ord("\\1")."%"', $str);

        $value = '';
        $check_component = !empty($components);
        $parts = explode(';', $str);
        foreach ($parts as $part) {
            if ($part == '') continue;
            $pair = explode('=', $part, 2);

            // strip whitespace from name string
            $pair[0] = preg_replace('/^\s*(\S+)\s*$/', '$1', $pair[0]);

            // trim it
            $pair[0] = trim($pair[0]);

            // convert % escaped characters back
            $pair[0] = preg_replace('/%(\d+)%/e', 'chr($1)', $pair[0]);

            if (isset($pair[1])) {
                $pair[1] = preg_replace('/%(\d+)%/e', 'chr($1)', $pair[1]);
            }

            if (!isset($pair[1])) {
                if ($value != '') $value .= '; ';
                $value .= $pair[0];
            // if the array wasn't empty, then we need to make sure that the component is already in the array
            } else if (!$check_component || isset($components[$pair[0]])) {
                $components[$pair[0]] = $pair[1];
            }

        }// end foreach

    }//end decodeValueString()


    public function saveAttributes($dont_run_updated=FALSE)
    {
        // We basically dont allow single or double quotation mark in the field name.
        $field_name_original = $this->attr('name');
        $field_name = str_replace('\'', '', $field_name_original);
        $field_name = str_replace('\"', '', $field_name);
        if ($field_name != $field_name_original) {
            $this->setAttrValue('name', $field_name);
        }//end if

        $GLOBALS['SQ_SYSTEM']->changeDatabaseConnection('db2');
        $GLOBALS['SQ_SYSTEM']->doTransaction('BEGIN');

        $default_val = self::encodeValueString($this->attr('default'), $this->attr('value_components'));

        // Only re-save the default value in the default metadata table if
        // the default value has actually changed
        if ((array_key_exists('vars_set', $this->_tmp) === TRUE) && (array_key_exists('default', $this->_tmp['vars_set']) === TRUE)) {
            $mm = $GLOBALS['SQ_SYSTEM']->getMetadataManager();

            if (!$mm->setMetadataFieldDefaultValue($this->id, $default_val)) {
                $GLOBALS['SQ_SYSTEM']->doTransaction('ROLLBACK');
                $GLOBALS['SQ_SYSTEM']->restoreDatabaseConnection();
                return FALSE;
            }
        }

        if (!parent::saveAttributes($dont_run_updated)) {
            $GLOBALS['SQ_SYSTEM']->doTransaction('ROLLBACK');
            $GLOBALS['SQ_SYSTEM']->restoreDatabaseConnection();
            return FALSE;
        }

        $GLOBALS['SQ_SYSTEM']->doTransaction('COMMIT');
        $GLOBALS['SQ_SYSTEM']->restoreDatabaseConnection();

        return TRUE;

    }//end saveAttributes()


    public function delete($release_lock=TRUE)
    {
        if (parent::delete($release_lock)) {
            $GLOBALS['SQ_SYSTEM']->changeDatabaseConnection('db2');
            $db = MatrixDAL::getDb();

            $GLOBALS['SQ_SYSTEM']->doTransaction('BEGIN');

            // First remove any values assets have for this field
            try {
                $sql = 'DELETE FROM sq_ast_mdata_val WHERE ';
                $sql .= 'fieldid = :fieldid';

                $query = MatrixDAL::preparePdoQuery($sql);
                MatrixDAL::bindValueToPdo($query, 'fieldid', $this->id);
                MatrixDAL::executePdoOne($query);
            } catch (Exception $e) {
                throw new Exception('Unable to delete metadata value for fieldid #'.$this->id.' due to the following database error:'.$e->getMessage());
            }//end try catch


            // Now we have to delete the default value information
            try {
                $sql = 'DELETE FROM sq_ast_mdata_dflt_val WHERE ';
                $sql .= 'assetid = :assetid';

                $query = MatrixDAL::preparePdoQuery($sql);
                MatrixDAL::bindValueToPdo($query, 'assetid', $this->id);
                MatrixDAL::executePdoOne($query);
            } catch (Exception $e) {
                throw new Exception('Unable to delete metadata default value for assetid #'.$this->id.' due to the following database error:'.$e->getMessage());
            }//end try catch

            $GLOBALS['SQ_SYSTEM']->doTransaction('COMMIT');
            $GLOBALS['SQ_SYSTEM']->restoreDatabaseConnection();

            return TRUE;
        }
        return FALSE;

    }//end delete()


    public function getAdditionalKeywordReplacement($additional_keyword)
    {
        return NULL;

    }//end getAdditionalKeywordReplacement()


}//end class

?>