使用 Agavi 进行 MVC 编程简介，第 4 部分: 创建一个带有多种输出类型（XML、RSS 或 SOAP）的 Agavi 搜索引擎

shell> agavi action-wizard
Module name: Listing
Action name: Search
Space-separated list of views to create for Search [Success]: Error Success
			

				        
<?xml version="1.0" encoding="UTF-8"?>
<ae:configurations xmlns:ae="http://agavi.org/agavi/config/global/envelope/1.0" 
 xmlns="http://agavi.org/agavi/config/parts/routing/1.0">
  <ae:configuration>
    <routes>
      ...
      <!-- action for listing pages "/listing" -->
      <route name="listing" pattern="^/listing" module="Listing">
        <route name=".create" pattern="^/create$" action="Create" />
        <route name=".display" pattern="^/display/(id:\d+)$" action="Display" />
        <route name=".search" pattern="^/search$" action="Search" />
      </route>
      ...
    </routes>
  </ae:configuration>
</ae:configurations>

				        
<?php
class Listing_SearchAction extends WASPListingBaseAction
{
  public function getDefaultViewName()
  {
    return 'Success';
  }
}
?>

				        
<?php
class Listing_SearchSuccessView extends WASPListingBaseView
{
  public function executeHtml(AgaviRequestDataHolder $rd)
  {
    $this->setupHtml($rd);
    $this->getContext()->getRequest()->setAttribute('populate', 
     array('fsearch' => true), 'org.agavi.filter.FormPopulationFilter');    
  }
}
?>

				        
<h3>Search Listings</h3>
<form id="fsearch" action="<?php echo $ro->gen('listing.search'); ?>" 
 method="get">
  <fieldset>
    <legend>Criteria</legend> 
    Color: 
    <input id="color" type="text" name="color" style="width:120px" />
    
    Year: 
    <input id="year" type="text" name="year" size="4" style="width:100px" />
    
    Price: 
    <input id="price" type="text" name="price" style="width:140px" />
    
    <button id="search" type="submit"/>
  </fieldset>    
</form>

<h3>Search Results</h3>

<?php if (count($t['records']) == 0): ?>
No records available
<?php else: ?>
  <?php $x = 1; ?>
  <?php foreach ($t['records'] as $record): ?>
  <div>
    <strong><?php echo $x; ?>. 
    <a href="<?php echo $ro->gen('listing.display', 
     array('id' => $record['RecordID'])); ?>"><?php printf('%d %s %s (%s)',
     $record['VehicleYear'], $record['Manufacturer']['ManufacturerName'], 
     ucwords(strtolower($record['VehicleModel'])), 
     ucwords(strtolower($record['VehicleColor']))); ?></a>
    </strong>
    <br/>
    Mileage: <?php echo $record['VehicleMileage']; ?>     
    <br/> 
    Sale price: $<?php echo $record['VehicleSalePriceMin']; ?> - 
    $<?php echo $record['VehicleSalePriceMax']; ?> 
    <?php echo ($record['VehicleSalePriceIsNegotiable'] == 1) ? 
     '(negotiable)' : null; ?>
    <br/> 
    Location: <?php echo $record['OwnerCity']; ?>, 
     <?php echo $record['Country']['CountryName']; ?>
    <br/> 
    Submitted: <?php echo date('d M Y', strtotime($record['RecordDate'])); ?>
    <p/>
  </div>
  <?php $x++; ?>
  <?php endforeach; ?>
<?php endif; ?>

<p/>
<strong>
  <a href="<?php echo $ro->gen('listing.create'); ?>">
  Add a new listing</a>
</strong>

				        
<?xml version="1.0" encoding="UTF-8"?>
<ae:configurations
  xmlns="http://agavi.org/agavi/config/parts/validators/1.0"
  xmlns:ae="http://agavi.org/agavi/config/global/envelope/1.0"
  parent="%core.module_dir%/Listing/config/validators.xml"
