MySQL user database management for AlternC. More...

Inheritance diagram for DB_users:

Public Member Functions
	__construct ()
	Creator. More...

	connect ($Database="", $Host="", $User="", $Password="")
	function for MySQL database connection management More...

	free ()
	Discard the query result. More...

	is_connected ()

	last_error ()

	query ($Query_String, $arguments=false)
	Perform a query. More...

	next_record ()
	walk result set More...

	fetchAll ()

	fetch ($mode=PDO::FETCH_ASSOC)

	lock ($table, $mode="write")
	table locking More...

	unlock ()
	table unlocking More...

	affected_rows ()
	evaluate the result (size, width) More...

	num_rows ()

	num_fields ()

	nf ()
	shorthand notation More...

	np ()

	f ($Name)

	current_record ()

	p ($Name)

	lastid ()

	quote ($string)
	Escape a string to use it into a SQL PDO query. More...

	exec ($query)
	Execute a direct query, not getting any result back. More...

	nextid ($seq_name)
	get next sequence numbers More...

	metadata ($table='', $full=false)
	DEPRECATED return table metadata. More...

	halt ($msg)
	private: error handling More...

	haltmsg ($msg)
	private: error handling More...

	table_names ()

Public Attributes
	$Host

	$HumanHostname

	$User

	$Password

	$Client

	$Record = array()

Private Attributes
	$Database

	$Auto_Free = False

	$Debug = False

	$Halt_On_Error = "no"

	$Seq_Table = "db_sequence"

	$Row = 0

	$num_rows

	$Errno

	$Error

	$Query_String

	$pdo_instance = NULL

	$pdo_query = NULL

Detailed Description

MySQL user database management for AlternC.

This class manage user's databases in MySQL, and user's MySQL accounts.

Copyright: AlternC-Team 2000-2017 https://alternc.com/

Definition at line 27 of file m_mysql.php.

Constructor & Destructor Documentation

◆ __construct()

DB_users::__construct ( )

Creator.

Definition at line 34 of file m_mysql.php.

                            { 
         // Sometimes we need to create this object with empty parameters, but by default we fill them with those of the current user's DB
         global $cuid, $db, $msg;
       
         $db->query("select db_servers.* from db_servers, membres where membres.uid= ? and membres.db_server_id=db_servers.id;", array($cuid));
         if (!$db->next_record()) {
             $msg->raise("ERROR", 'db_user', _("There are no databases in db_servers for this user. Please contact your administrator."));
             die();
         }
  
         // Create the object
         $this->HumanHostname = $db->f('name');
         $this->Host = $db->f('host');
         $this->User = $db->f('login');
         $this->Password = $db->f('password');
         $this->Client = $db->f('client');
         $this->Database = "mysql"; 
       
         parent::__construct("mysql", $db->f('host'), $db->f('login'), $db->f('password') );
       
     }

References $cuid, $db, and $msg.

Member Function Documentation

◆ affected_rows()

DB_Sql::affected_rows ( )

inherited

evaluate the result (size, width)

Definition at line 313 of file db_mysql.php.

                              {
         if (!$this->pdo_query) return 0;
         return $this->pdo_query->rowCount();
     }

◆ connect()

DB_Sql::connect	(	$Database = `""`,
		$Host = `""`,
		$User = `""`,
		$Password = `""`
	)

inherited

function for MySQL database connection management

This function manages the connection to the MySQL database.

Parameters

$Database	name of the database
$Host	DNS of the MySQL hosting server
$User	the user's name
$Password	the user's password

Returns: the class variable $Link_ID

Definition at line 89 of file db_mysql.php.

                                                                              {
         $this->halt('Mysql::connect() : This function should no longer be used');
         /* Handle defaults */
         if ("" == $Database)
             $Database = $this->Database;
         if ("" == $Host)
             $Host     = $this->Host;
         if ("" == $User)
             $User     = $this->User;
         if ("" == $Password)
             $Password = $this->Password;
      
         if (!$this->pdo_instance) {
             $dsn = sprintf('mysql:dbname=%s;host=%s', $Database, $Host);
  
             try {
                 $this->pdo_instance = new PDO($dsn, $User, $Password);
             } catch (PDOException $e) {
                 $this->halt("Mysql::PDO_instance" . $e->getMessage());
                 return FALSE;
             }
         }
     
         return True;
     }

