vendor/doctrine/common/lib/Doctrine/Common/Comparable.php

   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
  20
  21 namespace Doctrine\Common;
  22
  23 /**
  24  * Comparable interface that allows to compare two value objects to each other for similarity.
  25  *
  26  * @license     http://www.opensource.org/licenses/lgpl-license.php LGPL
  27  * @link        www.doctrine-project.com
  28  * @since       2.2
  29  * @author      Benjamin Eberlei <kontakt@beberlei.de>
  30  * @author      Guilherme Blanco <guilhermeblanco@hotmail.com>
  31  */
  32 interface Comparable
  33 {
  34     /**
  35      * Compare the current object to the passed $other.
  36      *
  37      * Returns 0 if they are semantically equal, 1 if the other object
  38      * is less than the current one, or -1 if its more than the current one.
  39      *
  40      * This method should not check for identity using ===, only for semantical equality for example
  41      * when two different DateTime instances point to the exact same Date + TZ.
  42      *
  43      * @param mixed $other
  44      *
  45      * @return int
  46      */
  47     public function compareTo($other);
  48 }
  49