|
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\Stories; |
|
45
|
|
|
|
|
46
|
|
|
use DataSift\Storyplayer\PlayerLib\Story; |
|
47
|
|
|
|
|
48
|
|
|
class BuildStory |
|
49
|
|
|
{ |
|
50
|
|
|
/** |
|
51
|
|
|
* Create a new story object |
|
52
|
|
|
* |
|
53
|
|
|
* @param string $category the category that the story belongs to |
|
|
|
|
|
|
54
|
|
|
* @return Story the new story object to use |
|
55
|
|
|
*/ |
|
56
|
|
|
public static function newStory() |
|
57
|
|
|
{ |
|
58
|
|
|
// our return value |
|
59
|
|
|
$story = new Story(); |
|
60
|
|
|
|
|
61
|
|
|
// our output reports may need to know which file the story itself |
|
62
|
|
|
// is defined in |
|
63
|
|
|
$story->determineStoryFilename(); |
|
64
|
|
|
|
|
65
|
|
|
// calculate these from the filesystem path |
|
66
|
|
|
// $filenameParts = static::getPartsFromFilename($story->getStoryFilename()); |
|
|
|
|
|
|
67
|
|
|
// if (!empty($filenameParts)) { |
|
|
|
|
|
|
68
|
|
|
// $story->setCategory(static::determineCategory($filenameParts)); |
|
|
|
|
|
|
69
|
|
|
// $story->inGroup(static::determineGroup($filenameParts)); |
|
|
|
|
|
|
70
|
|
|
// $story->called(static::determineCalled($filenameParts)); |
|
|
|
|
|
|
71
|
|
|
// } |
|
72
|
|
|
|
|
73
|
|
|
// we know that this story requires Storyplayer v2 |
|
74
|
|
|
$story->requiresStoryplayerVersion(2); |
|
75
|
|
|
|
|
76
|
|
|
// all done |
|
77
|
|
|
return $story; |
|
78
|
|
|
} |
|
79
|
|
|
|
|
80
|
|
|
private function determineCategory($filenameParts) |
|
|
|
|
|
|
81
|
|
|
{ |
|
82
|
|
|
return $filenameParts[0]; |
|
83
|
|
|
} |
|
84
|
|
|
|
|
85
|
|
|
private function determineGroup($filenameParts) |
|
|
|
|
|
|
86
|
|
|
{ |
|
87
|
|
|
$group = array_slice($filenameParts, 1, -1); |
|
88
|
|
|
return $group; |
|
89
|
|
|
} |
|
90
|
|
|
|
|
91
|
|
|
private function determineCalled($filenameParts) |
|
|
|
|
|
|
92
|
|
|
{ |
|
93
|
|
|
return end($filenameParts); |
|
94
|
|
|
} |
|
95
|
|
|
|
|
96
|
|
|
private function getPartsFromFilename($filename) |
|
|
|
|
|
|
97
|
|
|
{ |
|
98
|
|
|
// let's try our best to make this from the root of the project |
|
99
|
|
|
$cwd = getcwd() . DIRECTORY_SEPARATOR; |
|
100
|
|
|
$filename = str_replace($cwd, '', $filename); |
|
101
|
|
|
|
|
102
|
|
|
// now, let's look at what we have |
|
103
|
|
|
$parts = explode(DIRECTORY_SEPARATOR, $filename); |
|
104
|
|
|
while (!empty($parts)) { |
|
105
|
|
|
$part = array_shift($parts); |
|
106
|
|
|
if ($part === 'stories') { |
|
107
|
|
|
return $parts; |
|
108
|
|
|
} |
|
109
|
|
|
} |
|
110
|
|
|
|
|
111
|
|
|
return []; |
|
112
|
|
|
} |
|
113
|
|
|
} |
datasift /
storyplayer
Loading history...
This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function.
Consider the following example. The parameter
$italyis not defined by the methodfinale(...).The most likely cause is that the parameter was removed, but the annotation was not.