engine/lib/objects.php

Go to the documentation of this file.

<?php

    class ElggObject extends ElggEntity
    {
        protected function initialise_attributes()
        {
            parent::initialise_attributes();
            
            $this->attributes['type'] = "object";
            $this->attributes['title'] = "";
            $this->attributes['description'] = "";
            $this->attributes['tables_split'] = 2;
        }
                
        function __construct($guid = null) 
        {           
            $this->initialise_attributes();
            
            if (!empty($guid))
            {
                // Is $guid is a DB row - either a entity row, or a object table row.
                if ($guid instanceof stdClass) {                    
                    // Load the rest
                    if (!$this->load($guid->guid))
                        throw new IOException(sprintf(elgg_echo('IOException:FailedToLoadGUID'), get_class(), $guid->guid)); 
                }
                
                // Is $guid is an ElggObject? Use a copy constructor
                else if ($guid instanceof ElggObject)
                {                   
                     foreach ($guid->attributes as $key => $value) 
                        $this->attributes[$key] = $value;
                }
                
                // Is this is an ElggEntity but not an ElggObject = ERROR!
                else if ($guid instanceof ElggEntity)
                    throw new InvalidParameterException(elgg_echo('InvalidParameterException:NonElggObject'));
                                        
                // We assume if we have got this far, $guid is an int
                else if (is_numeric($guid)) {                   
                    if (!$this->load($guid)) IOException(sprintf(elgg_echo('IOException:FailedToLoadGUID'), get_class(), $guid));
                }
                
                else
                    throw new InvalidParameterException(elgg_echo('InvalidParameterException:UnrecognisedValue'));
            }
        }
        
        protected function load($guid)
        {           
            // Test to see if we have the generic stuff
            if (!parent::load($guid)) 
                return false;

            // Check the type
            if ($this->attributes['type']!='object')
                throw new InvalidClassException(sprintf(elgg_echo('InvalidClassException:NotValidElggStar'), $guid, get_class()));
                
            // Load missing data
            $row = get_object_entity_as_row($guid);
            if (($row) && (!$this->isFullyLoaded())) $this->attributes['tables_loaded'] ++; // If $row isn't a cached copy then increment the counter
                        
            // Now put these into the attributes array as core values
            $objarray = (array) $row;
            foreach($objarray as $key => $value) 
                $this->attributes[$key] = $value;
        
            return true;
        }
        
        public function save()
        {
            // Save generic stuff
            if (!parent::save())
                return false;
            
            // Now save specific stuff
            return create_object_entity($this->get('guid'), $this->get('title'), $this->get('description'), $this->get('container_guid'));
        }
        
        function getSites($subtype="", $limit = 10, $offset = 0) {
            return get_site_objects($this->getGUID(), $subtype, $limit, $offset);
        }
        
        function addToSite($site_guid) {
            return add_site_object($this->getGUID(), $site_guid); 
        }

        function setContainer($container_guid)
        {
            $container_guid = (int)$container_guid;
            
            return $this->set('container_guid', $container_guid);
        }
        
        function getContainer()
        {
            return $this->get('container_guid');
        }
        
        function getContainerEntity()
        {
            $result = get_entity($this->getContainer());
            
            if (($result) && ($result instanceof ElggGroup))
                return $result;
                
            return false;
        }
        
        //public function getCollections($subtype="", $limit = 10, $offset = 0) { get_object_collections($this->getGUID(), $subtype, $limit, $offset); }
        
        // EXPORTABLE INTERFACE ////////////////////////////////////////////////////////////
        
        public function getExportableValues()
        {
            return array_merge(parent::getExportableValues(), array(
                'title',
                'description',
            ));
        }
    }

    function get_object_entity_as_row($guid)
    {
        global $CONFIG;
        
        $guid = (int)$guid;
        
        /*$row = retrieve_cached_entity_row($guid);
        if ($row)
        {
            // We have already cached this object, so retrieve its value from the cache
            if (isset($CONFIG->debug) && $CONFIG->debug)
                error_log("** Retrieving sub part of GUID:$guid from cache");
                
            return $row;
        }
        else
        {*/
            // Object not cached, load it.
            if ($CONFIG->debug)
                error_log("** Sub part of GUID:$guid loaded from DB");
        
            return get_data_row("SELECT * from {$CONFIG->dbprefix}objects_entity where guid=$guid");
        //}
    }
    
    function create_object_entity($guid, $title, $description)
    {
        global $CONFIG;
        
        $guid = (int)$guid;
        $title = sanitise_string($title);
        $description = sanitise_string($description);
        
        $row = get_entity_as_row($guid);
        
        if ($row)
        {
            // Core entities row exists and we have access to it
            if ($exists = get_data_row("SELECT guid from {$CONFIG->dbprefix}objects_entity where guid = {$guid}")) {
                $result = update_data("UPDATE {$CONFIG->dbprefix}objects_entity set title='$title', description='$description' where guid=$guid");
                if ($result!=false)
                {
                    // Update succeeded, continue
                    $entity = get_entity($guid);
                    if (trigger_elgg_event('update',$entity->type,$entity)) {
                        return $guid;
                    } else {
                        $entity->delete();
                    }
                }
            }
            else
            {
                
                // Update failed, attempt an insert.
                $result = insert_data("INSERT into {$CONFIG->dbprefix}objects_entity (guid, title, description) values ($guid, '$title','$description')");
                if ($result!==false) {
                    $entity = get_entity($guid);
                    if (trigger_elgg_event('create',$entity->type,$entity)) {
                        return $guid;
                    } else {
                        $entity->delete();
                        //delete_entity($guid);
                    }
                }
            }
            
        }
        
        return false;
    }
    
    function delete_object_entity($guid)
    {
        system_message(sprintf(elgg_echo('deprecatedfunction'), 'delete_user_entity'));
        
        return 1; // Always return that we have deleted one row in order to not break existing code.
    }
    
    function search_for_object($criteria, $limit = 10, $offset = 0, $order_by = "", $count = false)
    {
        global $CONFIG;
        
        $criteria = sanitise_string($criteria);
        $limit = (int)$limit;
        $offset = (int)$offset;
        $order_by = sanitise_string($order_by);
        $container_guid = (int)$container_guid;
        
        $access = get_access_sql_suffix("e");
        
        if ($order_by == "") $order_by = "e.time_created desc";
        
        if ($count) {
            $query = "SELECT count(e.guid) as total ";
        } else {
            $query = "SELECT e.* "; 
        }
        $query .= "from {$CONFIG->dbprefix}entities e join {$CONFIG->dbprefix}objects_entity o on e.guid=o.guid where match(o.title,o.description) against ('$criteria') and $access";
        
        if (!$count) {
            $query .= " order by $order_by limit $offset, $limit"; // Add order and limit
            return get_data($query, "entity_row_to_elggstar");
        } else {
            if ($count = get_data_row($query)) {
                return $count->total;
            }
        }
        return false;
    }

    function get_object_sites($object_guid, $limit = 10, $offset = 0) {
        $object_guid = (int)$object_guid;
        $limit = (int)$limit;
        $offset = (int)$offset;
        
        return get_entities_from_relationship("member_of_site", $object_guid, false, "site", "", 0, "time_created desc", $limit, $offset);
    }
        
?>

---