vendor/doctrine/orm/tests/Doctrine/Tests/Mocks/TaskMock.php

   1 <?php
   2 /*
   3  *  $Id$
   4  *
   5  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
   6  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
   7  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
   8  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
   9  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  10  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  11  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  12  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  13  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  14  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  15  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  16  *
  17  * This software consists of voluntary contributions made by many individuals
  18  * and is licensed under the LGPL. For more information, see
  19  * <http://www.doctrine-project.org>.
  20  */
  21
  22 namespace Doctrine\Tests\Mocks;
  23
  24 use Doctrine\Common\Cli\AbstractNamespace;
  25
  26 /**
  27  * TaskMock used for testing the CLI interface.
  28  * @author Nils Adermann <naderman@naderman.de>
  29  */
  30 class TaskMock extends \Doctrine\Common\Cli\Tasks\AbstractTask
  31 {
  32     /**
  33      * Since instances of this class can be created elsewhere all instances
  34      * register themselves in this array for later inspection.
  35      *
  36      * @var array(TaskMock)
  37      */
  38     static public $instances = array();
  39
  40     private $runCounter = 0;
  41
  42     /**
  43      * Constructor of Task Mock Object.
  44      * Makes sure the object can be inspected later.
  45      *
  46      * @param AbstractNamespace CLI Namespace, passed to parent constructor
  47      */
  48     function __construct(AbstractNamespace $namespace)
  49     {
  50         self::$instances[] = $this;
  51
  52         parent::__construct($namespace);
  53     }
  54
  55     /**
  56      * Returns the number of times run() was called on this object.
  57      *
  58      * @return int
  59      */
  60     public function getRunCounter()
  61     {
  62         return $this->runCounter;
  63     }
  64
  65     /* Mock API */
  66
  67     /**
  68      * Method invoked by CLI to run task.
  69      */
  70     public function run()
  71     {
  72         $this->runCounter++;
  73     }
  74
  75     /**
  76      * Method supposed to generate the CLI Task Documentation
  77      */
  78     public function buildDocumentation()
  79     {
  80     }
  81 }