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. For more information, see
17 * <http://www.doctrine-project.org>.
18 */
19
20namespace Doctrine\Common\Persistence;
21
22/**
23 * Interface for proxy classes.
24 *
25 * @author Roman Borschel <roman@code-factory.org>
26 * @since  2.2
27 */
28interface Proxy
29{
30    /**
31     * Marker for Proxy class names.
32     *
33     * @var string
34     */
35    const MARKER = '__CG__';
36
37    /**
38     * Length of the proxy marker.
39     *
40     * @var integer
41     */
42    const MARKER_LENGTH = 6;
43
44    /**
45     * Initializes this proxy if its not yet initialized.
46     *
47     * Acts as a no-op if already initialized.
48     *
49     * @return void
50     */
51    public function __load();
52
53    /**
54     * Returns whether this proxy is initialized or not.
55     *
56     * @return bool
57     */
58    public function __isInitialized();
59}
60