aboutsummaryrefslogtreecommitdiff
path: root/doc/latex/classIsisSubfieldIterator.tex
blob: 9f2f193e42c48415b1f07df08dddaa77e0b11375 (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
\hypertarget{classIsisSubfieldIterator}{
\section{IsisSubfieldIterator Class Reference}
\label{classIsisSubfieldIterator}\index{IsisSubfieldIterator@{IsisSubfieldIterator}}
}
\subsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
\hyperlink{classIsisSubfieldIterator_adc5472ca67d20defcab9eba45975dc29}{\_\-\_\-construct} (\$class, \$field, \$main=false)
\item 
\hyperlink{classIsisSubfieldIterator_a971b36317fab4fc07573f215a118fb40}{rewind} ()
\item 
\hyperlink{classIsisSubfieldIterator_a4ee62ad436a7c4ec1dac0c0c5d2a2c85}{key} ()
\item 
\hyperlink{classIsisSubfieldIterator_a7c31b7e8db31e1465d29fb58b2448bd8}{current} ()
\item 
\hyperlink{classIsisSubfieldIterator_a74363e3dbfbde6d409b8ba3b70fc9371}{next} ()
\item 
\hyperlink{classIsisSubfieldIterator_a1934438bfdfa1827e6bcc71d3c90f2db}{valid} ()
\end{DoxyCompactItemize}


\subsection{Detailed Description}
Isis subfield iterator. Iterates over subfields for each result row. 

\subsection{Constructor \& Destructor Documentation}
\hypertarget{classIsisSubfieldIterator_adc5472ca67d20defcab9eba45975dc29}{
\index{IsisSubfieldIterator@{IsisSubfieldIterator}!\_\-\_\-construct@{\_\-\_\-construct}}
\index{\_\-\_\-construct@{\_\-\_\-construct}!IsisSubfieldIterator@{IsisSubfieldIterator}}
\subsubsection[{\_\-\_\-construct}]{\setlength{\rightskip}{0pt plus 5cm}IsisSubfieldIterator::\_\-\_\-construct (\$ {\em class}, \/  \$ {\em field}, \/  \$ {\em main} = {\ttfamily false})}}
\label{classIsisSubfieldIterator_adc5472ca67d20defcab9eba45975dc29}
Constructor.


\begin{DoxyParams}{Parameters}
\item[{\em \$class}]Instance of \hyperlink{classIsisConnector}{IsisConnector} or child class.\item[{\em \$field}]Field to iterate over.\item[{\em \$main}]Control to which subfield the main field should be mapped to. By default no mapping is made. \end{DoxyParams}


\subsection{Member Function Documentation}
\hypertarget{classIsisSubfieldIterator_a7c31b7e8db31e1465d29fb58b2448bd8}{
\index{IsisSubfieldIterator@{IsisSubfieldIterator}!current@{current}}
\index{current@{current}!IsisSubfieldIterator@{IsisSubfieldIterator}}
\subsubsection[{current}]{\setlength{\rightskip}{0pt plus 5cm}IsisSubfieldIterator::current ()}}
\label{classIsisSubfieldIterator_a7c31b7e8db31e1465d29fb58b2448bd8}
Return the current element. \hypertarget{classIsisSubfieldIterator_a4ee62ad436a7c4ec1dac0c0c5d2a2c85}{
\index{IsisSubfieldIterator@{IsisSubfieldIterator}!key@{key}}
\index{key@{key}!IsisSubfieldIterator@{IsisSubfieldIterator}}
\subsubsection[{key}]{\setlength{\rightskip}{0pt plus 5cm}IsisSubfieldIterator::key ()}}
\label{classIsisSubfieldIterator_a4ee62ad436a7c4ec1dac0c0c5d2a2c85}
Return the key of the current element. \hypertarget{classIsisSubfieldIterator_a74363e3dbfbde6d409b8ba3b70fc9371}{
\index{IsisSubfieldIterator@{IsisSubfieldIterator}!next@{next}}
\index{next@{next}!IsisSubfieldIterator@{IsisSubfieldIterator}}
\subsubsection[{next}]{\setlength{\rightskip}{0pt plus 5cm}IsisSubfieldIterator::next ()}}
\label{classIsisSubfieldIterator_a74363e3dbfbde6d409b8ba3b70fc9371}
Move forward to next element. \hypertarget{classIsisSubfieldIterator_a971b36317fab4fc07573f215a118fb40}{
\index{IsisSubfieldIterator@{IsisSubfieldIterator}!rewind@{rewind}}
\index{rewind@{rewind}!IsisSubfieldIterator@{IsisSubfieldIterator}}
\subsubsection[{rewind}]{\setlength{\rightskip}{0pt plus 5cm}IsisSubfieldIterator::rewind ()}}
\label{classIsisSubfieldIterator_a971b36317fab4fc07573f215a118fb40}
Rewind the Iterator to the first element. \hypertarget{classIsisSubfieldIterator_a1934438bfdfa1827e6bcc71d3c90f2db}{
\index{IsisSubfieldIterator@{IsisSubfieldIterator}!valid@{valid}}
\index{valid@{valid}!IsisSubfieldIterator@{IsisSubfieldIterator}}
\subsubsection[{valid}]{\setlength{\rightskip}{0pt plus 5cm}IsisSubfieldIterator::valid ()}}
\label{classIsisSubfieldIterator_a1934438bfdfa1827e6bcc71d3c90f2db}
Check if there is a current element after calls to \hyperlink{classIsisSubfieldIterator_a971b36317fab4fc07573f215a118fb40}{rewind()} or \hyperlink{classIsisSubfieldIterator_a74363e3dbfbde6d409b8ba3b70fc9371}{next()}. 

The documentation for this class was generated from the following file:\begin{DoxyCompactItemize}
\item 
classes/iterators/IsisSubfieldIterator.php\end{DoxyCompactItemize}