References DB_Sql\$Database, DB_Sql\$Host, DB_Sql\$Password, DB_Sql\$User, and DB_Sql\halt().

◆ current_record()

DB_Sql::current_record ( )

inherited

Definition at line 351 of file db_mysql.php.

                               {
         return $this->Record;
     }

References DB_Sql\$Record.

◆ exec()

DB_Sql::exec ( $query )

inherited

Execute a direct query, not getting any result back.

Parameters

query string query to execute

Returns: integer the number of affected rows

Definition at line 381 of file db_mysql.php.

                           {
         return $this->pdo_instance->exec($query);
     }

References $query.

◆ f()

DB_Sql::f ( $Name )

inherited

Parameters

string $Name

Returns: integer

Definition at line 343 of file db_mysql.php.

                       {
         if (isset($this->Record[$Name]))
             return $this->Record[$Name];
         else
             return false;
     }

Referenced by DB_Sql\nextid().

◆ fetch()

DB_Sql::fetch ( $mode = PDO::FETCH_ASSOC )

inherited

Definition at line 246 of file db_mysql.php.

                                          {
         if (!$this->pdo_query) {
             $this->halt("next_record called with no query pending.");
             return FALSE;
         }
  
         $data = $this->pdo_query->fetch($mode);
         $this->Errno = $this->pdo_query->errorCode();
         $this->Error = $this->pdo_query->errorInfo();
  
         if ($data == FALSE) {
             if ($this->Auto_Free) 
                 $this->free();
             return FALSE;
         }
  
         return $data;
     }

References $mode, DB_Sql\free(), and DB_Sql\halt().

◆ fetchAll()

DB_Sql::fetchAll ( )

inherited

Definition at line 226 of file db_mysql.php.

                         {
         if (!$this->pdo_query) {
             $this->halt("next_record called with no query pending.");
             return FALSE;
         }
  
         $data = $this->pdo_query->fetchAll(PDO::FETCH_BOTH);
         $this->Errno = $this->pdo_query->errorCode();
         $this->Error = $this->pdo_query->errorInfo();
  
         if ($data == FALSE) {
             if ($this->Auto_Free) 
                 $this->free();
             return FALSE;
         }
  
         return $data;
     }

References DB_Sql\free(), and DB_Sql\halt().

◆ free()

DB_Sql::free ( )

inherited

Discard the query result.

This function discards the last query result.

Definition at line 120 of file db_mysql.php.

                     {
         $this->pdo_query->closeCursor();
     }

Referenced by DB_Sql\fetch(), DB_Sql\fetchAll(), and DB_Sql\next_record().

◆ halt()

DB_Sql::halt ( $msg )

inherited

private: error handling

Definition at line 443 of file db_mysql.php.

                         {
         if ($this->Halt_On_Error == "no")
             return;
  
         $this->haltmsg($msg);
  
         if ($this->Halt_On_Error != "report")
             die("Session halted.");
     }

References $msg, and DB_Sql\haltmsg().

Referenced by DB_Sql\connect(), DB_Sql\fetch(), DB_Sql\fetchAll(), DB_Sql\lock(), DB_Sql\next_record(), DB_Sql\nextid(), DB_Sql\query(), and DB_Sql\unlock().

◆ haltmsg()

DB_Sql::haltmsg ( $msg )

inherited

private: error handling

Definition at line 457 of file db_mysql.php.

                            {
         printf("</td></tr></table><b>Database error:</b> %s<br />\n", $msg);
         printf("<b>MySQL Error</b>: %s (%s)<br />\n",
         $this->Errno,
         implode("\n", $this->Error));
     }

References $msg.

Referenced by DB_Sql\halt().

◆ is_connected()

DB_Sql::is_connected ( )

inherited

