Class XOAD_Client

Description

XOAD Client Class.

This class is used to register a PHP variable/class in JavaScript.

This class is also used to assign meta data to the classes. See XOAD_Client::publicMethods, XOAD_Client::privateMethods, XOAD_Client::publicVariables, XOAD_Client::privateVariables and XOAD_Client::mapMethods for more information.

Example:

  1. <?php
  2.  
  3. class Calculator
  4. {
  5. var $result;
  6.  
  7. function Calculator()
  8. {
  9. $this->result = 0;
  10. }
  11.  
  12. function Add($arg)
  13. {
  14. $this->result += $arg;
  15. }
  16. }
  17.  
  18. define('XOAD_AUTOHANDLE', true);
  19.  
  20. require_once('xoad.php');
  21.  
  22. ?>
  23. <?= XOAD_Utilities::header() ?>
  24. <script type="text/javascript">
  25.  
  26. var calc = <?= XOAD_Client::register(new Calculator()) ?>;
  27.  
  28. calc.add(10);
  29. calc.add(20);
  30.  
  31. alert(calc.result);
  32.  
  33. </script>

  • version: 0.6.0.0
  • author: Stanimir Angeloff

Located in /classes/Client.class.php (line 98)

XOAD_Observable
   |
   --XOAD_Client
Method Summary
 string addObserver (mixed &$observer)
 void mapMethods (object &$var, array $methodsMap)
 bool notifyObservers ([mixed $event = 'default'], [mixed $arg = null])
 void privateMethods (object &$var, array $methods)
 void privateVariables (object &$var, array $variables)
 void publicMethods (object &$var, array $methods)
 void publicVariables (object &$var, array $variables)
 string register (mixed $var, [mixed $params = null])
Methods
addObserver (line 531)

Adds a XOAD_Client events observer.

  • return: true on success, false otherwise.
  • static:
  • access: public
string addObserver (mixed &$observer)
  • mixed $observer: The observer object to add (must extend XOAD_Observer).

Redefinition of:
XOAD_Observable::addObserver()
mapMethods (line 502)

Assigns methods map to the class meta data.

  • static:
void mapMethods (object &$var, array $methodsMap)
  • object $var: The object where the meta data is stored.
  • array $methodsMap: The class methods map.
notifyObservers (line 543)
  • access: public
bool notifyObservers ([mixed $event = 'default'], [mixed $arg = null])

Redefinition of:
XOAD_Observable::notifyObservers()
privateMethods (line 415)

Assigns private methods to the class meta data.

  • static:
void privateMethods (object &$var, array $methods)
  • object $var: The object where the meta data is stored.
  • array $methods: The class private methods.
privateVariables (line 473)

Assigns private variables to the class meta data.

  • static:
void privateVariables (object &$var, array $variables)
  • object $var: The object where the meta data is stored.
  • array $variables: The class private variables.
publicMethods (line 386)

Assigns public methods to the class meta data.

  • static:
void publicMethods (object &$var, array $methods)
  • object $var: The object where the meta data is stored.
  • array $methods: The class public methods.
publicVariables (line 444)

Assigns public variables to the class meta data.

  • static:
void publicVariables (object &$var, array $variables)
  • object $var: The object where the meta data is stored.
  • array $variables: The class public variables.
register (line 128)

Registers a PHP variable/class in JavaScript.

Example:

  1. <script type="text/javascript">
  2. <?php require_once('xoad.php'); ?>
  3.  
  4. var arr = <?= XOAD_Client::register(array(1, 2, "string", array("Nested"))) ?>;
  5.  
  6. alert(arr);
  7.  
  8. </script>

  • return: JavaString code that represents the variable/class.
  • static:
  • access: public
string register (mixed $var, [mixed $params = null])
  • mixed $var: Variable/Class name to register.
  • mixed $params: When registering a variable/class you can provide extended parameters, like class name and callback URL.

Inherited Methods

Inherited From XOAD_Observable

 XOAD_Observable::addObserver()
 XOAD_Observable::notifyObservers()

Documentation generated on Sat, 12 Nov 2005 20:23:56 +0200 by phpDocumentor 1.3.0RC3