mirror of
https://github.com/moodle/moodle.git
synced 2025-02-25 12:33:18 +01:00
65 lines
2.0 KiB
PHP
65 lines
2.0 KiB
PHP
<?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/>.
|
|
|
|
namespace core_cache;
|
|
|
|
/**
|
|
* A cached object wrapper.
|
|
*
|
|
* This class gets used when the data is an object that has implemented the cacheable_object_interface interface.
|
|
*
|
|
* @package core_cache
|
|
* @category cache
|
|
* @copyright 2012 Sam Hemelryk
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
class cached_object {
|
|
/**
|
|
* The class of the cacheable object
|
|
* @var string
|
|
*/
|
|
protected $class;
|
|
|
|
/**
|
|
* The data returned by the cacheable_object_interface prepare_to_cache method.
|
|
* @var mixed
|
|
*/
|
|
protected $data;
|
|
|
|
/**
|
|
* Constructs a cached object wrapper.
|
|
* @param cacheable_object_interface $obj
|
|
*/
|
|
public function __construct(cacheable_object_interface $obj) {
|
|
$this->class = get_class($obj);
|
|
$this->data = $obj->prepare_to_cache();
|
|
}
|
|
|
|
/**
|
|
* Restores the data as an instance of the cacheable_object_interface class.
|
|
* @return object
|
|
*/
|
|
public function restore_object() {
|
|
$class = $this->class;
|
|
return $class::wake_from_cache($this->data);
|
|
}
|
|
}
|
|
|
|
// Alias this class to the old name.
|
|
// This file will be autoloaded by the legacyclasses autoload system.
|
|
// In future all uses of this class will be corrected and the legacy references will be removed.
|
|
class_alias(cached_object::class, \cache_cached_object::class);
|