base-object.inc.php

Go to the documentation of this file.

<?
//get our required stuff
require_once("lib/db.inc.php");

abstract class BaseObject extends MyModule
{
    public $tableName;

    private $dirtyFields = array();

    protected $data = array();

    public $creator;

    public $comments;

    public $commentsEnabled = false;
    
    public $useLatLng = false;

    public $useObjectCaching = false;

    public $useTags = false;

    public $tags;
    
    public $hasAuthor = true;

    private $internalId;

    public static $objectCacheLife = 3000000;
    
    public $fullTextFields = array();
    
    public $likeFields = array();
    
    public function __construct($data, $tableName)
    {
        //do our parent...
        parent::__construct();
        
        //set our table name...
        $this->tableName = $tableName;

        //check our fields.
        $this->checkTable();

        //omg noob... dont forget to load!
        $this->load($data);
            
        //do we want lat/lon?
        if ($this->useLatLng)
        {
            $this->fullTextFields[] = 'city';
            $this->fullTextFields[] = 'state';
        }
    }

    public function __destruct()
    {
    }

    public function __toString()
    {
        return $this->getName();
    }

    public function __get($name)
    {
        if ($name == 'id')
            return $this->internalId;
        else if ($this->hasField($name))
            return $this->data[$name];
        else
            return $this->$name;
    }

    public function __set($name, $value)
    {
        //if we got an id... we want to set the internal id... if its different
        if ($name == 'id')
        {
            if ($value != $this->internalId)
            {
                //save it and load.
                $this->internalId = $value;
                $this->__construct($value);
            }
        }
        //or do we have the field?
        else if ($this->hasField($name))
        {
            //only update it if they are different
            if ($this->data[$name] != $value || !isset($this->data['name']))
            {
                //mark it as dirty and save it.
                //WTF????  this is such a weird bug.  i dunno
                //why the fuck i have to do it, but without the
                //(string) cast it will cause the value to be
                //&UNKNOWN:0 via vardump, print_r segfaults,
                //and it totally fucks up everything. 
                $this->dirtyFields[$name] = (string)$name;
                $this->data[$name] = $value;
            }
        }
        //nope try and set it directly
        else
            $this->$name = $value;
    }

    protected function initEditPage($title = null, $data = null)
    {
        //create our object
        if ($data === null)
            $this->id = $this->params('id');
        else
            $this->data = $data;
        
        //set a pretty good default title.
        if ($title === null && $this->id)
            $this->pageTitle = 'Edit ' . ucfirst(strtolower($this->english)) . ' - ' . $this->__toString();
        else if ($this->pagetitle === null && !$this->id)
            $this->pageTitle = 'Add New ' . ucfirst(strtolower($this->english));
        else
            $this->pageTitle = $title;

        if (!$this->canEdit())
            throw new PageError("You do not have access to edit this $this->english.");

        if ($this->useTags)
            $this->tagFactory();
    }
        
    protected function initDeletePage($title = null)
    {
        //create our object
        $this->id = $this->params('id');
        
        //set a pretty good default title.
        if ($title === null)
            $title = 'Delete ' . ucfirst(strtolower($this->english));
        $this->pageTitle = $title;
            
        if (!$this->canDelete())
            throw new PageError("You are not authorized to delete this $this->english.");
    }

    protected function initViewPage($title = null)
    {
        //create our object
        $this->id = $this->params('id');

        //set a pretty good default title.
        if ($title === null)
            $this->pageTitle = $this->getName();
        else
            $this->pageTitle = $title;
        
        if (!$this->canView())
            throw new PageError("You do not have permission to view this $this->english.");
        
        if ($this->commentsEnabled)
        {
            $this->needsJs('lib/js/comment.js');
            $this->needsJs('lib/js/prototype-1.5.0.js');
        }
    }

    public function initJSONPage()
    {
        require_once("lib/json.inc.php");
        
        $this->initViewPage();

        $this->setTemplate(new BlankTemplate());
    }

    public function drawJSONPage()
    {
        echo JSON::encode($this->getPublicData());
    }
    
    public function initPHPPage()
    {
        $this->initViewPage();

        $this->setTemplate(new BlankTemplate());
    }

    public function drawPHPPage()
    {
        echo serialize($this->getPublicData());
    }
    
    public function initXMLPage()
    {
        $this->initViewPage();

        $this->setTemplate(new XMLTemplate());
    }

