plugins/Irc/extlib/phergie/Phergie/Plugin/Php/Source.php

   1 <?php
   2 /**
   3  * Phergie
   4  *
   5  * PHP version 5
   6  *
   7  * LICENSE
   8  *
   9  * This source file is subject to the new BSD license that is bundled
  10  * with this package in the file LICENSE.
  11  * It is also available through the world-wide-web at this URL:
  12  * http://phergie.org/license
  13  *
  14  * @category  Phergie
  15  * @package   Phergie_Plugin_Php
  16  * @author    Phergie Development Team <team@phergie.org>
  17  * @copyright 2008-2010 Phergie Development Team (http://phergie.org)
  18  * @license   http://phergie.org/license New BSD License
  19  * @link      http://pear.phergie.org/package/Phergie_Plugin_Php
  20  */
  21
  22 /**
  23  * Data source interface for the Php plugin.
  24  *
  25  * @category Phergie
  26  * @package  Phergie_Plugin_Php
  27  * @author   Phergie Development Team <team@phergie.org>
  28  * @license  http://phergie.org/license New BSD License
  29  * @link     http://pear.phergie.org/package/Phergie_Plugin_Php
  30  * @uses     extension pdo
  31  * @uses     extension pdo_sqlite
  32  * @uses     Phergie_Plugin_Command pear.phergie.org
  33  */
  34 interface Phergie_Plugin_Php_Source
  35 {
  36     /**
  37      * Searches for a description of the function.
  38      *
  39      * @param string $function Search pattern to match against the function
  40      *        name, wildcards supported using %
  41      *
  42      * @return array|null Associative array containing the function name and
  43      *         description or NULL if no results are found
  44      */
  45     public function findFunction($function);
  46 }