[Summary view] [Print] [Text view]

   1  <?php
   2  /*
   3   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
   4   * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
   5   * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
   6   * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
   7   * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
   8   * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
   9   * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  10   * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  11   * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  12   * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  13   * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  14   *
  15   * This software consists of voluntary contributions made by many individuals
  16   * and is licensed under the MIT license.
  17   */
  18  
  19  namespace ProxyManager\Inflector;
  20  
  21  /**
  22   * Interface for a proxy- to user-class and user- to proxy-class name inflector
  23   *
  24   * @author Marco Pivetta <ocramius@gmail.com>
  25   * @license MIT
  26   */
  27  interface ClassNameInflectorInterface
  28  {
  29      /**
  30       * Marker for proxy classes - classes containing this marker are considered proxies
  31       */
  32      const PROXY_MARKER = '__PM__';
  33  
  34      /**
  35       * Retrieve the class name of a user-defined class
  36       *
  37       * @param string $className
  38       *
  39       * @return string
  40       */
  41      public function getUserClassName($className);
  42  
  43      /**
  44       * Retrieve the class name of the proxy for the given user-defined class name
  45       *
  46       * @param string $className
  47       * @param array  $options   arbitrary options to be used for the generated class name
  48       *
  49       * @return string
  50       */
  51      public function getProxyClassName($className, array $options = array());
  52  
  53      /**
  54       * Retrieve whether the provided class name is a proxy
  55       *
  56       * @param string $className
  57       *
  58       * @return bool
  59       */
  60      public function isProxyClassName($className);
  61  }