>
  <ae:configuration>
    
    <validators>
    
      <validator class="string">
        <arguments>
          <argument>color</argument>
        </arguments>
        <errors>
          <error>ERROR: Vehicle color is invalid</error>
        </errors>
        <ae:parameters>
          <ae:parameter name="required">false</ae:parameter>
        </ae:parameters>
      </validator>              
                  
      <validator class="number">
        <arguments>
          <argument>year</argument>
        </arguments>
        <errors>
          <error for="type">ERROR: Vehicle year of manufacture is invalid
          </error>
          <error for="min">ERROR: Vehicle year of manufacture is before 1900
          </error>
          <error for="max">ERROR: Vehicle year of manufacture is after 2020
          </error>
        </errors>
        <ae:parameters>
          <ae:parameter name="type">int</ae:parameter>
          <ae:parameter name="min">1901</ae:parameter>
          <ae:parameter name="max">2020</ae:parameter>
          <ae:parameter name="required">false</ae:parameter>
        </ae:parameters>
      </validator>             
            
      <validator class="number">
        <arguments>
          <argument>price</argument>
        </arguments>
        <errors>
          <error>ERROR: Vehicle price is invalid</error>
        </errors>
        <ae:parameters>
          <ae:parameter name="type">int</ae:parameter>
          <ae:parameter name="min">0</ae:parameter>
          <ae:parameter name="required">false</ae:parameter>
        </ae:parameters>
      </validator>                            
                  
    </validators>
    
  </ae:configuration>
</ae:configurations>

				        
<?php
class Listing_SearchAction extends WASPListingBaseAction
{
  public function getDefaultViewName()
  {
    return 'Success';
  }
  
  public function executeRead(AgaviRequestDataHolder $rd) 
  {   
    try {
      // create base query
      $q = Doctrine_Query::create()
            ->from('Listing l')
            ->leftJoin('l.Manufacturer m')
            ->leftJoin('l.Country c')
            ->addWhere('l.DisplayStatus = 1')
            ->addWhere('l.DisplayUntilDate >= CURDATE()');
            
      // add criteria
      if ($rd->getParameter('color')) {
        $q->addWhere('l.VehicleColor LIKE ?', sprintf('%%%s%%', 
         $rd->getParameter('color')));  
      }            
      
      if ($rd->getParameter('year')) {
        $q->addWhere('l.VehicleYear = ?', $rd->getParameter('year'));  
      }            
      
      if ($rd->getParameter('price')) {
        $q->addWhere('? BETWEEN l.VehicleSalePriceMin AND l.VehicleSalePriceMax', 
         $rd->getParameter('price'));  
      }            

      $q->orderBy('l.RecordDate DESC');
      
      // execute query and assign results to template variable
      $results = $q->fetchArray();
      $this->setAttribute('records', $results);
      return 'Success';
    } catch (Exception $e) {
      $this->setAttribute('error', $e->getMessage());  
      return 'Error';
    }
  }
}
?>

				        
<?php
class Listing_SearchErrorView extends WASPListingBaseView
{
  public function executeHtml(AgaviRequestDataHolder $rd)
  {
    $this->setupHtml($rd);
    // if validation errors, render input template
    if ($this->container->getValidationManager()->getReport()->count()) {
      $this->getLayer('content')->setTemplate('SearchSuccess');   
      $this->getContext()->getRequest()->setAttribute('populate', 
       array('fsearch' => true), 'org.agavi.filter.FormPopulationFilter');    
    }   
  }
}
?>

				        
<h3>Search Listings</h3>
There was an error processing your submission. Please try again later.
<br/><br/>
<code style="color: red">
<?php echo $t['error']; ?>
</code>

				        
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" 
 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">

    ...
    <!-- begin header -->
    <div id="header">
      <div id="logo">
        <img src="/images/logo.jpg" />
      </div>
      <div id="menu">
        <ul>
          <li><a href="<?php echo $ro->gen('index'); ?>">
          Home</a></li>
          <li><a href="<?php echo $ro->gen('listing.search'); ?>">
          For Sale</a></li>
          <li><a href="<?php echo $ro->gen('content', 
           array('page' => 'other-services')); ?>">Other Services</a>
          </li>
          <li><a href="<?php echo $ro->gen('content', 
           array('page' => 'about-us')); ?>">About Us</a></li>
          <li><a href="<?php echo $ro->gen('contact'); ?>">
          Contact Us</a></li>
        </ul>
      </div>
    </div>
    <!-- end header -->
    ...

