org.netfrag.glib/DesignPattern/Proxy.php

<?php
/**
 * This file contains the DesignPattern::Proxy class
 *
 * @author Andreas Motl <andreas.motl@ilo.de>
 * @package org.netfrag.glib
 * @name DesignPattern::Proxy
 *
 *
 *
 *
 * <b>Cvs-Log:</b>
 *
 * <pre>
 * $Id: Proxy.php,v 1.5 2003/03/05 17:28:43 joko Exp $
 *
 * $Log: Proxy.php,v $
 * Revision 1.5  2003/03/05 17:28:43  joko
 * updated docu (phpDocumentor testing....)
 *
 * Revision 1.4  2003/03/05 16:32:18  joko
 * updated docu (phpDocumentor testing....)
 *
 * Revision 1.3  2003/03/05 16:10:17  joko
 * updated docu (phpDocumentor testing....)
 *
 * Revision 1.2  2003/03/05 12:12:42  joko
 * re-renamed methods and privates: _handler becomes _proxy again
 *
 * Revision 1.1  2003/03/03 22:05:25  joko
 * abstract implementation...  ;-)
 * </pre>
 *
 *
 */


/**
 * Load required modules:
 *
 */
loadModule('Class::Logger');


/**
 * An attempt to implement some software design patterns...
 * --- ProxyPattern
 *
 * @link http://c2.com/cgi-bin/wiki?ProxyPattern
 *
 * @author Andreas Motl <andreas.motl@ilo.de>
 * @link http://www.netfrag.org/~joko/
 *
 * @copyright (c) 2003 - All Rights reserved.
 * @license GNU LGPL (GNU Lesser General Public License)
 * @link http://www.gnu.org/licenses/lgpl.txt
 *
 * @package org.netfrag.glib
 * @subpackage DesignPattern
 * @name DesignPattern::Proxy
 *
 * @todo (x) DesignPattern::DecoratorProxy  (->decorate)
 * @todo (x) DesignPattern::TransparentProxy  (->make_transparent)
 * @todo (o) DesignPattern::MultiProxy   (->both???) (diamond inheritance? possible in php?)
 * @todo (o) DesignPattern::GenericAdapterProxy???
 * @todo   (o) no 'locator/query' or 'type/component'
 * @todo   (o) even more generic: just 'adapter_metadata'    (-> global adapter registry?)
 *
 */
class DesignPattern_Proxy extends Class_Logger {

  /**
   * This holds some information about the tracing level.
   *
   */
  var $_debug = array(
    notice => 1,
    trace => 1,
    payload => 1,
  );

  var $_component_name;
  var $_component_options;

  /**
   * This var holds the Handler object
   * that is used to do the work.
   * It acts as a dispatcher combining result caching.
   * It is assumed that this provides 4 methods:
   * queryData() - execute a query against a data storage
   * querySchema() - execute a query against underlying storage metadata
   * sendCommand() - send a command against an arbitrary execution engine
   * ... or others! (these are just proposals for convenience)
   *
   */
  var $_proxy = NULL;
  
  
  /**
   * This var holds options fed to the Proxy object
   * These are built from locator metadata (_locator) and query arguments (_query)
   * It's a simple structured hash:
   *  $proxy_options = array(
   *    method => '<remote-method-name>',
   *    args => array('list', 'of', 'arguments')
   *  );
   *
   */
  var $_proxy_options = NULL;


  function about() {
    $this->_about = 
<<<ABOUT
 * --- DesignPattern::Proxy
 * --- http://cvs.netfrag.org/nfo/php/libs/org.netfrag.glib/DesignPattern/Proxy.php
 *
 *  http://c2.com/cgi-bin/wiki?ProxyPattern says...
 *  Intent: Provide a surrogate or placeholder for another object to control access to it. 
 *  http://www.fluffycat.com/java/patterns.html says...
 *  One class controls the creation of and access to objects in another class. 
 
ABOUT;
  }


  function constructor($handler = array()) {
    if (sizeof($handler)) {
      $this->set_proxy($handler);
    }
    $this->create_proxy();
    $this->call_proxy();
  }
        
  /*
  function _abstract_method($method) {
    $package = get_class($this);
    $package_p = get_parent_class($this);
    user_error("DesignPattern::Proxy.$package_p.$package: Please implement method '$method'.");
  }
  */
  

/**
  * Directly inject a Handler instance to use.
  *
  * @param Handler object - &$handler
  *
  */
  function set_proxy( &$handler ) {
      $this->_proxy = &$handler;
  }

