asset_attribute.inc

<?php
class Asset_Attribute extends MySource_Object
{

    var $id = 0;

    var $name = '';

    var $uniq = FALSE;

    var $description = '';

    var $_params = Array();

    var $_default_value = NULL;

    var $_edit_params = Array();

    var $value = NULL;

    var $processed = FALSE;

    var $is_admin = FALSE;


    function Asset_Attribute($attributeid=0, $value=NULL, $default_params=Array())
    {
        $this->MySource_Object();

        if ($attributeid) {
            $db = DAL::getDb();

            $sql = 'SELECT attrid, name, type, uniq, description, is_admin, parameters_val, default_val
                    FROM sq_ast_attr
                    WHERE attrid = :attrid';

            try {
                $query = MatrixDAL::preparePdoQuery($sql);
                MatrixDAL::bindValueToPdo($query, 'attrid', $attributeid);
                $result = DAL::executePdoAll($query);
                if (empty($result)) {
                    return;
                } else {
                    $row = $result[0];
                }
                unset($result);
            } catch (Exception $e) {
                throw new Exception('Unable to get information for attribute ID '.$attributeid.' due to database error: '.$e->getMessage());
            }

            $this->id             = $row['attrid'];
            $this->name           = $row['name'];
            $type                 = $row['type'];
            $this->uniq           = $row['uniq'];
            $this->description    = $row['description'];
            $this->is_admin       = $row['is_admin'];
            $parameters           = $row['parameters_val'];
            $this->_default_value = $row['default_val'];

            // make sure the asset we are loading is of the same type as our class
            if ($type != $this->type()) {
                throw new Exception('Attribute type mismatch. Attribute ID '.$attributeid.' was created as a "'.$this->type().'" attribute but the database believes it is a "'.$type.'" attribute.');
                //$this->id = NULL;
                return;
            }

            $this->_params = ($parameters) ? unserialize($parameters) : Array();
            unset($result);

        }

        $this->value = $value;

        // now just make sure some default values are set
        foreach ($default_params as $name => $default) {
            if (!isset($this->_params[$name])) {
                $this->_params[$name] = $default;
            }
        }

    }//end constructor


    function &loadAttribute($attributeid=0, $value=NULL, $default_params=Array())
    {
        if ($attributeid == 0) {
            $empty_attr = new Asset_Attribute(0, $value, $default_params);
            return $empty_attr;
        }

        $db = DAL::getDb();

        $sql = 'SELECT type FROM sq_ast_attr
                    WHERE attrid = :attrid';
        try {
            $query = MatrixDAL::preparePdoQuery($sql);
            MatrixDAL::bindValueToPdo($query, 'attrid', $attributeid);
            $type = DAL::executePdoOne($query);
        } catch (Exception $e) {
            throw new Exception('Unable to load attribute ID #'.$attributeid.' due to database error: '.$e->getMessage());
        }

        $class = 'Asset_Attribute_'.$type;
        require_once SQ_ATTRIBUTES_PATH.'/'.$type.'/'.$type.'.inc';
        $attr = new $class($attributeid, $value, $default_params);

        return $attr;

    }//end loadAttribute()


    function type()
    {
        // strip the 'Asset_Attribute_' off the front
        // And lower-case it - PHP 5 uses the case the class was declared as
        return strtolower(substr(get_class($this), 16));

    }//end type()


    function paint($prefix, $read_only=FALSE)
    {
        echo translate('interface_not_created', ucwords(str_replace('_', ' ', $this->type())));

    }//end paint()


    function paintEditParams($prefix, $write_access=FALSE)
    {
        return TRUE;

    }//end paintEditParams()


    function processEditParams($prefix)
    {
        return TRUE;

    }//end processEditParams()


    function process($prefix)
    {
        $this->processed = FALSE;

    }//end process()


    function validateValue(&$value)
    {
        return TRUE;

    }//end validateValue()


    function setValue(&$value)
    {
        if (!$this->validateValue($value)) {
            trigger_localised_error('SYS0073', E_USER_WARNING, $value, $this->type());
            return FALSE;
        }
        $this->value = $value;
        return TRUE;

    }//end setValue()


    function setEditParams(&$node)
    {

        if (strtolower($node->getName()) != strtolower($this->type())) {
            trigger_localised_error('SYS0300', E_USER_WARNING, $node->getName(), $this->type(), '<pre>'.htmlspecialchars($node->asXml()).'</pre>');
            return FALSE;
        }
        return TRUE;

    }//end setEditParams()


    function setEditParam($field, $value)
    {
        if (isset($this->_edit_params[$field])) {
            $this->_edit_params[$field] = $value;
            return TRUE;
        } else {
            trigger_localised_error('SYS0258', E_USER_NOTICE, $field, $this->type());
            return FALSE;
        }

    }//end setEditParam()


    function setParam($field, $value)
    {
        if (isset($this->_params[$field])) {
            $this->_params[$field] = $value;
            return TRUE;
        } else {
            trigger_localised_error('SYS0258', E_USER_NOTICE, $field, $this->type());
            return FALSE;
        }

    }//end setParam()


    function getContent()
    {
        return $this->value;

    }//end getContent()


    function getKeywordValue($format='')
    {
        if ($format !== '') return ''; // no formats supported by default
        return $this->value;

    }//end getKeywordValue()


    function exportToXML()
    {
        $xml='';

        $tag_attributes  = 'name="'.$this->name.'" ';
        $tag_attributes .= 'id="'.$this->id.'" ';
        $tag_attributes .= 'uniq="'.$this->uniq.'" ';
        $tag_attributes .= 'description="'.$this->description.'" ';
        $tag_attributes .= 'default_value="'.$this->_default_value.'" ';
        $tag_attributes .= 'processed="'.$this->processed.'" ';
        $tag_attributes .= 'is_admin="'.$this->is_admin.'" ';

        $open_tag = '<'.$this->type().' '.$tag_attributes.'>';
        $close_tag = '</'.$this->type().'>';

        $contents = $this->exportContentsToXML();

        $xml = $open_tag.$contents.$close_tag;

        return $xml;

    }//end exportToXML()


    function exportContentsToXML()
    {
        $xml = '<value><![CDATA['.$this->getContent().']]></value>';
        return $xml;

    }//end exportContentsToXML()


}//end class

?>