Amiro.CMS API Reference
Amiro.Ru / Manual
Loading search...

The AMI_DB class

• Introduction

Database API.

• Class synopsis

AMI_DB {
/* Methods */
// Returns PHP DB driver resource.
public allowUnsafeQueryOnce ( ) returns resource|null;
// Enables or disables debug queries output.
public displayQueries ( [ bool $bDebug = true ] ) returns void;
// Escapes value.
public escape ( int|float|string $value ) returns string;
// Executes SELECT query and returns the recordset object containing only one column.
public fetchCol ( DB_Snippet|string $query, [ int $flags = 0 ] ) returns DB_Recordset_Column|false;
// Returns single record.
public fetchRow ( DB_Snippet|string $query, [ int $fetchType = MYSQL_ASSOC ], [ int $flags = 0 ] ) returns array|false;
// Returns single value.
public fetchValue ( DB_Snippet|string $query, [ int $flags = 0 ] ) returns mixed;
// Returns affected rows number.
public getAffectedRows ( ) returns int;
// Returns last error message.
public getErrorMessage ( ) returns string;
// Returns PHP DB driver last error number.
public getErrorNumber ( ) returns int;
// Returns last insert id.
public getInsertId ( ) returns int|false;
// Executes query.
public query ( DB_Snippet|string $query, [ int $flags = 0 ] ) returns resource|false;
// Executes SELECT query and returns the recordset object.
public select ( DB_Snippet|string $query, [ int $fetchType = MYSQL_ASSOC ], [ int $flags = 0 ] ) returns DB_Recordset|false;
}
Tags:
resource db AMI::getSingleton('db')

• Class Methods

// Returns PHP DB driver resource.
public allowUnsafeQueryOnce ( ) returns resource|null;
// Enables or disables debug queries output.
public displayQueries ( [ bool $bDebug = true ] ) returns void;
  • bool $bDebug
    True if display queries
// Escapes value.
public escape ( int|float|string $value ) returns string;
  • int|float|string $value
    Value
Tags:
since 5.12.4
// Executes SELECT query and returns the recordset object containing only one column.
public fetchCol ( DB_Snippet|string $query, [ int $flags = 0 ] ) returns DB_Recordset_Column|false;
  • DB_Snippet|string $query
    Query
  • int $flags
    Will be described later
Query cannot contain any quotes. Use DB_Query::getSnippet() to pass complex data.
  Example:
  •  $aColumn AMI::getSingleton('db')->fetchCol("SELECT DISTINCT(`id_page`) FROM `visit` WHERE `id_user` = 1");
  •  foreach($aColumn as $value){
  •      ...
  •  }
// Returns single record.
public fetchRow ( DB_Snippet|string $query, [ int $fetchType = MYSQL_ASSOC ], [ int $flags = 0 ] ) returns array|false;
  • DB_Snippet|string $query
    Query
  • int $fetchType
    See mysql_fetch_array $result_type parameter description
  • int $flags
    Will be described later
Query cannot contain any quotes. Use DB_Query::getSnippet() to pass complex data.
  Example:
// Returns single value.
public fetchValue ( DB_Snippet|string $query, [ int $flags = 0 ] ) returns mixed;
  • DB_Snippet|string $query
    Query
  • int $flags
    Will be described later
Query cannot contain any quotes. Use DB_Query::getSnippet() to pass complex data.
  Example:
// Returns affected rows number.
public getAffectedRows ( ) returns int;
// Returns last error message.
public getErrorMessage ( ) returns string;
// Returns PHP DB driver last error number.
public getErrorNumber ( ) returns int;
// Returns last insert id.
public getInsertId ( ) returns int|false;
// Executes query.
public query ( DB_Snippet|string $query, [ int $flags = 0 ] ) returns resource|false;
  • DB_Snippet|string $query
    Query
  • int $flags
    Will be described later
Query cannot contain any quotes. Use DB_Query::getSnippet() to pass complex data.
  Example:
// Executes SELECT query and returns the recordset object.
public select ( DB_Snippet|string $query, [ int $fetchType = MYSQL_ASSOC ], [ int $flags = 0 ] ) returns DB_Recordset|false;
  • DB_Snippet|string $query
    Query
  • int $fetchType
    See mysql_fetch_array $result_type parameter description
  • int $flags
    Will be described later
Query cannot contain any quotes. Use DB_Query::getSnippet() to pass complex data.
  Example:
  •  $oDB AMI::getSingleton('db');
  •  $oRS $oDB->select("SELECT * FROM `visit`");
  •  foreach($oRS as $aRecord){
  •      // $aRecord is an array
  •  }