aboutsummaryrefslogtreecommitdiff
path: root/doc/latex/classSchemaDb.tex
blob: 8cee477f55ba08d27dd77ac16f41c15efb9fbff8 (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
\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 (
\begin{DoxyParamCaption}
\item[{\$}]{ schema, }
\item[{\$}]{ section = {\ttfamily NULL}}
\end{DoxyParamCaption}
)\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 (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
)}}
\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 (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
)}}
\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 (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
)\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}