</html>

				        
<?xml version="1.0" encoding="UTF-8"?>
<ae:configurations xmlns:ae="http://agavi.org/agavi/config/global/envelope/1.0" 
 xmlns="http://agavi.org/agavi/config/parts/output_types/1.0">
  
  <ae:configuration>
    <output_types default="html">
      <output_type name="html">
        
        <renderers default="php">
          <renderer name="php" class="AgaviPhpRenderer">
            <ae:parameter name="assigns">
              <ae:parameter name="routing">ro</ae:parameter>
              <ae:parameter name="request">rq</ae:parameter>
              <ae:parameter name="controller">ct</ae:parameter>
              <ae:parameter name="user">us</ae:parameter>
              <ae:parameter name="translation_manager">tm</ae:parameter>
              <ae:parameter name="request_data">rd</ae:parameter>
            </ae:parameter>
            <ae:parameter name="default_extension">.php</ae:parameter>
            <!-- this changes the name of the variable with all template attributes 
            from the default $template to $t -->
            <ae:parameter name="var_name">t</ae:parameter>
          </renderer>
        </renderers>
        
        <layouts default="standard">
          <!-- standard layout with a content and a decorator layer -->
          <layout name="standard">
            <!-- content layer without further params. this means the standard 
            template is used, i.e. the one with the same name as the current view -->
            <layer name="content" />
            <!-- decorator layer with the HTML skeleton, navigation etc; set to 
            a specific template here -->
            <layer name="decorator">
              <ae:parameter name="directory">%core.template_dir%
              </ae:parameter>
              <ae:parameter name="template">Master</ae:parameter>
            </layer>
          </layout>
          
          <layout name="admin">
            <layer name="content" />
            <layer name="decorator">
              <ae:parameter name="directory">%core.template_dir%
              </ae:parameter>
              <ae:parameter name="template">AdminMaster</ae:parameter>
            </layer>
          </layout>         
          
          <!-- another example layout that has an intermediate wrapper layer in 
          between content and decorator -->
          <!-- it also shows how to use slots etc -->
          <layout name="wrapped">
            <!-- content layer without further params. this means the standard 
            template is used, i.e. the one with the same name as the current view -->
            <layer name="content" />
            <layer name="wrapper">
              <!-- use CurrentView.wrapper.php instead of CurrentView.php as 
              the template for this one -->
              <ae:parameter name="extension">.wrapper.php</ae:parameter>
            </layer>
            <!-- decorator layer with the HTML skeleton, navigation etc; set to 
            a specific template here -->
            <layer name="decorator">
              <ae:parameter name="directory">%core.template_dir%
              </ae:parameter>
              <ae:parameter name="template">Master</ae:parameter>
              <!-- an example for a slot -->
              <slot name="nav" module="Default" action="Widgets.Navigation" />
            </layer>
          </layout>
          
          <!-- special layout for slots that only has a content layer to prevent 
          the obvious infinite loop that would otherwise occur if the decorator layer 
          has slots assigned in the layout; this is loaded automatically by 
          ProjectBaseView::setupHtml() in case the current container is run as a slot -->
          <layout name="simple">
            <layer name="content" />
          </layout>
        </layouts>
        
        <ae:parameter name="http_headers">
          <ae:parameter name="Content-Type">text/html; charset=UTF-8
          </ae:parameter>
        </ae:parameter>
        
      </output_type>
    </output_types>
  </ae:configuration>
  
  <ae:configuration environment="production.*">
    <output_types default="html">
      
      <!-- use a different exception template in production envs -->
      <!-- others are defined in settings.xml -->
      <output_type name="html" 
       exception_template="%core.template_dir%/exceptions/web-html.php" />
      
    </output_types>
  </ae:configuration>
