aboutsummaryrefslogtreecommitdiff
path: root/doc/latex/classCinIsis.tex
blob: 9d1c55782594014fa02a5a430c42243d1401b732 (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
\hypertarget{classCinIsis}{
\section{CinIsis Class Reference}
\label{classCinIsis}\index{CinIsis@{CinIsis}}
}
\subsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
\hyperlink{classCinIsis_a0f8b918be2f0f1d2c68955b3295034fe}{\_\-\_\-construct} (\$config= 'config/config.yaml')
\item 
\hyperlink{classCinIsis_a831607c2fe9ffac63be8de42e1c9dbae}{load} (\$file)
\item 
\hyperlink{classCinIsis_afa9cbac9e165ebed194b24487344d2fb}{parse} (\$config, \$type= 'cinisis')
\item 
\hyperlink{classCinIsis_acd7e7486428fac5a0a85ad46b0486820}{check} (\$config)
\end{DoxyCompactItemize}
\subsection*{Public Attributes}
\begin{DoxyCompactItemize}
\item 
\hyperlink{classCinIsis_ada0e16c222436f776f040e0fe1a25184}{\$db}
\item 
\hyperlink{classCinIsis_aea1086b32d45308f6875f6ed0a6db2fc}{\$implementation}
\end{DoxyCompactItemize}


\subsection{Detailed Description}
\hyperlink{classCinIsis}{CinIsis} main class. 

\subsection{Constructor \& Destructor Documentation}
\hypertarget{classCinIsis_a0f8b918be2f0f1d2c68955b3295034fe}{
\index{CinIsis@{CinIsis}!\_\-\_\-construct@{\_\-\_\-construct}}
\index{\_\-\_\-construct@{\_\-\_\-construct}!CinIsis@{CinIsis}}
\subsubsection[{\_\-\_\-construct}]{\setlength{\rightskip}{0pt plus 5cm}CinIsis::\_\-\_\-construct (\$ {\em config} = {\ttfamily 'config/config.yaml'})}}
\label{classCinIsis_a0f8b918be2f0f1d2c68955b3295034fe}
Constructor.


\begin{DoxyParams}{Parameters}
\item[{\em \$config}]Optional parameter to set alternative config file or array with configuration. \end{DoxyParams}


\subsection{Member Function Documentation}
\hypertarget{classCinIsis_acd7e7486428fac5a0a85ad46b0486820}{
\index{CinIsis@{CinIsis}!check@{check}}
\index{check@{check}!CinIsis@{CinIsis}}
\subsubsection[{check}]{\setlength{\rightskip}{0pt plus 5cm}CinIsis::check (\$ {\em config})}}
\label{classCinIsis_acd7e7486428fac5a0a85ad46b0486820}
Check configuration.


\begin{DoxyParams}{Parameters}
\item[{\em \$config}]Config file or array with configuration.\end{DoxyParams}
\begin{DoxyReturn}{Returns}
Array with configuration or FALSE on error. 
\end{DoxyReturn}
\hypertarget{classCinIsis_a831607c2fe9ffac63be8de42e1c9dbae}{
\index{CinIsis@{CinIsis}!load@{load}}
\index{load@{load}!CinIsis@{CinIsis}}
\subsubsection[{load}]{\setlength{\rightskip}{0pt plus 5cm}CinIsis::load (\$ {\em file})}}
\label{classCinIsis_a831607c2fe9ffac63be8de42e1c9dbae}
Config file load.


\begin{DoxyParams}{Parameters}
\item[{\em \$file}]Config file.\end{DoxyParams}
\begin{DoxyReturn}{Returns}
Array with configuration. 
\end{DoxyReturn}
\hypertarget{classCinIsis_afa9cbac9e165ebed194b24487344d2fb}{
\index{CinIsis@{CinIsis}!parse@{parse}}
\index{parse@{parse}!CinIsis@{CinIsis}}
\subsubsection[{parse}]{\setlength{\rightskip}{0pt plus 5cm}CinIsis::parse (\$ {\em config}, \/  \$ {\em type} = {\ttfamily 'cinisis'})}}
\label{classCinIsis_afa9cbac9e165ebed194b24487344d2fb}
Parse configuration.


\begin{DoxyParams}{Parameters}
\item[{\em \$config}]Config file or array with configuration.\item[{\em \$type}]Configuration type (either 'cinisis' or 'schema').\end{DoxyParams}
\begin{DoxyReturn}{Returns}
Array with configuration or FALSE on error.
\end{DoxyReturn}
\begin{Desc}
\item[\hyperlink{todo__todo000001}{Todo}]Config and system check. \end{Desc}


\subsection{Member Data Documentation}
\hypertarget{classCinIsis_ada0e16c222436f776f040e0fe1a25184}{
\index{CinIsis@{CinIsis}!\$db@{\$db}}
\index{\$db@{\$db}!CinIsis@{CinIsis}}
\subsubsection[{\$db}]{\setlength{\rightskip}{0pt plus 5cm}CinIsis::\$db}}
\label{classCinIsis_ada0e16c222436f776f040e0fe1a25184}
Database resource. \hypertarget{classCinIsis_aea1086b32d45308f6875f6ed0a6db2fc}{
\index{CinIsis@{CinIsis}!\$implementation@{\$implementation}}
\index{\$implementation@{\$implementation}!CinIsis@{CinIsis}}
\subsubsection[{\$implementation}]{\setlength{\rightskip}{0pt plus 5cm}CinIsis::\$implementation}}
\label{classCinIsis_aea1086b32d45308f6875f6ed0a6db2fc}
Database implementation. 

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