org.netfrag.glib/Data/Lift.php

<?
/**
 * This file contains the Data::Lift component.
 *
 * @author Andreas Motl <andreas.motl@ilo.de>
 * @package org.netfrag.glib
 * @name Data::Lift
 *
 */

/**
 * Cvs-Log:
 *
 * $Id: Generic.php,v 1.19 2003/04/18 15:40:51 joko Exp $
 *
 * $Log: Generic.php,v $
 * Revision 1.8  2003/04/19 16:13:52  jonen
 * + added class var '$_hidden_elements' which are passed to 'ExplorerTree' if exists
 *
 * Revision 1.7  2003/04/18 15:48:00  joko
 * better error handling: a) croak messages, b) just perform lift module if instance could be created
 *
 * Revision 1.6  2003/03/09 15:49:20  joko
 * fix towards optimizing autodocumentation:
 * enriched with metadata to tell autodia how to build object-relationships by discarding the fancy namespacing stuff there
 *
 * Revision 1.5  2003/03/08 20:04:59  root
 * + optimized comments for Autodia
 *
 * Revision 1.4  2003/03/08 18:22:23  joko
 * updated comments: now in phpDocumentor style
 *
 * Revision 1.3  2003/03/03 21:28:11  joko
 * updated comments
 *
 * Revision 1.2  2003/02/27 16:30:17  joko
 * + enhanced '_autodetect'
 * + added '_check'
 * + now throughout returning lifted values by reference
 *
 * Revision 1.1  2003/02/22 16:20:04  joko
 * + initial commit
 *
 */

/**
 * Data::Lift
 *
 * <pre>
 *    Data::Lift  -  Pass data around between various "actors".
 *
 *    These "actors" are kinda plugin-modules 
 *    lying at "locations" and actually mungle the data.
 *
 *    "Locations" are by now:
 *      x local filesystem
 *      o remote anything
 *
 *    The "actors" require (by now) to be native php classes
 *    having a method "perform". Please have a look at others
 *    lying in the Data::Lift namespace at org.netfrag.glib to
 *    get a picture of how to implement own "actors".
 * </pre>
 *
 *
 * @author Andreas Motl <andreas.motl@ilo.de>
 * @copyright (c) 2003 - All Rights reserved.
 * @license GNU LGPL (GNU Lesser General Public License)
 *
 * @link http://www.netfrag.org/~joko/
 * @link http://www.gnu.org/licenses/lgpl.txt
 *
 * @package org.netfrag.glib
 * @subpackage DataLift
 * @name Data::Lift
 *
 * @link http://cvs.netfrag.org/php/libs/org.netfrag.glib
 *
 *
 * @todo refactor Data::Deep to a plugin module
 * @todo refactor Data::Encode to a plugin module
 * @todo combine Data::Lift and Data::Container somehow
 * @todo integrate with Data::Driver somehow  --  proposal:
 *         //  $lift = ne w Data::Lift($locator);
 *         //  $lift->perform();     // talks to a Data::Driver
 *
 *
 */
class Data_Lift {

  /**
   * this is to trick Autodia let understanding "namespaces" in php
   * unless the pattern can be tweaked by mode (namespace=0|1)
   * // $this = ne w Data::Lift(&$payload, $options = array());
   */

  var $dblocations;
  var $actor;
  var $actor_instance;

  var $payload;
  var $vartype;
  var $metatype;
  var $_link_args = NULL;

  function Data_Lift(&$payload, $options = array()) {
    $this->_init_locations();
    //print Dumper($options);
    //exit;
    $this->options = $options;
    if ($options[metatype]) { $this->metatype = $options[metatype]; }
    if ($options[link_args]) { $this->_link_args = $options[link_args]; }
    $this->set(&$payload);
  }
  
  function _init_locations() {
    $this->actor = array();
    $this->dblocations = array(
      'bla' => 'blub',
    );
  }
  
  function set(&$payload, $metatype = '') {
    $this->payload = &$payload;
    
    if ($metatype) { $this->metatype = $metatype; }
    $this->_autodetect();
    $this->_check();
  }
  
