blob: 0baaf89499af33bf9c38cf929e12f8f1afbb26bc (
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
173
174
175
176
177
178
179
|
\hypertarget{classMaleteDb}{
\section{MaleteDb Class Reference}
\label{classMaleteDb}\index{MaleteDb@{MaleteDb}}
}
Inheritance diagram for MaleteDb:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[height=2cm]{classMaleteDb}
\end{center}
\end{figure}
\subsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item
\hyperlink{classMaleteDb_a60f87371bc1ec156b010e5b38b4c22e2}{\_\-\_\-construct} (\$schema)
\item
\hyperlink{classMaleteDb_ad2a65876db24adc388afce465e0c153e}{read} (\$id)
\item
\hyperlink{classMaleteDb_a5c6cb09a072e5d2ddce31c77098ccba4}{entries} ()
\item
\hyperlink{classMaleteDb_a4f16c48facae498d0db1a042e9727d04}{example} ()
\item
\hyperlink{classMaleteDb_ab2da32d84af17df79d947ae32257b4ec}{check} (\$schema, \$section=NULL)
\item
\hyperlink{classMaleteDb_ac87c3ac1b3d9a6297be8574aa303e033}{tag} (\$results)
\item
\hyperlink{classMaleteDb_a17562c1c53594762454d65be823fcdb5}{logger} (\$message)
\end{DoxyCompactItemize}
\subsection*{Public Attributes}
\begin{DoxyCompactItemize}
\item
\hyperlink{classMaleteDb_af2cd60ce81381edc3ca09a6812cf79fd}{\$fdt}
\item
\hyperlink{classMaleteDb_a4b970df3631d2763f001c96ee417f27a}{\$db}
\item
\hyperlink{classMaleteDb_a833fed4faae9537306053ee966c06197}{\$format}
\item
\hyperlink{classMaleteDb_ae1c8cefd1a6e661fb03c214f47336368}{\$log}
\end{DoxyCompactItemize}
\subsection{Detailed Description}
Malete implementation of \hyperlink{interfaceIsisDb}{IsisDb}.
\begin{DoxyWarning}{Warning}
This implementation is currently outdated and lacks basic functionalities such as subfield handling and therefore it's use is not recommended.
\end{DoxyWarning}
\subsection{Constructor \& Destructor Documentation}
\hypertarget{classMaleteDb_a60f87371bc1ec156b010e5b38b4c22e2}{
\index{MaleteDb@{MaleteDb}!\_\-\_\-construct@{\_\-\_\-construct}}
\index{\_\-\_\-construct@{\_\-\_\-construct}!MaleteDb@{MaleteDb}}
\subsubsection[{\_\-\_\-construct}]{\setlength{\rightskip}{0pt plus 5cm}MaleteDb::\_\-\_\-construct (\$ {\em schema})}}
\label{classMaleteDb_a60f87371bc1ec156b010e5b38b4c22e2}
Constructor.
\begin{DoxySeeAlso}{See also}
\hyperlink{interfaceIsisDb_ae1c0a3496d55f710d34c5c19ada7a66b}{IsisDb::\_\-\_\-construct()}
\end{DoxySeeAlso}
Implements \hyperlink{interfaceIsisDb_ae1c0a3496d55f710d34c5c19ada7a66b}{IsisDb}.
\subsection{Member Function Documentation}
\hypertarget{classMaleteDb_ab2da32d84af17df79d947ae32257b4ec}{
\index{MaleteDb@{MaleteDb}!check@{check}}
\index{check@{check}!MaleteDb@{MaleteDb}}
\subsubsection[{check}]{\setlength{\rightskip}{0pt plus 5cm}MaleteDb::check (\$ {\em schema}, \/ \$ {\em section} = {\ttfamily NULL})}}
\label{classMaleteDb_ab2da32d84af17df79d947ae32257b4ec}
Check configuration.
\begin{DoxySeeAlso}{See also}
\hyperlink{interfaceIsisDb_af681b8f990b579f1835aa7ba4c83f1b8}{IsisDb::check()}
\end{DoxySeeAlso}
Implements \hyperlink{interfaceIsisDb_af681b8f990b579f1835aa7ba4c83f1b8}{IsisDb}.
\hypertarget{classMaleteDb_a5c6cb09a072e5d2ddce31c77098ccba4}{
\index{MaleteDb@{MaleteDb}!entries@{entries}}
\index{entries@{entries}!MaleteDb@{MaleteDb}}
\subsubsection[{entries}]{\setlength{\rightskip}{0pt plus 5cm}MaleteDb::entries ()}}
\label{classMaleteDb_a5c6cb09a072e5d2ddce31c77098ccba4}
Return number of entries in the database.
The Malete API doen't implement such feature so we have to emulate it by iterating over all entries until \hyperlink{classMaleteDb_ad2a65876db24adc388afce465e0c153e}{MaleteDb::read()} returns FALSE.
\begin{DoxySeeAlso}{See also}
\hyperlink{interfaceIsisDb_a86f38eca2b6d0835b60770d8a4e511ff}{IsisDb::entries()}
\end{DoxySeeAlso}
Implements \hyperlink{interfaceIsisDb_a86f38eca2b6d0835b60770d8a4e511ff}{IsisDb}.
\hypertarget{classMaleteDb_a4f16c48facae498d0db1a042e9727d04}{
\index{MaleteDb@{MaleteDb}!example@{example}}
\index{example@{example}!MaleteDb@{MaleteDb}}
\subsubsection[{example}]{\setlength{\rightskip}{0pt plus 5cm}MaleteDb::example ()}}
\label{classMaleteDb_a4f16c48facae498d0db1a042e9727d04}
Return an example schema.
\begin{DoxySeeAlso}{See also}
\hyperlink{interfaceIsisDb_a857c10d90da64067efa17afb2f32edb6}{IsisDb::example()}
\end{DoxySeeAlso}
Implements \hyperlink{interfaceIsisDb_a857c10d90da64067efa17afb2f32edb6}{IsisDb}.
\hypertarget{classMaleteDb_a17562c1c53594762454d65be823fcdb5}{
\index{MaleteDb@{MaleteDb}!logger@{logger}}
\index{logger@{logger}!MaleteDb@{MaleteDb}}
\subsubsection[{logger}]{\setlength{\rightskip}{0pt plus 5cm}MaleteDb::logger (\$ {\em message})}}
\label{classMaleteDb_a17562c1c53594762454d65be823fcdb5}
Class logger.
\begin{DoxyParams}{Parameters}
\item[{\em \$message}]Log message. \end{DoxyParams}
\hypertarget{classMaleteDb_ad2a65876db24adc388afce465e0c153e}{
\index{MaleteDb@{MaleteDb}!read@{read}}
\index{read@{read}!MaleteDb@{MaleteDb}}
\subsubsection[{read}]{\setlength{\rightskip}{0pt plus 5cm}MaleteDb::read (\$ {\em id})}}
\label{classMaleteDb_ad2a65876db24adc388afce465e0c153e}
Read an entry.
\begin{DoxySeeAlso}{See also}
\hyperlink{interfaceIsisDb_a68335ec0db01ef03f0725621b38b5686}{IsisDb::read()}
\end{DoxySeeAlso}
\begin{Desc}
\item[\hyperlink{todo__todo000002}{Todo}]Subfield handling. \end{Desc}
Implements \hyperlink{interfaceIsisDb_a68335ec0db01ef03f0725621b38b5686}{IsisDb}.
\hypertarget{classMaleteDb_ac87c3ac1b3d9a6297be8574aa303e033}{
\index{MaleteDb@{MaleteDb}!tag@{tag}}
\index{tag@{tag}!MaleteDb@{MaleteDb}}
\subsubsection[{tag}]{\setlength{\rightskip}{0pt plus 5cm}MaleteDb::tag (\$ {\em results})}}
\label{classMaleteDb_ac87c3ac1b3d9a6297be8574aa303e033}
Tag results of a db query.
This function converts the keys of query result from field numbers to names and and also puts repetition fields into place as Malete deals with field repetition by using a 'tag' property in the resulting query object.
\begin{DoxyParams}{Parameters}
\item[{\em \$results}]Database query results.\end{DoxyParams}
\begin{DoxyReturn}{Returns}
Tagged database result.
\end{DoxyReturn}
\subsection{Member Data Documentation}
\hypertarget{classMaleteDb_a4b970df3631d2763f001c96ee417f27a}{
\index{MaleteDb@{MaleteDb}!\$db@{\$db}}
\index{\$db@{\$db}!MaleteDb@{MaleteDb}}
\subsubsection[{\$db}]{\setlength{\rightskip}{0pt plus 5cm}MaleteDb::\$db}}
\label{classMaleteDb_a4b970df3631d2763f001c96ee417f27a}
Database resource. \hypertarget{classMaleteDb_af2cd60ce81381edc3ca09a6812cf79fd}{
\index{MaleteDb@{MaleteDb}!\$fdt@{\$fdt}}
\index{\$fdt@{\$fdt}!MaleteDb@{MaleteDb}}
\subsubsection[{\$fdt}]{\setlength{\rightskip}{0pt plus 5cm}MaleteDb::\$fdt}}
\label{classMaleteDb_af2cd60ce81381edc3ca09a6812cf79fd}
Field description table. \hypertarget{classMaleteDb_a833fed4faae9537306053ee966c06197}{
\index{MaleteDb@{MaleteDb}!\$format@{\$format}}
\index{\$format@{\$format}!MaleteDb@{MaleteDb}}
\subsubsection[{\$format}]{\setlength{\rightskip}{0pt plus 5cm}MaleteDb::\$format}}
\label{classMaleteDb_a833fed4faae9537306053ee966c06197}
Database format, derived from \$schema. \hypertarget{classMaleteDb_ae1c8cefd1a6e661fb03c214f47336368}{
\index{MaleteDb@{MaleteDb}!\$log@{\$log}}
\index{\$log@{\$log}!MaleteDb@{MaleteDb}}
\subsubsection[{\$log}]{\setlength{\rightskip}{0pt plus 5cm}MaleteDb::\$log}}
\label{classMaleteDb_ae1c8cefd1a6e661fb03c214f47336368}
Class action log.
The documentation for this class was generated from the following file:\begin{DoxyCompactItemize}
\item
classes/backends/MaleteDb.php\end{DoxyCompactItemize}
|
