File Source for gloobject.php

<?php
/**
* GloryLands OO System
*
* <pre>
* GloryLands, a Web-Based, Massive Multiplayer Online RPG/Strategy Game
* Copyright (C) 2008-09 John Haralampidis <jïhnys2[at]gmail.cïm>
*
* This program 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.
*
* This program 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 this program. If not, see <http://www.gnu.org/licenses/>.
*
* For any help/suggestions or troubleshooting you can see the
* project community website at <http://www.glorylands.gr>
* </pre>
*
* @license GNU/GPLv3 GNU General Public License version 3
* @package GloryLands
* @subpackage GLOO
* @author John Haralampidis <jïhnys2[at]gmail.cïm>
* @copyright Copyright (C) 2007-2009, John Haralampidis
* @version 1.0
*/
/**
* Basic DOM Element
*
* This class provides the basic class that implements
* the DOM element.
*
* @example sample_proxy.php An example of how to extend a GLOOObject
* @package GloryLands
* @subpackage GLOO
* @version 1.0
*/
class GLOOObject extends GLDOMElement {
/**
* A reference to the root module object
* @var GLModule
*/
protected $module;
/**
* The Link synchronization number between PHP and Javscript object
* @var int
*/
public $linkID;
/**
* The Unit configuration, as obtained from the config.xml
* @var array
*/
protected $config;
/**
* A flag that defines that objec variables are synced with the JS
* @var bool
*/
public $synced;
public function __sleep() {
// Remove the reference to the $module. We don't need it and
// it also causes trouble on serialization
$vars = get_object_vars($this);
unset($vars['module']);
$vars = array_keys($vars);
return $vars;
}
public function __wakeup() {
// Re-load the $module reference
$this->module = GLModules::get_module_for($this);
}
public function __construct($id=NULL) {
// Initialize my variables
$this->vars = array();
$this->linkID = false;
$this->synced = false;
// Detect my GLModule
// (Instead of using $v = GLMOdule::fetch(Class) we can directly instance this class, using $v = new Class()
// and let the GLModule::mine() function to do the detection of the appropriate module.
$this->module = GLModules::get_module_for($this);
$this->config = $this->module->get_config_for($this);
// Initialize the GLDOMElement, using this class name for the DOM class name.
// You can also provide an optional ID by the constructor
parent::__construct(get_class($this), $id);
// If we have client script, make the PHP-JS binding by allocating
// a link ID and registering this class to the GLOOLink structure.
if (isset($this->config['client'])) {
$client_class = $this->config['client'][0]['class'];
$this->linkID = GLOOLink::register($this, $client_class);
} else {
$this->linkID = false;
}
}
private function encode_structure($struct) {
if (is_array($struct)) {
foreach ($struct as $k => $v) {
$struct[$k] = $this->flatten_structure($v);
}
return $struct;
} elseif (is_object($struct)) {
if ($struct instanceof GLOOObject) {
return GLOOLink::get_object_reference($struct);
} else {
return encode_structure(get_object_vars($struct));
}
} else {
return $struct;
}
}
/**
* An inheritable function to notify a variable update
* [INHERITED FROM GLDataset]
*
* @param string $name The variable name that was updated
* @param mixed $value The variable value
*/
protected function var_changed($name, &$value) {
if ($this->synced) {
$this->_call('__set', $name, $this->encode_structure($value));
}
}
/**
* An inheritable function to notify a variable removal
* [INHERITED FROM GLDataset]
*
* @param string $name The variable name that was removed
*/
protected function var_removed($name) {
if ($this->synced) {
$this->_call('__unset', $name);
}
}
/**
* An inheritable function to notify an object attachment
* [INHERITED FROM GLDataset]
*
* @param string $name The variable name that was updated
* @param object $object The object that was added
*/
protected function object_added($name, &$object) {
if ($object instanceof GLDOMElement) {
$this->add_child($object);
}
}
/**
* An inheritable function to notify an object detachment
* [INHERITED FROM GLDataset]
*
* @param string $name The variable name that was updated
* @param object $object The object that was removed
*/
protected function object_removed($name, &$object) {
if ($object instanceof GLDOMElement) {
$this->remove_child($object);
}
}
/**
* Prepare the variables that will be sent to the JS interface
*/
public function _vars() {
return $this->vars;
}
/**
* Bind the object into the rendering template
*/
public function _bind($template) {
}
/**
* Perform a call to the JS interface
*/
public final function _call($call) {
if ($this->linkID === false) return;
$vars = func_get_args();
array_shift($vars);
GLOOLink::store_message($this->linkID, $call, $vars);
}
}
?>

	GloryLands GLOO

[ class tree: GloryLands ] [ index: GloryLands ] [ all elements ]

Source for file gloobject.php