MediaSearch_Config_ParseOptions
[ class tree: MediaSearch_Config_ParseOptions ] [ index: MediaSearch_Config_ParseOptions ] [ all elements ]

Source for file Interface.php

Documentation is available at Interface.php

  1. <?php
  2. /**
  3.  * MediaSearch
  4.  *
  5.  * LICENSE
  6.  *
  7.  * "THE BEER-WARE LICENSE" (Revision 42):
  8.  * "Sven Strittmatter" <ausserirdisch@sven-space.de> wrote this file.
  9.  * As long as you retain this notice you can do whatever you want with
  10.  * this stuff. If we meet some day, and you think this stuff is worth it,
  11.  * you can buy me a beer in return.
  12.  *
  13.  * $Author$
  14.  * $Revision$
  15.  *
  16.  * @category    MediaSearch
  17.  * @package     MediaSearch_Config_ParseOptions
  18.  * @copyright   Copyright (c) 2009 Sven Strittmatter
  19.  */
  20.  
  21.  /**
  22.   * Objects implementing this interface can be added to objects of type
  23.   * MediaSearch_Config_Interface. You can use these objects to implement
  24.   * parse options which modify the default parse behaviour of the
  25.   * a config file objects. This parse options are called in the order they
  26.   * were added. They receive the whole config data to process it.
  27.   *
  28.   * @category   MediaSearch
  29.   * @package    MediaSearch_Config_ParseOptions
  30.   * @copyright  Copyright (c) 2009 Sven Strittmatter
  31.   */
  32.     /**
  33.      * This method is called by the config object to which this parse option was
  34.      * added. Its expects the config data as input to parse. It must return the
  35.      * parsed config data.
  36.      *
  37.      * If the parse option object is the first one called by the config file
  38.      * it gets the original loaded config ffile string to process. All following
  39.      * parse options get the processed return valiou of the previous parse object.
  40.      * This can be a string or an array or any other type.
  41.      * 
  42.      * @access public
  43.      * @param  mixed $input 
  44.      * @return mixed 
  45.      */
  46.     public function parse($input);
  47. }

Documentation generated on Mon, 17 Aug 2009 14:53:14 +0200 by phpDocumentor 1.4.2