blob: 617feca474f2015403c1630a983e3be3f7e22eae (
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
|
\hypertarget{classIsisItemIterator}{
\section{IsisItemIterator Class Reference}
\label{classIsisItemIterator}\index{IsisItemIterator@{IsisItemIterator}}
}
\subsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item
\hyperlink{classIsisItemIterator_a6ee7fe126baaffa77ad2cf177fefc46a}{\_\-\_\-construct} (\$class, \$field, \$main=false)
\item
\hyperlink{classIsisItemIterator_ab87a4387a9fd745366ccf8e138a9f60c}{rewind} ()
\item
\hyperlink{classIsisItemIterator_ab51757f546b7d9efb9decd701a38b8b5}{key} ()
\item
\hyperlink{classIsisItemIterator_a3f602399a600d7b95d23b87111d0e72b}{current} ()
\item
\hyperlink{classIsisItemIterator_a17c6a2e50a0ca67feb92f4ffc4cbec23}{next} ()
\item
\hyperlink{classIsisItemIterator_aacea6ed6fd269ef1549ce86820da8b3b}{valid} ()
\end{DoxyCompactItemize}
\subsection{Detailed Description}
Isis field iterator. Iterates over a field for each result row.
\subsection{Constructor \& Destructor Documentation}
\hypertarget{classIsisItemIterator_a6ee7fe126baaffa77ad2cf177fefc46a}{
\index{IsisItemIterator@{IsisItemIterator}!\_\-\_\-construct@{\_\-\_\-construct}}
\index{\_\-\_\-construct@{\_\-\_\-construct}!IsisItemIterator@{IsisItemIterator}}
\subsubsection[{\_\-\_\-construct}]{\setlength{\rightskip}{0pt plus 5cm}IsisItemIterator::\_\-\_\-construct (
\begin{DoxyParamCaption}
\item[{\$}]{ class, }
\item[{\$}]{ field, }
\item[{\$}]{ main = {\ttfamily false}}
\end{DoxyParamCaption}
)}}
\label{classIsisItemIterator_a6ee7fe126baaffa77ad2cf177fefc46a}
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 item the main field should be mapped to. By default no mapping is made. \end{DoxyParams}
\subsection{Member Function Documentation}
\hypertarget{classIsisItemIterator_a3f602399a600d7b95d23b87111d0e72b}{
\index{IsisItemIterator@{IsisItemIterator}!current@{current}}
\index{current@{current}!IsisItemIterator@{IsisItemIterator}}
\subsubsection[{current}]{\setlength{\rightskip}{0pt plus 5cm}IsisItemIterator::current (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
)}}
\label{classIsisItemIterator_a3f602399a600d7b95d23b87111d0e72b}
Return the current element. \hypertarget{classIsisItemIterator_ab51757f546b7d9efb9decd701a38b8b5}{
\index{IsisItemIterator@{IsisItemIterator}!key@{key}}
\index{key@{key}!IsisItemIterator@{IsisItemIterator}}
\subsubsection[{key}]{\setlength{\rightskip}{0pt plus 5cm}IsisItemIterator::key (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
)}}
\label{classIsisItemIterator_ab51757f546b7d9efb9decd701a38b8b5}
Return the key of the current element. \hypertarget{classIsisItemIterator_a17c6a2e50a0ca67feb92f4ffc4cbec23}{
\index{IsisItemIterator@{IsisItemIterator}!next@{next}}
\index{next@{next}!IsisItemIterator@{IsisItemIterator}}
\subsubsection[{next}]{\setlength{\rightskip}{0pt plus 5cm}IsisItemIterator::next (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
)}}
\label{classIsisItemIterator_a17c6a2e50a0ca67feb92f4ffc4cbec23}
Move forward to next element. \hypertarget{classIsisItemIterator_ab87a4387a9fd745366ccf8e138a9f60c}{
\index{IsisItemIterator@{IsisItemIterator}!rewind@{rewind}}
\index{rewind@{rewind}!IsisItemIterator@{IsisItemIterator}}
\subsubsection[{rewind}]{\setlength{\rightskip}{0pt plus 5cm}IsisItemIterator::rewind (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
)}}
\label{classIsisItemIterator_ab87a4387a9fd745366ccf8e138a9f60c}
Rewind the Iterator to the first element. \hypertarget{classIsisItemIterator_aacea6ed6fd269ef1549ce86820da8b3b}{
\index{IsisItemIterator@{IsisItemIterator}!valid@{valid}}
\index{valid@{valid}!IsisItemIterator@{IsisItemIterator}}
\subsubsection[{valid}]{\setlength{\rightskip}{0pt plus 5cm}IsisItemIterator::valid (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
)}}
\label{classIsisItemIterator_aacea6ed6fd269ef1549ce86820da8b3b}
Check if there is a current element after calls to \hyperlink{classIsisItemIterator_ab87a4387a9fd745366ccf8e138a9f60c}{rewind()} or \hyperlink{classIsisItemIterator_a17c6a2e50a0ca67feb92f4ffc4cbec23}{next()}.
The documentation for this class was generated from the following file:\begin{DoxyCompactItemize}
\item
classes/iterators/IsisItemIterator.php\end{DoxyCompactItemize}
|
