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\Proxy;
Chris@0: 
Chris@0: use Closure;
Chris@0: use Doctrine\Common\Persistence\Proxy as BaseProxy;
Chris@0: 
Chris@0: /**
Chris@0:  * Interface for proxy classes.
Chris@0:  *
Chris@0:  * @author Roman Borschel <roman@code-factory.org>
Chris@0:  * @author Marco Pivetta  <ocramius@gmail.com>
Chris@0:  * @since  2.4
Chris@0:  */
Chris@0: interface Proxy extends BaseProxy
Chris@0: {
Chris@0:     /**
Chris@0:      * Marks the proxy as initialized or not.
Chris@0:      *
Chris@0:      * @param boolean $initialized
Chris@0:      *
Chris@0:      * @return void
Chris@0:      */
Chris@0:     public function __setInitialized($initialized);
Chris@0: 
Chris@0:     /**
Chris@0:      * Sets the initializer callback to be used when initializing the proxy. That
Chris@0:      * initializer should accept 3 parameters: $proxy, $method and $params. Those
Chris@0:      * are respectively the proxy object that is being initialized, the method name
Chris@0:      * that triggered initialization and the parameters passed to that method.
Chris@0:      *
Chris@0:      * @param Closure|null $initializer
Chris@0:      *
Chris@0:      * @return void
Chris@0:      */
Chris@0:     public function __setInitializer(Closure $initializer = null);
Chris@0: 
Chris@0:     /**
Chris@0:      * Retrieves the initializer callback used to initialize the proxy.
Chris@0:      *
Chris@0:      * @see __setInitializer
Chris@0:      *
Chris@0:      * @return Closure|null
Chris@0:      */
Chris@0:     public function __getInitializer();
Chris@0: 
Chris@0:     /**
Chris@0:      * Sets the callback to be used when cloning the proxy. That initializer should accept
Chris@0:      * a single parameter, which is the cloned proxy instance itself.
Chris@0:      *
Chris@0:      * @param Closure|null $cloner
Chris@0:      *
Chris@0:      * @return void
Chris@0:      */
Chris@0:     public function __setCloner(Closure $cloner = null);
Chris@0: 
Chris@0:     /**
Chris@0:      * Retrieves the callback to be used when cloning the proxy.
Chris@0:      *
Chris@0:      * @see __setCloner
Chris@0:      *
Chris@0:      * @return Closure|null
Chris@0:      */
Chris@0:     public function __getCloner();
Chris@0: 
Chris@0:     /**
Chris@0:      * Retrieves the list of lazy loaded properties for a given proxy
Chris@0:      *
Chris@0:      * @return array Keys are the property names, and values are the default values
Chris@0:      *               for those properties.
Chris@0:      */
Chris@0:     public function __getLazyProperties();
Chris@0: }