Docs For Class MySQL

$complex_query =

[line 101]

Variable defining the complete query to send to MySQL::sql_link.

Tags:

access:

public

Type:

string

[ Top ]

$database =

[line 39]

Variable that defines the database name.

Tags:

access:

public

Type:

string

[ Top ]

$dbhost = "localhost"

[line 22]

Variable that defines the server where the database is.

Tags:

access:

public

Type:

string

[ Top ]

$dbpass = "ajYz7yhrcUAX8ZAu"

[line 34]

Variable that defines the password with which you will connect.

Tags:

access:

public

Type:

string

[ Top ]

$dbuser = "webuser"

[line 28]

Variable that defines the user with which you will connect.

Tags:

access:

public

Type:

string

[ Top ]

$debug = false

[line 121]

Variable defining the debug mode. If defined to true, the object will echo the query.

Tags:

access:

public

Type:

bool

[ Top ]

$distinct = false

[line 64]

Variable defining if the SELECT must be distinct or not.

Tags:

access:

public

Type:

bool

[ Top ]

$error_report = "change to your mysql-master email"

[line 116]

Variable defining the email to throw when errors are displayed.

Tags:

access:

protected

Type:

string

[ Top ]

$fetch_method = MYSQLI_ASSOC

[line 111]

Variable defining the method used to fetch the results.

Tags:

access:

public

Type:

const

[ Top ]

$groupby = false

[line 69]

Variable defining if the SELECT must group the results by a specific column.

Tags:

access:

public

Type:

bool|string

[ Top ]

$leftjoin =

[line 54]

Variable containing left join statement used in SELECT.

Tags:

access:

public

Type:

array

[ Top ]

$limitfrom =

[line 85]

Variable defining the limit from to use. ... LIMIT $limitfrom,$limitqty; If this variable is not defined, no limit is used.

Tags:

access:

public

Type:

int

[ Top ]

$limitqty =

[line 91]

Variable defining the limit quantity to use. ... LIMIT $limitfrom,$limitqty; If this variable is not defined, no limit is used.

Tags:

access:

public

Type:

int

[ Top ]

$matchvalue = 1

[line 96]

Variable defining the HAVING minimal value for match selection.

Tags:

access:

public

Type:

int

[ Top ]

$order = "ASC"

[line 79]

Variable defining the way the results need to be ordered (Ascending / Descending).

Tags:

access:

public

Type:

string

[ Top ]

$orderrow =

[line 74]

Variable defining the row to use to order the results.

Tags:

access:

public

Type:

string

[ Top ]

$result =

[line 106]

Variable where the result of a select is stored.

Tags:

access:

public

Type:

array

[ Top ]

$sql_link =

[line 49]

Variable where the sql link is stored.

Tags:

access:

public

Type:

object

[ Top ]

$table =

[line 44]

Variable that defines the table name.

Tags:

access:

public

Type:

string

[ Top ]

$whereclause = 1

[line 59]

Variable defining the WHERE clause.

Tags:

access:

public

Type:

string

[ Top ]

constructor __construct [line 151]

MySQL __construct(
[array
$aParams = null], [string
$sAction = null])

Construction function

This function is used when object is generated. It places variables in "$this" var and can launch function

<?php
$aParams = array("database"=>"testdb");
$oMySQL = new MySQL($aParams)
echo $oMySQL->database;
// testdb
?>

Tags:

since:	Version 1.0
uses:	Strings

Parameters:

array	$aParams	array containing variable names and their value ($variablename => $value)
string	$sAction	string containing action to perform on object creation

[ Top ]

method ComplexQuery [line 705]

int|bool ComplexQuery(
object
$this->sql_link, string
$this->database, string
$this->complex_query, bool
$this->debug)

Special complex query function

This function is used to send special complex query using MySQL::sql_link

<?php
$complexquery = "SELECT foo AS bar FROM testtable WHERE SUM(col1,col2)=10;";
$aParams = array("database"=>"testdb","table"=>"testtable","complex_query"=>$complexquery);
$oMySQL = new MySQL($aParams,"ComplexQuery");
print_r($oMySQL->result);
//Displays all rows matching $complexquery
?>

