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;
Chris@0: 
Chris@0: /**
Chris@0:  * Comparable interface that allows to compare two value objects to each other for similarity.
Chris@0:  *
Chris@0:  * @link   www.doctrine-project.org
Chris@0:  * @since  2.2
Chris@0:  * @author Benjamin Eberlei <kontakt@beberlei.de>
Chris@0:  * @author Guilherme Blanco <guilhermeblanco@hotmail.com>
Chris@0:  */
Chris@0: interface Comparable
Chris@0: {
Chris@0:     /**
Chris@0:      * Compares the current object to the passed $other.
Chris@0:      *
Chris@0:      * Returns 0 if they are semantically equal, 1 if the other object
Chris@0:      * is less than the current one, or -1 if its more than the current one.
Chris@0:      *
Chris@0:      * This method should not check for identity using ===, only for semantical equality for example
Chris@0:      * when two different DateTime instances point to the exact same Date + TZ.
Chris@0:      *
Chris@0:      * @param mixed $other
Chris@0:      *
Chris@0:      * @return int
Chris@0:      */
Chris@0:     public function compareTo($other);
Chris@0: }