blob: 2ef116a6b628e61003e113125640f7a2a8314c6f (
plain)
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
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
|
\hypertarget{classIsisReader}{
\section{IsisReader Class Reference}
\label{classIsisReader}\index{IsisReader@{IsisReader}}
}
Inheritance diagram for IsisReader:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[height=5cm]{classIsisReader}
\end{center}
\end{figure}
\subsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item
\hyperlink{classIsisReader_a70d1444cf56269795b4947dd82b2a4ac}{\_\-\_\-construct} (\$config=null)
\item
\hyperlink{classIsisReader_afa6e3d3d94854913e5ed2604919d2316}{open} (\$config)
\item
\hyperlink{classIsisReader_a630791a319bec2bc55d0102cbb7f93df}{read} (\$entry)
\item
\hyperlink{classIsisReader_a99ce7b10b2997dad6a64558ac1f9f10e}{removeBrackets} (\$value)
\item
\hyperlink{classIsisReader_acba8842f0033356fff66c0f88391921e}{removeBracketsCallback} (\&\$value=NULL)
\item
\hyperlink{classIsisReader_a60ece3bbe11a2b4ac6afa6e65f282724}{removeBracketsFromArray} (\&\$values)
\item
\hyperlink{classIsisReader_a4610ebcf69c197e2c596965e2dc0358e}{explodeBrackets} (\$subject)
\item
\hyperlink{classIsisReader_aa6099ed6bd276b32bd7bba184f144529}{filterBrackets} (\$values)
\item
\hyperlink{classIsisReader_a109a6ef49b2190bfbcee796dae954baf}{hasBrackets} (\$value)
\item
\hyperlink{classIsisReader_a3cc08df25da082046d496db93778709b}{explodeValue} (\$value)
\item
\hyperlink{classIsisReader_ae65e172e3b5c9ac3c8a5e1352ba80904}{joinSubfields} ()
\end{DoxyCompactItemize}
\subsection{Detailed Description}
Provides basic Isis read capabilities around \hyperlink{classCinisis}{Cinisis}.
\subsection{Constructor \& Destructor Documentation}
\hypertarget{classIsisReader_a70d1444cf56269795b4947dd82b2a4ac}{
\index{IsisReader@{IsisReader}!\_\-\_\-construct@{\_\-\_\-construct}}
\index{\_\-\_\-construct@{\_\-\_\-construct}!IsisReader@{IsisReader}}
\subsubsection[{\_\-\_\-construct}]{\setlength{\rightskip}{0pt plus 5cm}IsisReader::\_\-\_\-construct (\$ {\em config} = {\ttfamily null})}}
\label{classIsisReader_a70d1444cf56269795b4947dd82b2a4ac}
Constructor.
\subsection{Member Function Documentation}
\hypertarget{classIsisReader_a4610ebcf69c197e2c596965e2dc0358e}{
\index{IsisReader@{IsisReader}!explodeBrackets@{explodeBrackets}}
\index{explodeBrackets@{explodeBrackets}!IsisReader@{IsisReader}}
\subsubsection[{explodeBrackets}]{\setlength{\rightskip}{0pt plus 5cm}IsisReader::explodeBrackets (\$ {\em subject})}}
\label{classIsisReader_a4610ebcf69c197e2c596965e2dc0358e}
Explode a bracketed string into values. Just strings inside brackets are returned.
\begin{DoxyParams}{Parameters}
\item[{\em \$subject}]Strings containing brackets.\end{DoxyParams}
\begin{DoxyReturn}{Returns}
Array of matched strings.
\end{DoxyReturn}
\hypertarget{classIsisReader_a3cc08df25da082046d496db93778709b}{
\index{IsisReader@{IsisReader}!explodeValue@{explodeValue}}
\index{explodeValue@{explodeValue}!IsisReader@{IsisReader}}
\subsubsection[{explodeValue}]{\setlength{\rightskip}{0pt plus 5cm}IsisReader::explodeValue (\$ {\em value})}}
\label{classIsisReader_a3cc08df25da082046d496db93778709b}
Explode values from fields or subfields. Split values inside brackets if needed, but then doesn't return any value outside brackets.
\begin{DoxyParams}{Parameters}
\item[{\em \$value}]String with values.\end{DoxyParams}
\begin{DoxyReturn}{Returns}
Array with values.
\end{DoxyReturn}
\hypertarget{classIsisReader_aa6099ed6bd276b32bd7bba184f144529}{
\index{IsisReader@{IsisReader}!filterBrackets@{filterBrackets}}
\index{filterBrackets@{filterBrackets}!IsisReader@{IsisReader}}
\subsubsection[{filterBrackets}]{\setlength{\rightskip}{0pt plus 5cm}IsisReader::filterBrackets (\$ {\em values})}}
\label{classIsisReader_aa6099ed6bd276b32bd7bba184f144529}
Filter out brackets from strings.
\begin{DoxyParams}{Parameters}
\item[{\em \$values}]String (or array filled with strings) to be filtered.\end{DoxyParams}
\begin{DoxyReturn}{Returns}
Filtered string or array.
\end{DoxyReturn}
\hypertarget{classIsisReader_a109a6ef49b2190bfbcee796dae954baf}{
\index{IsisReader@{IsisReader}!hasBrackets@{hasBrackets}}
\index{hasBrackets@{hasBrackets}!IsisReader@{IsisReader}}
\subsubsection[{hasBrackets}]{\setlength{\rightskip}{0pt plus 5cm}IsisReader::hasBrackets (\$ {\em value})}}
\label{classIsisReader_a109a6ef49b2190bfbcee796dae954baf}
Check if a string has brackets.
\begin{DoxyParams}{Parameters}
\item[{\em \$value}]String to be compared.\end{DoxyParams}
\begin{DoxyReturn}{Returns}
True if string has brackets, false otherwise.
\end{DoxyReturn}
\hypertarget{classIsisReader_ae65e172e3b5c9ac3c8a5e1352ba80904}{
\index{IsisReader@{IsisReader}!joinSubfields@{joinSubfields}}
\index{joinSubfields@{joinSubfields}!IsisReader@{IsisReader}}
\subsubsection[{joinSubfields}]{\setlength{\rightskip}{0pt plus 5cm}IsisReader::joinSubfields ()}}
\label{classIsisReader_ae65e172e3b5c9ac3c8a5e1352ba80904}
Whether to join field and subfields in a single array.
\begin{DoxyReturn}{Returns}
Boolean.
\end{DoxyReturn}
\hypertarget{classIsisReader_afa6e3d3d94854913e5ed2604919d2316}{
\index{IsisReader@{IsisReader}!open@{open}}
\index{open@{open}!IsisReader@{IsisReader}}
\subsubsection[{open}]{\setlength{\rightskip}{0pt plus 5cm}IsisReader::open (\$ {\em config})}}
\label{classIsisReader_afa6e3d3d94854913e5ed2604919d2316}
Open a database.
\begin{DoxyParams}{Parameters}
\item[{\em \$config}]Config file or array. \end{DoxyParams}
\hypertarget{classIsisReader_a630791a319bec2bc55d0102cbb7f93df}{
\index{IsisReader@{IsisReader}!read@{read}}
\index{read@{read}!IsisReader@{IsisReader}}
\subsubsection[{read}]{\setlength{\rightskip}{0pt plus 5cm}IsisReader::read (\$ {\em entry})}}
\label{classIsisReader_a630791a319bec2bc55d0102cbb7f93df}
Alias to \$isis-\/$>$db-\/$>$\hyperlink{classIsisReader_a630791a319bec2bc55d0102cbb7f93df}{read()}.
\begin{DoxyParams}{Parameters}
\item[{\em \$entry}]Row number.\end{DoxyParams}
\begin{DoxyReturn}{Returns}
Resulting data.
\end{DoxyReturn}
\hypertarget{classIsisReader_a99ce7b10b2997dad6a64558ac1f9f10e}{
\index{IsisReader@{IsisReader}!removeBrackets@{removeBrackets}}
\index{removeBrackets@{removeBrackets}!IsisReader@{IsisReader}}
\subsubsection[{removeBrackets}]{\setlength{\rightskip}{0pt plus 5cm}IsisReader::removeBrackets (\$ {\em value})}}
\label{classIsisReader_a99ce7b10b2997dad6a64558ac1f9f10e}
Remove brackets from strings whithin an array.
\begin{DoxyParams}{Parameters}
\item[{\em \$value}]Array with bracketed strings.\end{DoxyParams}
\begin{DoxyReturn}{Returns}
Array with strings without brackets.
\end{DoxyReturn}
\hypertarget{classIsisReader_acba8842f0033356fff66c0f88391921e}{
\index{IsisReader@{IsisReader}!removeBracketsCallback@{removeBracketsCallback}}
\index{removeBracketsCallback@{removeBracketsCallback}!IsisReader@{IsisReader}}
\subsubsection[{removeBracketsCallback}]{\setlength{\rightskip}{0pt plus 5cm}IsisReader::removeBracketsCallback (\&\$ {\em value} = {\ttfamily NULL})}}
\label{classIsisReader_acba8842f0033356fff66c0f88391921e}
Remove brackets from strings whithin an array. Callback version
\begin{DoxyParams}{Parameters}
\item[{\em \$value}]Array with bracketed strings. \end{DoxyParams}
\hypertarget{classIsisReader_a60ece3bbe11a2b4ac6afa6e65f282724}{
\index{IsisReader@{IsisReader}!removeBracketsFromArray@{removeBracketsFromArray}}
\index{removeBracketsFromArray@{removeBracketsFromArray}!IsisReader@{IsisReader}}
\subsubsection[{removeBracketsFromArray}]{\setlength{\rightskip}{0pt plus 5cm}IsisReader::removeBracketsFromArray (\&\$ {\em values})}}
\label{classIsisReader_a60ece3bbe11a2b4ac6afa6e65f282724}
Remove brackets from strings whithin an array.
\begin{DoxyParams}{Parameters}
\item[{\em \&\$values}]Array with bracketed strings. \end{DoxyParams}
The documentation for this class was generated from the following file:\begin{DoxyCompactItemize}
\item
classes/IsisReader.php\end{DoxyCompactItemize}
|
