tests/PHPUnit/Extensions/Story/Step.php

   1 <?php
   2 /**
   3  * PHPUnit
   4  *
   5  * Copyright (c) 2002-2009, Sebastian Bergmann <sb@sebastian-bergmann.de>.
   6  * All rights reserved.
   7  *
   8  * Redistribution and use in source and binary forms, with or without
   9  * modification, are permitted provided that the following conditions
  10  * are met:
  11  *
  12  *   * Redistributions of source code must retain the above copyright
  13  *     notice, this list of conditions and the following disclaimer.
  14  *
  15  *   * Redistributions in binary form must reproduce the above copyright
  16  *     notice, this list of conditions and the following disclaimer in
  17  *     the documentation and/or other materials provided with the
  18  *     distribution.
  19  *
  20  *   * Neither the name of Sebastian Bergmann nor the names of his
  21  *     contributors may be used to endorse or promote products derived
  22  *     from this software without specific prior written permission.
  23  *
  24  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  25  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  26  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  27  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
  28  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
  29  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
  30  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  31  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
  32  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  33  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
  34  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  35  * POSSIBILITY OF SUCH DAMAGE.
  36  *
  37  * @category   Testing
  38  * @package    PHPUnit
  39  * @author     Mattis Stordalen Flister <mattis@xait.no>
  40  * @author     Sebastian Bergmann <sb@sebastian-bergmann.de>
  41  * @copyright  2002-2009 Sebastian Bergmann <sb@sebastian-bergmann.de>
  42  * @license    http://www.opensource.org/licenses/bsd-license.php  BSD License
  43
  44  * @link       http://www.phpunit.de/
  45  * @since      File available since Release 3.3.0
  46  */
  47
  48 require_once 'PHPUnit/Util/Filter.php';
  49
  50 PHPUnit_Util_Filter::addFileToFilter(__FILE__, 'PHPUNIT');
  51
  52 /**
  53  * A step of a scenario.
  54  *
  55  * @category   Testing
  56  * @package    PHPUnit
  57  * @author     Mattis Stordalen Flister <mattis@xait.no>
  58  * @author     Sebastian Bergmann <sb@sebastian-bergmann.de>
  59  * @copyright  2002-2009 Sebastian Bergmann <sb@sebastian-bergmann.de>
  60  * @license    http://www.opensource.org/licenses/bsd-license.php  BSD License
  61  * @version    Release: 3.3.17
  62  * @link       http://www.phpunit.de/
  63  * @since      Class available since Release 3.3.0
  64  * @abstract
  65  */
  66 abstract class PHPUnit_Extensions_Story_Step
  67 {
  68     /**
  69      * @var    string
  70      */
  71     protected $action;
  72
  73     /**
  74      * @var    array
  75      */
  76     protected $arguments;
  77
  78     /**
  79      * Constructor.
  80      *
  81      * @param  array $arguments
  82      */
  83     public function __construct(array $arguments)
  84     {
  85         $this->action    = array_shift($arguments);
  86         $this->arguments = $arguments;
  87     }
  88
  89     /**
  90      * Returns this step's action.
  91      *
  92      * @return string
  93      */
  94     public function getAction()
  95     {
  96         return $this->action;
  97     }
  98
  99     /**
 100      * Returns this step's arguments.
 101      *
 102      * @param  boolean $asString
 103      * @return array|string
 104      */
 105     public function getArguments($asString = FALSE)
 106     {
 107         if (!$asString) {
 108             return $this->arguments;
 109         } else {
 110             switch (count($this->arguments)) {
 111                 case 0: {
 112                     return '';
 113                 }
 114                 break;
 115
 116                 case 1: {
 117                     return $this->arguments[0];
 118                 }
 119                 break;
 120
 121                 default: {
 122                     return var_export($this->arguments, TRUE);
 123                 }
 124             }
 125         }
 126     }
 127
 128     /**
 129      * Returns this step's name.
 130      *
 131      * @return string
 132      */
 133     abstract public function getName();
 134 }
 135 ?>