    public function drawXMLPage()
    {
        $options = array(
            "indent"         => "\t",
            "linebreak"      => "\n",
            "typeHints"      => false,
            "addDecl"        => false,
            "rootName" => get_class($this)
        );
        //setup our serializer
        $serial = new XML_Serializer($options);
        
        //serialize our data.
        $data = $this->getPublicData($this->params());
        if ($serial->serialize($data))
            echo $serial->getSerializedData();
    }

    public function getPublicData()
    {
        global $me;
        
        $data = array();

        if ($this->id)
        {
            $data['id'] = $this->id;

            if ($this->hasAuthor && $this->creator instanceOf BaseUser)
            {
                $data['user_id'] = $this->user_id;
                $data['username'] = $this->creator->getName();
            }
            if ($this->hasField('content_id'))
                $data['content_id'] = $this->content_id;
            if ($this->hasField('parent_id'))
                $data['parent_id'] = $this->parent_id;
            if ($this->hasField('add_date'))
                $data['add_date'] = $me->formatDateTime($this->add_date);
            if ($this->hasField('edit_date'))
                $data['edit_date'] = $me->formatDateTime($this->edit_date);
            if ($this->useLatLng)
            {
                $data['lat'] = $this->lat;
                $data['lon'] = $this->lon;
            }

            if ($this->hasField('comment_count'))
                $data['comment_count'] = $this->comment_count;

            if ($this->canView())
                $data['viewLink'] = $this->getUrl(".view?id=$this->id", null, true);
            
            if ($this->canEdit())
                $data['editLink'] = $this->getUrl(".edit?id=$this->id", null, true);
            
            if ($this->canDelete())
                $data['deleteLink'] = $this->getUrl(".delete?id=$this->id", null, true);
        }
        else
            $data['error'] = "That $this->english doesn't exist.";

        return $data;
    }

    public function getRssItem()
    {
        $item = new FeedItem();
        $item->title = 'Error';
        $item->description = 'You must define ' . get_class($this) . "::getRssItem() to enable rss support. Generally all you have to set are title and description.";
        $item->link = $this->getUrl(".view?id=$this->id", null, true);
        $item->date = strtotime($this->edit_date);
        $item->source = "http://" . Config::get('site_hostname');
        $item->descriptionHtmlSyndicated = true;

        //author?
        if ($this->hasAuthor)
        {
            $item->author = $this->creator->getName();
        }

        return $item;
    }

    public function load($data, $deep = true)
    {
        //did we get an array of data to set?
        if (is_array($data))
            $this->setDataFromCache($data, $deep);
        //nope, maybe its an id for the database...
        else if ($data)
            $this->loadData($data, $deep);
    }

    protected function loadData($id, $deep = true)
    {
        //do we have an id?
        if ($id)
        {
            //set our id first.
            $this->internalId = $id;
            
            //try our cache.. if it works, then we're good.
            if (!$this->loadCacheData($deep))
            {
                $this->lookupData($deep);

                if ($deep && $this->useObjectCaching)
                    $this->setCache();
            }
        }
        
        //create our thread.
        if ($this->commentsEnabled)
            $this->threadFactory();

        //create our tags.
        if ($this->useTags)
            $this->tagFactory();
    }

    protected function lookupData($deep = true)
    {
        //nope, load it normally.
        $data = $this->getData(true);
        if (count($data) && is_array($data))
            foreach ($data AS $key => $val)
                if ($key != 'id')
                    $this->data[$key] = $val;
        
        //what about our creator?
        if ($deep)
        {
            if ($this->hasAuthor)
            {
                $this->creator = new User();
                $this->creator->load($this->user_id, false);
            }
        }
    }

    protected function loadCacheData($deep = true)
    {
        //is it enabled?
        if ($this->useObjectCaching)
        {
            //get our cache data... is it there?
            $data = $this->getCache();
            if ($data)
            {
                //load it, and we're good.
                $this->load($data, $deep);
                return true;
            }
        }

        return false;
    }

    public function threadFactory()
    {
        $threadClass = get_class($this) . "Thread"; 
        
        if (class_exists($threadClass))
            $this->comments = new $threadClass($this->id);
    }
    
    public function tagFactory()
    {
        $tagClass = get_class($this) . "Tags"; 
        
        if (class_exists($tagClass))
            $this->tags = new $tagClass($this->id);
    }
        
    public function addPrivacyField()
    {
    }
    
