/docs/latex/classdb_backup.tex

\hypertarget{classdb_backup}{\section{db\-Backup Class Reference}
\label{classdb_backup}\index{db\-Backup@{db\-Backup}}
}


Inherits \hyperlink{classdb_p_d_o}{db\-P\-D\-O}.

\subsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
\hyperlink{classdb_backup_a7f93adf2a111686240ea50fdd8bd8ebf}{\-\_\-\-\_\-construct} (\$db\-Name, \$user, \$pass, \$opts=null, \$db\-Type= 'mysql', \$host\-O\-Rpath= 'localhost', \$port= '')
\item 
\hyperlink{classdb_backup_a421831a265621325e1fdd19aace0c758}{\-\_\-\-\_\-destruct} ()
\item 
\hyperlink{classdb_backup_a5d101758b135bd36ba8992cc3bb67a24}{set\-Path} (\$path)
\item 
\hyperlink{classdb_backup_af9ff1acb357a6c171c60643144717694}{set\-Pre\-String} (\$str= '')
\item 
\hyperlink{classdb_backup_afe408bb74f4a63a1be4f8db787b59453}{set\-Post\-String} (\$str= '')
\item 
\hyperlink{classdb_backup_a75da871b294ce5ac4e4e1ab1ae0bc5d4}{backup\-Table} (\$table, \$name=null)
\item 
\hyperlink{classdb_backup_a18a10140bf184faeb780ce8493446c55}{dump\-Multiple\-Tables} (\$array=null)
\item 
\hyperlink{classdb_backup_a0aa0472caa524c75db0b2f9cddc594c5}{table\-Columns} (\$table)
\item 
\hyperlink{classdb_backup_ac05be54f45477b0eeb08b0693dfa48ac}{get\-Data} (\$table)
\item 
\hyperlink{classdb_backup_aaa28a36632ff9f6df04cc3bbc13a8118}{write\-File} (\$file, \$data)
\end{DoxyCompactItemize}
\subsection*{Additional Inherited Members}


\subsection{Detailed Description}
Class \hyperlink{classdb_backup}{db\-Backup} 

Definition at line 6 of file db\-Backup.\-class.\-php.



\subsection{Constructor \& Destructor Documentation}
\hypertarget{classdb_backup_a7f93adf2a111686240ea50fdd8bd8ebf}{\index{db\-Backup@{db\-Backup}!\-\_\-\-\_\-construct@{\-\_\-\-\_\-construct}}
\index{\-\_\-\-\_\-construct@{\-\_\-\-\_\-construct}!dbBackup@{db\-Backup}}
\subsubsection[{\-\_\-\-\_\-construct}]{\setlength{\rightskip}{0pt plus 5cm}\-\_\-\-\_\-construct (
\begin{DoxyParamCaption}
\item[{}]{\$db\-Name, }
\item[{}]{\$user, }
\item[{}]{\$pass, }
\item[{}]{\$opts = {\ttfamily null}, }
\item[{}]{\$db\-Type = {\ttfamily 'mysql'}, }
\item[{}]{\$host\-O\-Rpath = {\ttfamily 'localhost'}, }
\item[{}]{\$port = {\ttfamily ''}}
\end{DoxyParamCaption}
)}}\label{classdb_backup_a7f93adf2a111686240ea50fdd8bd8ebf}

\begin{DoxyParams}[1]{Parameters}
 & {\em \$db\-Name} & \\
\hline
 & {\em \$user} & \\
\hline
 & {\em \$pass} & \\
\hline
null & {\em \$opts} & \\
\hline
string & {\em \$db\-Type} & \\
\hline
string & {\em \$host\-O\-Rpath} & \\
\hline
string & {\em \$port} & \\
\hline
\end{DoxyParams}


Definition at line 18 of file db\-Backup.\-class.\-php.

\hypertarget{classdb_backup_a421831a265621325e1fdd19aace0c758}{\index{db\-Backup@{db\-Backup}!\-\_\-\-\_\-destruct@{\-\_\-\-\_\-destruct}}
\index{\-\_\-\-\_\-destruct@{\-\_\-\-\_\-destruct}!dbBackup@{db\-Backup}}
\subsubsection[{\-\_\-\-\_\-destruct}]{\setlength{\rightskip}{0pt plus 5cm}\-\_\-\-\_\-destruct (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
)}}\label{classdb_backup_a421831a265621325e1fdd19aace0c758}
Destructor. Unsets all object variables 

Definition at line 26 of file db\-Backup.\-class.\-php.



\subsection{Member Function Documentation}
\hypertarget{classdb_backup_a75da871b294ce5ac4e4e1ab1ae0bc5d4}{\index{db\-Backup@{db\-Backup}!backup\-Table@{backup\-Table}}
\index{backup\-Table@{backup\-Table}!dbBackup@{db\-Backup}}
\subsubsection[{backup\-Table}]{\setlength{\rightskip}{0pt plus 5cm}backup\-Table (
\begin{DoxyParamCaption}
\item[{}]{\$table, }
\item[{}]{\$name = {\ttfamily null}}
\end{DoxyParamCaption}
)}}\label{classdb_backup_a75da871b294ce5ac4e4e1ab1ae0bc5d4}

\begin{DoxyParams}[1]{Parameters}
 & {\em \$table} & \\
\hline
null & {\em \$name} & \\
\hline
\end{DoxyParams}


Definition at line 68 of file db\-Backup.\-class.\-php.

