AjaMyAjax: Basic SOAP Example for Zend Framework

* Aja · My · Ajax *

Basic SOAP Example for Zend Framework from AjaMyAjax...

This app example based on a prior Zend QuickStart tutorial design and
is for those who want an EASY SOAP style example to get a jump start..
Or want a simple client/server project to build your own app engine...
Or want to engineer a cloud-based platform for your own in-house servers...
But this design is original and does NOT follow other SOAP conventions.

The source samples follow the install text.  All source should all be
platform independent: Linux, Windows, Mac, or anywhere you can run ZF.
But this test configuration is Windows/WampServer just for reference.

Easy install instructions (or how I use this app anyway):

1) download and install Zend Framework by putting the Zend folder in a
   server directory path (mine is wamp\www).  I renamed the current lib
   folder to 'Zend' just to keep it simple.  And the full or minimal
   package works here, but only min is needed for this basic example.

2) add either an include path for the \Zend\library... folder as they
   indicate, or copy the \Zend\library\Zend folder into the same library
   folder with the rest of this app.  The include path in this index.php
   start-up file should find either one.

   This is what I added to my server's php.ini just for reference:
   include_path = ".;c:\wamp\www\zend\library"
   (not the php.ini in the php directory, if you edit this manually)

3) install this app folder in the server path.  (I put it in ..\Zend also).

4) start/re-start your test server.

5) then run a URL something like this in your browser:
   http://localhost/Zend/BasicSOAP/index.php

Yes, you can use simpler URL's with server conf changes but that's up to you.
But .htaccess files are not needed with this.

Here is the default directory structure I use:

\wamp\www\Zend\BasicSOAP...
then:
   ..\application
      ..\controllers
      ..\layouts
      ..\models
      ..\views
   ..\data
      ..\php
      ..\text
      ..\xml
   ..\library (basically empty, where the Zend folder goes if needed)
   ..\public
      ..\css
      ..\SOAP

This works but I might move the shared files and libs to a more common area
later on.

For Linux, remember to install the php cURL lib with apt-get install curl php5-curl
or similar command in terminal (in this case for Debian-based Ubuntu).

Just another simple ZF example here, but hope this helps.  Best of luck.

Mark Omohundro, AjaMyAjax.com


This software provided "AS IS," but is FREE to use and share.
For details see the Creative Commons license:
http://creativecommons.org/licenses/by-sa/3.0/

Download Basic SOAP for Zend Framework here...

Here are some source samples of what is included. The index is in a Zend Framework
design of course with my simpler directory and include changes plus a bit more.
The DEFINEs carry through to the app content. The server URL is set here, but note
this is for demonstration purposes only. Use the included php to set up your own.

