123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288 |
- <?php
- /**
- * Elgg Object
- *
- * Elgg objects are the most common means of storing information in the database.
- * They are a child class of \ElggEntity, so receive all the benefits of the Entities,
- * but also include a title and description field.
- *
- * An \ElggObject represents a row from the objects_entity table, as well
- * as the related row in the entities table as represented by the parent
- * \ElggEntity object.
- *
- * @note Internal: Title and description are stored in the objects_entity table.
- *
- * @package Elgg.Core
- * @subpackage DataModel.Object
- *
- * @property string $title The title, name, or summary of this object
- * @property string $description The body, description, or content of the object
- * @property array $tags Tags that describe the object (metadata)
- */
- class ElggObject extends \ElggEntity {
- /**
- * Initialize the attributes array to include the type,
- * title, and description.
- *
- * @return void
- */
- protected function initializeAttributes() {
- parent::initializeAttributes();
- $this->attributes['type'] = "object";
- $this->attributes += self::getExternalAttributes();
- $this->tables_split = 2;
- }
- /**
- * Get default values for attributes stored in a separate table
- *
- * @return array
- * @access private
- *
- * @see \Elgg\Database\EntityTable::getEntities
- */
- final public static function getExternalAttributes() {
- return [
- 'title' => null,
- 'description' => null,
- ];
- }
- /**
- * Create a new \ElggObject.
- *
- * Plugin developers should only use the constructor to create a new entity.
- * To retrieve entities, use get_entity() and the elgg_get_entities* functions.
- *
- * If no arguments are passed, it creates a new entity.
- * If a database result is passed as a \stdClass instance, it instantiates
- * that entity.
- *
- * @param \stdClass $row Database row result. Default is null to create a new object.
- *
- * @throws IOException If cannot load remaining data from db
- * @throws InvalidParameterException If not passed a db row result
- */
- public function __construct($row = null) {
- $this->initializeAttributes();
- // compatibility for 1.7 api.
- $this->initialise_attributes(false);
- if (!empty($row)) {
- // Is $row is a DB row from the entity table
- if ($row instanceof \stdClass) {
- // Load the rest
- if (!$this->load($row)) {
- $msg = "Failed to load new " . get_class() . " for GUID: " . $row->guid;
- throw new \IOException($msg);
- }
- } else if ($row instanceof \ElggObject) {
- // $row is an \ElggObject so this is a copy constructor
- elgg_deprecated_notice('This type of usage of the \ElggObject constructor was deprecated. Please use the clone method.', 1.7);
- foreach ($row->attributes as $key => $value) {
- $this->attributes[$key] = $value;
- }
- } else if (is_numeric($row)) {
- // $row is a GUID so load
- elgg_deprecated_notice('Passing a GUID to constructor is deprecated. Use get_entity()', 1.9);
- if (!$this->load($row)) {
- throw new \IOException("Failed to load new " . get_class() . " from GUID:" . $row);
- }
- } else {
- throw new \InvalidParameterException("Unrecognized value passed to constuctor.");
- }
- }
- }
- /**
- * Loads the full \ElggObject when given a guid.
- *
- * @param mixed $guid GUID of an \ElggObject or the \stdClass object from entities table
- *
- * @return bool
- * @throws InvalidClassException
- */
- protected function load($guid) {
- $attr_loader = new \Elgg\AttributeLoader(get_class(), 'object', $this->attributes);
- $attr_loader->requires_access_control = !($this instanceof \ElggPlugin);
- $attr_loader->secondary_loader = 'get_object_entity_as_row';
- $attrs = $attr_loader->getRequiredAttributes($guid);
- if (!$attrs) {
- return false;
- }
- $this->attributes = $attrs;
- $this->tables_loaded = 2;
- $this->loadAdditionalSelectValues($attr_loader->getAdditionalSelectValues());
- _elgg_cache_entity($this);
- return true;
- }
- /**
- * {@inheritdoc}
- */
- protected function create() {
- global $CONFIG;
- $guid = parent::create();
- if (!$guid) {
- // @todo this probably means permission to create entity was denied
- // Is returning false the correct thing to do
- return false;
- }
- $title = sanitize_string($this->title);
- $description = sanitize_string($this->description);
-
- $query = "INSERT into {$CONFIG->dbprefix}objects_entity
- (guid, title, description) values ($guid, '$title', '$description')";
- $result = $this->getDatabase()->insertData($query);
- if ($result === false) {
- // TODO(evan): Throw an exception here?
- return false;
- }
-
- return $guid;
- }
- /**
- * {@inheritdoc}
- */
- protected function update() {
- global $CONFIG;
- if (!parent::update()) {
- return false;
- }
-
- $guid = (int)$this->guid;
- $title = sanitize_string($this->title);
- $description = sanitize_string($this->description);
- $query = "UPDATE {$CONFIG->dbprefix}objects_entity
- set title='$title', description='$description' where guid=$guid";
- return $this->getDatabase()->updateData($query) !== false;
- }
- /**
- * {@inheritdoc}
- */
- public function getDisplayName() {
- return $this->title;
- }
- /**
- * {@inheritdoc}
- */
- public function setDisplayName($displayName) {
- $this->title = $displayName;
- }
- /**
- * Return sites that this object is a member of
- *
- * Site membership is determined by relationships and not site_guid.
- *
- * @todo Moved to \ElggEntity so remove this in 2.0
- *
- * @param array $options Options array. Used to be $subtype
- * @param int $limit The number of results to return (deprecated)
- * @param int $offset Any indexing offset (deprecated)
- *
- * @return array
- */
- public function getSites($options = "", $limit = 10, $offset = 0) {
- if (is_string($options)) {
- elgg_deprecated_notice('\ElggObject::getSites() takes an options array', 1.9);
- return get_site_objects($this->getGUID(), $options, $limit, $offset);
- }
- return parent::getSites();
- }
- /**
- * Add this object to a site
- *
- * @param \ElggSite $site The site to add this object to. This used to be the
- * the site guid (still supported by deprecated)
- * @return bool
- */
- public function addToSite($site) {
- if (is_numeric($site)) {
- elgg_deprecated_notice('\ElggObject::addToSite() takes a site entity', 1.9);
- return add_site_object($site, $this->getGUID());
- }
- return parent::addToSite($site);
- }
- /**
- * {@inheritdoc}
- */
- protected function prepareObject($object) {
- $object = parent::prepareObject($object);
- $object->title = $this->getDisplayName();
- $object->description = $this->description;
- $object->tags = $this->tags ? $this->tags : array();
- return $object;
- }
- /*
- * EXPORTABLE INTERFACE
- */
- /**
- * Return an array of fields which can be exported.
- *
- * @return array
- * @deprecated 1.9 Use toObject()
- */
- public function getExportableValues() {
- return array_merge(parent::getExportableValues(), array(
- 'title',
- 'description',
- ));
- }
- /**
- * Can a user comment on this object?
- *
- * @see \ElggEntity::canComment()
- *
- * @param int $user_guid User guid (default is logged in user)
- * @return bool
- * @since 1.8.0
- */
- public function canComment($user_guid = 0) {
- $result = parent::canComment($user_guid);
- if ($result !== null) {
- return $result;
- }
- if ($user_guid == 0) {
- $user_guid = _elgg_services()->session->getLoggedInUserGuid();
- }
- // must be logged in to comment
- if (!$user_guid) {
- return false;
- }
- // must be member of group
- if (elgg_instanceof($this->getContainerEntity(), 'group')) {
- if (!$this->getContainerEntity()->canWriteToContainer($user_guid)) {
- return false;
- }
- }
- // no checks on read access since a user cannot see entities outside his access
- return true;
- }
- }
|