\hypertarget{classdb_backup_a18a10140bf184faeb780ce8493446c55}{\index{db\-Backup@{db\-Backup}!dump\-Multiple\-Tables@{dump\-Multiple\-Tables}}
\index{dump\-Multiple\-Tables@{dump\-Multiple\-Tables}!dbBackup@{db\-Backup}}
\subsubsection[{dump\-Multiple\-Tables}]{\setlength{\rightskip}{0pt plus 5cm}dump\-Multiple\-Tables (
\begin{DoxyParamCaption}
\item[{}]{\$array = {\ttfamily null}}
\end{DoxyParamCaption}
)}}\label{classdb_backup_a18a10140bf184faeb780ce8493446c55}

\begin{DoxyParams}[1]{Parameters}
null & {\em \$array} & \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
bool 
\end{DoxyReturn}


Definition at line 122 of file db\-Backup.\-class.\-php.

\hypertarget{classdb_backup_ac05be54f45477b0eeb08b0693dfa48ac}{\index{db\-Backup@{db\-Backup}!get\-Data@{get\-Data}}
\index{get\-Data@{get\-Data}!dbBackup@{db\-Backup}}
\subsubsection[{get\-Data}]{\setlength{\rightskip}{0pt plus 5cm}get\-Data (
\begin{DoxyParamCaption}
\item[{}]{\$table}
\end{DoxyParamCaption}
)}}\label{classdb_backup_ac05be54f45477b0eeb08b0693dfa48ac}

\begin{DoxyParams}{Parameters}
{\em \$table} & \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
bool$|$array 
\end{DoxyReturn}


Definition at line 168 of file db\-Backup.\-class.\-php.

\hypertarget{classdb_backup_a5d101758b135bd36ba8992cc3bb67a24}{\index{db\-Backup@{db\-Backup}!set\-Path@{set\-Path}}
\index{set\-Path@{set\-Path}!dbBackup@{db\-Backup}}
\subsubsection[{set\-Path}]{\setlength{\rightskip}{0pt plus 5cm}set\-Path (
\begin{DoxyParamCaption}
\item[{}]{\$path}
\end{DoxyParamCaption}
)}}\label{classdb_backup_a5d101758b135bd36ba8992cc3bb67a24}
Sets a path into which the backup files will be placed


\begin{DoxyParams}[1]{Parameters}
string & {\em \$path} & filesystem path \\
\hline
\end{DoxyParams}


Definition at line 42 of file db\-Backup.\-class.\-php.

\hypertarget{classdb_backup_afe408bb74f4a63a1be4f8db787b59453}{\index{db\-Backup@{db\-Backup}!set\-Post\-String@{set\-Post\-String}}
\index{set\-Post\-String@{set\-Post\-String}!dbBackup@{db\-Backup}}
\subsubsection[{set\-Post\-String}]{\setlength{\rightskip}{0pt plus 5cm}set\-Post\-String (
\begin{DoxyParamCaption}
\item[{}]{\$str = {\ttfamily ''}}
\end{DoxyParamCaption}
)}}\label{classdb_backup_afe408bb74f4a63a1be4f8db787b59453}
Sets a string that will be prepended onto the file string 

Definition at line 58 of file db\-Backup.\-class.\-php.

\hypertarget{classdb_backup_af9ff1acb357a6c171c60643144717694}{\index{db\-Backup@{db\-Backup}!set\-Pre\-String@{set\-Pre\-String}}
\index{set\-Pre\-String@{set\-Pre\-String}!dbBackup@{db\-Backup}}
\subsubsection[{set\-Pre\-String}]{\setlength{\rightskip}{0pt plus 5cm}set\-Pre\-String (
\begin{DoxyParamCaption}
\item[{}]{\$str = {\ttfamily ''}}
\end{DoxyParamCaption}
)}}\label{classdb_backup_af9ff1acb357a6c171c60643144717694}
Sets a string that will be prepended onto the file string 

Definition at line 50 of file db\-Backup.\-class.\-php.

\hypertarget{classdb_backup_a0aa0472caa524c75db0b2f9cddc594c5}{\index{db\-Backup@{db\-Backup}!table\-Columns@{table\-Columns}}
\index{table\-Columns@{table\-Columns}!dbBackup@{db\-Backup}}
\subsubsection[{table\-Columns}]{\setlength{\rightskip}{0pt plus 5cm}table\-Columns (
\begin{DoxyParamCaption}
\item[{}]{\$table}
\end{DoxyParamCaption}
)}}\label{classdb_backup_a0aa0472caa524c75db0b2f9cddc594c5}
Gets an array of table columns


\begin{DoxyParams}{Parameters}
{\em \$table} & \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
array$|$bool 
\end{DoxyReturn}


Definition at line 152 of file db\-Backup.\-class.\-php.

\hypertarget{classdb_backup_aaa28a36632ff9f6df04cc3bbc13a8118}{\index{db\-Backup@{db\-Backup}!write\-File@{write\-File}}
\index{write\-File@{write\-File}!dbBackup@{db\-Backup}}
\subsubsection[{write\-File}]{\setlength{\rightskip}{0pt plus 5cm}write\-File (
\begin{DoxyParamCaption}
\item[{}]{\$file, }
\item[{}]{\$data}
\end{DoxyParamCaption}
)}}\label{classdb_backup_aaa28a36632ff9f6df04cc3bbc13a8118}

\begin{DoxyParams}{Parameters}
{\em \$file} & \\
\hline
{\em \$data} & \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
bool 
\end{DoxyReturn}


Definition at line 184 of file db\-Backup.\-class.\-php.



The documentation for this class was generated from the following file\-:\begin{DoxyCompactItemize}
\item 
/\-Users/karlgroves/\-Documents/sites/gs\-\_\-libs/db\-Backup.\-class.\-php\end{DoxyCompactItemize}