  function _autodetect() {

    // FIXME: distinguish between is_array and is_hash here!
    if (is_object($this->payload)) {
      $this->vartype = 'object';
      $this->metatype = get_class($this->payload);
      if ($parent_class = get_parent_class($this->payload)) {
        $this->metatype = $parent_class;
      }

    } elseif (is_array($this->payload)) {
      $this->vartype = 'hash';

    } else {
      $this->vartype = 'scalar';
    
    }
  }
  
  function _check() {

    $good = $this->vartype && $this->metatype;
    
    //print "metatype: " . $this->metatype . "<br>";
    
    if (!$good) {
      $msg = "Data::Lift cannot handle this payload: ";
      $msg .= "[vartype=" . $this->vartype . ", metatype=" . $this->metatype . "]<br/>";
      $msg .= "payload: '" . Dumper($this->payload) . "'";
      user_error($msg);
    }
    
  }
  
  function &to($level) {
    $this->_resolve_location($level);
    //print Dumper($this->actor);
    //exit;
    //$result = array( name => 'abc', description => 'def' );
    $result = &$this->_perform_actor();
    return $result;
  }
  
  function _resolve_location($level) {
    
    // location can be resolved by location-table
    if ($location = $this->dblocations[$level]) {
      $this->actor = split('/', $location);
    }
    
    // try to automagically resolve location
    $part = array();
    array_push($part, $this->vartype);
    array_push($part, $this->metatype);
    array_push($part, $level);
    $this->actor = $part;
    
  }

  function &_perform_actor() {
    //$actor_file = join('/', $this->actor) . '.php';
    //include($actor_file);

    /**
     * <!-- Autodia -->
     * can do: (this is metadata supplied for Autodia, don't delete!)
     *  $this->_actor_instance = new Data_Lift_hash_job_html()
     *  $this->_actor_instance = new Data_Lift_hash_tree_PEAR_Tree()
     *  $this->_actor_instance = new Data_Lift_object_tree_common_PEAR_HTML_TreeMenu()
     *  $this->_actor_instance = new Data_Lift_object_tree_common_PEAR_HTML_TreeMenu_DHTML()
     *  $this->_actor_instance = new Data_Lift_object_tree_common_PEAR_HTML_TreeMenu_Listbox()
     *
     */

    $actor_name = 'Data/Lift/' . join('/', $this->actor);
    //$actor_name = 'Data::Lift::' . join('::', $this->actor);

    //$actor_object = mkObject($actor_name);
    //return $actor_object->perform($this->payload);
    
    // fix [2003-04-13]: just perform if instance good
    //if ($actor_object = php::mkComponent($actor_name)) {
    // enhanced [2003-04-20]: pass Lift's options to actor's constructor
    $actor_object = mkObject($actor_name, $this->options);
    if (is_object($actor_object) && method_exists($actor_object, 'perform')) {
      // enhanced [2003-04-20]: *inject* Lift's options to actor's instance - prefix attribute by '_' to prevent collisions
      $actor_object->_options = $this->options;
      return $actor_object->perform($this->payload);
      if ($actor_name == "Data/Lift/hash/topic/ExplorerTree") {
        return $actor_object->perform($this->payload, $this->_link_args);
      } else {
        return $actor_object->perform($this->payload);
      }
    } else {
      user_error("Data::Lift could not call method 'perform' on actor object. [actor_name='$actor_name']");
      //return array();
    }
    
  }

  function get() {
    return $this->payload;
  }
  
  function add($data = array()) {
    $this->payload = array_merge($this->payload, $data);
  }

}

