[Sommaire] [Imprimer]

   1  <?php
   2  //
   3  // Definition of eZTemplateOperator class
   4  //
   5  // Created on: <01-Mar-2002 13:50:09 amos>
   6  //
   7  // SOFTWARE NAME: eZ publish
   8  // SOFTWARE RELEASE: 3.9.0
   9  // BUILD VERSION: 17785
  10  // COPYRIGHT NOTICE: Copyright (C) 1999-2006 eZ systems AS
  11  // SOFTWARE LICENSE: GNU General Public License v2.0
  12  // NOTICE: >
  13  //   This program is free software; you can redistribute it and/or
  14  //   modify it under the terms of version 2.0  of the GNU General
  15  //   Public License as published by the Free Software Foundation.
  16  //
  17  //   This program is distributed in the hope that it will be useful,
  18  //   but WITHOUT ANY WARRANTY; without even the implied warranty of
  19  //   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  20  //   GNU General Public License for more details.
  21  //
  22  //   You should have received a copy of version 2.0 of the GNU General
  23  //   Public License along with this program; if not, write to the Free
  24  //   Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
  25  //   MA 02110-1301, USA.
  26  //
  27  //
  28  
  29  /*!
  30    \class eZTemplateOperator eztemplateoperator.php
  31    \ingroup eZTemplateOperators
  32    \brief Base documentation class for operators
  33  
  34    \note This class is never used but only exists for documentation purposes.
  35  */
  36  
  37  class eZTemplateOperator
  38  {
  39      /*!
  40       Returns the template operators which are registered when using eZTemplate::registerOperators()
  41      */
  42      function &operatorList()
  43      {
  44          $operationList = array();
  45          return $operationList;
  46      }
  47  
  48      /*!
  49       Returns an array of named parameters, this allows for easier retrieval
  50       of operator parameters. This also requires the function modify() has an extra
  51       parameter called $named_params.
  52  
  53       The position of each element (starts at 0) represents the position of the original
  54       sequenced parameters. The key of the element is used as parameter name, while the
  55       contents define the type and requirements.
  56       The keys of each element content is:
  57       * type - defines the type of parameter allowed
  58       * required - boolean which says if the parameter is required or not, if missing
  59                    and required an error is displayed
  60       * default - the default value if the parameter is missing
  61      */
  62      function namedParameterList()
  63      {
  64          return array();
  65      }
  66  
  67      /*!
  68       Modifies the input variable $value and sets the output result in the same variable.
  69  
  70       \note Remember to use references on the function arguments.
  71      */
  72      function modify( /*! The operator element, can be used for doing advanced querying but should be avoided. */
  73                       &$element,
  74                       /*! The template object which called this class */
  75                       &$tpl,
  76                       /*! The name of this operator */
  77                       &$op_name,
  78                       /*! The parameters for this operator */
  79                       &$op_params,
  80                       /*! The namespace which this operator works in */
  81                       &$namespace,
  82                       /*! The current namespace for functions, this is usually used in functions
  83                           for setting new variables. */
  84                       /*! The input/output value */
  85                       &$value,
  86                       /*! The parameters as named lookups, only required if namedParameterList() is defined.
  87                           The values of each parameter is also fetched for you. */
  88                       &$named_params )
  89      {
  90      }
  91  
  92  }
  93  
  94  ?>