\hypertarget{classDoliDb}{ \section{R\'{e}f\'{e}rence de la classe Doli\-Db} \label{classDoliDb}\index{DoliDb@{DoliDb}} } Classe permettant de g\'{e}r\'{e}r la database de dolibarr. \subsection*{Fonctions membres publiques} \begin{CompactItemize} \item \hyperlink{classDoliDb_a0}{Doli\-Db} (\$type= 'mysql', \$host= '', \$user= '', \$pass= '', \$name= '') \begin{CompactList}\small\item\em ouverture d'une connection vers le serveur et/ou une database. \item\end{CompactList}\item \hyperlink{classDoliDb_a1}{select\_\-db} (\$database) \begin{CompactList}\small\item\em selectionne une database. \item\end{CompactList}\item \hyperlink{classDoliDb_a2}{connect} (\$host, \$login, \$passwd) \begin{CompactList}\small\item\em connection vers une database. \item\end{CompactList}\item \hyperlink{classDoliDb_a3}{create\_\-db} (\$database) \begin{CompactList}\small\item\em cr\'{e}ation d'une database. \item\end{CompactList}\item \hyperlink{classDoliDb_a4}{clone} () \begin{CompactList}\small\item\em copie d'une database. \item\end{CompactList}\item \hyperlink{classDoliDb_a5}{pconnect} (\$host, \$login, \$passwd) \begin{CompactList}\small\item\em ouverture d'une connection vers une database. \item\end{CompactList}\item \hyperlink{classDoliDb_a6}{close} () \begin{CompactList}\small\item\em fermeture d'une connection vers une database. \item\end{CompactList}\item \hyperlink{classDoliDb_a7}{begin} (\$do=1) \begin{CompactList}\small\item\em debut d'une transaction. \item\end{CompactList}\item \hyperlink{classDoliDb_a8}{commit} (\$do=1) \begin{CompactList}\small\item\em \'{e}criture d'une transaction. \item\end{CompactList}\item \hyperlink{classDoliDb_a9}{rollback} (\$do=1) \begin{CompactList}\small\item\em \'{e}ffacement d'une transaction et retour au ancienne valeurs. \item\end{CompactList}\item \hyperlink{classDoliDb_a10}{query} (\$query, \$limit=\char`\"{}\char`\"{}, \$offset=\char`\"{}\char`\"{}) \begin{CompactList}\small\item\em requete vers une database. \item\end{CompactList}\item \hyperlink{classDoliDb_a11}{list\_\-tables} (\$database) \begin{CompactList}\small\item\em liste des tables dans une database. \item\end{CompactList}\item \hyperlink{classDoliDb_a12}{result} (\$nb, \$fieldname) \begin{CompactList}\small\item\em renvoie les donn\'{e}es de la requete. \item\end{CompactList}\item \hyperlink{classDoliDb_a13}{free} () \begin{CompactList}\small\item\em d\'{e}salloue la memoire de la requete. \item\end{CompactList}\item \hyperlink{classDoliDb_a14}{fetch\_\-object} () \begin{CompactList}\small\item\em renvoie les donn\'{e}es comme un objet. \item\end{CompactList}\item \hyperlink{classDoliDb_a15}{plimit} (\$limit=0, \$offset=0) \begin{CompactList}\small\item\em d\'{e}fini les limites de la requ\`{e}te. \item\end{CompactList}\item \hyperlink{classDoliDb_a17}{idate} (\$fname) \begin{CompactList}\small\item\em formatage de la date en fonction des locales. \item\end{CompactList}\item \hyperlink{classDoliDb_a18}{fetch\_\-array} () \begin{CompactList}\small\item\em renvoie les donn\'{e}es dans un tableau. \item\end{CompactList}\item \hyperlink{classDoliDb_a19}{fetch\_\-row} () \begin{CompactList}\small\item\em renvoie les donn\'{e}es comme un tableau. \item\end{CompactList}\item \hypertarget{classDoliDb_a20}{ \hyperlink{classDoliDb_a20}{fetch\_\-field} ()} \label{classDoliDb_a20} \begin{CompactList}\small\item\em obtient les donn\'{e}es d'un colonne et renvoie les donn\'{e}es sous forme d'objet. \item\end{CompactList}\item \hyperlink{classDoliDb_a21}{num\_\-rows} () \begin{CompactList}\small\item\em renvoie le nombre de lignes dans le resultat de la requete. \item\end{CompactList}\item \hyperlink{classDoliDb_a22}{num\_\-fields} () \begin{CompactList}\small\item\em renvoie le nombre de champs dans le resultat de la requete. \item\end{CompactList}\item \hyperlink{classDoliDb_a23}{error} () \begin{CompactList}\small\item\em renvoie le texte de l'erreur mysql de l'operation precedente. \item\end{CompactList}\item \hyperlink{classDoliDb_a24}{errno} () \begin{CompactList}\small\item\em renvoie la valeur numerique de l'erreur mysql de l'operation precedente. \item\end{CompactList}\item \hyperlink{classDoliDb_a25}{last\_\-insert\_\-id} () \begin{CompactList}\small\item\em obtient l'id gen\'{e}r\'{e} par le pr\'{e}cedent INSERT. \item\end{CompactList}\item \hyperlink{classDoliDb_a26}{affected\_\-rows} () \begin{CompactList}\small\item\em obtient le nombre de lignes affect\'{e}es dans la pr\'{e}c\'{e}dente op\'{e}ration. \item\end{CompactList}\end{CompactItemize} \subsection{Description d\'{e}taill\'{e}e} Classe permettant de g\'{e}r\'{e}r la database de dolibarr. Ensemble des fonctions permettant de g\'{e}rer la database de dolibarr D\'{e}finition \`{a} la ligne 41 du fichier mysql.lib.php. \subsection{Documentation des contructeurs et destructeur} \hypertarget{classDoliDb_a0}{ \index{DoliDb@{Doli\-Db}!DoliDb@{DoliDb}} \index{DoliDb@{DoliDb}!DoliDb@{Doli\-Db}} \subsubsection[DoliDb]{\setlength{\rightskip}{0pt plus 5cm}Doli\-Db::Doli\-Db (\$ {\em type} = {\tt 'mysql'}, \$ {\em host} = {\tt ''}, \$ {\em user} = {\tt ''}, \$ {\em pass} = {\tt ''}, \$ {\em name} = {\tt ''})}} \label{classDoliDb_a0} ouverture d'une connection vers le serveur et/ou une database. \begin{Desc} \item[Param\`{e}tres:] \begin{description} \item[{\em type}]type de base de donn\'{e}es (mysql ou pgsql) \item[{\em host}]addresse de la base de donn\'{e}es \item[{\em user}]nom de l'utilisateur autoris\'{e} \item[{\em pass}]mot de passe \item[{\em name}]nom de la database \end{description} \end{Desc} D\'{e}finition \`{a} la ligne 57 du fichier mysql.lib.php. R\'{e}f\'{e}rences connect(), et select\_\-db(). \subsection{Documentation des fonctions membres} \hypertarget{classDoliDb_a26}{ \index{DoliDb@{Doli\-Db}!affected_rows@{affected\_\-rows}} \index{affected_rows@{affected\_\-rows}!DoliDb@{Doli\-Db}} \subsubsection[affected\_\-rows]{\setlength{\rightskip}{0pt plus 5cm}Doli\-Db::affected\_\-rows ()}} \label{classDoliDb_a26} obtient le nombre de lignes affect\'{e}es dans la pr\'{e}c\'{e}dente op\'{e}ration. \begin{Desc} \item[Renvoie:]rows \end{Desc} D\'{e}finition \`{a} la ligne 448 du fichier mysql.lib.php.\hypertarget{classDoliDb_a7}{ \index{DoliDb@{Doli\-Db}!begin@{begin}} \index{begin@{begin}!DoliDb@{Doli\-Db}} \subsubsection[begin]{\setlength{\rightskip}{0pt plus 5cm}Doli\-Db::begin (\$ {\em do} = {\tt 1})}} \label{classDoliDb_a7} debut d'une transaction. \begin{Desc} \item[Param\`{e}tres:] \begin{description} \item[{\em do}]\end{description} \end{Desc} \begin{Desc} \item[Renvoie:]string \end{Desc} D\'{e}finition \`{a} la ligne 216 du fichier mysql.lib.php. R\'{e}f\'{e}rences begin(), et query(). R\'{e}f\'{e}renc\'{e} par begin().\hypertarget{classDoliDb_a4}{ \index{DoliDb@{Doli\-Db}!clone@{clone}} \index{clone@{clone}!DoliDb@{Doli\-Db}} \subsubsection[clone]{\setlength{\rightskip}{0pt plus 5cm}Doli\-Db::clone ()}} \label{classDoliDb_a4} copie d'une database. \begin{Desc} \item[Renvoie:]resource \end{Desc} D\'{e}finition \`{a} la ligne 179 du fichier mysql.lib.php.\hypertarget{classDoliDb_a6}{ \index{DoliDb@{Doli\-Db}!close@{close}} \index{close@{close}!DoliDb@{Doli\-Db}} \subsubsection[close]{\setlength{\rightskip}{0pt plus 5cm}Doli\-Db::close ()}} \label{classDoliDb_a6} fermeture d'une connection vers une database. \begin{Desc} \item[Renvoie:]resource \end{Desc} D\'{e}finition \`{a} la ligne 205 du fichier mysql.lib.php.\hypertarget{classDoliDb_a8}{ \index{DoliDb@{Doli\-Db}!commit@{commit}} \index{commit@{commit}!DoliDb@{Doli\-Db}} \subsubsection[commit]{\setlength{\rightskip}{0pt plus 5cm}Doli\-Db::commit (\$ {\em do} = {\tt 1})}} \label{classDoliDb_a8} \'{e}criture d'une transaction. \begin{Desc} \item[Param\`{e}tres:] \begin{description} \item[{\em do}]\end{description} \end{Desc} \begin{Desc} \item[Renvoie:]string \end{Desc} D\'{e}finition \`{a} la ligne 234 du fichier mysql.lib.php. R\'{e}f\'{e}rences commit(), et query(). R\'{e}f\'{e}renc\'{e} par commit().\hypertarget{classDoliDb_a2}{ \index{DoliDb@{Doli\-Db}!connect@{connect}} \index{connect@{connect}!DoliDb@{Doli\-Db}} \subsubsection[connect]{\setlength{\rightskip}{0pt plus 5cm}Doli\-Db::connect (\$ {\em host}, \$ {\em login}, \$ {\em passwd})}} \label{classDoliDb_a2} connection vers une database. \begin{Desc} \item[Param\`{e}tres:] \begin{description} \item[{\em host}]addresse de la base de donn\'{e}es \item[{\em login}]nom de l'utilisateur autoris\'{e} \item[{\em passwd}]mot de passe \end{description} \end{Desc} \begin{Desc} \item[Renvoie:]resource \end{Desc} D\'{e}finition \`{a} la ligne 149 du fichier mysql.lib.php. R\'{e}f\'{e}rences connect(). R\'{e}f\'{e}renc\'{e} par connect(), et Doli\-Db().\hypertarget{classDoliDb_a3}{ \index{DoliDb@{Doli\-Db}!create_db@{create\_\-db}} \index{create_db@{create\_\-db}!DoliDb@{Doli\-Db}} \subsubsection[create\_\-db]{\setlength{\rightskip}{0pt plus 5cm}Doli\-Db::create\_\-db (\$ {\em database})}} \label{classDoliDb_a3} cr\'{e}ation d'une database. \begin{Desc} \item[Param\`{e}tres:] \begin{description} \item[{\em database}]nom de la database \end{description} \end{Desc} \begin{Desc} \item[Renvoie:]result resultat 1 pour ok, 0 pour non ok \end{Desc} D\'{e}finition \`{a} la ligne 162 du fichier mysql.lib.php. R\'{e}f\'{e}rences create\_\-db(). R\'{e}f\'{e}renc\'{e} par create\_\-db().\hypertarget{classDoliDb_a24}{ \index{DoliDb@{Doli\-Db}!errno@{errno}} \index{errno@{errno}!DoliDb@{Doli\-Db}} \subsubsection[errno]{\setlength{\rightskip}{0pt plus 5cm}Doli\-Db::errno ()}} \label{classDoliDb_a24} renvoie la valeur numerique de l'erreur mysql de l'operation precedente. \begin{Desc} \item[Renvoie:]error\_\-num \end{Desc} D\'{e}finition \`{a} la ligne 425 du fichier mysql.lib.php.\hypertarget{classDoliDb_a23}{ \index{DoliDb@{Doli\-Db}!error@{error}} \index{error@{error}!DoliDb@{Doli\-Db}} \subsubsection[error]{\setlength{\rightskip}{0pt plus 5cm}Doli\-Db::error ()}} \label{classDoliDb_a23} renvoie le texte de l'erreur mysql de l'operation precedente. \begin{Desc} \item[Renvoie:]error\_\-text \end{Desc} D\'{e}finition \`{a} la ligne 415 du fichier mysql.lib.php.\hypertarget{classDoliDb_a18}{ \index{DoliDb@{Doli\-Db}!fetch_array@{fetch\_\-array}} \index{fetch_array@{fetch\_\-array}!DoliDb@{Doli\-Db}} \subsubsection[fetch\_\-array]{\setlength{\rightskip}{0pt plus 5cm}Doli\-Db::fetch\_\-array ()}} \label{classDoliDb_a18} renvoie les donn\'{e}es dans un tableau. \begin{Desc} \item[Renvoie:]array \end{Desc} D\'{e}finition \`{a} la ligne 365 du fichier mysql.lib.php.\hypertarget{classDoliDb_a14}{ \index{DoliDb@{Doli\-Db}!fetch_object@{fetch\_\-object}} \index{fetch_object@{fetch\_\-object}!DoliDb@{Doli\-Db}} \subsubsection[fetch\_\-object]{\setlength{\rightskip}{0pt plus 5cm}Doli\-Db::fetch\_\-object ()}} \label{classDoliDb_a14} renvoie les donn\'{e}es comme un objet. \begin{Desc} \item[Renvoie:]resource \end{Desc} D\'{e}finition \`{a} la ligne 319 du fichier mysql.lib.php.\hypertarget{classDoliDb_a19}{ \index{DoliDb@{Doli\-Db}!fetch_row@{fetch\_\-row}} \index{fetch_row@{fetch\_\-row}!DoliDb@{Doli\-Db}} \subsubsection[fetch\_\-row]{\setlength{\rightskip}{0pt plus 5cm}Doli\-Db::fetch\_\-row ()}} \label{classDoliDb_a19} renvoie les donn\'{e}es comme un tableau. \begin{Desc} \item[Renvoie:]array \end{Desc} D\'{e}finition \`{a} la ligne 375 du fichier mysql.lib.php.\hypertarget{classDoliDb_a13}{ \index{DoliDb@{Doli\-Db}!free@{free}} \index{free@{free}!DoliDb@{Doli\-Db}} \subsubsection[free]{\setlength{\rightskip}{0pt plus 5cm}Doli\-Db::free ()}} \label{classDoliDb_a13} d\'{e}salloue la memoire de la requete. \begin{Desc} \item[Renvoie:]resource \end{Desc} D\'{e}finition \`{a} la ligne 309 du fichier mysql.lib.php.\hypertarget{classDoliDb_a17}{ \index{DoliDb@{Doli\-Db}!idate@{idate}} \index{idate@{idate}!DoliDb@{Doli\-Db}} \subsubsection[idate]{\setlength{\rightskip}{0pt plus 5cm}Doli\-Db::idate (\$ {\em fname})}} \label{classDoliDb_a17} formatage de la date en fonction des locales. \begin{Desc} \item[Param\`{e}tres:] \begin{description} \item[{\em fname}]\end{description} \end{Desc} \begin{Desc} \item[Renvoie:]date \end{Desc} D\'{e}finition \`{a} la ligne 355 du fichier mysql.lib.php. R\'{e}f\'{e}rences idate(). R\'{e}f\'{e}renc\'{e} par idate().\hypertarget{classDoliDb_a25}{ \index{DoliDb@{Doli\-Db}!last_insert_id@{last\_\-insert\_\-id}} \index{last_insert_id@{last\_\-insert\_\-id}!DoliDb@{Doli\-Db}} \subsubsection[last\_\-insert\_\-id]{\setlength{\rightskip}{0pt plus 5cm}Doli\-Db::last\_\-insert\_\-id ()}} \label{classDoliDb_a25} obtient l'id gen\'{e}r\'{e} par le pr\'{e}cedent INSERT. \begin{Desc} \item[Renvoie:]id \end{Desc} D\'{e}finition \`{a} la ligne 438 du fichier mysql.lib.php.\hypertarget{classDoliDb_a11}{ \index{DoliDb@{Doli\-Db}!list_tables@{list\_\-tables}} \index{list_tables@{list\_\-tables}!DoliDb@{Doli\-Db}} \subsubsection[list\_\-tables]{\setlength{\rightskip}{0pt plus 5cm}Doli\-Db::list\_\-tables (\$ {\em database})}} \label{classDoliDb_a11} liste des tables dans une database. \begin{Desc} \item[Param\`{e}tres:] \begin{description} \item[{\em database}]nom de la database \end{description} \end{Desc} \begin{Desc} \item[Renvoie:]resource \end{Desc} D\'{e}finition \`{a} la ligne 286 du fichier mysql.lib.php. R\'{e}f\'{e}rences list\_\-tables(). R\'{e}f\'{e}renc\'{e} par list\_\-tables().\hypertarget{classDoliDb_a22}{ \index{DoliDb@{Doli\-Db}!num_fields@{num\_\-fields}} \index{num_fields@{num\_\-fields}!DoliDb@{Doli\-Db}} \subsubsection[num\_\-fields]{\setlength{\rightskip}{0pt plus 5cm}Doli\-Db::num\_\-fields ()}} \label{classDoliDb_a22} renvoie le nombre de champs dans le resultat de la requete. \begin{Desc} \item[Renvoie:]int \end{Desc} D\'{e}finition \`{a} la ligne 405 du fichier mysql.lib.php.\hypertarget{classDoliDb_a21}{ \index{DoliDb@{Doli\-Db}!num_rows@{num\_\-rows}} \index{num_rows@{num\_\-rows}!DoliDb@{Doli\-Db}} \subsubsection[num\_\-rows]{\setlength{\rightskip}{0pt plus 5cm}Doli\-Db::num\_\-rows ()}} \label{classDoliDb_a21} renvoie le nombre de lignes dans le resultat de la requete. \begin{Desc} \item[Renvoie:]int \end{Desc} D\'{e}finition \`{a} la ligne 395 du fichier mysql.lib.php.\hypertarget{classDoliDb_a5}{ \index{DoliDb@{Doli\-Db}!pconnect@{pconnect}} \index{pconnect@{pconnect}!DoliDb@{Doli\-Db}} \subsubsection[pconnect]{\setlength{\rightskip}{0pt plus 5cm}Doli\-Db::pconnect (\$ {\em host}, \$ {\em login}, \$ {\em passwd})}} \label{classDoliDb_a5} ouverture d'une connection vers une database. \begin{Desc} \item[Param\`{e}tres:] \begin{description} \item[{\em host}]addresse de la base de donn\'{e}es \item[{\em login}]nom de l'utilisateur autoris\'{e} \item[{\em passwd}]mot de passe \end{description} \end{Desc} \begin{Desc} \item[Renvoie:]resource \end{Desc} D\'{e}finition \`{a} la ligne 194 du fichier mysql.lib.php. R\'{e}f\'{e}rences pconnect(). R\'{e}f\'{e}renc\'{e} par pconnect().\hypertarget{classDoliDb_a15}{ \index{DoliDb@{Doli\-Db}!plimit@{plimit}} \index{plimit@{plimit}!DoliDb@{Doli\-Db}} \subsubsection[plimit]{\setlength{\rightskip}{0pt plus 5cm}Doli\-Db::plimit (\$ {\em limit} = {\tt 0}, \$ {\em offset} = {\tt 0})}} \label{classDoliDb_a15} d\'{e}fini les limites de la requ\`{e}te. \begin{Desc} \item[Param\`{e}tres:] \begin{description} \item[{\em limit}]\item[{\em offset}]\end{description} \end{Desc} \begin{Desc} \item[Renvoie:]limit \end{Desc} D\'{e}finition \`{a} la ligne 331 du fichier mysql.lib.php. R\'{e}f\'{e}rences plimit(). R\'{e}f\'{e}renc\'{e} par plimit().\hypertarget{classDoliDb_a10}{ \index{DoliDb@{Doli\-Db}!query@{query}} \index{query@{query}!DoliDb@{Doli\-Db}} \subsubsection[query]{\setlength{\rightskip}{0pt plus 5cm}Doli\-Db::query (\$ {\em query}, \$ {\em limit} = {\tt \char`\"{}\char`\"{}}, \$ {\em offset} = {\tt \char`\"{}\char`\"{}})}} \label{classDoliDb_a10} requete vers une database. \begin{Desc} \item[Param\`{e}tres:] \begin{description} \item[{\em query}]contenu de la query \item[{\em limit}]\item[{\em offset}]\end{description} \end{Desc} \begin{Desc} \item[Renvoie:]resource \end{Desc} D\'{e}finition \`{a} la ligne 272 du fichier mysql.lib.php. R\'{e}f\'{e}rences query(). R\'{e}f\'{e}renc\'{e} par begin(), commit(), query(), et rollback().\hypertarget{classDoliDb_a12}{ \index{DoliDb@{Doli\-Db}!result@{result}} \index{result@{result}!DoliDb@{Doli\-Db}} \subsubsection[result]{\setlength{\rightskip}{0pt plus 5cm}Doli\-Db::result (\$ {\em nb}, \$ {\em fieldname})}} \label{classDoliDb_a12} renvoie les donn\'{e}es de la requete. \begin{Desc} \item[Param\`{e}tres:] \begin{description} \item[{\em nb}]contenu de la query \item[{\em fieldname}]nom du champ \end{description} \end{Desc} \begin{Desc} \item[Renvoie:]resource \end{Desc} D\'{e}finition \`{a} la ligne 299 du fichier mysql.lib.php. R\'{e}f\'{e}rences result(). R\'{e}f\'{e}renc\'{e} par result().\hypertarget{classDoliDb_a9}{ \index{DoliDb@{Doli\-Db}!rollback@{rollback}} \index{rollback@{rollback}!DoliDb@{Doli\-Db}} \subsubsection[rollback]{\setlength{\rightskip}{0pt plus 5cm}Doli\-Db::rollback (\$ {\em do} = {\tt 1})}} \label{classDoliDb_a9} \'{e}ffacement d'une transaction et retour au ancienne valeurs. \begin{Desc} \item[Param\`{e}tres:] \begin{description} \item[{\em do}]\end{description} \end{Desc} \begin{Desc} \item[Renvoie:]string \end{Desc} D\'{e}finition \`{a} la ligne 252 du fichier mysql.lib.php. R\'{e}f\'{e}rences query(), et rollback(). R\'{e}f\'{e}renc\'{e} par rollback().\hypertarget{classDoliDb_a1}{ \index{DoliDb@{Doli\-Db}!select_db@{select\_\-db}} \index{select_db@{select\_\-db}!DoliDb@{Doli\-Db}} \subsubsection[select\_\-db]{\setlength{\rightskip}{0pt plus 5cm}Doli\-Db::select\_\-db (\$ {\em database})}} \label{classDoliDb_a1} selectionne une database. \begin{Desc} \item[Param\`{e}tres:] \begin{description} \item[{\em database}]nom de la database \end{description} \end{Desc} \begin{Desc} \item[Renvoie:]resource \end{Desc} D\'{e}finition \`{a} la ligne 136 du fichier mysql.lib.php. R\'{e}f\'{e}rences select\_\-db(). R\'{e}f\'{e}renc\'{e} par Doli\-Db(), et select\_\-db(). 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{mysql_8lib_8php}{mysql.lib.php}\end{CompactItemize}