  function &get_proxy() {
      return $this->_proxy;
  }

  function call_proxy() {
    $this->_abstract_method('call_proxy', 'DesignPattern::Proxy');
  }

  function set_component_name($name) {
    $this->_component_name = $name;
  }
  function get_component_name() {
    return $this->_component_name;
  }
  function set_component_options_v1() {
    $options = func_get_args();
    if (is_array($options)) {
      if (is_hash($options)) {
        $this->_component_options = $options;
      } else {
        $this->_component_options = array();
        foreach ($options as $option) {
          array_push($this->_component_options, $option);
        }
      }
    } else {
      $this->_component_options = $options;
    }
  }
  function set_component_options() {
    $options = func_get_args();
    if (sizeof($options) >= 1) {
      $this->_component_options = array();
      foreach ($options as $option) {
        array_push($this->_component_options, $option);
      }
    } else {
      $this->_component_options = $options;
    }
  }
  function get_component_options() {
    return $this->_component_options;
  }

  function create_proxy() {
    //print "DesignPattern::Proxy->create_proxy<br/>";
    //print "comp: " . $this->get_component_name() . "<br/>";
    //print "comp: " . $this->get_component_options() . "<br/>";
    $handler = php::mkComponent( $this->get_component_name(), $this->get_component_options() );
    //print Dumper($handler);
    //exit;
    
    $this->set_proxy( $handler );
  }


}

