GitHub Access Token became invalid

It seems like the GitHub access token used for retrieving details about this repository from GitHub became invalid. This might prevent certain types of inspections from being run (in particular, everything related to pull requests).
Please ask an admin of your repository to re-new the access token on this website.
Completed
Push — develop ( b6562d...080777 )
by Stuart
08:15
created

Asserts::assertsArray()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 4
Code Lines 2

Duplication

Lines 0
Ratio 0 %

Importance

Changes 1
Bugs 0 Features 0
Metric Value
dl 0
loc 4
rs 10
c 1
b 0
f 0
cc 1
eloc 2
nc 1
nop 1
1
<?php
2
3
/**
4
 * Copyright (c) 2011-present Mediasift Ltd
5
 * All rights reserved.
6
 *
7
 * Redistribution and use in source and binary forms, with or without
8
 * modification, are permitted provided that the following conditions
9
 * are met:
10
 *
11
 *   * Redistributions of source code must retain the above copyright
12
 *     notice, this list of conditions and the following disclaimer.
13
 *
14
 *   * Redistributions in binary form must reproduce the above copyright
15
 *     notice, this list of conditions and the following disclaimer in
16
 *     the documentation and/or other materials provided with the
17
 *     distribution.
18
 *
19
 *   * Neither the names of the copyright holders nor the names of his
20
 *     contributors may be used to endorse or promote products derived
21
 *     from this software without specific prior written permission.
22
 *
23
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
24
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
25
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
26
 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
27
 * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
28
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
29
 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
30
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
31
 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
32
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
33
 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
34
 * POSSIBILITY OF SUCH DAMAGE.
35
 *
36
 * @category  Libraries
37
 * @package   Storyplayer
38
 * @author    Stuart Herbert <[email protected]>
39
 * @copyright 2011-present Mediasift Ltd www.datasift.com
40
 * @license   http://www.opensource.org/licenses/bsd-license.php  BSD License
41
 * @link      http://datasift.github.io/storyplayer
42
 */
43
44
namespace Storyplayer\SPv2\Modules;
45
46
use DataSift\Storyplayer\PlayerLib\StoryTeller;
47
48
// ==================================================================
49
//
50
// a list of all the Prose modules that we are exposing
51
//
52
// this file registers global functions for each of our Prose modules
53
// it is a great help for everyone who uses autocompletion in their
54
// editor / IDE of choice
55
//
56
// keep this list in alphabetical order, please!
57
//
58
// ------------------------------------------------------------------
59
60
use Storyplayer\SPv2\Modules\Asserts\AssertsArray;
61
use Storyplayer\SPv2\Modules\Asserts\AssertsBoolean;
62
use Storyplayer\SPv2\Modules\Asserts\AssertsDouble;
63
use Storyplayer\SPv2\Modules\Asserts\AssertsInteger;
64
use Storyplayer\SPv2\Modules\Asserts\AssertsObject;
65
use Storyplayer\SPv2\Modules\Asserts\AssertsString;
66
67
use Prose\E5xx_ActionFailed;
68
69
class Asserts
70
{
71
    /**
72
     * returns the AssertsArray module
73
     *
74
     * @param  array $actual
75
     *         the array to be tested
76
     * @return \Prose\AssertsArray
0 ignored issues
show
Documentation introduced by
Should the return type not be AssertsArray?

This check compares the return type specified in the @return annotation of a function or method doc comment with the types returned by the function and raises an issue if they mismatch.

Loading history...
77
     */
78
    public static function assertsArray($actual)
79
    {
80
        return new AssertsArray(StoryTeller::instance(), [$actual]);
81
    }
82
83
    /**
84
     * returns the AssertsBoolean module
85
     *
86
     * @param  boolean $actual
87
     *         the data to be tested
88
     * @return \Prose\AssertsBoolean
0 ignored issues
show
Documentation introduced by
Should the return type not be AssertsBoolean?

This check compares the return type specified in the @return annotation of a function or method doc comment with the types returned by the function and raises an issue if they mismatch.

Loading history...
89
     */
90
    public static function assertsBoolean($actual)
91
    {
92
        return new AssertsBoolean(StoryTeller::instance(), [$actual]);
93
    }
94
95
    /**
96
     * returns the AssertsDouble module
97
     *
98
     * @param  double $actual
99
     *         the data to be tested
100
     * @return \Prose\AssertsDouble
0 ignored issues
show
Documentation introduced by
Should the return type not be AssertsDouble?

This check compares the return type specified in the @return annotation of a function or method doc comment with the types returned by the function and raises an issue if they mismatch.

Loading history...
101
     */
102
    public static function assertsDouble($actual)
103
    {
104
        return new AssertsDouble(StoryTeller::instance(), [$actual]);
105
    }
106
107
    /**
108
     * returns the AssertsInteger module
109
     *
110
     * @param  int $actual
111
     *         the data to be tested
112
     * @return \Prose\AssertsInteger
0 ignored issues
show
Documentation introduced by
Should the return type not be AssertsInteger?

This check compares the return type specified in the @return annotation of a function or method doc comment with the types returned by the function and raises an issue if they mismatch.

Loading history...
113
     */
114
    public static function assertsInteger($actual)
115
    {
116
        return new AssertsInteger(StoryTeller::instance(), [$actual]);
117
    }
118
119
    /**
120
     * returns the AssertsObject module
121
     *
122
     * @param  object $actual
123
     *         the data to be tested
124
     * @return \Prose\AssertsObject
0 ignored issues
show
Documentation introduced by
Should the return type not be AssertsObject?

This check compares the return type specified in the @return annotation of a function or method doc comment with the types returned by the function and raises an issue if they mismatch.

Loading history...
125
     */
126
    public static function assertsObject($actual)
127
    {
128
        return new AssertsObject(StoryTeller::instance(), [$actual]);
129
    }
130
131
    /**
132
     * returns the AssertsString module
133
     *
134
     * @param  string $actual
135
     *         the data to be tested
136
     * @return \Prose\AssertsString
0 ignored issues
show
Documentation introduced by
Should the return type not be AssertsString?

This check compares the return type specified in the @return annotation of a function or method doc comment with the types returned by the function and raises an issue if they mismatch.

Loading history...
137
     */
138
    public static function assertsString($actual)
139
    {
140
        return new AssertsString(StoryTeller::instance(), [$actual]);
141
    }
142
}