Amiro.CMS API Reference [beta] (available from v5.10) Amiro.Ru / Manual
Interfaces:
DB_iRecordset
Orphus
[ class tree: DB ] [ index: DB ] [ all elements ] [ Resource List ]
DB / The DB_Snippet class

The DB_Snippet class

• Introduction

Database query snippet.

• Class synopsis

DB_Snippet {
/* Properties */
// Template arguments
protected array $aArgs = array();
// SQL template
protected string $snippet = '';
/* Methods */
// Constructor.
public __construct ( string $snippet ) returns DB_Snippet;
// Returns parsed snippet as string.
public get ( ) returns string;
// Adds imploded array.
public implode ( $aValue, [ bool $asInt = FALSE ] ) returns DB_Snippet;
// Adds plain value.
public plain ( string|int $value ) returns DB_Snippet;
// Adds quoted value.
public q ( string|int $value ) returns DB_Snippet;
}

• Class Details

Contains functionality to construct query snippets having quotes.
  Example:
  1.  // PlgAJAXResp::initModel()
  2.  $oModelList->addWhereDef(
  3.      DB_Query::getSnippet("AND %s = %s")
  4.          ->plain($prefix . $this->oTableModel->getFieldName('id_page'))
  5.          ->q($this->oRequest->get('id_page'))
  6.  );
  7.  // ~ AND id_page = '....'

• Class Properies

protected array $aArgs

Template arguments

protected string $snippet

SQL template

• Class Methods

// Constructor.
public __construct ( string $snippet ) returns DB_Snippet;
  • string $snippet
    Query snippet in sprintf() format
// Returns parsed snippet as string.
public get ( ) returns string;
// Adds imploded array.
public implode ( $aValue, [ bool $asInt = FALSE ] ) returns DB_Snippet;
  • array $aValue
    Argument value containing array
  • bool $asInt
    Implode array having integer values (since 5.14.0)
  Example:
  1.  $oQuery->addWhereDef(
  2.      DB_Query::getSnippet("AND id IN (%s)")
  3.          ->implode(array(1, 2, 3))
  4.  );
// Adds plain value.
public plain ( string|int $value ) returns DB_Snippet;
  • string|int $value
    Argument value containing no quotes
Plain value cannot contain any quotes.
  Example:
  1.  $oQuery->addWhereDef(
  2.      DB_Query::getSnippet("AND %s = 'value'")
  3.          ->plain($fieldName)
  4.  );
// Adds quoted value.
public q ( string|int $value ) returns DB_Snippet;
  • string|int $value
    Argument value
  Example:
  1.  $oQuery->addWhereDef(
  2.      DB_Query::getSnippet("AND name = %s")
  3.          ->q($exactName)
  4.  );
Documentation generated on Wed, 21 Dec 2011 10:41:32 +0600 by