forked from Wavyzz/dolibarr
260 lines
9.8 KiB
TeX
260 lines
9.8 KiB
TeX
\hypertarget{classvCard}{
|
|
\section{R\'{e}f\'{e}rence de la classe v\-Card}
|
|
\label{classvCard}\index{vCard@{vCard}}
|
|
}
|
|
Classe permettant de cr\'{e}er un fichier vcard.
|
|
|
|
|
|
\subsection*{Fonctions membres publiques}
|
|
\begin{CompactItemize}
|
|
\item
|
|
\hyperlink{classvCard_a0}{set\-Phone\-Number} (\$number, \$type=\char`\"{}\char`\"{})
|
|
\begin{CompactList}\small\item\em mise en forme du num\'{e}ro de t\'{e}lephone \item\end{CompactList}\item
|
|
\hyperlink{classvCard_a1}{set\-Photo} (\$type, \$photo)
|
|
\begin{CompactList}\small\item\em mise en forme de la photo \item\end{CompactList}\item
|
|
\hyperlink{classvCard_a2}{set\-Formatted\-Name} (\$name)
|
|
\begin{CompactList}\small\item\em mise en forme du nom format\'{e} \item\end{CompactList}\item
|
|
\hyperlink{classvCard_a3}{set\-Name} (\$family=\char`\"{}\char`\"{}, \$first=\char`\"{}\char`\"{}, \$additional=\char`\"{}\char`\"{}, \$prefix=\char`\"{}\char`\"{}, \$suffix=\char`\"{}\char`\"{})
|
|
\begin{CompactList}\small\item\em mise en forme du nom complet \item\end{CompactList}\item
|
|
\hyperlink{classvCard_a4}{set\-Birthday} (\$date)
|
|
\begin{CompactList}\small\item\em mise en forme de l'anniversaire \item\end{CompactList}\item
|
|
\hyperlink{classvCard_a5}{set\-Address} (\$postoffice=\char`\"{}\char`\"{}, \$extended=\char`\"{}\char`\"{}, \$street=\char`\"{}\char`\"{}, \$city=\char`\"{}\char`\"{}, \$region=\char`\"{}\char`\"{}, \$zip=\char`\"{}\char`\"{}, \$country=\char`\"{}\char`\"{}, \$type=\char`\"{}HOME;POSTAL\char`\"{})
|
|
\begin{CompactList}\small\item\em mise en forme de l'adresse \item\end{CompactList}\item
|
|
\hyperlink{classvCard_a6}{set\-Label} (\$postoffice=\char`\"{}\char`\"{}, \$extended=\char`\"{}\char`\"{}, \$street=\char`\"{}\char`\"{}, \$city=\char`\"{}\char`\"{}, \$region=\char`\"{}\char`\"{}, \$zip=\char`\"{}\char`\"{}, \$country=\char`\"{}\char`\"{}, \$type=\char`\"{}HOME;POSTAL\char`\"{})
|
|
\begin{CompactList}\small\item\em mise en forme du label \item\end{CompactList}\item
|
|
\hyperlink{classvCard_a7}{set\-Email} (\$address)
|
|
\begin{CompactList}\small\item\em mise en forme de l'email \item\end{CompactList}\item
|
|
\hyperlink{classvCard_a8}{set\-Note} (\$note)
|
|
\begin{CompactList}\small\item\em mise en forme de la note \item\end{CompactList}\item
|
|
\hyperlink{classvCard_a9}{set\-URL} (\$url, \$type=\char`\"{}\char`\"{})
|
|
\begin{CompactList}\small\item\em mise en forme de l'url \item\end{CompactList}\item
|
|
\hypertarget{classvCard_a10}{
|
|
\hyperlink{classvCard_a10}{get\-VCard} ()}
|
|
\label{classvCard_a10}
|
|
|
|
\begin{CompactList}\small\item\em permet d'obtenir une vcard \item\end{CompactList}\item
|
|
\hypertarget{classvCard_a11}{
|
|
\hyperlink{classvCard_a11}{get\-File\-Name} ()}
|
|
\label{classvCard_a11}
|
|
|
|
\begin{CompactList}\small\item\em permet d'obtenir le nom de fichier \item\end{CompactList}\end{CompactItemize}
|
|
|
|
|
|
\subsection{Description d\'{e}taill\'{e}e}
|
|
Classe permettant de cr\'{e}er un fichier vcard.
|
|
|
|
Ensemble des fonctions permettant de cr\'{e}er un fichier vcard
|
|
|
|
|
|
|
|
D\'{e}finition \`{a} la ligne 83 du fichier vcard.class.php.
|
|
|
|
\subsection{Documentation des fonctions membres}
|
|
\hypertarget{classvCard_a5}{
|
|
\index{vCard@{v\-Card}!setAddress@{setAddress}}
|
|
\index{setAddress@{setAddress}!vCard@{v\-Card}}
|
|
\subsubsection[setAddress]{\setlength{\rightskip}{0pt plus 5cm}v\-Card::set\-Address (\$ {\em postoffice} = {\tt \char`\"{}\char`\"{}}, \$ {\em extended} = {\tt \char`\"{}\char`\"{}}, \$ {\em street} = {\tt \char`\"{}\char`\"{}}, \$ {\em city} = {\tt \char`\"{}\char`\"{}}, \$ {\em region} = {\tt \char`\"{}\char`\"{}}, \$ {\em zip} = {\tt \char`\"{}\char`\"{}}, \$ {\em country} = {\tt \char`\"{}\char`\"{}}, \$ {\em type} = {\tt \char`\"{}HOME;POSTAL\char`\"{}})}}
|
|
\label{classvCard_a5}
|
|
|
|
|
|
mise en forme de l'adresse
|
|
|
|
\begin{Desc}
|
|
\item[Param\`{e}tres:]
|
|
\begin{description}
|
|
\item[{\em postoffice}]\item[{\em extended}]\item[{\em street}]\item[{\em city}]\item[{\em region}]\item[{\em zip}]\item[{\em country}]\item[{\em type}]\end{description}
|
|
\end{Desc}
|
|
|
|
|
|
D\'{e}finition \`{a} la ligne 158 du fichier vcard.class.php.
|
|
|
|
R\'{e}f\'{e}rences set\-Address().
|
|
|
|
R\'{e}f\'{e}renc\'{e} par set\-Address().\hypertarget{classvCard_a4}{
|
|
\index{vCard@{v\-Card}!setBirthday@{setBirthday}}
|
|
\index{setBirthday@{setBirthday}!vCard@{v\-Card}}
|
|
\subsubsection[setBirthday]{\setlength{\rightskip}{0pt plus 5cm}v\-Card::set\-Birthday (\$ {\em date})}}
|
|
\label{classvCard_a4}
|
|
|
|
|
|
mise en forme de l'anniversaire
|
|
|
|
\begin{Desc}
|
|
\item[Param\`{e}tres:]
|
|
\begin{description}
|
|
\item[{\em date}]\end{description}
|
|
\end{Desc}
|
|
|
|
|
|
D\'{e}finition \`{a} la ligne 142 du fichier vcard.class.php.
|
|
|
|
R\'{e}f\'{e}rences set\-Birthday().
|
|
|
|
R\'{e}f\'{e}renc\'{e} par set\-Birthday().\hypertarget{classvCard_a7}{
|
|
\index{vCard@{v\-Card}!setEmail@{setEmail}}
|
|
\index{setEmail@{setEmail}!vCard@{v\-Card}}
|
|
\subsubsection[setEmail]{\setlength{\rightskip}{0pt plus 5cm}v\-Card::set\-Email (\$ {\em address})}}
|
|
\label{classvCard_a7}
|
|
|
|
|
|
mise en forme de l'email
|
|
|
|
\begin{Desc}
|
|
\item[Param\`{e}tres:]
|
|
\begin{description}
|
|
\item[{\em address}]\end{description}
|
|
\end{Desc}
|
|
|
|
|
|
D\'{e}finition \`{a} la ligne 200 du fichier vcard.class.php.
|
|
|
|
R\'{e}f\'{e}rences set\-Email().
|
|
|
|
R\'{e}f\'{e}renc\'{e} par set\-Email().\hypertarget{classvCard_a2}{
|
|
\index{vCard@{v\-Card}!setFormattedName@{setFormattedName}}
|
|
\index{setFormattedName@{setFormattedName}!vCard@{v\-Card}}
|
|
\subsubsection[setFormattedName]{\setlength{\rightskip}{0pt plus 5cm}v\-Card::set\-Formatted\-Name (\$ {\em name})}}
|
|
\label{classvCard_a2}
|
|
|
|
|
|
mise en forme du nom format\'{e}
|
|
|
|
\begin{Desc}
|
|
\item[Param\`{e}tres:]
|
|
\begin{description}
|
|
\item[{\em name}]\end{description}
|
|
\end{Desc}
|
|
|
|
|
|
D\'{e}finition \`{a} la ligne 118 du fichier vcard.class.php.
|
|
|
|
R\'{e}f\'{e}rences set\-Formatted\-Name().
|
|
|
|
R\'{e}f\'{e}renc\'{e} par set\-Formatted\-Name().\hypertarget{classvCard_a6}{
|
|
\index{vCard@{v\-Card}!setLabel@{setLabel}}
|
|
\index{setLabel@{setLabel}!vCard@{v\-Card}}
|
|
\subsubsection[setLabel]{\setlength{\rightskip}{0pt plus 5cm}v\-Card::set\-Label (\$ {\em postoffice} = {\tt \char`\"{}\char`\"{}}, \$ {\em extended} = {\tt \char`\"{}\char`\"{}}, \$ {\em street} = {\tt \char`\"{}\char`\"{}}, \$ {\em city} = {\tt \char`\"{}\char`\"{}}, \$ {\em region} = {\tt \char`\"{}\char`\"{}}, \$ {\em zip} = {\tt \char`\"{}\char`\"{}}, \$ {\em country} = {\tt \char`\"{}\char`\"{}}, \$ {\em type} = {\tt \char`\"{}HOME;POSTAL\char`\"{}})}}
|
|
\label{classvCard_a6}
|
|
|
|
|
|
mise en forme du label
|
|
|
|
\begin{Desc}
|
|
\item[Param\`{e}tres:]
|
|
\begin{description}
|
|
\item[{\em postoffice}]\item[{\em extended}]\item[{\em street}]\item[{\em city}]\item[{\em region}]\item[{\em zip}]\item[{\em country}]\item[{\em type}]\end{description}
|
|
\end{Desc}
|
|
|
|
|
|
D\'{e}finition \`{a} la ligne 182 du fichier vcard.class.php.
|
|
|
|
R\'{e}f\'{e}rences set\-Label().
|
|
|
|
R\'{e}f\'{e}renc\'{e} par set\-Label().\hypertarget{classvCard_a3}{
|
|
\index{vCard@{v\-Card}!setName@{setName}}
|
|
\index{setName@{setName}!vCard@{v\-Card}}
|
|
\subsubsection[setName]{\setlength{\rightskip}{0pt plus 5cm}v\-Card::set\-Name (\$ {\em family} = {\tt \char`\"{}\char`\"{}}, \$ {\em first} = {\tt \char`\"{}\char`\"{}}, \$ {\em additional} = {\tt \char`\"{}\char`\"{}}, \$ {\em prefix} = {\tt \char`\"{}\char`\"{}}, \$ {\em suffix} = {\tt \char`\"{}\char`\"{}})}}
|
|
\label{classvCard_a3}
|
|
|
|
|
|
mise en forme du nom complet
|
|
|
|
\begin{Desc}
|
|
\item[Param\`{e}tres:]
|
|
\begin{description}
|
|
\item[{\em family}]\item[{\em first}]\item[{\em additional}]\item[{\em prefix}]\item[{\em suffix}]\end{description}
|
|
\end{Desc}
|
|
|
|
|
|
D\'{e}finition \`{a} la ligne 131 du fichier vcard.class.php.
|
|
|
|
R\'{e}f\'{e}rences set\-Name().
|
|
|
|
R\'{e}f\'{e}renc\'{e} par set\-Name().\hypertarget{classvCard_a8}{
|
|
\index{vCard@{v\-Card}!setNote@{setNote}}
|
|
\index{setNote@{setNote}!vCard@{v\-Card}}
|
|
\subsubsection[setNote]{\setlength{\rightskip}{0pt plus 5cm}v\-Card::set\-Note (\$ {\em note})}}
|
|
\label{classvCard_a8}
|
|
|
|
|
|
mise en forme de la note
|
|
|
|
\begin{Desc}
|
|
\item[Param\`{e}tres:]
|
|
\begin{description}
|
|
\item[{\em note}]\end{description}
|
|
\end{Desc}
|
|
|
|
|
|
D\'{e}finition \`{a} la ligne 209 du fichier vcard.class.php.
|
|
|
|
R\'{e}f\'{e}rences set\-Note().
|
|
|
|
R\'{e}f\'{e}renc\'{e} par set\-Note().\hypertarget{classvCard_a0}{
|
|
\index{vCard@{v\-Card}!setPhoneNumber@{setPhoneNumber}}
|
|
\index{setPhoneNumber@{setPhoneNumber}!vCard@{v\-Card}}
|
|
\subsubsection[setPhoneNumber]{\setlength{\rightskip}{0pt plus 5cm}v\-Card::set\-Phone\-Number (\$ {\em number}, \$ {\em type} = {\tt \char`\"{}\char`\"{}})}}
|
|
\label{classvCard_a0}
|
|
|
|
|
|
mise en forme du num\'{e}ro de t\'{e}lephone
|
|
|
|
\begin{Desc}
|
|
\item[Param\`{e}tres:]
|
|
\begin{description}
|
|
\item[{\em number}]num\'{e}ro de t\'{e}l\'{e}phone \item[{\em type}]\end{description}
|
|
\end{Desc}
|
|
|
|
|
|
D\'{e}finition \`{a} la ligne 93 du fichier vcard.class.php.
|
|
|
|
R\'{e}f\'{e}rences set\-Phone\-Number().
|
|
|
|
R\'{e}f\'{e}renc\'{e} par set\-Phone\-Number().\hypertarget{classvCard_a1}{
|
|
\index{vCard@{v\-Card}!setPhoto@{setPhoto}}
|
|
\index{setPhoto@{setPhoto}!vCard@{v\-Card}}
|
|
\subsubsection[setPhoto]{\setlength{\rightskip}{0pt plus 5cm}v\-Card::set\-Photo (\$ {\em type}, \$ {\em photo})}}
|
|
\label{classvCard_a1}
|
|
|
|
|
|
mise en forme de la photo
|
|
|
|
\begin{Desc}
|
|
\item[Param\`{e}tres:]
|
|
\begin{description}
|
|
\item[{\em type}]\item[{\em photo}]\end{description}
|
|
\end{Desc}
|
|
\begin{Desc}
|
|
\item[Avertissement:]NON TESTE ! \end{Desc}
|
|
|
|
|
|
D\'{e}finition \`{a} la ligne 109 du fichier vcard.class.php.
|
|
|
|
R\'{e}f\'{e}rences set\-Photo().
|
|
|
|
R\'{e}f\'{e}renc\'{e} par set\-Photo().\hypertarget{classvCard_a9}{
|
|
\index{vCard@{v\-Card}!setURL@{setURL}}
|
|
\index{setURL@{setURL}!vCard@{v\-Card}}
|
|
\subsubsection[setURL]{\setlength{\rightskip}{0pt plus 5cm}v\-Card::set\-URL (\$ {\em url}, \$ {\em type} = {\tt \char`\"{}\char`\"{}})}}
|
|
\label{classvCard_a9}
|
|
|
|
|
|
mise en forme de l'url
|
|
|
|
\begin{Desc}
|
|
\item[Param\`{e}tres:]
|
|
\begin{description}
|
|
\item[{\em url}]\item[{\em type}]\end{description}
|
|
\end{Desc}
|
|
|
|
|
|
D\'{e}finition \`{a} la ligne 219 du fichier vcard.class.php.
|
|
|
|
R\'{e}f\'{e}rences set\-URL().
|
|
|
|
R\'{e}f\'{e}renc\'{e} par set\-URL().
|
|
|
|
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/vcard/\hyperlink{vcard_8class_8php}{vcard.class.php}\end{CompactItemize}
|