Definition at line 125 of file db_mysql.php.

                             {
         return $this->pdo_instance != FALSE;
     }

Referenced by DB_Sql\lock(), DB_Sql\nextid(), DB_Sql\query(), and DB_Sql\unlock().

◆ last_error()

DB_Sql::last_error ( )

inherited

Definition at line 130 of file db_mysql.php.

                           {
         return $this->Error;
     }

References DB_Sql\$Error.

◆ lastid()

DB_Sql::lastid ( )

inherited

Definition at line 361 of file db_mysql.php.

                       {
         return $this->pdo_instance->lastInsertId();
     }

◆ lock()

DB_Sql::lock	(	$table,
		$mode = `"write"`
	)

inherited

table locking

Definition at line 268 of file db_mysql.php.

                                          {
         if (!$this->is_connected())
             return FALSE;
     
         $query="lock tables ";
         if (is_array($table)) {
             while (list($key,$value)=each($table)) {
                 if ($key=="read" && $key!=0) {
                     $query.="$value read, ";
                 } else {
                     $query.="$value $mode, ";
                 }
             }
             $query=substr($query,0,-2);
         } else {
             $query.="$table $mode";
         }
      
  
         if (!$this->query($query)) {
             $this->halt("lock($table, $mode) failed.");
             return FALSE;
         }
  
         return TRUE;
  
     }

References $key, $query, $value, DB_Sql\halt(), DB_Sql\is_connected(), and DB_Sql\query().

Referenced by DB_Sql\nextid().

◆ metadata()

DB_Sql::metadata	(	$table = `''`,
		$full = `false`
	)

inherited

DEPRECATED return table metadata.

Definition at line 434 of file db_mysql.php.

                                              {
         global $msg;
         $msg->raise("ERROR", 'Mysql', 'function is no longer implemented (metadata())');
         return FALSE;
     }

References $msg.

◆ next_record()

DB_Sql::next_record ( )

inherited

walk result set

This function tests if a new record is available in the current query result.

Returns: TRUE if a new record is available

Definition at line 205 of file db_mysql.php.

                            {
         if (!$this->pdo_query) {
             $this->halt("next_record called with no query pending.");
             return FALSE;
         }
  
         $this->Record = $this->pdo_query->fetch(PDO::FETCH_BOTH);
         $this->Row++;
         $this->Errno = $this->pdo_query->errorCode();
         $this->Error = $this->pdo_query->errorInfo();
  
         if ($this->Record == FALSE) {
             if ($this->Auto_Free) 
                 $this->free();
             return FALSE;
         }
  
         return TRUE;
     }

References DB_Sql\free(), and DB_Sql\halt().

Referenced by DB_Sql\nextid(), and DB_Sql\table_names().

◆ nextid()

DB_Sql::nextid ( $seq_name )

inherited

get next sequence numbers

Definition at line 389 of file db_mysql.php.

                                {
         if (!$this->is_connected())
             return FALSE;
  
         if ($this->lock($this->Seq_Table)) {
             /* get sequence number (locked) and increment */
             $q  = sprintf("select nextid from %s where seq_name = '%s'",
             $this->Seq_Table,
             $seq_name);
             $this->query($q);
             $this->next_record();
         
             $id = $this->f('nextid');
       
             /* No current value, make one */
             if (!$id) {
                 $currentid = 0;
                 $q = sprintf("insert into %s values('%s', %s)",
                 $this->Seq_Table,
                 $seq_name,
                 $currentid);
                 $this->query($q);
             } else {
                 $currentid = $id;
             }
         
             $nextid = $currentid + 1;
             $q = sprintf("update %s set nextid = '%s' where seq_name = '%s'",
             $this->Seq_Table,
             $nextid,
             $seq_name);
             $this->query($q);
             $this->unlock();
         } else {
             $this->halt("cannot lock ".$this->Seq_Table." - has it been created?");
             return FALSE;
         }
      
         return $nextid;
     }

References $id, $q, DB_Sql\f(), DB_Sql\halt(), DB_Sql\is_connected(), DB_Sql\lock(), DB_Sql\next_record(), DB_Sql\query(), and DB_Sql\unlock().

