Passed
Push — master ( 0b1012...a6bb3c )
by Scott
02:18
created

SubString::synopsis()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 4
Code Lines 2

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
dl 0
loc 4
rs 10
c 0
b 0
f 0
cc 1
eloc 2
nc 1
nop 0
1
<?php
2
namespace Desmond\functions\docs;
3
use Desmond\functions\Doc;
4
5
class SubString implements Doc
6
{
7
    public function id()
8
    {
9
        return 'sub-string';
10
    }
11
12
    public function synopsis()
13
    {
14
        return 'Grabs a portion of a string. Same as PHP\'s substr().';
15
    }
16
17
    public function usage()
18
    {
19
        return '(sub-string string:String start:Number [length:Number])';
20
    }
21
22
    public function examples()
23
    {
24
        return [
25
            '(sub-string "test" 2)',
26
            '(sub-string "test" 2 1)'
27
        ];
28
    }
29
}