Apache Zeta Components Manual :: File Source for view_handler.php

Source for file view_handler.php

Documentation is available at view_handler.php

  1. <?php
  2. /**
  3.  * File containing the ezcMvcViewHandler class
  4.  *
  5.  * Licensed to the Apache Software Foundation (ASF) under one
  6.  * or more contributor license agreements.  See the NOTICE file
  7.  * distributed with this work for additional information
  8.  * regarding copyright ownership.  The ASF licenses this file
  9.  * to you under the Apache License, Version 2.0 (the
  10.  * "License"); you may not use this file except in compliance
  11.  * with the License.  You may obtain a copy of the License at
  12.  * 
  13.  *   http://www.apache.org/licenses/LICENSE-2.0
  14.  * 
  15.  * Unless required by applicable law or agreed to in writing,
  16.  * software distributed under the License is distributed on an
  17.  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
  18.  * KIND, either express or implied.  See the License for the
  19.  * specific language governing permissions and limitations
  20.  * under the License.
  21.  *
  22.  * @license http://www.apache.org/licenses/LICENSE-2.0 Apache License, Version 2.0
  23.  * @version //autogentag//
  24.  * @filesource
  25.  * @package MvcTools
  26.  */
  27.  
  28. /**
  29.  * Interface defining view handlers.
  30.  *
  31.  * A view handler is the implementation of a view that converts the abstract
  32.  * ezcMvcResult objects to ezcMvcResponse objects - which are then send to the
  33.  * client with a response writer.
  34.  *
  35.  * @package MvcTools
  36.  * @version //autogentag//
  37.  */
  38. {
  39.     /**
  40.      * Creates a new view handler, where $name is the name of the block and
  41.      * $templateLocation the location of a view template.
  42.      *
  43.      * @param string $name 
  44.      * @param string $templateLocation 
  45.      */
  46.     public function __construct$name$templateLocation null );
  47.  
  48.     /**
  49.      * Adds a variable to the template, which can then be used for rendering
  50.      * the view.
  51.      *
  52.      * @param string $name 
  53.      * @param mixed $value 
  54.      */
  55.     public function send$name$value );
  56.  
  57.     /**
  58.      * Processes the template with the variables added by the send() method.
  59.      * The result of this action should be retrievable through the getResult() method.
  60.      *
  61.      * The $last parameter is set if the view handler is the last one in the
  62.      * list of zones for a specific view.
  63.      *
  64.      * @param bool $last 
  65.      */
  66.     public function process$last );
  67.  
  68.     /**
  69.      * Returns the name of the template, as set in the constructor.
  70.      *
  71.      * @return string 
  72.      */
  73.     public function getName();
  74.  
  75.     /**
  76.      * Returns the result of the process() method.
  77.      *
  78.      * @return mixed 
  79.      */
  80.     public function getResult();
  81. }
  82. ?>
Documentation generated by phpDocumentor 1.4.3