[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\Proxy;
  20  
  21  /**
  22   * Lazy loading object identifier
  23   *
  24   * @author Marco Pivetta <ocramius@gmail.com>
  25   * @license MIT
  26   */
  27  interface LazyLoadingInterface extends ProxyInterface
  28  {
  29      /**
  30       * Set or unset the initializer for the proxy instance
  31       *
  32       * @link https://github.com/Ocramius/ProxyManager/blob/master/docs/lazy-loading-value-holder.md#lazy-initialization
  33       *
  34       * An initializer should have a signature like following:
  35       *
  36       * <code>
  37       * $initializer = function (& $wrappedObject, $proxy, $method, $parameters, & $initializer) {};
  38       * </code>
  39       *
  40       * @param \Closure|null $initializer
  41       *
  42       * @return mixed
  43       */
  44      public function setProxyInitializer(\Closure $initializer = null);
  45  
  46      /**
  47       * @return \Closure|null
  48       */
  49      public function getProxyInitializer();
  50  
  51      /**
  52       * Force initialization of the proxy
  53       *
  54       * @return bool true if the proxy could be initialized
  55       */
  56      public function initializeProxy();
  57  
  58      /**
  59       * Retrieves current initialization status of the proxy
  60       *
  61       * @return bool
  62       */
  63      public function isProxyInitialized();
  64  }