Elgg / Elgg

engine/classes/ElggSite.php

Indentation +260 added lines, -260 removed lines

@@ -27,272 +27,272 @@
  */
 class ElggSite extends \ElggEntity {
 
-	/**
-	 * Initialize the attributes array.
-	 * This is vital to distinguish between metadata and base attributes.
-	 *
-	 * @return void
-	 */
-	protected function initializeAttributes() {
-		parent::initializeAttributes();
-
-		$this->attributes['type'] = "site";
-		$this->attributes += self::getExternalAttributes();
-	}
-
-	/**
-	 * 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 [
-			'name' => null,
-			'description' => null,
-			'url' => null,
-		];
-	}
-
-	/**
-	 * Create a new \ElggSite.
-	 *
-	 * Plugin developers should only use the constructor to create a new entity.
-	 * To retrieve entities, use get_entity() and the elgg_get_entities* functions.
-	 *
-	 * @param \stdClass $row Database row result. Default is null to create a new site.
-	 *
-	 * @throws IOException If cannot load remaining data from db
-	 * @throws InvalidParameterException If not passed a db result
-	 */
-	public function __construct(\stdClass $row = null) {
-		$this->initializeAttributes();
-
-		if ($row) {
-			// Load the rest
-			if (!$this->load($row)) {
-				$msg = "Failed to load new " . get_class() . " for GUID:" . $row->guid;
-				throw new \IOException($msg);
-			}
-		}
-	}
-
-	/**
-	 * {@inheritdoc}
-	 */
-	public function save() {
-		$db = $this->getDatabase();
-		$row = $db->getDataRow("
+    /**
+     * Initialize the attributes array.
+     * This is vital to distinguish between metadata and base attributes.
+     *
+     * @return void
+     */
+    protected function initializeAttributes() {
+        parent::initializeAttributes();
+
+        $this->attributes['type'] = "site";
+        $this->attributes += self::getExternalAttributes();
+    }
+
+    /**
+     * 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 [
+            'name' => null,
+            'description' => null,
+            'url' => null,
+        ];
+    }
+
+    /**
+     * Create a new \ElggSite.
+     *
+     * Plugin developers should only use the constructor to create a new entity.
+     * To retrieve entities, use get_entity() and the elgg_get_entities* functions.
+     *
+     * @param \stdClass $row Database row result. Default is null to create a new site.
+     *
+     * @throws IOException If cannot load remaining data from db
+     * @throws InvalidParameterException If not passed a db result
+     */
+    public function __construct(\stdClass $row = null) {
+        $this->initializeAttributes();
+
+        if ($row) {
+            // Load the rest
+            if (!$this->load($row)) {
+                $msg = "Failed to load new " . get_class() . " for GUID:" . $row->guid;
+                throw new \IOException($msg);
+            }
+        }
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function save() {
+        $db = $this->getDatabase();
+        $row = $db->getDataRow("
 			SELECT guid FROM {$db->prefix}sites_entity
 		");
-		if ($row) {
-			if ($row->guid == $this->attributes['guid']) {
-				// can save active site
-				return parent::save();
-			}
-
-			_elgg_services()->logger->error('More than 1 site entity cannot be created.');
-			return false;
-		}
-
-		return parent::save(); // TODO: Change the autogenerated stub
-	}
-
-	/**
-	 * Loads the full \ElggSite when given a guid.
-	 *
-	 * @param mixed $guid GUID of \ElggSite entity or database row object
-	 *
-	 * @return bool
-	 * @throws InvalidClassException
-	 */
-	protected function load($guid) {
-		// TODO(steve) we only have 1 site, simplify this...
-		$attr_loader = new \Elgg\AttributeLoader(get_class(), 'site', $this->attributes);
-		$attr_loader->requires_access_control = !($this instanceof \ElggPlugin);
-		$attr_loader->secondary_loader = 'get_site_entity_as_row';
-
-		$attrs = $attr_loader->getRequiredAttributes($guid);
-		if (!$attrs) {
-			return false;
-		}
-
-		$this->attributes = $attrs;
-		$this->loadAdditionalSelectValues($attr_loader->getAdditionalSelectValues());
-		_elgg_services()->entityCache->set($this);
-
-		return true;
-	}
-
-	/**
-	 * {@inheritdoc}
-	 */
-	protected function create() {
-		$guid = parent::create();
-		$db = $this->getDatabase();
-
-		$query = "
+        if ($row) {
+            if ($row->guid == $this->attributes['guid']) {
+                // can save active site
+                return parent::save();
+            }
+
+            _elgg_services()->logger->error('More than 1 site entity cannot be created.');
+            return false;
+        }
+
+        return parent::save(); // TODO: Change the autogenerated stub
+    }
+
+    /**
+     * Loads the full \ElggSite when given a guid.
+     *
+     * @param mixed $guid GUID of \ElggSite entity or database row object
+     *
+     * @return bool
+     * @throws InvalidClassException
+     */
+    protected function load($guid) {
+        // TODO(steve) we only have 1 site, simplify this...
+        $attr_loader = new \Elgg\AttributeLoader(get_class(), 'site', $this->attributes);
+        $attr_loader->requires_access_control = !($this instanceof \ElggPlugin);
+        $attr_loader->secondary_loader = 'get_site_entity_as_row';
+
+        $attrs = $attr_loader->getRequiredAttributes($guid);
+        if (!$attrs) {
+            return false;
+        }
+
+        $this->attributes = $attrs;
+        $this->loadAdditionalSelectValues($attr_loader->getAdditionalSelectValues());
+        _elgg_services()->entityCache->set($this);
+
+        return true;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    protected function create() {
+        $guid = parent::create();
+        $db = $this->getDatabase();
+
+        $query = "
 			INSERT INTO {$db->prefix}sites_entity
 			(guid, name, description, url) VALUES (:guid, :name, :desc, :url)
 		";
-		$params = [
-			':guid' => $guid,
-			':name' => (string) $this->attributes['name'],
-			':desc' => (string) $this->attributes['description'],
-			':url' => '',
-		];
-
-		$result = $db->insertData($query, $params);
-		if ($result === false) {
-			return false;
-		}
-
-		return $guid;
-	}
-
-	/**
-	 * {@inheritdoc}
-	 */
-	protected function update() {
-		if (!parent::update()) {
-			return false;
-		}
-
-		$guid = (int) $this->guid;
-		$db = $this->getDatabase();
-
-		$query = "
+        $params = [
+            ':guid' => $guid,
+            ':name' => (string) $this->attributes['name'],
+            ':desc' => (string) $this->attributes['description'],
+            ':url' => '',
+        ];
+
+        $result = $db->insertData($query, $params);
+        if ($result === false) {
+            return false;
+        }
+
+        return $guid;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    protected function update() {
+        if (!parent::update()) {
+            return false;
+        }
+
+        $guid = (int) $this->guid;
+        $db = $this->getDatabase();
+
+        $query = "
 			UPDATE {$db->prefix}sites_entity
 			SET name = :name, description = :desc, url = :url WHERE guid = :guid
 		";
-		$params = [
-			':guid' => $guid,
-			':name' => (string) $this->attributes['name'],
-			':desc' => (string) $this->attributes['description'],
-			':url' => '',
-		];
-
-		return $db->updateData($query, false, $params) !== false;
-	}
-
-	/**
-	 * Delete the site.
-	 *
-	 * @note You cannot delete the current site.
-	 *
-	 * @return bool
-	 * @throws SecurityException
-	 */
-	public function delete() {
-		global $CONFIG;
-		if ($CONFIG->site->getGUID() == $this->guid) {
-			throw new \SecurityException('You cannot delete the current site');
-		}
-
-		return parent::delete();
-	}
-
-	/**
-	 * Disable the site
-	 *
-	 * @note You cannot disable the current site.
-	 *
-	 * @param string $reason    Optional reason for disabling
-	 * @param bool   $recursive Recursively disable all contained entities?
-	 *
-	 * @return bool
-	 * @throws SecurityException
-	 */
-	public function disable($reason = "", $recursive = true) {
-		if ($this->guid == 1) {
-			throw new \SecurityException('You cannot disable the current site');
-		}
-
-		return parent::disable($reason, $recursive);
-	}
-
-	/**
-	 * {@inheritdoc}
-	 */
-	public function __set($name, $value) {
-		if ($name === 'url') {
-			_elgg_services()->logger->warn("ElggSite::url cannot be set");
-			return;
-		}
-		parent::__set($name, $value);
-	}
-
-	/**
-	 * {@inheritdoc}
-	 */
-	public function __get($name) {
-		if ($name === 'url') {
-			return $this->getURL();
-		}
-		return parent::__get($name);
-	}
-
-	/**
-	 * Returns the URL for this site
-	 *
-	 * @return string The URL
-	 */
-	public function getURL() {
-		return _elgg_services()->config->getSiteUrl();
-	}
-
-	/**
-	 * {@inheritdoc}
-	 */
-	public function getDisplayName() {
-		return $this->name;
-	}
-
-	/**
-	 * {@inheritdoc}
-	 */
-	public function setDisplayName($displayName) {
-		$this->name = $displayName;
-	}
-
-	/**
-	 * {@inheritdoc}
-	 */
-	protected function prepareObject($object) {
-		$object = parent::prepareObject($object);
-		$object->name = $this->getDisplayName();
-		$object->description = $this->description;
-		unset($object->read_access);
-		return $object;
-	}
-
-	/**
-	 * Get the domain for this site
-	 *
-	 * @return string
-	 * @since 1.9
-	 */
-	public function getDomain() {
-		$breakdown = parse_url($this->url);
-		return $breakdown['host'];
-	}
-
-	/**
-	 * Get the email address for the site
-	 *
-	 * This can be set in the basic site settings or fallback to noreply@domain
-	 *
-	 * @return string
-	 * @since 3.0.0
-	 */
-	public function getEmailAddress() {
-		$email = $this->email;
-		if (empty($email)) {
-			$email = "noreply@{$this->getDomain()}";
-		}
-
-		return $email;
-	}
+        $params = [
+            ':guid' => $guid,
+            ':name' => (string) $this->attributes['name'],
+            ':desc' => (string) $this->attributes['description'],
+            ':url' => '',
+        ];
+
+        return $db->updateData($query, false, $params) !== false;
+    }
+
+    /**
+     * Delete the site.
+     *
+     * @note You cannot delete the current site.
+     *
+     * @return bool
+     * @throws SecurityException
+     */
+    public function delete() {
+        global $CONFIG;
+        if ($CONFIG->site->getGUID() == $this->guid) {
+            throw new \SecurityException('You cannot delete the current site');
+        }
+
+        return parent::delete();
+    }
+
+    /**
+     * Disable the site
+     *
+     * @note You cannot disable the current site.
+     *
+     * @param string $reason    Optional reason for disabling
+     * @param bool   $recursive Recursively disable all contained entities?
+     *
+     * @return bool
+     * @throws SecurityException
+     */
+    public function disable($reason = "", $recursive = true) {
+        if ($this->guid == 1) {
+            throw new \SecurityException('You cannot disable the current site');
+        }
+
+        return parent::disable($reason, $recursive);
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function __set($name, $value) {
+        if ($name === 'url') {
+            _elgg_services()->logger->warn("ElggSite::url cannot be set");
+            return;
+        }
+        parent::__set($name, $value);
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function __get($name) {
+        if ($name === 'url') {
+            return $this->getURL();
+        }
+        return parent::__get($name);
+    }
+
+    /**
+     * Returns the URL for this site
+     *
+     * @return string The URL
+     */
+    public function getURL() {
+        return _elgg_services()->config->getSiteUrl();
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getDisplayName() {
+        return $this->name;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function setDisplayName($displayName) {
+        $this->name = $displayName;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    protected function prepareObject($object) {
+        $object = parent::prepareObject($object);
+        $object->name = $this->getDisplayName();
+        $object->description = $this->description;
+        unset($object->read_access);
+        return $object;
+    }
+
+    /**
+     * Get the domain for this site
+     *
+     * @return string
+     * @since 1.9
+     */
+    public function getDomain() {
+        $breakdown = parse_url($this->url);
+        return $breakdown['host'];
+    }
+
+    /**
+     * Get the email address for the site
+     *
+     * This can be set in the basic site settings or fallback to noreply@domain
+     *
+     * @return string
+     * @since 3.0.0
+     */
+    public function getEmailAddress() {
+        $email = $this->email;
+        if (empty($email)) {
+            $email = "noreply@{$this->getDomain()}";
+        }
+
+        return $email;
+    }
 }