tests/PHPUnit/PHPUnit/Extensions/Story/Step.php

   1 <?php
   2 /**
   3  * PHPUnit
   4  *
   5  * Copyright (c) 2002-2011, Sebastian Bergmann <sebastian@phpunit.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  * @package    PHPUnit
  38  * @subpackage Extensions_Story
  39  * @author     Mattis Stordalen Flister <mattis@xait.no>
  40  * @author     Sebastian Bergmann <sebastian@phpunit.de>
  41  * @copyright  2002-2011 Sebastian Bergmann <sebastian@phpunit.de>
  42  * @license    http://www.opensource.org/licenses/bsd-license.php  BSD License
  43  * @link       http://www.phpunit.de/
  44  * @since      File available since Release 3.3.0
  45  */
  46
  47 /**
  48  * A step of a scenario.
  49  *
  50  * @package    PHPUnit
  51  * @subpackage Extensions_Story
  52  * @author     Mattis Stordalen Flister <mattis@xait.no>
  53  * @author     Sebastian Bergmann <sebastian@phpunit.de>
  54  * @copyright  2002-2011 Sebastian Bergmann <sebastian@phpunit.de>
  55  * @license    http://www.opensource.org/licenses/bsd-license.php  BSD License
  56  * @version    Release: 3.5.13
  57  * @link       http://www.phpunit.de/
  58  * @since      Class available since Release 3.3.0
  59  */
  60 abstract class PHPUnit_Extensions_Story_Step
  61 {
  62     /**
  63      * @var    string
  64      */
  65     protected $action;
  66
  67     /**
  68      * @var    array
  69      */
  70     protected $arguments;
  71
  72     /**
  73      * Constructor.
  74      *
  75      * @param  array $arguments
  76      */
  77     public function __construct(array $arguments)
  78     {
  79         $this->action    = array_shift($arguments);
  80         $this->arguments = $arguments;
  81     }
  82
  83     /**
  84      * Returns this step's action.
  85      *
  86      * @return string
  87      */
  88     public function getAction()
  89     {
  90         return $this->action;
  91     }
  92
  93     /**
  94      * Returns this step's arguments.
  95      *
  96      * @param  boolean $asString
  97      * @return array|string
  98      */
  99     public function getArguments($asString = FALSE)
 100     {
 101         if (!$asString) {
 102             return $this->arguments;
 103         } else {
 104             switch (count($this->arguments)) {
 105                 case 0: {
 106                     return '';
 107                 }
 108                 break;
 109
 110                 case 1: {
 111                     return $this->arguments[0];
 112                 }
 113                 break;
 114
 115                 default: {
 116                     return var_export($this->arguments, TRUE);
 117                 }
 118             }
 119         }
 120     }
 121
 122     /**
 123      * Returns this step's name.
 124      *
 125      * @return string
 126      */
 127     abstract public function getName();
 128 }