aboutsummaryrefslogtreecommitdiff
path: root/doc/latex/classIsisFieldIterator.tex
blob: 191d4c982b63e2feec7cbeffc9745e4ab5861ac6 (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
\hypertarget{classIsisFieldIterator}{
\section{IsisFieldIterator Class Reference}
\label{classIsisFieldIterator}\index{IsisFieldIterator@{IsisFieldIterator}}
}
\subsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
\hyperlink{classIsisFieldIterator_a6be7899f5131064d980017dbaa892a1f}{\_\-\_\-construct} (\$class, \$field)
\item 
\hyperlink{classIsisFieldIterator_a19e38c95726a11124f0a46228095cea0}{rewind} ()
\item 
\hyperlink{classIsisFieldIterator_afad4839168701adff27f1037b2d8fafc}{key} ()
\item 
\hyperlink{classIsisFieldIterator_a23a9cbf26e7786777bca2c7a0cb3d87e}{current} ()
\item 
\hyperlink{classIsisFieldIterator_a7a8b7866abd01b6e7ea07c7bb24e9de0}{next} ()
\item 
\hyperlink{classIsisFieldIterator_aff5eab62ba63049c0c09609300dfd348}{has\_\-more\_\-rows} ()
\item 
\hyperlink{classIsisFieldIterator_a0904dcbdd044353ef339c4f1a96d4387}{current\_\-null} ()
\item 
\hyperlink{classIsisFieldIterator_a030cf47b3e4d174e9409c635ce1b49c7}{valid} ()
\end{DoxyCompactItemize}


\subsection{Detailed Description}
Isis field iterator. Iterates over all field values for each result row. 

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


\begin{DoxyParams}{Parameters}
\item[{\em \$class}]Instance of \hyperlink{classIsisConnector}{IsisConnector} or child class.\item[{\em \$field}]Field to iterate over. \end{DoxyParams}


\subsection{Member Function Documentation}
\hypertarget{classIsisFieldIterator_a23a9cbf26e7786777bca2c7a0cb3d87e}{
\index{IsisFieldIterator@{IsisFieldIterator}!current@{current}}
\index{current@{current}!IsisFieldIterator@{IsisFieldIterator}}
\subsubsection[{current}]{\setlength{\rightskip}{0pt plus 5cm}IsisFieldIterator::current ()}}
\label{classIsisFieldIterator_a23a9cbf26e7786777bca2c7a0cb3d87e}
Return the current element. \hypertarget{classIsisFieldIterator_a0904dcbdd044353ef339c4f1a96d4387}{
\index{IsisFieldIterator@{IsisFieldIterator}!current\_\-null@{current\_\-null}}
\index{current\_\-null@{current\_\-null}!IsisFieldIterator@{IsisFieldIterator}}
\subsubsection[{current\_\-null}]{\setlength{\rightskip}{0pt plus 5cm}IsisFieldIterator::current\_\-null ()}}
\label{classIsisFieldIterator_a0904dcbdd044353ef339c4f1a96d4387}
Check if the current value is null. \hypertarget{classIsisFieldIterator_aff5eab62ba63049c0c09609300dfd348}{
\index{IsisFieldIterator@{IsisFieldIterator}!has\_\-more\_\-rows@{has\_\-more\_\-rows}}
\index{has\_\-more\_\-rows@{has\_\-more\_\-rows}!IsisFieldIterator@{IsisFieldIterator}}
\subsubsection[{has\_\-more\_\-rows}]{\setlength{\rightskip}{0pt plus 5cm}IsisFieldIterator::has\_\-more\_\-rows ()}}
\label{classIsisFieldIterator_aff5eab62ba63049c0c09609300dfd348}
Check if there are more rows. \hypertarget{classIsisFieldIterator_afad4839168701adff27f1037b2d8fafc}{
\index{IsisFieldIterator@{IsisFieldIterator}!key@{key}}
\index{key@{key}!IsisFieldIterator@{IsisFieldIterator}}
\subsubsection[{key}]{\setlength{\rightskip}{0pt plus 5cm}IsisFieldIterator::key ()}}
\label{classIsisFieldIterator_afad4839168701adff27f1037b2d8fafc}
Return the key of the current element. \hypertarget{classIsisFieldIterator_a7a8b7866abd01b6e7ea07c7bb24e9de0}{
\index{IsisFieldIterator@{IsisFieldIterator}!next@{next}}
\index{next@{next}!IsisFieldIterator@{IsisFieldIterator}}
\subsubsection[{next}]{\setlength{\rightskip}{0pt plus 5cm}IsisFieldIterator::next ()}}
\label{classIsisFieldIterator_a7a8b7866abd01b6e7ea07c7bb24e9de0}
Move forward to next element. \hypertarget{classIsisFieldIterator_a19e38c95726a11124f0a46228095cea0}{
\index{IsisFieldIterator@{IsisFieldIterator}!rewind@{rewind}}
\index{rewind@{rewind}!IsisFieldIterator@{IsisFieldIterator}}
\subsubsection[{rewind}]{\setlength{\rightskip}{0pt plus 5cm}IsisFieldIterator::rewind ()}}
\label{classIsisFieldIterator_a19e38c95726a11124f0a46228095cea0}
Rewind the Iterator to the first element. \hypertarget{classIsisFieldIterator_a030cf47b3e4d174e9409c635ce1b49c7}{
\index{IsisFieldIterator@{IsisFieldIterator}!valid@{valid}}
\index{valid@{valid}!IsisFieldIterator@{IsisFieldIterator}}
\subsubsection[{valid}]{\setlength{\rightskip}{0pt plus 5cm}IsisFieldIterator::valid ()}}
\label{classIsisFieldIterator_a030cf47b3e4d174e9409c635ce1b49c7}
Check if there is a current element after calls to \hyperlink{classIsisFieldIterator_a19e38c95726a11124f0a46228095cea0}{rewind()} or \hyperlink{classIsisFieldIterator_a7a8b7866abd01b6e7ea07c7bb24e9de0}{next()}. 

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