ElggUpgrade.php

Go to the documentation of this file.

<?php
class ElggUpgrade extends ElggObject {
    private $requiredProperties = array(
        'title',
        'description',
        'upgrade_url',
    );

    public $_callable_egefps = 'elgg_get_entities_from_private_settings';

    public function initializeAttributes() {
        parent::initializeAttributes();

        $this->attributes['subtype'] = 'elgg_upgrade';

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

        $this->is_completed = 0;
    }

    public function setCompleted() {
        $this->setCompletedTime();
        return $this->is_completed = true;
    }

    public function isCompleted() {
        return (bool) $this->is_completed;
    }

    public function setPath($path) {
        if (!$path) {
            throw new InvalidArgumentException('Invalid value for URL path.');
        }

        $path = ltrim($path, '/');

        if ($this->getUpgradeFromPath($path)) {
            throw new InvalidArgumentException('Upgrade URL paths must be unique.');
        }

        $this->upgrade_url = $path;
    }

    public function getURL() {
        return elgg_normalize_url($this->upgrade_url);
    }

    public function setCompletedTime($time = null) {
        if (!$time) {
            $time = time();
        }

        return $this->completed_time = $time;
    }

    public function getCompletedTime() {
        return $this->completed_time;
    }

    public function save() {
        foreach ($this->requiredProperties as $prop) {
            if (!$this->$prop) {
                throw new UnexpectedValueException("ElggUpgrade objects must have a value for the $prop property.");
            }
        }

        return parent::save();
    }

    public function __set($name, $value) {
        if (array_key_exists($name, $this->attributes)) {
            parent::__set($name, $value);
        } else {
            $this->setPrivateSetting($name, $value);
        }
    }

    public function __get($name) {
        // See if its in our base attribute
        if (array_key_exists($name, $this->attributes)) {
            return parent::__get($name);
        }

        return $this->getPrivateSetting($name);
    }

    public function getUpgradeFromPath($path) {
        $path = ltrim($path, '/');

        if (!$path) {
            return false;
        }

        // test for full URL values (used at 1.9.0)
        $options = array(
            'type' => 'object',
            'subtype' => 'elgg_upgrade',
            'private_setting_name' => 'upgrade_url',
            'private_setting_value' => elgg_normalize_url($path),
        );
        $upgrades = call_user_func($this->_callable_egefps, $options);
        /* @var ElggUpgrade[] $upgrades */

        if ($upgrades) {
            // replace URL with path (we can't use setPath due to recursion)
            $upgrades[0]->upgrade_url = $path;
            return $upgrades[0];
        }

        $options['private_setting_value'] = $path;
        $upgrades = call_user_func($this->_callable_egefps, $options);

        if ($upgrades) {
            return $upgrades[0];
        }

        return false;
    }
}