</ae:configurations>

<route name="show" pattern="^/show$" module="Default" action="Show" output_type="xml" />

				        
<?xml version="1.0" encoding="UTF-8"?>
<ae:configurations xmlns:ae="http://agavi.org/agavi/config/global/envelope/1.0" 
xmlns="http://agavi.org/agavi/config/parts/output_types/1.0">
  
  <ae:configuration>    
    <output_types default="html">      
      <output_type name="html">
        ...
      </output_type>
      
      <output_type name="xml">
        <ae:parameter name="http_headers">
          <ae:parameter name="Content-Type">text/xml; charset=UTF-8
          </ae:parameter>
        </ae:parameter>
      </output_type>               
    </output_types>    
  </ae:configuration>
  
</ae:configurations>

				        
<?xml version="1.0" encoding="UTF-8"?>
<ae:configurations xmlns:ae="http://agavi.org/agavi/config/global/envelope/1.0" 
 xmlns="http://agavi.org/agavi/config/parts/routing/1.0">
  <ae:configuration>
    <routes>
      <!-- handler for .xml requests -->
      <route name="xml" pattern=".xml$" cut="true" stop="false" output_type="xml" />    
      ...  
    </routes>
  </ae:configuration>
</ae:configurations>

				        
<?php
class Listing_SearchSuccessView extends WASPListingBaseView
{
  public function executeHtml(AgaviRequestDataHolder $rd)
  {
    $this->setupHtml($rd);
    $this->getContext()->getRequest()->setAttribute('populate', 
     array('fsearch' => true), 'org.agavi.filter.FormPopulationFilter');    
  }
  
  public function executeXml(AgaviRequestDataHolder $rd)
  {
    // get records
    $records = $this->getAttribute('records');
    
    // create document
    $dom = new DOMDocument('1.0', 'utf-8');

    // create root element
    $root = $dom->createElementNS('http://www.melonfire.com/agavi-wasp', 
     'wasp:results');    
    $dom->appendChild($root);
    
    // import to SimpleXML for easier manipulation
    $xml = simplexml_import_dom($dom);
    
    // add result count
    $xml->addChild('count', count($records));
        
    // add results
    foreach ($records as $record) {
      $listing = $xml->addChild('result');      
      $listing->addChild('id', $record['RecordID']);
      $listing->addChild('submissionDate', $record['RecordDate']);
      $listing->addChild('manufacturer', 
       $record['Manufacturer']['ManufacturerName']);
      $listing->addChild('model', ucwords(strtolower($record['VehicleModel'])));
      $listing->addChild('year', $record['VehicleYear']);
      $listing->addChild('color', $record['VehicleColor']);
      $listing->addChild('year', $record['VehicleYear']);
      $listing->addChild('mileage', $record['VehicleMileage']);
      $price = $listing->addChild('price');
      $price->addChild('min', $record['VehicleSalePriceMin']);
      $price->addChild('max', $record['VehicleSalePriceMax']);
      $location = $listing->addChild('location');
      $location->addChild('city', $record['OwnerCity']);
      $location->addChild('country', $record['Country']['CountryName']);        
    }
    
    // return output
    return $xml->asXML();    
  }   
}
?>

				        
<?xml version="1.0" encoding="utf-8"?>
<wasp:results xmlns:wasp="http://www.melonfire.com/agavi-wasp">
  <wasp:count>2</wasp:count>
  <wasp:result>
    <wasp:id>1</wasp:id>
    <wasp:submissionDate>2009-07-03</wasp:submissionDate>
    <wasp:manufacturer>Porsche</wasp:manufacturer>
    <wasp:model>Boxster</wasp:model>
    <wasp:year>2005</wasp:year>
    <wasp:color>Yellow</wasp:color>
    <wasp:year>2005</wasp:year>
    <wasp:mileage>15457</wasp:mileage>
    <wasp:price>
      <wasp:min>35000</wasp:min>
      <wasp:max>40000</wasp:max>
    </wasp:price>
    <wasp:location>
      <wasp:city>London</wasp:city>
      <wasp:country>United Kingdom</wasp:country>
    </wasp:location>
  </wasp:result>
  <wasp:result>
    <wasp:id>7</wasp:id>
    <wasp:submissionDate>2009-06-07</wasp:submissionDate>
    <wasp:manufacturer>Ferrari</wasp:manufacturer>
    <wasp:model>612 Scaglietti</wasp:model>
    <wasp:year>2003</wasp:year>
    <wasp:color>Yellow</wasp:color>
    <wasp:year>2003</wasp:year>
    <wasp:mileage>10974</wasp:mileage>
    <wasp:price>
      <wasp:min>125000</wasp:min>
      <wasp:max>200000</wasp:max>
    </wasp:price>
    <wasp:location>
      <wasp:city>London</wasp:city>
      <wasp:country>United Kingdom</wasp:country>
    </wasp:location>
  </wasp:result>