◆ nf()

DB_Sql::nf ( )

inherited

shorthand notation

Definition at line 330 of file db_mysql.php.

                   {
         return $this->num_rows();
     }

References DB_Sql\num_rows().

◆ np()

DB_Sql::np ( )

inherited

Definition at line 334 of file db_mysql.php.

                   {
         print $this->num_rows();
     }

References DB_Sql\num_rows(), and print.

◆ num_fields()

DB_Sql::num_fields ( )

inherited

Definition at line 322 of file db_mysql.php.

                           {
         if (!$this->pdo_query) return 0;
         return $this->pdo_query->columnCount();
     }

◆ num_rows()

DB_Sql::num_rows ( )

inherited

Definition at line 317 of file db_mysql.php.

                         {
         if (!$this->pdo_query) return 0;
         return $this->pdo_query->rowCount();
     }

Referenced by DB_Sql\nf(), and DB_Sql\np().

◆ p()

DB_Sql::p ( $Name )

inherited

Definition at line 356 of file db_mysql.php.

                       {
         print $this->Record[$Name];
     }

References print.

Referenced by DB_Sql\table_names().

◆ query()

DB_Sql::query	(	$Query_String,
		$arguments = `false`
	)

inherited

Perform a query.

This function performs the MySQL query described in the string parameter

Parameters

a	string describing the MySQL query
arguments	is an optionnal array for future use with PDO parametrized requests

Returns: the $Query_ID class variable (null if fails)

Definition at line 144 of file db_mysql.php.

                                                       {
         global $debug_alternc;
  
         if (empty($Query_String) || !$this->is_connected())
             return FALSE;
  
         $this->Query_String = $Query_String;
         if ($this->Debug)
             printf("Debug: query = %s<br />\n", $Query_String);
  
         $debug_chrono_start = microtime(true);
  
         if ($arguments===false) {
             $this->pdo_query = $this->pdo_instance->query($Query_String);
             $exec_state = is_object($this->pdo_query);
  
         } else {
        
             $this->pdo_query = $this->pdo_instance->prepare($this->Query_String);
             $exec_state = ($arguments) ? $this->pdo_query->execute($arguments) 
                 : $this->pdo_query->execute(); 
             // WARNING: this ternary is when we pass array() as $arguments
         }
  
         $debug_chrono_start = (microtime(true) - $debug_chrono_start)*1000;
         $this->Row = 0;
  
         if ($exec_state == FALSE) {
             if (is_object($this->pdo_query)) {
                 $this->Errno = $this->pdo_query->errorCode();
                 $this->Error = $this->pdo_query->errorInfo();
             } else {
                 $this->Errno = $this->pdo_instance->errorCode();
                 $this->Error = $this->pdo_instance->errorInfo();
             }
  
             if( defined("THROW_EXCEPTIONS") && THROW_EXCEPTIONS ){
                 throw new \Exception("Mysql query failed : $this->Error");
             }
             $this->halt("SQL Error: ".$Query_String);
             return FALSE;
         }
      
         if (isset($debug_alternc)) {
             $debug_alternc->add("SQL Query : (".substr($debug_chrono_start,0,5)." ms)\t $Query_String");
             $debug_alternc->nb_sql_query++;
             $debug_alternc->tps_sql_query += $debug_chrono_start;
         }
  
         return TRUE;
     }

References DB_Sql\$Query_String, DB_Sql\halt(), DB_Sql\is_connected(), and THROW_EXCEPTIONS.

Referenced by DB_Sql\lock(), DB_Sql\nextid(), DB_Sql\table_names(), and DB_Sql\unlock().

◆ quote()

DB_Sql::quote ( $string )

inherited

Escape a string to use it into a SQL PDO query.

Parameters

string string to escape

Returns: string escaped string

Definition at line 371 of file db_mysql.php.

                             {
         return $this->pdo_instance->quote($string);
     }

References $string.

◆ table_names()

DB_Sql::table_names ( )

inherited

