[Summary view] [Print] [Text view]

   1  <?php
   2  //=============================================================================
   3  //
   4  // Copyright Francois Laupretre <automap@tekwire.net>
   5  //
   6  //   Licensed under the Apache License, Version 2.0 (the "License");
   7  //   you may not use this file except in compliance with the License.
   8  //   You may obtain a copy of the License at
   9  //
  10  //       http://www.apache.org/licenses/LICENSE-2.0
  11  //
  12  //   Unless required by applicable law or agreed to in writing, software
  13  //   distributed under the License is distributed on an "AS IS" BASIS,
  14  //   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15  //   See the License for the specific language governing permissions and
  16  //   limitations under the License.
  17  //
  18  //=============================================================================
  19  /**
  20  * @copyright Francois Laupretre <automap@tekwire.net>
  21  * @license http://www.apache.org/licenses/LICENSE-2.0 Apache License, V 2.0
  22  * @category Automap
  23  * @package Automap
  24  *///==========================================================================
  25  
  26  //===========================================================================
  27  /**
  28  * Parser interface
  29  *
  30  * A parser class used to create a map must implement this interface
  31  *
  32  * Included in the PHK PHP runtime: No
  33  * Implemented in the extension: No
  34  *///==========================================================================
  35  
  36  namespace Automap\Build {
  37  
  38  if (!interface_exists('Automap\Build\ParserInterface',false)) 
  39  {
  40  interface ParserInterface
  41  {
  42  //---------------------------------
  43  /**
  44  * Extracts symbols from an extension
  45  *
  46  * @param string $file Extension name
  47  * @return null
  48  * @throw \Exception if extension cannot be loaded
  49  */
  50  
  51  public function parseExtension($file);
  52  
  53  //---------------------------------
  54  /**
  55  * Extracts symbols from a PHP script file
  56  *
  57  * @param string $path File to parse
  58  * @return array of symbols
  59  * @throws \Exception on parse error
  60  */
  61  
  62  public function parseScriptFile($path);
  63  
  64  //---------------------------------
  65  /**
  66  * Extracts symbols from a PHP script contained in a string
  67  *
  68  * @param string $buf The script to parse
  69  * @return null
  70  * @throws \Exception on parse error
  71  */
  72  
  73  public function parseScript($buf);
  74  
  75  //---
  76  } // End of class
  77  //===========================================================================
  78  } // End of interface_exists
  79  //===========================================================================
  80  } // End of namespace
  81  //===========================================================================
  82  ?>