vendor/doctrine/common/lib/Doctrine/Common/Persistence/Proxy.php

   1 <?php
   2
   3 /*
   4  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
   5  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
   6  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
   7  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
   8  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
   9  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  10  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  11  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  12  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  13  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  14  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  15  *
  16  * This software consists of voluntary contributions made by many individuals
  17  * and is licensed under the MIT license. For more information, see
  18  * <http://www.doctrine-project.org>.
  19  */
  20
  21 namespace Doctrine\Common\Persistence;
  22
  23 /**
  24  * Interface for proxy classes.
  25  *
  26  * @author Roman Borschel <roman@code-factory.org>
  27  * @since 2.2
  28  */
  29 interface Proxy
  30 {
  31     /**
  32      * Marker for Proxy class names.
  33      *
  34      * @var string
  35      */
  36     const MARKER = '__CG__';
  37
  38     /**
  39      * Length of the proxy marker
  40      *
  41      * @var int
  42      */
  43     const MARKER_LENGTH = 6;
  44
  45     /**
  46      * Initialize this proxy if its not yet initialized.
  47      *
  48      * Acts as a no-op if already initialized.
  49      *
  50      * @return void
  51      */
  52     public function __load();
  53
  54     /**
  55      * Is this proxy initialized or not.
  56      *
  57      * @return bool
  58      */
  59     public function __isInitialized();
  60 }