Tags:

return:	quantity of affected rows if the query could be applied
since:	Version 1.0
uses:	MySQL::ConnectDB()

Parameters:

object	$this->sql_link	SQL link to database
string	$this->database	database name (required)
string	$this->complex_query	query to be sent (required)
bool	$this->debug	defines if the function needs to echo the query

[ Top ]

method ConnectDB [line 197]

bool ConnectDB(
string
$this->dbhost, string
$this->dbuser, string
$this->dbpass, string
$this->database)

Function to connect to database

This function is used to connect to database.

<?php
$oMySQL = new MySQL();
$oMySQL->ConnectDB();
print_r($oMySQL->sql_link);
// Object corresponding to SQL link
?>

Tags:

return:	true if the connection could be completed
since:	Version 1.0
usedby:	MySQL::MatchTerms()
usedby:	MySQL::ComplexQuery()
usedby:	MySQL::ShowColumns()
usedby:	MySQL::EmptyTable()
usedby:	MySQL::UpdateRow()
usedby:	MySQL::InsertDatas()
usedby:	MySQL::SelectRow()
usedby:	MySQL::DeleteRow()

Parameters:

string	$this->dbhost	database host (required)
string	$this->dbuser	database user (required)
string	$this->dbpass	database password (required)
string	$this->database	database name (required)

[ Top ]

method DeleteRow [line 435]

int|bool DeleteRow(
object
$this->sql_link, string
$this->database, string
$this->table, string
$this->whereclause, string
$this->orderrow, string
$this->order, int
$this->limitfrom, string
$this->limitqty, bool
$this->debug)

Data deletion function

This function is used to delete rows using MySQL::sql_link

<?php
$aParams = array("database"=>"testdb","table"=>"testtable","whereclause"=>"row2=2");
$oMySQL = new MySQL($aParams);
$oMySQL->DeleteRow();
?>

Tags:

return:	quantity of the deleted rows or false if the query could not be applied
since:	Version 1.0
uses:	MySQL::ConnectDB()

Parameters:

object	$this->sql_link	SQL link to database
string	$this->database	database name (required)
string	$this->table	table name (required)
string	$this->whereclause	where clause statement
string	$this->orderrow	column with which making an order by statement
string	$this->order	order to apply (ASCENDING / DESCENDING)
int	$this->limitfrom	integer defining the limit from statement
string	$this->limitqty	integer defining the limit quantity
bool	$this->debug	defines if the function needs to echo the query

[ Top ]

method EmptyTable [line 566]

bool EmptyTable(
object
$this->sql_link, string
$this->database, string
$this->table, bool
$this->debug)

Table reset function

This function is used to empty a table using MySQL::sql_link

<?php
$aParams = array("database"=>"testdb","table"=>"testtable");
$oMySQL = new MySQL($aParams);
$oMySQL->EmptyTable();
?>

Tags:

return:	true if the table could be emptied
since:	Version 1.0
uses:	MySQL::ConnectDB()

Parameters:

object	$this->sql_link	SQL link to database
string	$this->database	database name (required)
string	$this->table	table name (required)
bool	$this->debug	defines if the function needs to echo the query

[ Top ]

method InsertDatas [line 253]

int|bool InsertDatas(
array
$rows, array
$datas, object
$this->sql_link, string
$this->database, string
$this->table, bool
$this->debug)

Data insertion function

This function is used to insert data using MySQL::sql_link

<?php
$aParams = array("database"=>"testdb","table"=>"testtable");
$oMySQL = new MySQL($aParams);
$aRows = array("row1","row2","row3");
$aValue = array("test",2,"value");
$oMySQL->InsertDatas($aRows,$aValue);
?>

Tags:

return:	id of the inserted row or false if the query could not be applied
since:	Version 1.0
usedby:	WBobject::addToDB()
usedby:	EW_Manufacturers::ManufacturerAdd()
usedby:	BlueBox_CacheControl::InsertQuery()
uses:	MySQL::ConnectDB()
usedby:	EW_Manufacturer_Models::ModelAdd()

