1: <?php
  2: /*
  3:     File: xajaxEventPlugin.inc.php
  4: 
  5:     Contains the xajaxEventPlugin class
  6: 
  7:     Title: xajaxEventPlugin class
  8: 
  9:     Please see <copyright.inc.php> for a detailed description, copyright
 10:     and license information.
 11: */
 12: 
 13: /*
 14:     @package xajax
 15:     @version $Id: xajaxEventPlugin.inc.php 362 2007-05-29 15:32:24Z calltoconstruct $
 16:     @copyright Copyright (c) 2005-2007 by Jared White & J. Max Wilson
 17:     @copyright Copyright (c) 2008-2009 by Joseph Woolley, Steffen Konerow, Jared White  & J. Max Wilson
 18:     @license http://www.xajaxproject.org/bsd_license.txt BSD License
 19: */
 20: 
 21: /*
 22:     Constant: XAJAX_EVENT
 23:         Specifies that the item being registered via the <xajax->register> function
 24:         is an event.
 25:         
 26:     Constant: XAJAX_EVENT_HANDLER
 27:         Specifies that the item being registered via the <xajax->register> function
 28:         is an event handler.
 29: */
 30: if (!defined ('XAJAX_EVENT')) define ('XAJAX_EVENT', 'xajax event');
 31: if (!defined ('XAJAX_EVENT_HANDLER')) define ('XAJAX_EVENT_HANDLER', 'xajax event handler');
 32: 
 33: //SkipAIO
 34: require dirname(__FILE__) . '/support/xajaxEvent.inc.php';
 35: //EndSkipAIO
 36: 
 37: /*
 38:     Class: xajaxEventPlugin
 39:     
 40:     Plugin that adds server side event handling capabilities to xajax.  Events can
 41:     be registered, then event handlers attached.
 42: */
 43: class xajaxEventPlugin extends xajaxRequestPlugin
 44: {
 45:     /*
 46:         Array: aEvents
 47:     */
 48:     var $aEvents;
 49: 
 50:     /*
 51:         String: sXajaxPrefix
 52:     */
 53:     var $sXajaxPrefix;
 54:     
 55:     /*
 56:         String: sEventPrefix
 57:     */
 58:     var $sEventPrefix;
 59: 
 60:     /*
 61:         String: sDefer
 62:     */
 63:     var $sDefer;
 64:     
 65:     var $bDeferScriptGeneration;
 66: 
 67:     /*
 68:         String: sRequestedEvent
 69:     */
 70:     var $sRequestedEvent;
 71: 
 72:     /*
 73:         Function: xajaxEventPlugin
 74:     */
 75:     function xajaxEventPlugin()
 76:     {
 77:         $this->aEvents = array();
 78: 
 79:         $this->sXajaxPrefix = 'xajax_';
 80:         $this->sEventPrefix = 'event_';
 81:         $this->sDefer = '';
 82:         $this->bDeferScriptGeneration = false;
 83: 
 84:         $this->sRequestedEvent = NULL;
 85: 
 86:         if (isset($_GET['xjxevt'])) $this->sRequestedEvent = $_GET['xjxevt'];
 87:         if (isset($_POST['xjxevt'])) $this->sRequestedEvent = $_POST['xjxevt'];
 88:     }
 89: 
 90:     /*
 91:         Function: configure
 92:     */
 93:     function configure($sName, $mValue)
 94:     {
 95:         if ('wrapperPrefix' == $sName) {
 96:             $this->sXajaxPrefix = $mValue;
 97:         } else if ('eventPrefix' == $sName) {
 98:             $this->sEventPrefix = $mValue;
 99:         } else if ('scriptDefferal' == $sName) {
100:             if (true === $mValue) $this->sDefer = 'defer ';
101:             else $this->sDefer = '';
102:         } else if ('deferScriptGeneration' == $sName) {
103:             if (true === $mValue || false === $mValue)
104:                 $this->bDeferScriptGeneration = $mValue;
105:             else if ('deferred' === $mValue)
106:                 $this->bDeferScriptGeneration = $mValue;
107:         }
108:     }
109: 
110:     /*
111:         Function: register
112: 
113:         $sType - (string): type of item being registered
114:         $sEvent - (string): the name of the event
115:         $ufHandler - (function name or reference): a reference to the user function to call
116:         $aConfiguration - (array): an array containing configuration options
117:     */
118:     function register($aArgs)
119:     {
120:         if (1 < count($aArgs))
121:         {
122:             $sType = $aArgs[0];
123: 
124:             if (XAJAX_EVENT == $sType)
125:             {
126:                 $sEvent = $aArgs[1];
127: 
128:                 if (false === isset($this->aEvents[$sEvent]))
129:                 {
130:                     $xe = new xajaxEvent($sEvent);
131: 
132:                     if (2 < count($aArgs))
133:                         if (is_array($aArgs[2]))
134:                             foreach ($aArgs[2] as $sKey => $sValue)
135:                                 $xe->configure($sKey, $sValue);
136: 
137:                     $this->aEvents[$sEvent] =& $xe;
138: 
139:                     return $xe->generateRequest($this->sXajaxPrefix, $this->sEventPrefix);
140:                 }
141:             }
142: 
143:             if (XAJAX_EVENT_HANDLER == $sType)
144:             {
145:                 $sEvent = $aArgs[1];
146: 
147:                 if (isset($this->aEvents[$sEvent]))
148:                 {
149:                     if (isset($aArgs[2]))
150:                     {
151:                         $xuf =& $aArgs[2];
152: 
153:                         if (false === ($xuf instanceof xajaxUserFunction))
154:                             $xuf = new xajaxUserFunction($xuf);
155: 
156:                         $objEvent =& $this->aEvents[$sEvent];
157:                         $objEvent->addHandler($xuf);
158: 
159:                         return true;
160:                     }
161:                 }
162:             }
163:         }
164: 
165:         return false;
166:     }
167: 
168:     /*
169:         Function: generateClientScript
170:     */
171:     function generateClientScript()
172:     {
173:         if (false === $this->bDeferScriptGeneration || 'deferred' === $this->bDeferScriptGeneration)
174:         {
175:             if (0 < count($this->aEvents))
176:             {
177:                 echo "\n<script type='text/javascript' ";
178:                 echo $this->sDefer;
179:                 echo "charset='UTF-8'>\n";
180:                 echo "/* <![CDATA[ */\n";
181: 
182:                 foreach (array_keys($this->aEvents) as $sKey)
183:                     $this->aEvents[$sKey]->generateClientScript($this->sXajaxPrefix, $this->sEventPrefix);
184: 
185:                 echo "/* ]]> */\n";
186:                 echo "</script>\n";
187:             }
188:         }
189:     }
190: 
191:     /*
192:         Function: canProcessRequest
193:     */
194:     function canProcessRequest()
195:     {
196:         if (NULL == $this->sRequestedEvent)
197:             return false;
198: 
199:         return true;
200:     }
201: 
202:     /*
203:         Function: processRequest
204:     */
205:     function processRequest()
206:     {
207:         if (NULL == $this->sRequestedEvent)
208:             return false;
209: 
210:         $objArgumentManager =& xajaxArgumentManager::getInstance();
211:         $aArgs = $objArgumentManager->process();
212:         
213: 
214: 
215:         foreach (array_keys($this->aEvents) as $sKey)
216:         {
217:             $objEvent =& $this->aEvents[$sKey];
218: 
219:             if ($objEvent->getName() == $this->sRequestedEvent)
220:             {
221:                 $objEvent->fire($aArgs);
222:                 return true;
223:             }
224:         }
225: 
226:         return 'Invalid event request received; no event was registered with this name.';
227:     }
228: }
229: 
230: $objPluginManager =& xajaxPluginManager::getInstance();
231: $objPluginManager->registerPlugin(new xajaxEventPlugin(), 103);