forked from Wavyzz/dolibarr
75 lines
2.6 KiB
TeX
75 lines
2.6 KiB
TeX
\hypertarget{classWebcal}{
|
|
\section{R\'{e}f\'{e}rence de la classe Webcal}
|
|
\label{classWebcal}\index{Webcal@{Webcal}}
|
|
}
|
|
Classe permettant d'acceder a la database webcalendar.
|
|
|
|
|
|
\subsection*{Fonctions membres publiques}
|
|
\begin{CompactItemize}
|
|
\item
|
|
\hypertarget{classWebcal_a0}{
|
|
\hyperlink{classWebcal_a0}{Webcal} ()}
|
|
\label{classWebcal_a0}
|
|
|
|
\begin{CompactList}\small\item\em Permet de se connecter a la database webcalendar. \item\end{CompactList}\item
|
|
\hyperlink{classWebcal_a1}{add} (\$user, \$date, \$texte, \$desc)
|
|
\begin{CompactList}\small\item\em ajoute une entree dans le calendrier de l'utilsateur \item\end{CompactList}\item
|
|
\hyperlink{classWebcal_a2}{get\_\-next\_\-id} ()
|
|
\begin{CompactList}\small\item\em obtient l'id suivant dans le webcalendar \item\end{CompactList}\end{CompactItemize}
|
|
|
|
|
|
\subsection{Description d\'{e}taill\'{e}e}
|
|
Classe permettant d'acceder a la database webcalendar.
|
|
|
|
Ensemble des fonctions permettant d'acceder a la database webcalendar
|
|
|
|
|
|
|
|
D\'{e}finition \`{a} la ligne 37 du fichier webcal.class.php.
|
|
|
|
\subsection{Documentation des fonctions membres}
|
|
\hypertarget{classWebcal_a1}{
|
|
\index{Webcal@{Webcal}!add@{add}}
|
|
\index{add@{add}!Webcal@{Webcal}}
|
|
\subsubsection[add]{\setlength{\rightskip}{0pt plus 5cm}Webcal::add (\$ {\em user}, \$ {\em date}, \$ {\em texte}, \$ {\em desc})}}
|
|
\label{classWebcal_a1}
|
|
|
|
|
|
ajoute une entree dans le calendrier de l'utilsateur
|
|
|
|
\begin{Desc}
|
|
\item[Param\`{e}tres:]
|
|
\begin{description}
|
|
\item[\mbox{$\leftarrow$} {\em user}]le login de l'utilisateur \item[\mbox{$\leftarrow$} {\em date}]la date de l'evenement dans le calendrier \item[\mbox{$\leftarrow$} {\em texte}]le titre a indiquer dans l'evenement \item[\mbox{$\leftarrow$} {\em desc}]la description a indiquer dans l'evenement \end{description}
|
|
\end{Desc}
|
|
|
|
|
|
D\'{e}finition \`{a} la ligne 65 du fichier webcal.class.php.
|
|
|
|
R\'{e}f\'{e}rences add(), et get\_\-next\_\-id().
|
|
|
|
R\'{e}f\'{e}renc\'{e} par add().\hypertarget{classWebcal_a2}{
|
|
\index{Webcal@{Webcal}!get_next_id@{get\_\-next\_\-id}}
|
|
\index{get_next_id@{get\_\-next\_\-id}!Webcal@{Webcal}}
|
|
\subsubsection[get\_\-next\_\-id]{\setlength{\rightskip}{0pt plus 5cm}Webcal::get\_\-next\_\-id ()}}
|
|
\label{classWebcal_a2}
|
|
|
|
|
|
obtient l'id suivant dans le webcalendar
|
|
|
|
\begin{Desc}
|
|
\item[Valeurs retourn\'{e}es:]
|
|
\begin{description}
|
|
\item[{\em id}]retourne l'id suivant dans le webcalendar \end{description}
|
|
\end{Desc}
|
|
|
|
|
|
D\'{e}finition \`{a} la ligne 118 du fichier webcal.class.php.
|
|
|
|
R\'{e}f\'{e}renc\'{e} par add().
|
|
|
|
La documentation de cette classe a \'{e}t\'{e} g\'{e}n\'{e}r\'{e}e \`{a} partir du fichier suivant:\begin{CompactItemize}
|
|
\item
|
|
htdocs/lib/\hyperlink{webcal_8class_8php}{webcal.class.php}\end{CompactItemize}
|