Parameters:

object	$this->sql_link	SQL link to database
array	$rows	rows that will be completed with values (required)
array	$datas	values to put in specific rows (required)
string	$this->database	database name (required)
string	$this->table	table name (required)
bool	$this->debug	defines if the function needs to echo the query

[ Top ]

method MatchTerms [line 631]

int|bool MatchTerms(
array
$rows2show, array
$rows2search, string
$searchterm, object
$this->sql_link, string
$this->database, string
$this->table, string
$order, string
$limitfrom, string
$limit, bool
$this->debug)

Match term function

This function is used to match a term in specific rows using MySQL::sql_link

<?php
$aParams = array("database"=>"testdb","table"=>"testtable");
$oMySQL = new MySQL($aParams);
$aCols2show = array("col1","col2");
$aCols2search = array("col2","col4");
$searchterm = "football";
$oMySQL->MatchTerms($aCols2show,$aCols2search,$searchterm);
print_r($oMySQL->result);
//Displays all rows matching searchterm in col2 and col4. It shows only col1 and col2.
?>

Tags:

return:	quantity of fetched rows if the query could be applied
since:	Version 1.0
uses:	MySQL::ConnectDB()

Parameters:

object	$this->sql_link	SQL link to database
string	$this->database	database name (required)
string	$this->table	table name (required)
array	$rows2show	rows to be displayed
array	$rows2search	rows in which search will be performed
string	$searchterm	term that will be searched in rows
string	$order	order to use (ASCENDING / DESCENDING)
string	$limitfrom	limit from value
string	$limit	quantity limit quantity to show
bool	$this->debug	defines if the function needs to echo the query

[ Top ]

method SelectRow [line 337]

int|bool SelectRow(
[array
$rows = "*"], object
$this->sql_link, string
$this->database, string
$this->table, string
$this->whereclause, bool
$this->distinct, array
$this->leftjoin, string
$this->groupby, string
$this->orderrow, int
$this->limitfrom, string
$this->limitqty, bool
$this->debug)

Data selection function

This function is used to select data using MySQL::sql_link

<?php
$aParams = array("database"=>"testdb","table"=>"testtable","whereclause"=>"row2=2");
$oMySQL = new MySQL($aParams);
$aRows = array("row1","row2","row3");
$oMySQL->SelectRow($aRows);
print_r($oMySQL->result);
// Displays all rows where column "row2=2". It will only show "row1", "row2" and "row3"
?>

Tags:

return:	quantity of the selected rows or false if the query could not be applied
since:	Version 1.0
usedby:	Hardgoods::getlist()
usedby:	Exchange_Rates::getLastFromCurrToCurr()
usedby:	Exchange_Rates::maxminLast2Weeks()
usedby:	Links_Hardgoods_Owners::getbyhardgood()
usedby:	Exchange_Rates::maxmin()
usedby:	MacAddresses::getbyhardgood()
usedby:	WBobject::getUniqueFromDB()
usedby:	WBcollection::getFromDB()
usedby:	Programs::listprograms()
usedby:	Programs::getByID()
usedby:	Menus::MenuArrayFromDB()
usedby:	Exchange_Rates::maxminLastQuarter()
usedby:	Exchange_Rates::avgEndLastQuarter()
usedby:	BlueBox_Config::OnStartup()
usedby:	EW_Manufacturer_Models::ModelByID()
usedby:	BlueBox_Config::ValueByName()
usedby:	BlueBox_CacheControl::InDB()
uses:	MySQL::ConnectDB()
usedby:	EW_Manufacturer_Models::ModelByCode()
usedby:	EW_Manufacturer_Models::ModelsList()
usedby:	Exchange_Rates::getByDateFromCurrToCurr()
usedby:	EW_Manufacturers::ManufacturersList()
usedby:	EW_Manufacturers::ManufacturerByCode()
usedby:	EW_Manufacturers::ManufacturerByID()
usedby:	Exchange_Rates::avgLast2Weeks()

Parameters:

