aboutsummaryrefslogtreecommitdiff
path: root/doc/latex/classIsisFinder.tex
blob: a7e83ea235c1dd5a5a9a7470133ef36d03175310 (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
\hypertarget{classIsisFinder}{
\section{IsisFinder Class Reference}
\label{classIsisFinder}\index{IsisFinder@{IsisFinder}}
}
Inheritance diagram for IsisFinder:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[height=5cm]{classIsisFinder}
\end{center}
\end{figure}
\subsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
\hyperlink{classIsisFinder_ac4e3a8f45995cbf940b3f2899b71bd1e}{nextRepetition} (\$field, \$entry=1)
\item 
\hyperlink{classIsisFinder_a7d708e281bea35ee38f5875c8f2cad8d}{nextField} (\$field, \$entry=1)
\item 
\hyperlink{classIsisFinder_aa367980783d341197e003684a639ff1a}{nextSubfield} (\$field, \$subfield, \$entry=1)
\item 
\hyperlink{classIsisFinder_a41410b18c4462c05ac669e4ee889d8a7}{hasSubfieldInRows} (\$field, \$subfield)
\item 
\hyperlink{classIsisFinder_af965ba4acae18aa61bc4a3242bcdadfc}{nextResult} (\$field, \$item, \$search, \$entry=1, \$match=TRUE)
\item 
\hyperlink{classIsisFinder_ab35a9bb21e83df846b6ff57bcbe117ae}{matchMainItem} (\$field, \$row, \$search, \$match)
\item 
\hyperlink{classIsisFinder_a20539e44cfc30ca3897e174781c4b26c}{matchSubfield} (\$field, \$subfield, \$row, \$search, \$match)
\end{DoxyCompactItemize}


\subsection{Detailed Description}
Provides Isis Database search methods. 

\subsection{Member Function Documentation}
\hypertarget{classIsisFinder_a41410b18c4462c05ac669e4ee889d8a7}{
\index{IsisFinder@{IsisFinder}!hasSubfieldInRows@{hasSubfieldInRows}}
\index{hasSubfieldInRows@{hasSubfieldInRows}!IsisFinder@{IsisFinder}}
\subsubsection[{hasSubfieldInRows}]{\setlength{\rightskip}{0pt plus 5cm}IsisFinder::hasSubfieldInRows (\$ {\em field}, \/  \$ {\em subfield})}}
\label{classIsisFinder_a41410b18c4462c05ac669e4ee889d8a7}
Check if a field result has a given subfield.


\begin{DoxyParams}{Parameters}
\item[{\em \$field}]Field data.\item[{\em \$subfield}]Subfield.\end{DoxyParams}
\begin{DoxyReturn}{Returns}
True if result has the subfield, false otherwise. 
\end{DoxyReturn}
\hypertarget{classIsisFinder_ab35a9bb21e83df846b6ff57bcbe117ae}{
\index{IsisFinder@{IsisFinder}!matchMainItem@{matchMainItem}}
\index{matchMainItem@{matchMainItem}!IsisFinder@{IsisFinder}}
\subsubsection[{matchMainItem}]{\setlength{\rightskip}{0pt plus 5cm}IsisFinder::matchMainItem (\$ {\em field}, \/  \$ {\em row}, \/  \$ {\em search}, \/  \$ {\em match})}}
\label{classIsisFinder_ab35a9bb21e83df846b6ff57bcbe117ae}
Check if a main item match a given value.


\begin{DoxyParams}{Parameters}
\item[{\em \$field}]Field data.\item[{\em \$row}]Row number.\item[{\em \$search}]Search token.\item[{\em \$match}]Set to false do find the next result where the item has not the token specified in \$search.\end{DoxyParams}
\begin{DoxyReturn}{Returns}
True if match, false otherwise. 
\end{DoxyReturn}
\hypertarget{classIsisFinder_a20539e44cfc30ca3897e174781c4b26c}{
\index{IsisFinder@{IsisFinder}!matchSubfield@{matchSubfield}}
\index{matchSubfield@{matchSubfield}!IsisFinder@{IsisFinder}}
\subsubsection[{matchSubfield}]{\setlength{\rightskip}{0pt plus 5cm}IsisFinder::matchSubfield (\$ {\em field}, \/  \$ {\em subfield}, \/  \$ {\em row}, \/  \$ {\em search}, \/  \$ {\em match})}}
\label{classIsisFinder_a20539e44cfc30ca3897e174781c4b26c}
Check if a subfield match a given value.


\begin{DoxyParams}{Parameters}
\item[{\em \$field}]Field data.\item[{\em \$subfield}]Subfield name.\item[{\em \$row}]Row number.\item[{\em \$search}]Search token.\item[{\em \$match}]Set to false do find the next result where the item has not the token specified in \$search.\end{DoxyParams}
\begin{DoxyReturn}{Returns}
True if match, false otherwise. 
\end{DoxyReturn}
\hypertarget{classIsisFinder_a7d708e281bea35ee38f5875c8f2cad8d}{
\index{IsisFinder@{IsisFinder}!nextField@{nextField}}
\index{nextField@{nextField}!IsisFinder@{IsisFinder}}
\subsubsection[{nextField}]{\setlength{\rightskip}{0pt plus 5cm}IsisFinder::nextField (\$ {\em field}, \/  \$ {\em entry} = {\ttfamily 1})}}
\label{classIsisFinder_a7d708e281bea35ee38f5875c8f2cad8d}
Find the next occurrence of a field.


\begin{DoxyParams}{Parameters}
\item[{\em \$entry}]Start entry number to begin the search.\item[{\em \$field}]Field data.\end{DoxyParams}
\begin{DoxyReturn}{Returns}
Next occurrence. 
\end{DoxyReturn}
\hypertarget{classIsisFinder_ac4e3a8f45995cbf940b3f2899b71bd1e}{
\index{IsisFinder@{IsisFinder}!nextRepetition@{nextRepetition}}
\index{nextRepetition@{nextRepetition}!IsisFinder@{IsisFinder}}
\subsubsection[{nextRepetition}]{\setlength{\rightskip}{0pt plus 5cm}IsisFinder::nextRepetition (\$ {\em field}, \/  \$ {\em entry} = {\ttfamily 1})}}
\label{classIsisFinder_ac4e3a8f45995cbf940b3f2899b71bd1e}
Find the next repetition of a field.


\begin{DoxyParams}{Parameters}
\item[{\em \$entry}]Start entry number to begin the search.\item[{\em \$field}]Field data.\end{DoxyParams}
\begin{DoxyReturn}{Returns}
Next repetition entry and result. 
\end{DoxyReturn}
\hypertarget{classIsisFinder_af965ba4acae18aa61bc4a3242bcdadfc}{
\index{IsisFinder@{IsisFinder}!nextResult@{nextResult}}
\index{nextResult@{nextResult}!IsisFinder@{IsisFinder}}
\subsubsection[{nextResult}]{\setlength{\rightskip}{0pt plus 5cm}IsisFinder::nextResult (\$ {\em field}, \/  \$ {\em item}, \/  \$ {\em search}, \/  \$ {\em entry} = {\ttfamily 1}, \/  \$ {\em match} = {\ttfamily TRUE})}}
\label{classIsisFinder_af965ba4acae18aa61bc4a3242bcdadfc}
Search the next match inside a result.


\begin{DoxyParams}{Parameters}
\item[{\em \$field}]Field data.\item[{\em \$item}]Item name (main field or subfield).\item[{\em \$search}]Search token.\item[{\em \$entry}]Start entry number to begin the search.\item[{\em \$match}]Set to false do find the next result where the item has not the token specified in \$search. \end{DoxyParams}
\hypertarget{classIsisFinder_aa367980783d341197e003684a639ff1a}{
\index{IsisFinder@{IsisFinder}!nextSubfield@{nextSubfield}}
\index{nextSubfield@{nextSubfield}!IsisFinder@{IsisFinder}}
\subsubsection[{nextSubfield}]{\setlength{\rightskip}{0pt plus 5cm}IsisFinder::nextSubfield (\$ {\em field}, \/  \$ {\em subfield}, \/  \$ {\em entry} = {\ttfamily 1})}}
\label{classIsisFinder_aa367980783d341197e003684a639ff1a}
Find the next occurrence of a subfield.


\begin{DoxyParams}{Parameters}
\item[{\em \$entry}]Start entry number to begin the search.\item[{\em \$field}]Field data.\item[{\em \$subfield}]Subfield name.\end{DoxyParams}
\begin{DoxyReturn}{Returns}
Next occurrence. 
\end{DoxyReturn}


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