?>
1	joko	1.1	<?
2	joko	1.4	/**
3			* This file contains the Data::Lift component.
4			*
5			* @author Andreas Motl <andreas.motl@ilo.de>
6			* @package org.netfrag.glib
7			* @name Data::Lift
8			*
9			*/
10
11	joko	1.9	/**
12			* Cvs-Log:
13			*
14			* $Id: Generic.php,v 1.19 2003/04/18 15:40:51 joko Exp $
15			*
16			* $Log: Generic.php,v $
17			* Revision 1.8 2003/04/19 16:13:52 jonen
18			* + added class var '$_hidden_elements' which are passed to 'ExplorerTree' if exists
19			*
20			* Revision 1.7 2003/04/18 15:48:00 joko
21			* better error handling: a) croak messages, b) just perform lift module if instance could be created
22			*
23			* Revision 1.6 2003/03/09 15:49:20 joko
24			* fix towards optimizing autodocumentation:
25			* enriched with metadata to tell autodia how to build object-relationships by discarding the fancy namespacing stuff there
26			*
27			* Revision 1.5 2003/03/08 20:04:59 root
28			* + optimized comments for Autodia
29			*
30			* Revision 1.4 2003/03/08 18:22:23 joko
31			* updated comments: now in phpDocumentor style
32			*
33			* Revision 1.3 2003/03/03 21:28:11 joko
34			* updated comments
35			*
36			* Revision 1.2 2003/02/27 16:30:17 joko
37			* + enhanced '_autodetect'
38			* + added '_check'
39			* + now throughout returning lifted values by reference
40			*
41			* Revision 1.1 2003/02/22 16:20:04 joko
42			* + initial commit
43			*
44			*/
45	joko	1.1
46	joko	1.4	/**
47	joko	1.9	* Data::Lift
48	joko	1.4	*
49			* <pre>
50			* Data::Lift - Pass data around between various "actors".
51			*
52			* These "actors" are kinda plugin-modules
53			* lying at "locations" and actually mungle the data.
54			*
55			* "Locations" are by now:
56			* x local filesystem
57			* o remote anything
58			*
59			* The "actors" require (by now) to be native php classes
60			* having a method "perform". Please have a look at others
61			* lying in the Data::Lift namespace at org.netfrag.glib to
62			* get a picture of how to implement own "actors".
63			* </pre>
64			*
65			*
66			* @author Andreas Motl <andreas.motl@ilo.de>
67			* @copyright (c) 2003 - All Rights reserved.
68			* @license GNU LGPL (GNU Lesser General Public License)
69			*
70			* @link http://www.netfrag.org/~joko/
71			* @link http://www.gnu.org/licenses/lgpl.txt
72			*
73			* @package org.netfrag.glib
74	joko	1.6	* @subpackage DataLift
75	joko	1.4	* @name Data::Lift
76			*
77			* @link http://cvs.netfrag.org/php/libs/org.netfrag.glib
78			*
79			*
80			* @todo refactor Data::Deep to a plugin module
81			* @todo refactor Data::Encode to a plugin module
82			* @todo combine Data::Lift and Data::Container somehow
83			* @todo integrate with Data::Driver somehow -- proposal:
84	root	1.5	* // $lift = ne w Data::Lift($locator);
85			* // $lift->perform(); // talks to a Data::Driver
86	joko	1.4	*
87			*
88			*/
89	joko	1.1	class Data_Lift {
90	root	1.5
91			/**
92			* this is to trick Autodia let understanding "namespaces" in php
93			* unless the pattern can be tweaked by mode (namespace=0\|1)
94			* // $this = ne w Data::Lift(&$payload, $options = array());
95			*/
96
97	joko	1.1	var $dblocations;
98			var $actor;
99	root	1.5	var $actor_instance;
100	joko	1.1
101			var $payload;
102			var $vartype;
103			var $metatype;
104	jonen	1.8	var $_link_args = NULL;
105	joko	1.1
106			function Data_Lift(&$payload, $options = array()) {
107			$this->_init_locations();
108			//print Dumper($options);
109			//exit;
110	joko	1.9	$this->options = $options;
111	joko	1.1	if ($options[metatype]) { $this->metatype = $options[metatype]; }
112	jonen	1.8	if ($options[link_args]) { $this->_link_args = $options[link_args]; }
113	joko	1.1	$this->set(&$payload);
114			}
115
116			function _init_locations() {
117			$this->actor = array();
118			$this->dblocations = array(
119			'bla' => 'blub',
120			);
121			}
122
123			function set(&$payload, $metatype = '') {
124			$this->payload = &$payload;
125	joko	1.2
126	joko	1.1	if ($metatype) { $this->metatype = $metatype; }
127			$this->_autodetect();
128	joko	1.2	$this->_check();
129	joko	1.1	}
130
131			function _autodetect() {
132	joko	1.2
133	joko	1.1	// FIXME: distinguish between is_array and is_hash here!
134	joko	1.2	if (is_object($this->payload)) {
135			$this->vartype = 'object';
136			$this->metatype = get_class($this->payload);
137			if ($parent_class = get_parent_class($this->payload)) {
138			$this->metatype = $parent_class;
139			}
140
141			} elseif (is_array($this->payload)) {
142	joko	1.1	$this->vartype = 'hash';
143	joko	1.2
144			} else {
145			$this->vartype = 'scalar';
146
147			}
148			}
149
150			function _check() {
151
152			$good = $this->vartype && $this->metatype;
153
154			//print "metatype: " . $this->metatype . "<br>";
155
156			if (!$good) {
157	joko	1.7	$msg = "Data::Lift cannot handle this payload: ";
158			$msg .= "[vartype=" . $this->vartype . ", metatype=" . $this->metatype . "]<br/>";
159			$msg .= "payload: '" . Dumper($this->payload) . "'";
160			user_error($msg);
161	joko	1.1	}
162	joko	1.2
163	joko	1.1	}
164
165	joko	1.2	function &to($level) {
166	joko	1.1	$this->_resolve_location($level);
167			//print Dumper($this->actor);
168			//exit;
169			//$result = array( name => 'abc', description => 'def' );
170	joko	1.2	$result = &$this->_perform_actor();
171	joko	1.1	return $result;
172			}
173
174			function _resolve_location($level) {
175
176			// location can be resolved by location-table
177			if ($location = $this->dblocations[$level]) {
178			$this->actor = split('/', $location);
179			}
180
181			// try to automagically resolve location
182			$part = array();
183			array_push($part, $this->vartype);
184			array_push($part, $this->metatype);
185			array_push($part, $level);
186			$this->actor = $part;
187
188			}
189
190	joko	1.2	function &_perform_actor() {
191	joko	1.1	//$actor_file = join('/', $this->actor) . '.php';
192			//include($actor_file);
193	root	1.5
194			/**
195	joko	1.6	* <!-- Autodia -->
196	root	1.5	* can do: (this is metadata supplied for Autodia, don't delete!)
197	joko	1.6	* $this->_actor_instance = new Data_Lift_hash_job_html()
198			* $this->_actor_instance = new Data_Lift_hash_tree_PEAR_Tree()
199	root	1.5	* $this->_actor_instance = new Data_Lift_object_tree_common_PEAR_HTML_TreeMenu()
200	joko	1.6	* $this->_actor_instance = new Data_Lift_object_tree_common_PEAR_HTML_TreeMenu_DHTML()
201			* $this->_actor_instance = new Data_Lift_object_tree_common_PEAR_HTML_TreeMenu_Listbox()
202			*
203	root	1.5	*/
204
205	joko	1.1	$actor_name = 'Data/Lift/' . join('/', $this->actor);
206	joko	1.7	//$actor_name = 'Data::Lift::' . join('::', $this->actor);
207
208			//$actor_object = mkObject($actor_name);
209			//return $actor_object->perform($this->payload);
210
211			// fix [2003-04-13]: just perform if instance good
212			//if ($actor_object = php::mkComponent($actor_name)) {
213	joko	1.9	// enhanced [2003-04-20]: pass Lift's options to actor's constructor
214			$actor_object = mkObject($actor_name, $this->options);
215	joko	1.7	if (is_object($actor_object) && method_exists($actor_object, 'perform')) {
216	joko	1.9	// enhanced [2003-04-20]: inject Lift's options to actor's instance - prefix attribute by '_' to prevent collisions
217			$actor_object->_options = $this->options;
218			return $actor_object->perform($this->payload);
219			if ($actor_name == "Data/Lift/hash/topic/ExplorerTree") {
220	jonen	1.8	return $actor_object->perform($this->payload, $this->_link_args);
221			} else {
222			return $actor_object->perform($this->payload);
223			}
224	joko	1.7	} else {
225			user_error("Data::Lift could not call method 'perform' on actor object. [actor_name='$actor_name']");
226			//return array();
227			}
228
229	joko	1.1	}
230
231			function get() {
232			return $this->payload;
233			}
234
235			function add($data = array()) {
236			$this->payload = array_merge($this->payload, $data);
237			}
238
239			}
240
241	root	1.5	?>
MailToCvsAdmin">MailToCvsAdmin	ViewVC Help
Powered by ViewVC 1.1.26