[commits] [Wiki] changed: Doc/Dev/HordeAjaxApplications

[Michael Slusarz]

slusarz  Tue, 23 Jul 2013 17:35:35 +0000

Modified page: http://wiki.horde.org/Doc/Dev/HordeAjaxApplications
New Revision:  5
Change log:  Don't use imples; they are archaic and can generally be  
rewritten using the Ajax framework instead

@@ -95,55 +95,8 @@
   * @author  Michael Slusarz <slusarz at horde.org>
   * @package Horde
   */
  </code>
-
-
-+++ What is an imple?
-An Imple inherits from Horde_Core_Ajax_Imple and implements php code  
tied to a javascript request
-(how is this related to a services/ajax call?)
-
-Horde_Core ships some imple's, apps define theirs in  
$app/lib/Ajax/Imple/Foo.php
-<code>
-<?php
-// phpdoc here
-class $App_Ajax_Imple_$Foo extends Horde_Core_Ajax_Imple {}
-// or
-class $App_Ajax_Imple_$Foo extends Horde_Core_Ajax_Imple_$Bar {}
-?>
-</code>
-
-Imple methods:
-(Not much documentation available. Maybe we find a good example)
-<code>
- /**
-     * Attach the object to a javascript event.
-     */
-    abstract public function attach();
-
-  /**
-     * TODO
-     *
-     * @param array $args  TODO
-     */
-    abstract public function handle($args, $post);
-</code>
-
-Example:
-
-''This example is probably not the way they do it today as I read it  
some time ago from a very dated 2/2012 git checkout''
-
-Kronolith_Ajax_Imple_Embed returns a javascript calendar widget for  
use in external sites
-The attach() method is implemented as noop.
-The handle() method takes some arguments and returns a processed  
js/html snippet
-
-Kronolith users should paste a snippet like this into their website  
to use the calendar widget:
-<code>
-<div id="kronolithCal"></div><script  
src="/services/ajax.php/kronolith/embed?token=c_T1Vso1zfaSOMEMAGICHERENHKWmg1&calendar=internal_70fhZCYOURSISDIFFERENTRWNDA&container=kronolithCal&view=month"  
type="text/javascript"></script>
-</code>
-So this finally calls services/ajax.php , starts/authenticates (HOW?)  
the kronolith app, passes the "embed" action and the URL parameters to  
Kronolith_Ajax_Application which runs doAction();
-(How does doAction trigger the imple?)
-

  +++ $App_Ajax_Application_Handler
  A Handler inherits from Horde_Core_Ajax_Application_Handler and can  
manage external/public (unauthenticated??) calls
  extends Horde_Core_Ajax_Application_Handler