Loader/PluginLoader/Interface.php

0001 <?php
0002 /**
0003  * Zend Framework
0004  *
0005  * LICENSE
0006  *
0007  * This source file is subject to the new BSD license that is bundled
0008  * with this package in the file LICENSE.txt.
0009  * It is also available through the world-wide-web at this URL:
0010  * http://framework.zend.com/license/new-bsd
0011  * If you did not receive a copy of the license and are unable to
0012  * obtain it through the world-wide-web, please send an email
0013  * to license@zend.com so we can send you a copy immediately.
0014  *
0015  * @category   Zend
0016  * @package    Zend_Loader
0017  * @subpackage PluginLoader
0018  * @copyright  Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
0019  * @license    http://framework.zend.com/license/new-bsd     New BSD License
0020  * @version    $Id$
0021  */
0022
0023 /**
0024  * Plugin class loader interface
0025  *
0026  * @category   Zend
0027  * @package    Zend_Loader
0028  * @subpackage PluginLoader
0029  * @copyright  Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
0030  * @license    http://framework.zend.com/license/new-bsd     New BSD License
0031  */
0032 interface Zend_Loader_PluginLoader_Interface
0033 {
0034     /**
0035      * Add prefixed paths to the registry of paths
0036      *
0037      * @param string $prefix
0038      * @param string $path
0039      * @return Zend_Loader_PluginLoader
0040      */
0041     public function addPrefixPath($prefix, $path);
0042
0043     /**
0044      * Remove a prefix (or prefixed-path) from the registry
0045      *
0046      * @param string $prefix
0047      * @param string $path OPTIONAL
0048      * @return Zend_Loader_PluginLoader
0049      */
0050     public function removePrefixPath($prefix, $path = null);
0051
0052     /**
0053      * Whether or not a Helper by a specific name
0054      *
0055      * @param string $name
0056      * @return Zend_Loader_PluginLoader
0057      */
0058     public function isLoaded($name);
0059
0060     /**
0061      * Return full class name for a named helper
0062      *
0063      * @param string $name
0064      * @return string
0065      */
0066     public function getClassName($name);
0067
0068     /**
0069      * Load a helper via the name provided
0070      *
0071      * @param string $name
0072      * @return string
0073      */
0074     public function load($name);
0075 }