C:/xampp/htdocs/moodle/backup/util/structure/base_atom.class.php

Go to the documentation of this file.

<?php

// This file is part of Moodle - http://moodle.org/
//
// Moodle is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// Moodle is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.

abstract class base_atom {

    private $name;

    private $value;

    private $is_set;

    public function __construct($name) {

        $this->validate_name($name); // Check name

        $this->name  = $name;
        $this->value = null;
        $this->is_set= false;
    }

    protected function validate_name($name) {
        // Validate various name constraints, throwing exception if needed
        if (empty($name)) {
            throw new base_atom_struct_exception('backupatomemptyname', $name);
        }
        if (preg_replace('/\s/', '', $name) != $name) {
            throw new base_atom_struct_exception('backupatomwhitespacename', $name);
        }
        if (preg_replace('/[^\x30-\x39\x41-\x5a\x5f\x61-\x7a]/', '', $name) != $name) {
            throw new base_atom_struct_exception('backupatomnotasciiname', $name);
        }
    }


    public function get_name() {
        return $this->name;
    }

    public function get_value() {
        return $this->value;
    }

    public function set_value($value) {
        if ($this->is_set) {
            throw new base_atom_content_exception('backupatomalreadysetvalue', $value);
        }
        $this->value = $value;
        $this->is_set= true;
    }

    public function clean_value() {
        $this->value = null;
        $this->is_set= false;
    }

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

    public function to_string($showvalue = false) {
        $output = $this->name;
        if ($showvalue) {
            $value = $this->is_set ? $this->value : 'not set';
            $output .= ' => ' . $value;
        }
        return $output;
    }
}

abstract class base_atom_exception extends moodle_exception {

    public function __construct($errorcode, $a = null, $debuginfo = null) {
        parent::__construct($errorcode, '', '', $a, $debuginfo);
    }
}

class base_atom_struct_exception extends base_atom_exception {

    public function __construct($errorcode, $a = null, $debuginfo = null) {
        parent::__construct($errorcode, $a, $debuginfo);
    }
}

class base_atom_content_exception extends base_atom_exception {

    public function __construct($errorcode, $a = null, $debuginfo = null) {
        parent::__construct($errorcode, $a, $debuginfo);
    }
}