[Summary view] [Print] [Text view]

   1  <?php
   2  
   3  declare(strict_types=1);
   4  
   5  namespace ProxyManager\Inflector;
   6  
   7  /**
   8   * Interface for a proxy- to user-class and user- to proxy-class name inflector
   9   *
  10   * @author Marco Pivetta <ocramius@gmail.com>
  11   * @license MIT
  12   */
  13  interface ClassNameInflectorInterface
  14  {
  15      /**
  16       * Marker for proxy classes - classes containing this marker are considered proxies
  17       */
  18      const PROXY_MARKER = '__PM__';
  19  
  20      /**
  21       * Retrieve the class name of a user-defined class
  22       */
  23      public function getUserClassName(string $className) : string;
  24  
  25      /**
  26       * Retrieve the class name of the proxy for the given user-defined class name
  27       *
  28       * @param string $className
  29       * @param array  $options   arbitrary options to be used for the generated class name
  30       */
  31      public function getProxyClassName(string $className, array $options = []) : string;
  32  
  33      /**
  34       * Retrieve whether the provided class name is a proxy
  35       */
  36      public function isProxyClassName(string $className) : bool;
  37  }