Chris@0: <?php
Chris@0: /*
Chris@0:  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
Chris@0:  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
Chris@0:  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
Chris@0:  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
Chris@0:  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
Chris@0:  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
Chris@0:  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
Chris@0:  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
Chris@0:  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
Chris@0:  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
Chris@0:  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Chris@0:  *
Chris@0:  * This software consists of voluntary contributions made by many individuals
Chris@0:  * and is licensed under the MIT license. For more information, see
Chris@0:  * <http://www.doctrine-project.org>.
Chris@0:  */
Chris@0: 
Chris@0: namespace Doctrine\Common\Persistence;
Chris@0: 
Chris@0: /**
Chris@0:  * Interface for proxy classes.
Chris@0:  *
Chris@0:  * @author Roman Borschel <roman@code-factory.org>
Chris@0:  * @since  2.2
Chris@0:  */
Chris@0: interface Proxy
Chris@0: {
Chris@0:     /**
Chris@0:      * Marker for Proxy class names.
Chris@0:      *
Chris@0:      * @var string
Chris@0:      */
Chris@0:     const MARKER = '__CG__';
Chris@0: 
Chris@0:     /**
Chris@0:      * Length of the proxy marker.
Chris@0:      *
Chris@0:      * @var integer
Chris@0:      */
Chris@0:     const MARKER_LENGTH = 6;
Chris@0: 
Chris@0:     /**
Chris@0:      * Initializes this proxy if its not yet initialized.
Chris@0:      *
Chris@0:      * Acts as a no-op if already initialized.
Chris@0:      *
Chris@0:      * @return void
Chris@0:      */
Chris@0:     public function __load();
Chris@0: 
Chris@0:     /**
Chris@0:      * Returns whether this proxy is initialized or not.
Chris@0:      *
Chris@0:      * @return bool
Chris@0:      */
Chris@0:     public function __isInitialized();
Chris@0: }