    public function save()
    {
        //we should do any cleanup if possible
        if ($this->isDirty())
            $this->clean();

        //get our comment count
        $this->lookupCommentCount();
    
        //save it to wherever
        $data = $this->saveData();

        //save our cache.
        if ($this->useObjectCaching)
            $this->deleteCache();

        //delete our cached view page.
        self::deleteCachedPage('/' . strtolower(get_class($this)) . "/view/id/$this->id");
        
        return $data;
    }

    public function lookupCommentCount()
    {
        //update our comment count.
        if ($this->commentsEnabled && $this->hasField('comment_count') && $this->comments instanceOf BaseThread)
            $this->comment_count = $this->comments->searchCount(array(
                'content_id' => $this->id
            ), false);
        
        return $this->comment_count;
    }

    public function clean()
    {
        foreach ($this->dirtyFields AS $field)
            $this->cleanField($field);
    }

    public function cleanField($field)
    {
        //by default... we dont clean anything
    }

    public function isDirty()
    {
        return (bool)count($this->dirtyFields);
    }

    public function delete()
    {
        //if we're using comments... delete them!
        if ($this->commentsEnabled && $this->comments instanceOf BaseThread)
            $this->comments->delete();
        
        //if we're using comments... delete them!
        if ($this->useTags && $this->tags instanceOf BaseTags)
            $this->tags->delete();
        
        //delete our cache.
        if ($this->useObjectCaching)
            $this->deleteCache();
        
        //delete our cached view page.
        self::deleteCachedPage('/' + strtolower(get_class($this)) . "/view/id/$this->id");

        return $this->deleteDb();
    }

    public function drawEditPage()
    {
        $this->editPageLogic();
    }

    function lookupLatLon()
    {
        $geo = new Geocode();
        
        //get our data
        $csz['city'] = $this->city;
        $csz['state'] = $this->state;
        $csz['zip'] = $this->zip;
        $csz['street'] = $this->street;
        
        //do a search
        $result = $geo->search($csz);
        if ($result)
        {
            $this->lat = $result['lat'];
            $this->lon = $result['lon'];

            if (!$this->city)
                $this->city = $result['city'];
            if (!$this->state)
                $this->state = $result['state'];
            if (!$this->zip)
                $this->zip = $result['zip'];
        }
    }
    
    public function drawViewPage($ignore = array())
    {
        //loop thru and print the non ignored ones
        echo "<table width=\"100%\">\n";
        if (count($this->data))
        {
            foreach ($this->data AS $key => $val)
            {
                if (!in_array($key, $ignore))
                    echo "\t<tr>\n\t\t<td>$key</td>\n\t\t<td>$val</td>\n\t</tr>\n";
            }
        }
        echo "</table>\n";
    }

    public function drawDeletePage($preText = null, $button = null, $postText = null, $isUrl = true)
    {
        if (!isset($_POST['submit']))
            $this->deleteForm($preText, $button);
        else
            $this->deletePost($postText, $isUrl);
    }

    function canEdit()
    {
        global $me;
        
        //if its a real item, they must be the owner or admin.
        if (($this->user_id == $me->id && $me->id) || $me->isAdmin())
            return true;
        //otherwise, its a new one and they just have to be logged in.
        else if (!$this->id && $me->id)
            return true;
        else
            return false;
    }

    function canDelete()
    {
        global $me;
        
        if (($this->user_id == $me->id && $me->id) || $me->isAdmin() && $this->id)
            return true;
        else
            return false;
    }
    
    function drawHeaderRow()
    { 

    }
    
    function getName($link = false, $text = '')
    {
        $text = trim($text);
        if (!$text)
            $text = '???';

        if ($link)
            return $this->getLink(".view?id=$this->id", $text);
        return $text;
    }

    function drawRow()
    {
        echo "<h3>" . $this->getName(true) . "</h3>";
        echo "<p>By: ";
        echo $this->creator->getName(true) . "<br/>"; 
        echo Time::formatRelative($this->add_date) . "<br/>";
        
        if ($this->commentsEnabled)
            echo $this->getCommentsLink($this->id);
        "</p>\n";
    }

    public function getAutoCompleteRow()
    {
        return "<li>" . $this->getName() . "</li>";
    }

    public function getCommentsLink()
    {
        return $this->getLink(".view?id=$this->id#comments", Util::pluralize('comment', $this->comment_count, true));
    }

    function drawHeaderLine()
    {
    }

    function drawLine()
    {
    }