And please note this has only the client/server portion of a SOAP re-design implemented
at this time. But you should find it easy to use and enhance (that's the goal here).

<?php
// root/index.php

define('APPLICATION_NAME','Your App');
define('APPLICATION_PATH','application');
define('APPLICATION_SERVER','http://ajamyajax.com/');
define('APPLICATION_LINK','http://yourlink.com');

// get SOAP app run-time menu option
$menuopt = (isset($_REQUEST['opt'])) ? $_REQUEST['opt'] : 1;
define('APPLICATION_MENUOPT', $menuopt);

error_reporting(E_ALL | E_STRICT);

// hard code path appended for easy Linux use (tested with Ubuntu)
set_include_path('library'. PATH_SEPARATOR. get_include_path().
  PATH_SEPARATOR. 'public/SOAP/'.
  PATH_SEPARATOR. '/usr/share/php/libzend-framework-php/');     

include 'Zend/Loader/Autoloader.php';
$autoloader = Zend_Loader_Autoloader::getInstance();
$autoloader->setFallbackAutoloader(true);
...
?>

The bootstrap file is similar to the Quick Start design but has only what this app needs.
APPLICATION_PATH needed again for the Zend Framework library...

<?php
// application/bootstrap.php

defined('APPLICATION_PATH')
    or define('APPLICATION_PATH', dirname(__FILE__));

//defined('APPLICATION_ENVIRONMENT')
//    or define('APPLICATION_ENVIRONMENT', 'development');

$frontController = Zend_Controller_Front::getInstance();
$frontController->throwExceptions(true);
$frontController->setControllerDirectory(APPLICATION_PATH. '/controllers');
...
?>

Uses a fat controller design that includes parameter-based example server calls with
a user id and pw security option. XML support is only built into a cURL lib used here
but a future release might add an XML payload for a full ZF SOAP implementation.

<?php
// application/controllers/IndexController.php

class IndexController extends Zend_Controller_Action {
  protected $_model;

  // direct index call available from controller...
  public function indexAction() {
    $model = $this->_getModel();

    // example stock quote data displayed from server at screen coordinates
    // note example1-5 params are id values used for css only
    switch (APPLICATION_MENUOPT):
      case 1:
        // encoded name and password added to request (validated by server):
        $client1 = $this->clientdata_encode("mycorporatehrdept");
        $pw1 = $this->clientdata_encode("hrpw");
        $url = APPLICATION_SERVER.
          "soapserver.php?symbol=aapl&type=simple&auth=$client1&pw=$pw1";
        $model->fetchSOAP($url, 15, 125, 'example1');
        break;

      case 2:
        $url = APPLICATION_SERVER. "soapserver.php?symbol=aapl&type=detailed";
        $model->fetchSOAP($url, 15, 125, 'example2');
        break;
      ...
      default:
    endswitch;
  }

  protected function _getModel() {
    if (null === $this->_model) {
      require_once APPLICATION_PATH. '/models/SOAP.php';
      $this->_model = new Model_SOAP();
    }
    return $this->_model;
  }
  ...
}
?>

The model contains the SOAP client request translated into a cURL object call.

<?php /* application/models/SOAP.php */ ?>

<?php
class Model_SOAP {
  public function fetchSOAP($strurl, $intleft, $inttop, $container) {
    // note: cURL lib used to run server URL (included)

    $testSOAP = new cURLCore;
    $testSOAP->url = $strurl;
    $testSOAP->leftpx = $intleft;
    $testSOAP->toppx = $inttop;
    $testSOAP->container = $container;
    $testSOAP->cURLCoreInit();
    $testSOAP = null;
  }
}
?>

The layout has the static page information: header, footer plus content
as demonstrated in the Quick Start. I customized it from there.

<?php /* application/layouts/scripts/layout.phtml */ ?>

<?php echo $this->doctype() ?>
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"/>
<title><?php echo APPLICATION_NAME ?> Application</title>
<link href="public/css/global.css" rel="stylesheet" type="text/css"/>
</head>
<body>

<div id="header">
  <div id="header-logo" style="float: left">
    <b><?php echo APPLICATION_NAME ?> Logo here</b>
  </div>
  <div id="header-navigation" style="float: right">
    <a href="<?php echo APPLICATION_LINK ?>">Home Page</a>
  </div>
</div>

<div id="content">
  <?php echo $this->layout()->content ?>
</div>

<div id="helper">
  <br/><br/>
  [Sample data retrieved from soapserver on:&nbsp;
  <?php echo APPLICATION_SERVER ?>]
</div>
...
</body>
</html>

The view page in this example has the user interaction features.
Content combines with the layout gives you a flexible SOAP ZF design.
This should be apparent when you run the example.

<?php /* application/views/scripts/index/index.phtml */ ?>

<h2 align="center">
  <?php echo APPLICATION_NAME ?> Title
</h2>

<!-- anchor menu examples for interactive use demonstration -->
<a href="index.php?opt=1" title="aapl stock, basic example"/>
  Simple Quote</a>

<a href="index.php?opt=2" title="aapl stock, detailed example"/>
  Detailed Quote</a>
...

I hope that gives you more info about what MVC and Zend Framework can do for you
with simple PHP SOAP routines added. A few sample data files are in the download with
the PHP cURL Lib source, CSS, and the install text at the top of this page.

If Zend with JavaScript AJAX is what you need instead, try the BasicAjax example...

Download Basic SOAP for Zend Framework here...

More tips later plus other PHP, JavaScript, SOAP source can be accessed at AjaMyAjax...
(where you can get free example code that actually works)....

Also have you tried free, fast, easy-to-use Ubuntu Linux yet, Windows($) users???
Get it here: Ubuntu download page ...

"Why Ubuntu Linux is better than Windows"
(or IMO at least worth trying before paying for your next O/S upgrade*)

* Easy to install and supports more devices than you might think
* Several current versions available from server to cool graphics and low memory U/I
* Fast booting after install, even on old computers with little memory
* Can coexist with Windows (if necessary) and be trial run on boot CD or DVD
* More secure operating system by design with practically no viruses
* Various customizable user interfaces to suit your preferences and your hardware
* Easy app software upgrade and maintenance utilities with graphical interfaces
* Many free add-on packages include office tools, available with one-click installation
* Popular browsers such as FireFox, Opera, and even Google Chrome are now available
* Smart user community with plenty of internet support available
* And best of all, Ubuntu is free!