diff options
Diffstat (limited to 'doc/latex/classCinisisDisplayHelper.tex')
| -rw-r--r-- | doc/latex/classCinisisDisplayHelper.tex | 296 |
1 files changed, 296 insertions, 0 deletions
diff --git a/doc/latex/classCinisisDisplayHelper.tex b/doc/latex/classCinisisDisplayHelper.tex new file mode 100644 index 0000000..80624db --- /dev/null +++ b/doc/latex/classCinisisDisplayHelper.tex @@ -0,0 +1,296 @@ +\hypertarget{classCinisisDisplayHelper}{ +\section{CinisisDisplayHelper Class Reference} +\label{classCinisisDisplayHelper}\index{CinisisDisplayHelper@{CinisisDisplayHelper}} +} +\subsection*{Public Member Functions} +\begin{DoxyCompactItemize} +\item +\hyperlink{classCinisisDisplayHelper_ae60a4cc7ad15109c83b3d934f89b283e}{\_\-\_\-construct} (\$title) +\item +\hyperlink{classCinisisDisplayHelper_a5601da7181ece90313c1abe2fd0ae621}{\_\-\_\-call} (\$method, \$arguments) +\end{DoxyCompactItemize} +\subsection*{Static Public Member Functions} +\begin{DoxyCompactItemize} +\item +static \hyperlink{classCinisisDisplayHelper_ab263cf81e5c459c60baa6ef7fa5f76b2}{methodName} (\$method) +\item +static \hyperlink{classCinisisDisplayHelper_abae906d7606b7d76ef5ed754835ba7e2}{\_\-\_\-callStatic} (\$method, \$arguments) +\end{DoxyCompactItemize} +\subsection*{Static Protected Member Functions} +\begin{DoxyCompactItemize} +\item +static \hyperlink{classCinisisDisplayHelper_af3849efbba5e6980ddfdb4ceddb6ad17}{webTitle} (\$title) +\item +static \hyperlink{classCinisisDisplayHelper_a8f0c8aec5b11a144b14278d287238c85}{cliTitle} (\$title) +\item +static \hyperlink{classCinisisDisplayHelper_a356d8117dfcb220b7bb9996b569f5f25}{webHeader} (\$title) +\item +static \hyperlink{classCinisisDisplayHelper_aa331cd95a86ffd270784736e74f253e6}{webFooter} () +\item +static \hyperlink{classCinisisDisplayHelper_a7ba5dd0ddd1ba9de5efdbfa1b62d4efa}{webForm} (\$content, \$action= 'index.php', \$method= 'get') +\item +static \hyperlink{classCinisisDisplayHelper_a4c8934dc88cda9c7a894106b4dc7abba}{webFormInputText} (\$name, \$default=null) +\item +static \hyperlink{classCinisisDisplayHelper_a291e2da97fd646e7fa34fb92879fc3d6}{webNavbar} (\$entry, \$entries, \$action= 'index.php', \$extra=NULL) +\item +static \hyperlink{classCinisisDisplayHelper_aadc869909d8be43402d73fa3415827b4}{webLink} (\$action, \$args, \$title) +\item +static \hyperlink{classCinisisDisplayHelper_a7ffe33c336d0b495807a2c4bae78cbfb}{webEntryLink} (\$entry) +\item +static \hyperlink{classCinisisDisplayHelper_a4028def92d8511e525251ec7ab06246d}{webOpenTable} () +\item +static \hyperlink{classCinisisDisplayHelper_ab4e55ec58b59bc8b2af32b93cdf0d7c1}{webCloseTable} () +\item +static \hyperlink{classCinisisDisplayHelper_a0f2e5c78f6fdd146df04382e497cfe94}{webH2} (\$text) +\item +static \hyperlink{classCinisisDisplayHelper_aa15ca1975a280814a1cdc2df82b8c67d}{cliH2} (\$text) +\item +static \hyperlink{classCinisisDisplayHelper_acc20c726a214895584d15a434b2f3548}{webH3} (\$text) +\item +static \hyperlink{classCinisisDisplayHelper_a1ed9ee357ffda8e2efd885a6eae20550}{cliH3} (\$text) +\item +static \hyperlink{classCinisisDisplayHelper_a9c8b637e47e4263901baf4c5f2064d8d}{webBr} () +\item +static \hyperlink{classCinisisDisplayHelper_ad61db99c9d639678c96879aa34288323}{cliBr} () +\item +static \hyperlink{classCinisisDisplayHelper_a528283a8b16090918f1878dca5ee24fb}{webPre} (\$text) +\item +static \hyperlink{classCinisisDisplayHelper_a50bf73bd3722766cbae1b46b3092453d}{cliPre} (\$text) +\end{DoxyCompactItemize} + + +\subsection{Detailed Description} +Display helpers for test scripts. + +\subsection{Constructor \& Destructor Documentation} +\hypertarget{classCinisisDisplayHelper_ae60a4cc7ad15109c83b3d934f89b283e}{ +\index{CinisisDisplayHelper@{CinisisDisplayHelper}!\_\-\_\-construct@{\_\-\_\-construct}} +\index{\_\-\_\-construct@{\_\-\_\-construct}!CinisisDisplayHelper@{CinisisDisplayHelper}} +\subsubsection[{\_\-\_\-construct}]{\setlength{\rightskip}{0pt plus 5cm}CinisisDisplayHelper::\_\-\_\-construct (\$ {\em title})}} +\label{classCinisisDisplayHelper_ae60a4cc7ad15109c83b3d934f89b283e} +Constructor. + + +\begin{DoxyParams}{Parameters} +\item[{\em \$title}]Page title; \end{DoxyParams} + + +\subsection{Member Function Documentation} +\hypertarget{classCinisisDisplayHelper_a5601da7181ece90313c1abe2fd0ae621}{ +\index{CinisisDisplayHelper@{CinisisDisplayHelper}!\_\-\_\-call@{\_\-\_\-call}} +\index{\_\-\_\-call@{\_\-\_\-call}!CinisisDisplayHelper@{CinisisDisplayHelper}} +\subsubsection[{\_\-\_\-call}]{\setlength{\rightskip}{0pt plus 5cm}CinisisDisplayHelper::\_\-\_\-call (\$ {\em method}, \/ \$ {\em arguments})}} +\label{classCinisisDisplayHelper_a5601da7181ece90313c1abe2fd0ae621} +Dispatcher, dynamic version. + + +\begin{DoxyParams}{Parameters} +\item[{\em \$method}]Method name.\item[{\em \$arguments}]Argument list.\end{DoxyParams} +\begin{DoxyReturn}{Returns} +Callback result. +\end{DoxyReturn} +\hypertarget{classCinisisDisplayHelper_abae906d7606b7d76ef5ed754835ba7e2}{ +\index{CinisisDisplayHelper@{CinisisDisplayHelper}!\_\-\_\-callStatic@{\_\-\_\-callStatic}} +\index{\_\-\_\-callStatic@{\_\-\_\-callStatic}!CinisisDisplayHelper@{CinisisDisplayHelper}} +\subsubsection[{\_\-\_\-callStatic}]{\setlength{\rightskip}{0pt plus 5cm}static CinisisDisplayHelper::\_\-\_\-callStatic (\$ {\em method}, \/ \$ {\em arguments})\hspace{0.3cm}{\ttfamily \mbox{[}static\mbox{]}}}} +\label{classCinisisDisplayHelper_abae906d7606b7d76ef5ed754835ba7e2} +Dispatcher, static version. + + +\begin{DoxyParams}{Parameters} +\item[{\em \$method}]Method name.\item[{\em \$arguments}]Argument list.\end{DoxyParams} +\begin{DoxyReturn}{Returns} +Callback result. +\end{DoxyReturn} +\hypertarget{classCinisisDisplayHelper_ad61db99c9d639678c96879aa34288323}{ +\index{CinisisDisplayHelper@{CinisisDisplayHelper}!cliBr@{cliBr}} +\index{cliBr@{cliBr}!CinisisDisplayHelper@{CinisisDisplayHelper}} +\subsubsection[{cliBr}]{\setlength{\rightskip}{0pt plus 5cm}static CinisisDisplayHelper::cliBr ()\hspace{0.3cm}{\ttfamily \mbox{[}static, protected\mbox{]}}}} +\label{classCinisisDisplayHelper_ad61db99c9d639678c96879aa34288323} +Draws a line break element, CLI version. \hypertarget{classCinisisDisplayHelper_aa15ca1975a280814a1cdc2df82b8c67d}{ +\index{CinisisDisplayHelper@{CinisisDisplayHelper}!cliH2@{cliH2}} +\index{cliH2@{cliH2}!CinisisDisplayHelper@{CinisisDisplayHelper}} +\subsubsection[{cliH2}]{\setlength{\rightskip}{0pt plus 5cm}static CinisisDisplayHelper::cliH2 (\$ {\em text})\hspace{0.3cm}{\ttfamily \mbox{[}static, protected\mbox{]}}}} +\label{classCinisisDisplayHelper_aa15ca1975a280814a1cdc2df82b8c67d} +Draws a h2 element, CLI version. + + +\begin{DoxyParams}{Parameters} +\item[{\em \$text}]Inner text. \end{DoxyParams} +\hypertarget{classCinisisDisplayHelper_a1ed9ee357ffda8e2efd885a6eae20550}{ +\index{CinisisDisplayHelper@{CinisisDisplayHelper}!cliH3@{cliH3}} +\index{cliH3@{cliH3}!CinisisDisplayHelper@{CinisisDisplayHelper}} +\subsubsection[{cliH3}]{\setlength{\rightskip}{0pt plus 5cm}static CinisisDisplayHelper::cliH3 (\$ {\em text})\hspace{0.3cm}{\ttfamily \mbox{[}static, protected\mbox{]}}}} +\label{classCinisisDisplayHelper_a1ed9ee357ffda8e2efd885a6eae20550} +Draws a h3 element, CLI version. + + +\begin{DoxyParams}{Parameters} +\item[{\em \$text}]Inner text. \end{DoxyParams} +\hypertarget{classCinisisDisplayHelper_a50bf73bd3722766cbae1b46b3092453d}{ +\index{CinisisDisplayHelper@{CinisisDisplayHelper}!cliPre@{cliPre}} +\index{cliPre@{cliPre}!CinisisDisplayHelper@{CinisisDisplayHelper}} +\subsubsection[{cliPre}]{\setlength{\rightskip}{0pt plus 5cm}static CinisisDisplayHelper::cliPre (\$ {\em text})\hspace{0.3cm}{\ttfamily \mbox{[}static, protected\mbox{]}}}} +\label{classCinisisDisplayHelper_a50bf73bd3722766cbae1b46b3092453d} +Draws a pre format block element. + + +\begin{DoxyParams}{Parameters} +\item[{\em \$text}]Inner text. \end{DoxyParams} +\hypertarget{classCinisisDisplayHelper_a8f0c8aec5b11a144b14278d287238c85}{ +\index{CinisisDisplayHelper@{CinisisDisplayHelper}!cliTitle@{cliTitle}} +\index{cliTitle@{cliTitle}!CinisisDisplayHelper@{CinisisDisplayHelper}} +\subsubsection[{cliTitle}]{\setlength{\rightskip}{0pt plus 5cm}static CinisisDisplayHelper::cliTitle (\$ {\em title})\hspace{0.3cm}{\ttfamily \mbox{[}static, protected\mbox{]}}}} +\label{classCinisisDisplayHelper_a8f0c8aec5b11a144b14278d287238c85} +Draws title, CLI version. + + +\begin{DoxyParams}{Parameters} +\item[{\em \$title}]Page title; \end{DoxyParams} +\hypertarget{classCinisisDisplayHelper_ab263cf81e5c459c60baa6ef7fa5f76b2}{ +\index{CinisisDisplayHelper@{CinisisDisplayHelper}!methodName@{methodName}} +\index{methodName@{methodName}!CinisisDisplayHelper@{CinisisDisplayHelper}} +\subsubsection[{methodName}]{\setlength{\rightskip}{0pt plus 5cm}static CinisisDisplayHelper::methodName (\$ {\em method})\hspace{0.3cm}{\ttfamily \mbox{[}static\mbox{]}}}} +\label{classCinisisDisplayHelper_ab263cf81e5c459c60baa6ef7fa5f76b2} +Determine internal method names. + + +\begin{DoxyParams}{Parameters} +\item[{\em \$method}]Method name.\end{DoxyParams} +\begin{DoxyReturn}{Returns} +Method name. +\end{DoxyReturn} +\hypertarget{classCinisisDisplayHelper_a9c8b637e47e4263901baf4c5f2064d8d}{ +\index{CinisisDisplayHelper@{CinisisDisplayHelper}!webBr@{webBr}} +\index{webBr@{webBr}!CinisisDisplayHelper@{CinisisDisplayHelper}} +\subsubsection[{webBr}]{\setlength{\rightskip}{0pt plus 5cm}static CinisisDisplayHelper::webBr ()\hspace{0.3cm}{\ttfamily \mbox{[}static, protected\mbox{]}}}} +\label{classCinisisDisplayHelper_a9c8b637e47e4263901baf4c5f2064d8d} +Draws a line break element. \hypertarget{classCinisisDisplayHelper_ab4e55ec58b59bc8b2af32b93cdf0d7c1}{ +\index{CinisisDisplayHelper@{CinisisDisplayHelper}!webCloseTable@{webCloseTable}} +\index{webCloseTable@{webCloseTable}!CinisisDisplayHelper@{CinisisDisplayHelper}} +\subsubsection[{webCloseTable}]{\setlength{\rightskip}{0pt plus 5cm}static CinisisDisplayHelper::webCloseTable ()\hspace{0.3cm}{\ttfamily \mbox{[}static, protected\mbox{]}}}} +\label{classCinisisDisplayHelper_ab4e55ec58b59bc8b2af32b93cdf0d7c1} +Draws tags for closing a table. \hypertarget{classCinisisDisplayHelper_a7ffe33c336d0b495807a2c4bae78cbfb}{ +\index{CinisisDisplayHelper@{CinisisDisplayHelper}!webEntryLink@{webEntryLink}} +\index{webEntryLink@{webEntryLink}!CinisisDisplayHelper@{CinisisDisplayHelper}} +\subsubsection[{webEntryLink}]{\setlength{\rightskip}{0pt plus 5cm}static CinisisDisplayHelper::webEntryLink (\$ {\em entry})\hspace{0.3cm}{\ttfamily \mbox{[}static, protected\mbox{]}}}} +\label{classCinisisDisplayHelper_a7ffe33c336d0b495807a2c4bae78cbfb} +Format an entry link. + + +\begin{DoxyParams}{Parameters} +\item[{\em \$entry}]Entry number.\end{DoxyParams} +\begin{DoxyReturn}{Returns} +Formatted link. +\end{DoxyReturn} +\hypertarget{classCinisisDisplayHelper_aa331cd95a86ffd270784736e74f253e6}{ +\index{CinisisDisplayHelper@{CinisisDisplayHelper}!webFooter@{webFooter}} +\index{webFooter@{webFooter}!CinisisDisplayHelper@{CinisisDisplayHelper}} +\subsubsection[{webFooter}]{\setlength{\rightskip}{0pt plus 5cm}static CinisisDisplayHelper::webFooter ()\hspace{0.3cm}{\ttfamily \mbox{[}static, protected\mbox{]}}}} +\label{classCinisisDisplayHelper_aa331cd95a86ffd270784736e74f253e6} +Draws the page footer. \hypertarget{classCinisisDisplayHelper_a7ba5dd0ddd1ba9de5efdbfa1b62d4efa}{ +\index{CinisisDisplayHelper@{CinisisDisplayHelper}!webForm@{webForm}} +\index{webForm@{webForm}!CinisisDisplayHelper@{CinisisDisplayHelper}} +\subsubsection[{webForm}]{\setlength{\rightskip}{0pt plus 5cm}static CinisisDisplayHelper::webForm (\$ {\em content}, \/ \$ {\em action} = {\ttfamily 'index.php'}, \/ \$ {\em method} = {\ttfamily 'get'})\hspace{0.3cm}{\ttfamily \mbox{[}static, protected\mbox{]}}}} +\label{classCinisisDisplayHelper_a7ba5dd0ddd1ba9de5efdbfa1b62d4efa} +Draws a form. + + +\begin{DoxyParams}{Parameters} +\item[{\em \$content}]Form inner content.\item[{\em \$action}]Form action.\item[{\em \$method}]Form method. \end{DoxyParams} +\hypertarget{classCinisisDisplayHelper_a4c8934dc88cda9c7a894106b4dc7abba}{ +\index{CinisisDisplayHelper@{CinisisDisplayHelper}!webFormInputText@{webFormInputText}} +\index{webFormInputText@{webFormInputText}!CinisisDisplayHelper@{CinisisDisplayHelper}} +\subsubsection[{webFormInputText}]{\setlength{\rightskip}{0pt plus 5cm}static CinisisDisplayHelper::webFormInputText (\$ {\em name}, \/ \$ {\em default} = {\ttfamily null})\hspace{0.3cm}{\ttfamily \mbox{[}static, protected\mbox{]}}}} +\label{classCinisisDisplayHelper_a4c8934dc88cda9c7a894106b4dc7abba} +Draws a form text input. + + +\begin{DoxyParams}{Parameters} +\item[{\em \$name}]Input name.\item[{\em \$default}]Default value.\end{DoxyParams} +\begin{DoxyReturn}{Returns} +Rendered text input. +\end{DoxyReturn} +\hypertarget{classCinisisDisplayHelper_a0f2e5c78f6fdd146df04382e497cfe94}{ +\index{CinisisDisplayHelper@{CinisisDisplayHelper}!webH2@{webH2}} +\index{webH2@{webH2}!CinisisDisplayHelper@{CinisisDisplayHelper}} +\subsubsection[{webH2}]{\setlength{\rightskip}{0pt plus 5cm}static CinisisDisplayHelper::webH2 (\$ {\em text})\hspace{0.3cm}{\ttfamily \mbox{[}static, protected\mbox{]}}}} +\label{classCinisisDisplayHelper_a0f2e5c78f6fdd146df04382e497cfe94} +Draws a h2 element. + + +\begin{DoxyParams}{Parameters} +\item[{\em \$text}]Inner text. \end{DoxyParams} +\hypertarget{classCinisisDisplayHelper_acc20c726a214895584d15a434b2f3548}{ +\index{CinisisDisplayHelper@{CinisisDisplayHelper}!webH3@{webH3}} +\index{webH3@{webH3}!CinisisDisplayHelper@{CinisisDisplayHelper}} +\subsubsection[{webH3}]{\setlength{\rightskip}{0pt plus 5cm}static CinisisDisplayHelper::webH3 (\$ {\em text})\hspace{0.3cm}{\ttfamily \mbox{[}static, protected\mbox{]}}}} +\label{classCinisisDisplayHelper_acc20c726a214895584d15a434b2f3548} +Draws a h3 element. + + +\begin{DoxyParams}{Parameters} +\item[{\em \$text}]Inner text. \end{DoxyParams} +\hypertarget{classCinisisDisplayHelper_a356d8117dfcb220b7bb9996b569f5f25}{ +\index{CinisisDisplayHelper@{CinisisDisplayHelper}!webHeader@{webHeader}} +\index{webHeader@{webHeader}!CinisisDisplayHelper@{CinisisDisplayHelper}} +\subsubsection[{webHeader}]{\setlength{\rightskip}{0pt plus 5cm}static CinisisDisplayHelper::webHeader (\$ {\em title})\hspace{0.3cm}{\ttfamily \mbox{[}static, protected\mbox{]}}}} +\label{classCinisisDisplayHelper_a356d8117dfcb220b7bb9996b569f5f25} +Draws the page header. + + +\begin{DoxyParams}{Parameters} +\item[{\em \$title}]Page title; \end{DoxyParams} +\hypertarget{classCinisisDisplayHelper_aadc869909d8be43402d73fa3415827b4}{ +\index{CinisisDisplayHelper@{CinisisDisplayHelper}!webLink@{webLink}} +\index{webLink@{webLink}!CinisisDisplayHelper@{CinisisDisplayHelper}} +\subsubsection[{webLink}]{\setlength{\rightskip}{0pt plus 5cm}static CinisisDisplayHelper::webLink (\$ {\em action}, \/ \$ {\em args}, \/ \$ {\em title})\hspace{0.3cm}{\ttfamily \mbox{[}static, protected\mbox{]}}}} +\label{classCinisisDisplayHelper_aadc869909d8be43402d73fa3415827b4} +Format a link. + + +\begin{DoxyParams}{Parameters} +\item[{\em \$action}]Link action.\item[{\em \$args}]Action arguments.\item[{\em \$title}]Link title.\end{DoxyParams} +\begin{DoxyReturn}{Returns} +Formatted link. +\end{DoxyReturn} +\hypertarget{classCinisisDisplayHelper_a291e2da97fd646e7fa34fb92879fc3d6}{ +\index{CinisisDisplayHelper@{CinisisDisplayHelper}!webNavbar@{webNavbar}} +\index{webNavbar@{webNavbar}!CinisisDisplayHelper@{CinisisDisplayHelper}} +\subsubsection[{webNavbar}]{\setlength{\rightskip}{0pt plus 5cm}static CinisisDisplayHelper::webNavbar (\$ {\em entry}, \/ \$ {\em entries}, \/ \$ {\em action} = {\ttfamily 'index.php'}, \/ \$ {\em extra} = {\ttfamily NULL})\hspace{0.3cm}{\ttfamily \mbox{[}static, protected\mbox{]}}}} +\label{classCinisisDisplayHelper_a291e2da97fd646e7fa34fb92879fc3d6} +Draws a navigation bar. + + +\begin{DoxyParams}{Parameters} +\item[{\em \$entry}]Current entry.\item[{\em \$entries}]Total number of entries.\item[{\em \$action}]Page action.\item[{\em \$extra}]Extra parameters. \end{DoxyParams} +\hypertarget{classCinisisDisplayHelper_a4028def92d8511e525251ec7ab06246d}{ +\index{CinisisDisplayHelper@{CinisisDisplayHelper}!webOpenTable@{webOpenTable}} +\index{webOpenTable@{webOpenTable}!CinisisDisplayHelper@{CinisisDisplayHelper}} +\subsubsection[{webOpenTable}]{\setlength{\rightskip}{0pt plus 5cm}static CinisisDisplayHelper::webOpenTable ()\hspace{0.3cm}{\ttfamily \mbox{[}static, protected\mbox{]}}}} +\label{classCinisisDisplayHelper_a4028def92d8511e525251ec7ab06246d} +Draws tags for opening a table. \hypertarget{classCinisisDisplayHelper_a528283a8b16090918f1878dca5ee24fb}{ +\index{CinisisDisplayHelper@{CinisisDisplayHelper}!webPre@{webPre}} +\index{webPre@{webPre}!CinisisDisplayHelper@{CinisisDisplayHelper}} +\subsubsection[{webPre}]{\setlength{\rightskip}{0pt plus 5cm}static CinisisDisplayHelper::webPre (\$ {\em text})\hspace{0.3cm}{\ttfamily \mbox{[}static, protected\mbox{]}}}} +\label{classCinisisDisplayHelper_a528283a8b16090918f1878dca5ee24fb} +Draws a pre format block element. + + +\begin{DoxyParams}{Parameters} +\item[{\em \$text}]Inner text. \end{DoxyParams} +\hypertarget{classCinisisDisplayHelper_af3849efbba5e6980ddfdb4ceddb6ad17}{ +\index{CinisisDisplayHelper@{CinisisDisplayHelper}!webTitle@{webTitle}} +\index{webTitle@{webTitle}!CinisisDisplayHelper@{CinisisDisplayHelper}} +\subsubsection[{webTitle}]{\setlength{\rightskip}{0pt plus 5cm}static CinisisDisplayHelper::webTitle (\$ {\em title})\hspace{0.3cm}{\ttfamily \mbox{[}static, protected\mbox{]}}}} +\label{classCinisisDisplayHelper_af3849efbba5e6980ddfdb4ceddb6ad17} +Draws a page title. + + +\begin{DoxyParams}{Parameters} +\item[{\em \$title}]Page title; \end{DoxyParams} + + +The documentation for this class was generated from the following file:\begin{DoxyCompactItemize} +\item +classes/helpers/CinisisDisplayHelper.php\end{DoxyCompactItemize} |