</wasp:results>

				        
<?php

/**
 * The base view from which all Listing module views inherit.
 */
class WASPListingBaseView extends WASPBaseView
{
  // set values from selection lists
  function setInputViewAttributes() {
    $q = Doctrine_Query::create()
          ->from('Country c');    
    $this->setAttribute('countries', $q->fetchArray());
    
    $q = Doctrine_Query::create()
          ->from('Manufacturer m');
    $this->setAttribute('manufacturers', $q->fetchArray());
  }  
  
  // generate XML-encoded error message
  function getErrorXml($message) {
    $dom = new DOMDocument('1.0');
    $root = $dom->createElementNS('http://www.melonfire.com/agavi-wasp', 
     'wasp:error');    
    $dom->appendChild($root);        
    $xml = simplexml_import_dom($dom);
    $xml->addChild('message', $message);      
    return $xml->asXML();       
  }    
}
?>

				        
<?php
class Listing_SearchErrorView extends WASPListingBaseView
{
  public function executeHtml(AgaviRequestDataHolder $rd)
  {
    $this->setupHtml($rd);
    // if validation errors, render input template
    if ($this->container->getValidationManager()->getReport()->count()) {
      $this->getLayer('content')->setTemplate('SearchSuccess');   
      $this->getContext()->getRequest()->setAttribute('populate', 
       array('fsearch' => true), 'org.agavi.filter.FormPopulationFilter');    
    }   
  }
  
  public function executeXml(AgaviRequestDataHolder $rd)
  {
    if ($this->container->getValidationManager()->getReport()->count()) {
      return $this->getErrorXml('Validation error');
    } else {
      return $this->getErrorXml('Application error');      
    }
  }   
}
?>

				        
<?php
class Listing_DisplayAction extends WASPListingBaseAction
{

  public function getDefaultViewName()
  {
    return 'Success';
  }

  public function executeRead(AgaviRequestDataHolder $rd)
  {
    try {
      $id = $rd->getParameter('id');
      $q = Doctrine_Query::create()
            ->from('Listing l')
            ->leftJoin('l.Manufacturer m')
            ->leftJoin('l.Country c')
            ->where('l.RecordID = ?', $id)
            ->addWhere('l.DisplayStatus = 1')
            ->addWhere('l.DisplayUntilDate >= CURDATE()')
            ->orderBy('l.RecordDate DESC');
      $result = $q->fetchArray();
      if (count($result) == 1) {
        $this->setAttribute('listing', $result[0]);
        return 'Success';
      } else {
        return 'Redirect404';
      }
    } catch (Exception $e) {
      $this->setAttribute('error', $e->getMessage());  
      return 'Error';
    }
  }  
}

?>

				        
<?php

class Listing_DisplaySuccessView extends WASPListingBaseView
{
  public function executeHtml(AgaviRequestDataHolder $rd)
  {
    $this->setupHtml($rd);
  }
  