object	$this->sql_link	SQL link to database
array	$rows	rows that will be completed with values (required)
string	$this->database	database name (required)
string	$this->table	table name (required)
string	$this->whereclause	where clause statement
bool	$this->distinct	defines if the selection needs to be distinct or not
array	$this->leftjoin	used when left join statement has to be used
string	$this->groupby	column with which making a group by statement
string	$this->orderrow	column with which making an order by statement
int	$this->limitfrom	integer defining the limit from statement
string	$this->limitqty	integer defining the limit quantity
bool	$this->debug	defines if the function needs to echo the query

[ Top ]

method ShowColumns [line 769]

array ShowColumns(
[string
$rows = "*"], object
$this->sql_link, string
$this->database, string
$this->table, bool
$this->debug)

Show Columns function

This function is used to show columns and their info from a table using MySQL::sql_link

<?php
$aParams = array("database"=>"testdb","table"=>"testtable");
$oMySQL = new MySQL($aParams,"ComplexQuery");
print_r($oMySQL->result);
//Displays all rows matching $complexquery
?>

Tags:

return:	PHP array corresponding to columns informations
since:	Version 1.0
uses:	MySQL::ConnectDB()

Parameters:

object	$this->sql_link	SQL link to database
string	$this->database	database name (required)
string	$this->table	table name (required)
string	$rows	rows to be shown
bool	$this->debug	defines if the function needs to echo the query

[ Top ]

method UpdateRow [line 496]

int|bool UpdateRow(
array
$rows, array
$datas, object
$this->sql_link, string
$this->database, string
$this->table, string
$this->whereclause, bool
$this->debug)

Data update function

This function is used to update rows using MySQL::sql_link

<?php
$aParams = array("database"=>"testdb","table"=>"testtable","whereclause"=>"row2=2");
$oMySQL = new MySQL($aParams);
$aRows = array("row1","row2","row3");
$aValue = array("foo","bar",12);
$oMySQL->UpdateRow($aRows,$aValue);
?>

Tags:

return:	quantity of the updated rows or false if the query could not be applied
since:	Version 1.0
usedby:	WBobject::deleteFromDB()
usedby:	WBobject::updateDB()
usedby:	EW_Manufacturer_Models::ModelUpdate()
uses:	MySQL::ConnectDB()
usedby:	EW_Manufacturers::ManufacturerUpdate()

Parameters:

object	$this->sql_link	SQL link to database
string	$this->database	database name (required)
string	$this->table	table name (required)
array	$rows	rows to be updated
array	$datas	datas to apply in rows
string	$this->whereclause	where clause statement
bool	$this->debug	defines if the function needs to echo the query

[ Top ]

Class: MySQL

Class Overview

Author(s):

Version:

Variables

Methods

Class Details

Tags:

Class Variables

$complex_query =

Tags:

$database =

Tags:

$dbhost = "localhost"

Tags:

$dbpass = "ajYz7yhrcUAX8ZAu"

Tags:

$dbuser = "webuser"

Tags:

$debug = false

Tags:

$distinct = false

Tags:

$error_report = "change to your mysql-master email"

Tags:

$fetch_method = MYSQLI_ASSOC

Tags:

$groupby = false

Tags:

$leftjoin =

Tags:

$limitfrom =

Tags:

$limitqty =

Tags:

$matchvalue = 1

Tags:

$order = "ASC"

Tags:

$orderrow =

Tags:

$result =

Tags:

$sql_link =

Tags:

$table =

Tags:

$whereclause = 1

Tags:

Class Methods

constructor __construct [line 151]

Tags:

Parameters:

method ComplexQuery [line 705]

Tags:

Parameters:

method ConnectDB [line 197]

Tags:

Parameters:

method DeleteRow [line 435]

Tags:

Parameters:

method EmptyTable [line 566]

Tags:

Parameters:

method InsertDatas [line 253]

Tags:

Parameters:

method MatchTerms [line 631]

Tags:

Parameters:

method SelectRow [line 337]

Tags:

Parameters:

method ShowColumns [line 769]

Tags:

Parameters:

method UpdateRow [line 496]

Tags:

Parameters: