Completed
Push — master ( 65ee7b...5d2ba3 )
by Joschi
02:37
created

PropertyListIteratorTrait::rewind()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 4
Code Lines 2

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 3
CRAP Score 1

Importance

Changes 1
Bugs 0 Features 1
Metric Value
dl 0
loc 4
ccs 3
cts 3
cp 1
rs 10
c 1
b 0
f 1
cc 1
eloc 2
nc 1
nop 0
crap 1
1
<?php
2
3
/**
4
 * rdfa-lite
5
 *
6
 * @category Jkphl
7
 * @package Jkphl\Micrometa
8
 * @subpackage Jkphl\RdfaLiteMicrodata\Domain\Property
9
 * @author Joschi Kuphal <[email protected]> / @jkphl
10
 * @copyright Copyright © 2017 Joschi Kuphal <[email protected]> / @jkphl
11
 * @license http://opensource.org/licenses/MIT The MIT License (MIT)
12
 */
13
14
/***********************************************************************************
15
 *  The MIT License (MIT)
16
 *
17
 *  Copyright © 2017 Joschi Kuphal <[email protected]> / @jkphl
18
 *
19
 *  Permission is hereby granted, free of charge, to any person obtaining a copy of
20
 *  this software and associated documentation files (the "Software"), to deal in
21
 *  the Software without restriction, including without limitation the rights to
22
 *  use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
23
 *  the Software, and to permit persons to whom the Software is furnished to do so,
24
 *  subject to the following conditions:
25
 *
26
 *  The above copyright notice and this permission notice shall be included in all
27
 *  copies or substantial portions of the Software.
28
 *
29
 *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
30
 *  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
31
 *  FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
32
 *  COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
33
 *  IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
34
 *  CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
35
 ***********************************************************************************/
36
37
namespace Jkphl\RdfaLiteMicrodata\Domain\Property;
38
39
use Jkphl\RdfaLiteMicrodata\Domain\Iri\IriInterface;
40
41
/**
42
 * Property list iterator trait
43
 *
44
 * @package Jkphl\Micrometa
45
 * @subpackage Jkphl\RdfaLiteMicrodata\Domain
46
 * @property array[] $values Property values
47
 * @property IriInterface[] $names Property names
48
 * @property int $cursor Cursor
49
 */
50
trait PropertyListIteratorTrait
51
{
52
    /**
53
     * Return the current property values
54
     *
55
     * @return array Property values
56
     */
57 8
    public function current()
58
    {
59 8
        return $this->values[$this->cursor];
60
    }
61
62
    /**
63
     * Move forward to next element
64
     */
65 8
    public function next()
66
    {
67 8
        ++$this->cursor;
68 8
    }
69
70
    /**
71
     * Return the current IRI key
72
     *
73
     * @return IriInterface IRI key
74
     */
75 1
    public function key()
76
    {
77 1
        return $this->names[$this->cursor];
78
    }
79
80
    /**
81
     * Checks if current position is valid
82
     *
83
     * @return boolean The current position is valid
84
     */
85 8
    public function valid()
86
    {
87 8
        return isset($this->values[$this->cursor]);
88
    }
89
90
    /**
91
     * Rewind the Iterator to the first element
92
     */
93 8
    public function rewind()
94
    {
95 8
        $this->cursor = 0;
96 8
    }
97
}
98