root/dev/mods/xajax/xajax_core/plugin_layer/support/xajaxCallableObject.inc.php @ 259

<?php
/*
        File: xajaxCallableObject.inc.php

        Contains the xajaxCallableObject class

        Title: xajaxCallableObject class

        Please see <copyright.inc.php> for a detailed description, copyright
        and license information.
*/

/*
        @package xajax
        @version $Id: xajaxCallableObject.inc.php 362 2007-05-29 15:32:24Z calltoconstruct $
        @copyright Copyright (c) 2005-2006 by Jared White & J. Max Wilson
        @license http://www.xajaxproject.org/bsd_license.txt BSD License
*/

/*
        Class: xajaxCallableObject
        
        A class that stores a reference to an object whose methods can be called from
        the client via a xajax request.  <xajax> will call 
        <xajaxCallableObject->generateClientScript> so that stub functions can be 
        generated and sent to the browser.
*/
class xajaxCallableObject
{
        /*
                Object: obj
                
                A reference to the callable object.
        */
        var $obj;
        
        /*
                Array: aConfiguration
                
                An associative array that will contain configuration options for zero
                or more of the objects methods.  These configuration options will 
                define the call options for each request.  The call options will be
                passed to the client browser when the function stubs are generated.
        */
        var $aConfiguration;
        
        /*
                Function: xajaxCallableObject
                
                Constructs and initializes the <xajaxCallableObject>
                
                obj - (object):  The object to reference.
        */
        function xajaxCallableObject(&$obj)
        {
                $this->obj =& $obj;
                $this->aConfiguration = array();
        }
        
        /*
                Function: getName
                
                Returns the name of this callable object.  This is typically the
                class name of the object.
        */
        function getName()
        {
                return get_class($this->obj);
        }
        
        /*
                Function: configure
                
                Used to set configuration options / call options for each method.
                
                sMethod - (string):  The name of the method.
                sName - (string):  The name of the configuration option.
                sValue - (string):  The value to be set.
        */
        function configure($sMethod, $sName, $sValue)
        {
                $sMethod = strtolower($sMethod);
                
                if (false == isset($this->aConfiguration[$sMethod]))
                        $this->aConfiguration[$sMethod] = array();
                        
                $this->aConfiguration[$sMethod][$sName] = $sValue;
        }

        /*
                Function: generateRequests
                
                Produces an array of <xajaxRequest> objects, one for each method
                exposed by this callable object.
                
                sXajaxPrefix - (string):  The prefix to be prepended to the
                        javascript function names; this will correspond to the name
                        used for the function stubs that are generated by the
                        <xajaxCallableObject->generateClientScript> call.
        */
        function generateRequests($sXajaxPrefix)
        {
                $aRequests = array();
                
                $sClass = get_class($this->obj);
                
                foreach (get_class_methods($this->obj) as $sMethodName)
                {
                        $bInclude = true;
                        // exclude magic __call method
                        if ("__call" == $sMethodName)
                                $bInclude = false;
                        // exclude constructor
                        if ($sClass == $sMethodName)
                                $bInclude = false;
                        if ($bInclude)
                                $aRequests[strtolower($sMethodName)] =& 
                                        new xajaxRequest("{$sXajaxPrefix}{$sClass}.{$sMethodName}");
                }

                return $aRequests;
        }
        
        /*
                Function: generateClientScript
                
                Called by <xajaxCallableObject->generateClientScript> while <xajax> is 
                generating the javascript to be sent to the browser.

                sXajaxPrefix - (string):  The prefix to be prepended to the
                        javascript function names.
        */      
        function generateClientScript($sXajaxPrefix)
        {
                $sClass = get_class($this->obj);
                
                echo "{$sXajaxPrefix}{$sClass} = {};\n";
                
                foreach (get_class_methods($this->obj) as $sMethodName)
                {
                        $bInclude = true;
                        // exclude magic __call method
                        if ("__call" == $sMethodName)
                                $bInclude = false;
                        // exclude constructor
                        if ($sClass == $sMethodName)
                                $bInclude = false;
                        if ($bInclude)
                        {
                                echo "{$sXajaxPrefix}{$sClass}.{$sMethodName} = function() { ";
                                echo "return xajax.request( ";
                                echo "{ xjxcls: '{$sClass}', xjxmthd: '{$sMethodName}' }, ";
                                echo "{ parameters: arguments";
                                
                                $sSeparator = ", ";
                                if (isset($this->aConfiguration['*']))
                                        foreach ($this->aConfiguration['*'] as $sKey => $sValue)
                                                echo "{$sSeparator}{$sKey}: {$sValue}";
                                if (isset($this->aConfiguration[strtolower($sMethodName)]))
                                        foreach ($this->aConfiguration[strtolower($sMethodName)] as $sKey => $sValue)
                                                echo "{$sSeparator}{$sKey}: {$sValue}";

                                echo " } ); ";
                                echo "};\n";
                        }
                }
        }
        
        /*
                Function: isClass
                
                Determins if the specified class name matches the class name of the
                object referenced by <xajaxCallableObject->obj>.
                
                sClass - (string):  The name of the class to check.
                
                Returns:
                
                boolean - True of the specified class name matches the class of
                        the object being referenced; false otherwise.
        */
        function isClass($sClass)
        {
                return is_a($this->obj, $sClass);
        }
        
        /*
                Function: hasMethod
                
                Determines if the specified method name is one of the methods of the
                object referenced by <xajaxCallableObject->obj>.
                
                sMethod - (object):  The name of the method to check.
                
                Returns:
                
                boolean - True of the referenced object contains the specified method,
                        false otherwise.
        */
        function hasMethod($sMethod)
        {
                return method_exists($this->obj, $sMethod) || method_exists($this->obj, "__call");
        }
        
        /*
                Function: call
                
                Call the specified method of the object being referenced using the specified
                array of arguments.
                
                sMethod - (string): The name of the method to call.
                aArgs - (array):  The arguments to pass to the method.
        */
        function call($sMethod, $aArgs)
        {
                $objResponseManager =& xajaxResponseManager::getInstance();
                $objResponseManager->append(
                        call_user_func_array(
                                array(&$this->obj, $sMethod), 
                                $aArgs
                                )
                        );
        }
}