  public function executeXml(AgaviRequestDataHolder $rd)
  {
    // get record
    $record = $this->getAttribute('listing');
    
    // create document
    $dom = new DOMDocument('1.0', 'utf-8');

    // create root element
    $root = $dom->createElementNS('http://www.melonfire.com/agavi-wasp', 
     'wasp:result');    
    $dom->appendChild($root);
    
    // import to SimpleXML for easier manipulation
    $xml = simplexml_import_dom($dom);
    
    // add nodes to XML output
    $xml->addChild('id', $record['RecordID']);
    $xml->addChild('submissionDate', $record['RecordDate']);
    $xml->addChild('manufacturer', $record['Manufacturer']['ManufacturerName']);
    $xml->addChild('model', ucwords(strtolower($record['VehicleModel'])));
    $xml->addChild('year', $record['VehicleYear']);
    $xml->addChild('color', strtolower($record['VehicleColor']));
    $xml->addChild('mileage', $record['VehicleMileage']);
    $xml->addChild('singleOwner', $record['VehicleIsFirstOwned']);
    $xml->addChild('certified', $record['VehicleIsCertified']);
    $xml->addChild('certifiedDate', $record['VehicleCertificationDate']);
    $xml->addChild('note', $record['Note']);
    
    $accessoryArr = array(
      '1'  => 'Power steering', 
      '2'  => 'Power windows', 
      '4'  => 'Audio system', 
      '8'  => 'Video system', 
      '16' => 'Keyless entry system',
      '32' => 'GPS',
      '64' => 'Alloy wheels'
    );
    $accessories = $xml->addChild('accessories');
    foreach ($accessoryArr as $k => $v) {
      if ($record['VehicleAccessoryBit'] & $k) {
        $accessories->addChild('item', $v);
      }
    }
    
    $price = $xml->addChild('price');
    $price->addChild('min', $record['VehicleSalePriceMin']);
    $price->addChild('max', $record['VehicleSalePriceMax']);
    $price->addChild('negotiable', $record['VehicleSalePriceIsNegotiable']);
    
    $location = $xml->addChild('location');
    $location->addChild('city', $record['OwnerCity']);
    $location->addChild('country', $record['Country']['CountryName']);        
    
    // return output
    return $xml->asXML();       
  }    
}
?>

				        
<?xml version="1.0" encoding="utf-8"?>
<wasp:result xmlns:wasp="http://www.melonfire.com/agavi-wasp">
  <wasp:id>1</wasp:id>
  <wasp:submissionDate>2009-07-03</wasp:submissionDate>
  <wasp:manufacturer>Porsche</wasp:manufacturer>
  <wasp:model>Boxster</wasp:model>
  <wasp:year>2005</wasp:year>
  <wasp:color>yellow</wasp:color>
  <wasp:mileage>15457</wasp:mileage>
  <wasp:singleOwner>1</wasp:singleOwner>
  <wasp:certified>1</wasp:certified>
  <wasp:certifiedDate>2008-01-01</wasp:certifiedDate>
  <wasp:note></wasp:note>
  <wasp:accessories>
    <wasp:item>Power steering</wasp:item>
    <wasp:item>Power windows</wasp:item>
    <wasp:item>Audio system</wasp:item>
    <wasp:item>Keyless entry system</wasp:item>
  </wasp:accessories>
  <wasp:price>
    <wasp:min>35000</wasp:min>
    <wasp:max>40000</wasp:max>
    <wasp:negotiable>1</wasp:negotiable>
  </wasp:price>
  <wasp:location>
    <wasp:city>London</wasp:city>
    <wasp:country>United Kingdom</wasp:country>
  </wasp:location>
</wasp:result>

				        
<?php
class Listing_DisplayErrorView extends WASPListingBaseView
{
  public function executeHtml(AgaviRequestDataHolder $rd)
  {
    $this->setupHtml($rd);
  }
  
  public function executeXml(AgaviRequestDataHolder $rd)
  {
    if ($this->container->getValidationManager()->getReport()->count()) {
      return $this->getErrorXml('Validation error');
    } else {
      return $this->getErrorXml('Application error');      
    }
  }    
}
?>