ElggSite.php

Go to the documentation of this file.

<?php

use Elgg\Database\EntityTable;
use Elgg\Database\Select;
use Elgg\Exceptions\SecurityException;

class ElggSite extends \ElggEntity {

    protected function initializeAttributes() {
        // Using ElggData for testing purposes
        ElggData::initializeAttributes();

        $this->attributes['guid'] = null;
        $this->attributes['type'] = 'site';
        $this->attributes['subtype'] = 'site';

        $this->attributes['owner_guid'] = 0;
        $this->attributes['container_guid'] = 0;

        $this->attributes['access_id'] = ACCESS_PUBLIC;
        $this->attributes['time_updated'] = null;
        $this->attributes['last_action'] = null;
        $this->attributes['enabled'] = 'yes';
        $this->attributes['deleted'] = 'no';
        $this->attributes['time_deleted'] = null;
    }

    public function getType(): string {
        return 'site';
    }

    public function save(): bool {
        $qb = Select::fromTable(EntityTable::TABLE_NAME);
        $qb->select('*')
            ->where($qb->compare('type', '=', 'site', ELGG_VALUE_STRING));

        $row = $this->getDatabase()->getDataRow($qb);
        if (!empty($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();
    }

    public function delete(bool $recursive = true, bool $persistent = null): bool {
        if ($this->guid === 1) {
            throw new SecurityException('You cannot delete the current site');
        }
        
        return parent::delete($recursive, $persistent);
    }
    
    public function disable(string $reason = '', bool $recursive = true): bool {
        if ($this->guid == 1) {
            throw new SecurityException('You cannot disable the current site');
        }

        return parent::disable($reason, $recursive);
    }

    public function __set($name, $value) {
        if ($name === 'url') {
            _elgg_services()->logger->warning('ElggSite::url cannot be set');
            return;
        }
        
        parent::__set($name, $value);
    }

    public function __get($name) {
        if ($name === 'url') {
            return $this->getURL();
        }
        
        return parent::__get($name);
    }

    public function getURL(): string {
        return _elgg_services()->config->wwwroot;
    }

    public function isCacheable(): bool {
        return false;
    }

    protected function prepareObject(\Elgg\Export\Entity $object) {
        $object = parent::prepareObject($object);
        $object->name = $this->getDisplayName();
        $object->description = $this->description;
        unset($object->read_access);
        return $object;
    }

    public function getDomain(): string {
        $breakdown = parse_url($this->url);
        return $breakdown['host'];
    }

    public function getEmailAddress(): string {
        $email = $this->email;
        if (empty($email)) {
            // If all else fails, use the domain of the site.
            $token = _elgg_services()->crypto->getRandomString(24);
            $email = "noreply-{$token}@{$this->getDomain()}";
        }

        return $email;
    }
    
    public function updateLastAction(int $posted = null): int {
        // setting last action on ElggSite makes no sense... just returning current value to be compliant
        return $this->last_action;
    }
}