forked from MARCspec/php-marc-spec
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathPositionOrRangeInterface.php
More file actions
executable file
·114 lines (104 loc) · 2.84 KB
/
PositionOrRangeInterface.php
File metadata and controls
executable file
·114 lines (104 loc) · 2.84 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
<?php
/**
* MARCspec is the specification of a reference, encoded as string, to a set of data
* from within a MARC record.
*
* @author Carsten Klee <mailme.klee@yahoo.de>
* @copyright For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace CK\MARCspec;
/**
* MARCspec position or range interface.
*/
interface PositionOrRangeInterface
{
/**
* Set the field index starting and ending position.
*
* @api
*
* @param int|string $start The index starting position
* @param int|string|null $end The index ending position
*/
public function setIndexStartEnd($start, $end = null);
/**
* Set the field index starting and ending position via length.
*
* @api
*
* @param int|string $start The index starting position
* @param int $length The length count
*/
public function setIndexStartLength($start, $length);
/**
* Get the character starting position as integer or '#'.
*
* @api
*
* @return int|string $indexStart The field index starting position
*/
public function getIndexStart();
/**
* Get the field index ending position as integer or '#'.
*
* @api
*
* @return int|string $indexEnd The field index ending position
*/
public function getIndexEnd();
/**
* Set character starting and ending position.
*
* @api
*
* @param int|string $start The character starting position
* @param int|string|null $end The character ending position
*/
public function setCharStartEnd($start, $end = null);
/**
* Set character starting and ending position via start and length.
*
* @api
*
* @param int|string $start The character starting position
* @param int $length The character length count
*/
public function setCharStartLength($start, $length);
/**
* Get the character starting position as integer or '#'.
*
* @api
*
* @return int|string $charStart The character starting position
*/
public function getCharStart();
/**
* Get the character ending position as integer or '#'.
*
* @api
*
* @return int|string $charEnd The character ending position
*/
public function getCharEnd();
/**
* Get length of character range.
*
* @api
*
* @throws \InvalidArgumentException if length is less than 1
*
* @return null|int $length The character length
*/
public function getCharLength();
/**
* Get length of index range.
*
* @api
*
* @throws \InvalidArgumentException if length is less than 1
*
* @return null|int $length The index range length
*/
public function getIndexLength();
} // EOI