Definition at line 465 of file db_mysql.php.

                            {
         $this->query("SHOW TABLES");
         $return = array();
         while ($this->next_record())
             $return[] = array('table_name' => $this->p(0), 'tablespace_name' => $this->Database, 'database' => $this->Database);
  
         return $return;
     }

References DB_Sql\next_record(), DB_Sql\p(), and DB_Sql\query().

◆ unlock()

DB_Sql::unlock ( )

inherited

table unlocking

Definition at line 299 of file db_mysql.php.

                       {
         if (!$this->is_connected())
             return FALSE;
  
         if (!$this->query('unlock tables')) {
             $this->halt("unlock() failed.");
             return FALSE;
         }
     }

References DB_Sql\halt(), DB_Sql\is_connected(), and DB_Sql\query().

Referenced by DB_Sql\nextid().

Member Data Documentation

◆ $Auto_Free

DB_Sql::$Auto_Free = False

privateinherited

Definition at line 36 of file db_mysql.php.

◆ $Client

DB_users::$Client

Definition at line 29 of file m_mysql.php.

◆ $Database

DB_Sql::$Database

privateinherited

Definition at line 31 of file db_mysql.php.

Referenced by DB_Sql\connect().

◆ $Debug

DB_Sql::$Debug = False

privateinherited

Definition at line 37 of file db_mysql.php.

◆ $Errno

DB_Sql::$Errno

privateinherited

Definition at line 47 of file db_mysql.php.

◆ $Error

DB_Sql::$Error

privateinherited

Definition at line 48 of file db_mysql.php.

Referenced by DB_Sql\last_error().

◆ $Halt_On_Error

DB_Sql::$Halt_On_Error = "no"

privateinherited

Definition at line 38 of file db_mysql.php.

◆ $Host

DB_users::$Host

Definition at line 29 of file m_mysql.php.

◆ $HumanHostname

DB_users::$HumanHostname

Definition at line 29 of file m_mysql.php.

◆ $num_rows

DB_Sql::$num_rows

privateinherited

Definition at line 44 of file db_mysql.php.

◆ $Password

DB_users::$Password

Definition at line 29 of file m_mysql.php.

◆ $pdo_instance

DB_Sql::$pdo_instance = NULL

privateinherited

Definition at line 54 of file db_mysql.php.

◆ $pdo_query

DB_Sql::$pdo_query = NULL

privateinherited

Definition at line 55 of file db_mysql.php.

◆ $Query_String

DB_Sql::$Query_String

privateinherited

Definition at line 51 of file db_mysql.php.

Referenced by DB_Sql\query().

◆ $Record

DB_Sql::$Record = array()

inherited

Definition at line 42 of file db_mysql.php.

Referenced by DB_Sql\current_record().

◆ $Row

DB_Sql::$Row = 0

privateinherited

Definition at line 43 of file db_mysql.php.

◆ $Seq_Table

DB_Sql::$Seq_Table = "db_sequence"

privateinherited

Definition at line 39 of file db_mysql.php.

◆ $User

DB_users::$User

Definition at line 29 of file m_mysql.php.

The documentation for this class was generated from the following file:

bureau/class/m_mysql.php

Public Member Functions

Public Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ affected_rows()

◆ connect()

◆ current_record()

◆ exec()

◆ f()

◆ fetch()

◆ fetchAll()

◆ free()

◆ halt()

◆ haltmsg()

◆ is_connected()

◆ last_error()

◆ lastid()

◆ lock()

◆ metadata()

◆ next_record()

◆ nextid()

◆ nf()

◆ np()

◆ num_fields()

◆ num_rows()

◆ p()

◆ query()

◆ quote()

◆ table_names()

◆ unlock()

Member Data Documentation

◆ $Auto_Free

◆ $Client

◆ $Database

◆ $Debug

◆ $Errno

◆ $Error

◆ $Halt_On_Error

◆ $Host

◆ $HumanHostname

◆ $num_rows

◆ $Password

◆ $pdo_instance

◆ $pdo_query

◆ $Query_String

◆ $Record

◆ $Row

◆ $Seq_Table

◆ $User