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

Source for file FinderInterface.php

Documentation is available at FinderInterface.php

  1. <?php
  2.  
  3. /* vim: set expandtab tabstop=4 shiftwidth=4 softtabstop=4: */
  4.  
  5. /**
  6.  * This file is part of the PEAR Testing_DocTest package.
  7.  *
  8.  * PHP version 5
  9.  *
  10.  * LICENSE: This source file is subject to the MIT license that is available
  11.  * through the world-wide-web at the following URI:
  12.  * http://opensource.org/licenses/mit-license.php
  13.  *
  14.  * @category  Testing
  15.  * @package   Testing_DocTest
  16.  * @author    David JEAN LOUIS <izimobil@gmail.com>
  17.  * @copyright 2008 David JEAN LOUIS
  18.  * @license   http://opensource.org/licenses/mit-license.php MIT License
  19.  * @version   CVS: $Id$
  20.  * @link      http://pear.php.net/package/Testing_DocTest
  21.  * @since     File available since release 0.1.0
  22.  * @filesource
  23.  */
  24.  
  25. /**
  26.  * DocTest Finder interface.
  27.  * All finders must implement this interface.
  28.  *
  29.  * @category  Testing
  30.  * @package   Testing_DocTest
  31.  * @author    David JEAN LOUIS <izimobil@gmail.com>
  32.  * @copyright 2008 David JEAN LOUIS
  33.  * @license   http://opensource.org/licenses/mit-license.php MIT License
  34.  * @version   Release: 0.6.0
  35.  * @link      http://pear.php.net/package/Testing_DocTest
  36.  * @since     Class available since release 0.1.0
  37.  */
  38. {
  39.     // find() {{{
  40.  
  41.     /**
  42.      * Must return an array that have this structure:
  43.      * <code>
  44.      * array(
  45.      *     '/absolute/path/to/file1.php',
  46.      *     '/absolute/path/to/file2.php',
  47.      * )
  48.      * </code>
  49.      *
  50.      * @param array $pathes an array of files and/or directories, glob syntax
  51.      *                       is supported, ie. you can pass arrays like this:
  52.      *                       array('file1.php', '{dir2,dir3}/*.php')
  53.      *
  54.      * @access public
  55.      * @return array an array of files with their realpathes
  56.      */
  57.     public function find(array $pathes);
  58.  
  59.     // }}}
  60. }

Documentation generated on Thu, 17 Jan 2013 10:30:05 +0000 by phpDocumentor 1.4.3. PEAR Logo Copyright © PHP Group 2004.