?>
1	joko	1.1	<?php
2			/**
3	joko	1.3	* This file contains the DesignPattern::Proxy class
4	joko	1.1	*
5			* @author Andreas Motl <andreas.motl@ilo.de>
6	joko	1.3	* @package org.netfrag.glib
7			* @name DesignPattern::Proxy
8	joko	1.1	*
9	joko	1.3	*
10	joko	1.4	*
11			*
12			* <b>Cvs-Log:</b>
13			*
14			* <pre>
15	joko	1.6	* $Id: Proxy.php,v 1.5 2003/03/05 17:28:43 joko Exp $
16	joko	1.2	*
17			* $Log: Proxy.php,v $
18	joko	1.6	* Revision 1.5 2003/03/05 17:28:43 joko
19			* updated docu (phpDocumentor testing....)
20			*
21	joko	1.5	* Revision 1.4 2003/03/05 16:32:18 joko
22			* updated docu (phpDocumentor testing....)
23			*
24	joko	1.4	* Revision 1.3 2003/03/05 16:10:17 joko
25			* updated docu (phpDocumentor testing....)
26			*
27	joko	1.3	* Revision 1.2 2003/03/05 12:12:42 joko
28			* re-renamed methods and privates: _handler becomes _proxy again
29			*
30	joko	1.2	* Revision 1.1 2003/03/03 22:05:25 joko
31			* abstract implementation... ;-)
32	joko	1.4	* </pre>
33			*
34	joko	1.1	*
35	joko	1.4	*/
36
37
38			/**
39			* Load required modules:
40	joko	1.1	*
41			*/
42	joko	1.4	loadModule('Class::Logger');
43	joko	1.1
44
45			/**
46	joko	1.3	* An attempt to implement some software design patterns...
47	joko	1.1	* --- ProxyPattern
48			*
49	joko	1.3	* @link http://c2.com/cgi-bin/wiki?ProxyPattern
50	joko	1.1	*
51			* @author Andreas Motl <andreas.motl@ilo.de>
52	joko	1.3	* @link http://www.netfrag.org/~joko/
53			*
54	joko	1.1	* @copyright (c) 2003 - All Rights reserved.
55			* @license GNU LGPL (GNU Lesser General Public License)
56	joko	1.3	* @link http://www.gnu.org/licenses/lgpl.txt
57	joko	1.1	*
58			* @package org.netfrag.glib
59	joko	1.5	* @subpackage DesignPattern
60	joko	1.3	* @name DesignPattern::Proxy
61	joko	1.1	*
62	joko	1.6	* @todo (x) DesignPattern::DecoratorProxy (->decorate)
63			* @todo (x) DesignPattern::TransparentProxy (->make_transparent)
64			* @todo (o) DesignPattern::MultiProxy (->both???) (diamond inheritance? possible in php?)
65			* @todo (o) DesignPattern::GenericAdapterProxy???
66			* @todo (o) no 'locator/query' or 'type/component'
67			* @todo (o) even more generic: just 'adapter_metadata' (-> global adapter registry?)
68	joko	1.1	*
69			*/
70			class DesignPattern_Proxy extends Class_Logger {
71
72			/**
73			* This holds some information about the tracing level.
74			*
75			*/
76			var $_debug = array(
77	joko	1.2	notice => 1,
78			trace => 1,
79			payload => 1,
80	joko	1.1	);
81
82			var $_component_name;
83			var $_component_options;
84
85			/**
86			* This var holds the Handler object
87			* that is used to do the work.
88			* It acts as a dispatcher combining result caching.
89			* It is assumed that this provides 4 methods:
90			* queryData() - execute a query against a data storage
91			* querySchema() - execute a query against underlying storage metadata
92			* sendCommand() - send a command against an arbitrary execution engine
93			* ... or others! (these are just proposals for convenience)
94			*
95			*/
96	joko	1.2	var $_proxy = NULL;
97	joko	1.1
98
99			/**
100			* This var holds options fed to the Proxy object
101			* These are built from locator metadata (_locator) and query arguments (_query)
102			* It's a simple structured hash:
103			* $proxy_options = array(
104			* method => '<remote-method-name>',
105			* args => array('list', 'of', 'arguments')
106			* );
107			*
108			*/
109	joko	1.2	var $_proxy_options = NULL;
110	joko	1.1
111
112			function about() {
113			$this->_about =
114			<<<ABOUT
115			* --- DesignPattern::Proxy
116			* --- http://cvs.netfrag.org/nfo/php/libs/org.netfrag.glib/DesignPattern/Proxy.php
117			*
118			* http://c2.com/cgi-bin/wiki?ProxyPattern says...
119			* Intent: Provide a surrogate or placeholder for another object to control access to it.
120			* http://www.fluffycat.com/java/patterns.html says...
121			* One class controls the creation of and access to objects in another class.
122
123			ABOUT;
124			}
125
126
127			function constructor($handler = array()) {
128			if (sizeof($handler)) {
129	joko	1.2	$this->set_proxy($handler);
130	joko	1.1	}
131	joko	1.2	$this->create_proxy();
132			$this->call_proxy();
133	joko	1.1	}
134
135			/*
136			function _abstract_method($method) {
137			$package = get_class($this);
138			$package_p = get_parent_class($this);
139			user_error("DesignPattern::Proxy.$package_p.$package: Please implement method '$method'.");
140			}
141			*/
142
143
144			/**
145			* Directly inject a Handler instance to use.
146			*
147			* @param Handler object - &$handler
148			*
149			*/
150	joko	1.2	function set_proxy( &$handler ) {
151			$this->_proxy = &$handler;
152	joko	1.1	}
153
154	joko	1.2	function &get_proxy() {
155			return $this->_proxy;
156	joko	1.1	}
157
158	joko	1.2	function call_proxy() {
159			$this->_abstract_method('call_proxy', 'DesignPattern::Proxy');
160	joko	1.1	}
161
162			function set_component_name($name) {
163			$this->_component_name = $name;
164			}
165			function get_component_name() {
166			return $this->_component_name;
167			}
168	joko	1.2	function set_component_options_v1() {
169			$options = func_get_args();
170			if (is_array($options)) {
171			if (is_hash($options)) {
172			$this->_component_options = $options;
173			} else {
174			$this->_component_options = array();
175			foreach ($options as $option) {
176			array_push($this->_component_options, $option);
177			}
178			}
179			} else {
180			$this->_component_options = $options;
181			}
182			}
183			function set_component_options() {
184			$options = func_get_args();
185			if (sizeof($options) >= 1) {
186			$this->_component_options = array();
187			foreach ($options as $option) {
188			array_push($this->_component_options, $option);
189			}
190			} else {
191			$this->_component_options = $options;
192			}
193	joko	1.1	}
194			function get_component_options() {
195			return $this->_component_options;
196			}
197
198	joko	1.2	function create_proxy() {
199			//print "DesignPattern::Proxy->create_proxy<br/>";
200	joko	1.1	//print "comp: " . $this->get_component_name() . "<br/>";
201			//print "comp: " . $this->get_component_options() . "<br/>";
202			$handler = php::mkComponent( $this->get_component_name(), $this->get_component_options() );
203			//print Dumper($handler);
204			//exit;
205
206	joko	1.2	$this->set_proxy( $handler );
207	joko	1.1	}
208
209
210			}
211
212			?>
MailToCvsAdmin">MailToCvsAdmin	ViewVC Help
Powered by ViewVC 1.1.26