aboutsummaryrefslogtreecommitdiff
path: root/doc/latex/classSchemaDb.tex
diff options
context:
space:
mode:
Diffstat (limited to 'doc/latex/classSchemaDb.tex')
-rw-r--r--doc/latex/classSchemaDb.tex69
1 files changed, 69 insertions, 0 deletions
diff --git a/doc/latex/classSchemaDb.tex b/doc/latex/classSchemaDb.tex
new file mode 100644
index 0000000..d2a5c1c
--- /dev/null
+++ b/doc/latex/classSchemaDb.tex
@@ -0,0 +1,69 @@
+\hypertarget{classSchemaDb}{
+\section{SchemaDb Class Reference}
+\label{classSchemaDb}\index{SchemaDb@{SchemaDb}}
+}
+\subsection*{Public Member Functions}
+\begin{DoxyCompactItemize}
+\item
+\hyperlink{classSchemaDb_af5c9271759bed2f9cccc80a05f7c5da8}{optional} ()
+\item
+\hyperlink{classSchemaDb_a923a94169459c4dee3f74000b4aa1807}{example} ()
+\end{DoxyCompactItemize}
+\subsection*{Static Public Member Functions}
+\begin{DoxyCompactItemize}
+\item
+static \hyperlink{classSchemaDb_a31db21bccb179162b5bb02b14b72d3e3}{required} ()
+\item
+static \hyperlink{classSchemaDb_a42acc85b08a20b121204b1caf3a83e61}{check} (\$schema, \$section=NULL)
+\end{DoxyCompactItemize}
+
+
+\subsection{Detailed Description}
+\hyperlink{classSchemaDb}{SchemaDb} class with standard database procedures and configuration.
+
+\subsection{Member Function Documentation}
+\hypertarget{classSchemaDb_a42acc85b08a20b121204b1caf3a83e61}{
+\index{SchemaDb@{SchemaDb}!check@{check}}
+\index{check@{check}!SchemaDb@{SchemaDb}}
+\subsubsection[{check}]{\setlength{\rightskip}{0pt plus 5cm}static SchemaDb::check (\$ {\em schema}, \/ \$ {\em section} = {\ttfamily NULL})\hspace{0.3cm}{\ttfamily \mbox{[}static\mbox{]}}}}
+\label{classSchemaDb_a42acc85b08a20b121204b1caf3a83e61}
+Recursively check for required fields in a database schema.
+
+\begin{DoxySeeAlso}{See also}
+\hyperlink{interfaceIsisDb_af681b8f990b579f1835aa7ba4c83f1b8}{IsisDb::check()}
+\end{DoxySeeAlso}
+\hypertarget{classSchemaDb_a923a94169459c4dee3f74000b4aa1807}{
+\index{SchemaDb@{SchemaDb}!example@{example}}
+\index{example@{example}!SchemaDb@{SchemaDb}}
+\subsubsection[{example}]{\setlength{\rightskip}{0pt plus 5cm}SchemaDb::example ()}}
+\label{classSchemaDb_a923a94169459c4dee3f74000b4aa1807}
+Return an example database schema.
+
+\begin{DoxySeeAlso}{See also}
+\hyperlink{interfaceIsisDb_a857c10d90da64067efa17afb2f32edb6}{IsisDb::example()}
+\end{DoxySeeAlso}
+\hypertarget{classSchemaDb_af5c9271759bed2f9cccc80a05f7c5da8}{
+\index{SchemaDb@{SchemaDb}!optional@{optional}}
+\index{optional@{optional}!SchemaDb@{SchemaDb}}
+\subsubsection[{optional}]{\setlength{\rightskip}{0pt plus 5cm}SchemaDb::optional ()}}
+\label{classSchemaDb_af5c9271759bed2f9cccc80a05f7c5da8}
+Return the optional database config.
+
+\begin{DoxyReturn}{Returns}
+Array with optional config.
+\end{DoxyReturn}
+\hypertarget{classSchemaDb_a31db21bccb179162b5bb02b14b72d3e3}{
+\index{SchemaDb@{SchemaDb}!required@{required}}
+\index{required@{required}!SchemaDb@{SchemaDb}}
+\subsubsection[{required}]{\setlength{\rightskip}{0pt plus 5cm}static SchemaDb::required ()\hspace{0.3cm}{\ttfamily \mbox{[}static\mbox{]}}}}
+\label{classSchemaDb_a31db21bccb179162b5bb02b14b72d3e3}
+Return the required database config.
+
+\begin{DoxyReturn}{Returns}
+Array with required config.
+\end{DoxyReturn}
+
+
+The documentation for this class was generated from the following file:\begin{DoxyCompactItemize}
+\item
+classes/backends/SchemaDb.php\end{DoxyCompactItemize}