    function drawPostedOwner()
    {
        global $me;
    
        echo "<h3>Created: " . Util::formatTimeRelative($this->add_date) . " by " . $this->creator->getName(true) . "</h3>\n";
        if ($this->add_date != $this->edit_date)
            echo "<h4>Last updated: " . Util::formatTimeRelative($this->edit_date) . "</h4>\n";
    }
    
    public function getPagesXml()
    {
        $xml = parent::getPagesXml();

        $xml .= $this->getEditPageXml();
        $xml .= $this->getViewPageXml();
        $xml .= $this->getDeletePageXml();
        $xml .= $this->getJSONPageXml();
        $xml .= $this->getPHPPageXml();
        $xml .= $this->getXMLPageXml();

        return $xml;
    }

    protected function getViewPageXml()
    {
        return <<<XML
            <page name="view" type="content" desc="view a content">
                <param name="id" desc="id of the content" required="1" type="int"/>
            </page>
XML;
    }
    
    protected function getDeletePageXml()
    {
        return <<<XML
            <page name="delete" type="content" desc="delete an object">
                <param name="id" required="1" desc="the id of the module" type="int"/>
            </page>
XML;
    }

    protected function getJSONPageXml()
    {
        return <<<XML
            <page name="json" desc="fetch the json representation of this object">
                <param name="id" desc="id of the content" required="1" type="int"/>
            </page>
XML;
    }

    protected function getPHPPageXml()
    {
        return <<<XML
            <page name="php" desc="fetch the php serialize() representation of this object">
                <param name="id" desc="id of the content" required="1" type="int"/>
            </page>
XML;
    }
    
    protected function getXMLPageXml()
    {
        return <<<XML
            <page name="xml" desc="fetch the XML representation of this object">
                <param name="id" desc="id of the content" required="1" type="int"/>
            </page>
XML;
    }
    
    protected function getEditPageXml()
    {
        $var =  "\n\t<page name=\"edit\" desc=\"create or edit a(n) $this->english\">\n";
        $var .= "\t\t<param name=\"id\" desc=\"the id of the $this->english.  if not supplied, a new record will be created.\" type=\"int\"/>\n";
        $var .= $this->getEditPageParamXml();
        $var .= "\n\t</page>\n";
        
        return $var;
    }

    protected function getEditPageParamXml()
    {
        $var = '';
    
    /*
        this never even really comes into play.... we need to make it someday

        foreach ($this->getDbFields(array(
            'id', 'user_id', 'add_date', 'edit_date', 'privacy', 'status', 'parent_id'
        )) AS $key => $val)
            $var .= "\t\t<param name=\"$key\" />\n";
    */

        return $var;
    }

    public function canView()
    {
        //you cant view a blank content
        if (!$this->id)
            return false;
        return true;
    }

    protected function getData($useDb = true)
    {
        if ($useDb)
            return $this->getDbData();
        else
        {
            $data = $this->data;
            $data['id'] = $this->id;

            return $data;
        }
    }

    //equivalent object members to that (if they exist)
    public function setData($data, $ignore = null)
    {
        //make sure we have an array here =)
        if (is_array($data))
        {
            if (!is_array($ignore))
                $ignore = array($ignore);

            //okay loop thur our data...
            foreach ($data AS $key => $val)
            {
                //if we ignore it... continue
                if (in_array($key, $ignore))
                    continue;

                //make sure this key exists for us....
                if ($key === 'id')
                    $this->internalId = (int)$val;
                else if ($this->hasField($key))
                    $this->data[$key] = $val;
            }
            
            return true;
        }
        else
            return false;

    }

    protected function saveData()
    {
        return $this->saveDb();
    }

    private function getDbData()
    {
        //make sure we have an id....
        if ($this->id)
        {
            $result = dbFetchAssoc(dbQuery("
                SELECT *
                FROM $this->tableName
                WHERE id = '$this->id'
            "));

            if (is_array($result))
                return $result;
        }
        
        return false;
    }

    private function saveDb()
    {
        //format our sql statements w/ the valid fields
        $fields = array();
        $columns = $this->getDbFields();
        
        //loop thru all our dirty fields.
        foreach ($this->dirtyFields AS $key)
        {
            //get our value.
            if ($columns[$key] && isset($this->data[$key]) && $key != 'id')
            {
                $val = $this->data[$key];

                //slashes replacement..
                $val = str_replace("\\\\", "\\", $val);
                $val = str_replace("\'", "'", $val);
                $val = str_replace("\\\"", "\"", $val);

                //add it if we have it...
                $fields[] = "`$key` = '" . addslashes($val) . "'";
            }
        }
        
        //update if we have an id....
        if (count($fields))
        {
            //now make our array
            $sqlFields = implode(",\n", $fields) . "\n";
            
            //update it?
            if ($this->id)
            {
                $sql  = "UPDATE $this->tableName SET\n";
                $sql .= $sqlFields;
                $sql .= "WHERE id = '$this->id'\n";
                $sql .= "LIMIT 1";

                dbExecute($sql);
            }
            //otherwise insert it...
            else
            {
                $sql  = "INSERT INTO $this->tableName SET\n";
                $sql .= $sqlFields;

                $this->id = dbExecute($sql, true);
            }
        }
    }

    private function deleteDb()
    {
        //do we have an id?
        if ($this->id)
        {
            dbExecute("
                DELETE FROM $this->tableName
                WHERE id = '$this->id'
            ");

            return true;
        }
        return false;
    }

    protected function editFormInit()
    {
        //create our form.
        $form = $this->editFormCreate();
        
        //add our fields
        $this->editFormAddFields($form);

        return $form;
    }

    protected function editFormCreate()
    {
        //obviously start the form
        $form = new Form();
        $form->action = $this->getUrl(".edit?id=$this->id");
    
        return $form;
    }
    
    protected function editFormAddFields($form)
    {
    }

    protected function editPageLogic()
    {
        //do we have a form?
        $form = $this->editFormInit();
        
        //first we want to check if its submitted 
        if ($form->isSubmitted())
        {
            //validate our form.
            $this->editFormValidate($form);
            
            //then send it off to the handler
            if (!$form->hasError())
            {
                //send them to success...
                $this->editPagePostSaveSync($form);
                $this->editPagePostSuccess($form);
            }
        }
        //no submit... load our initial data...
        else
            $this->editFormLoad($form);
        
        //finally draw the form if needed
        if ($form->needsDrawn())
            $this->editFormDraw($form);
    }

    protected function editFormValidate($form)
    {
        //do our validation
        $form->validate();
    }

    protected function editFormLoad($form)
    {
        if (!$form->isSubmitted())
            $form->setData($this->data);
    }

    public function loadDirtyData($data)
    {
        //load our data back from the form...
        $columns = $this->getDbFields();
        foreach ($columns AS $key => $val)
        {
            //if we got it... load it.
            if (array_key_exists($key, $data))
                $this->$key = $data[$key];
        }
    }

    public function getDbFields()
    {
        return BaseJumper::getDbTable($this->tableName);
    }

    protected function editPagePostSaveSync($form)
    {
        global $me;
        
        //load our data back from the form...
        $columns = $this->getDbFields();
        foreach ($columns AS $key => $data)
        {
            if (!$this->id && $key == 'add_date')
                $this->$key = date('Y-m-d H:i:s');
            else if ($key == 'edit_date')
                $this->$key = date('Y-m-d H:i:s');
            else if ($key == 'user_id' && !$this->id)
                    $this->$key = $me->id;
            else if ($form->hasField($key))
                $this->$key = $form->getData($key);
        }
        
        //has zip?
        if ($form->hasField('citystzip') && $this->hasField('city') && $this->hasField('state') && $this->hasField('zip'))
        {
            $csz = $form->getData('citystzip');
            $this->city = $csz['city'];
            $this->state = $csz['state'];
            $this->zip = $csz['zip'];
        }

        //do we do location lookup?
        if ($this->useLatLng)
            $this->lookupLatLon();

        //save the info
        $this->save();

        //save our tags..
        if ($this->useTags)
            $this->tags->updateTagsForm($form);
    }

    protected function editPagePostSuccess($form)
    {
        Util::redirect($this->getUrl(".view?id=$this->id"));
    }

    protected function editFormDraw($form)
    {
        $form->drawAll();
    }

    protected function deleteForm($body = null, $button = null)
    {
        //set a default string
        if ($body === null)
            $body = "Are you sure you want to delete this $this->english?";

        if ($button === null)
            $button = 'Delete ' . ucfirst($this->english);
                
        echo "<form method=\"POST\" action=\"$_SERVER[REQUEST_URI]\">\n";
        echo "<input type=\"hidden\" name=\"submit\" value=\"1\">\n";
        echo "<table>";
        echo "<tr><td>$body</td></tr>\n";
        echo "<tr><td align=\"center\"><input type=\"submit\" value=\"$button\"></td></tr>\n";
        echo "</table>";
        echo "</form>";
    }

    protected function deletePost($body = null, $isUrl = true)
    {
        $this->delete();
        
        if ($isUrl)
        {
            if ($body === null)
                Util::redirect($this->baseUrl);
            else
                Util::redirect($body);
        }
        else
            echo $body;
    }

    public function checkTable($skip = array())
    {
        if (!BaseJumper::dbHasTable($this->tableName))
            $this->addStatus(
                "Oops, table <b>$this->tableName</b> doesn't exist.  You may
                want to visit the " .  $this->getLink(".createtable", "create
                table") . " page to create it.<br/>Until then, the <b>" .
                get_class($this) . "</b> module may not work correctly."
            );
    }

    public function isAdmin()
    {
        global $me;
        return $me->isAdmin();
    }
    
    public function hasField($key)
    {
        if ($this->tableName)
            return BaseJumper::tableHasField($this->tableName, $key);
    
        return false;
    }

    public function getCreateTableSql()
    {
        $fields = implode(",\n", $this->getCreateFieldsArray());
        $indexes = implode(",\n", $this->getCreateIndexesArray());

        //add in our fulltext index.
        if (count($this->fullTextFields))
            $indexes .= ",\n FULLTEXT(" . implode(",", $this->fullTextFields) . ")";
        
        return "CREATE TABLE IF NOT EXISTS $this->tableName\n(\n$fields,\n$indexes\n);";
    }

    public function getCreateFieldsArray()
    {
        $fields = array(
            "id" => "id INT(11) not null auto_increment",
            "add_date" => "add_date datetime not null",
            "edit_date" => "edit_date datetime not null"
        );
            
        if ($this->hasAuthor)
            $fields['user_id'] = "user_id INT(11) default 0 not null";
        
        if ($this->useLatLng)
        {
            $fields['lat'] = "lat double default 0 not null";
            $fields['lon'] = "lon double default 0 not null";
            $fields['street'] = "street varchar(255) default '' not null";
            $fields['city'] = "city varchar(128) default '' not null";
            $fields['state'] = "state char(2) default '' not null";
            $fields['zip'] = "zip char(5) default '' not null";
        }

        if ($this->commentsEnabled)
            $fields['comment_count'] = "comment_count INT(11) default 0 not null";

        return $fields;
    }

    public function getCreateIndexesArray()
    {
        $fields = array();
        $fields['id'] = "PRIMARY KEY (id)";
        $fields['add_date'] = "KEY (add_date)";
        $fields['edit_date'] = "KEY (edit_date)";
        
        if ($this->hasAuthor)
            $fields['user_id'] = "KEY (user_id)";

        if ($this->useLatLng)
            $fields['latlon'] = "KEY (lat, lon)";
        
        return $fields;
    }

    public function getCacheKey($id = null)
    {
        if ($id === null)
            $id = $this->id;

        return "BaseJumper:object:" . get_class($this) . ":" . $id;
    }

    protected function getDataToCache($deep = true)
    {
        $data = array();
    
        //obviously we want our data.
        $data['id'] = $this->id;
        $data['data'] = $this->data;

/*      //save our comments object..
        if ($this->commentsEnabled)
        {
            $this->threadFactory();
            $data['comments'] = $this->comments;
        }
        
        //what about tags?
        if ($this->useTags)
        {
            $this->tagFactory();
            $data['tags'] = $this->tags;
        }
*/
        if ($deep)
        {
            if ($this->hasAuthor && $this->creator instanceOf BaseUser)
                $data['creator'] = $this->creator->getDataToCache(false);
        }

        return $data;
    }

    protected function setDataFromCache($data, $deep = true)
    {
        if (is_array($data))
        {
            //get our id back
            $this->internalId = $data['id'];

            //obviously we want to load our data.
            $this->data = $data['data'];
        
/*          //save our comments object..
            if ($this->commentsEnabled)
                $this->comments = $data['comments'];
            
            //what about tags?
            if ($this->useTags)
                $this->tags = $data['tags'];
*/

            //do we set deep data?
            if ($deep)
            {
                if ($this->hasAuthor)
                {
                    $this->creator = new User();
                    $this->creator->load($data['creator'], false);
                }
            }
        }
    }

    public function getCache()
    {
        return CacheBot::get($this->getCacheKey(), self::$objectCacheLife);
    }

    public function setCache()
    {
        return CacheBot::set($this->getCacheKey(), $this->getDataToCache(), self::$objectCacheLife);
    }

    public function deleteCache()
    {
        return CacheBot::delete($this->getCacheKey());
    }
}
?>

---