Class: VMysqlQuery

Source Location: /libraries/vwp/dbi/drivers/mysql/query.php

Class Overview [line 56]

VType
   |
   --VObject
      |
      --VDBI
         |
         --VDatabase
            |
            --VMysqlDatabase
               |
               --VMysqlQuery

Virtual Web Platform - MySQL Table

Author(s):

Version:

Copyright:

  • (c) Ralph Ritoch - All Rights Reserved

Variables

Constants

Methods

Child classes:

VMysqlQueryRow
Virtual Web Platform - MySQL Table Row

Inherited Variables

Class: VMysqlDatabase

VMysqlDatabase::$database
VMysqlDatabase::$password
VMysqlDatabase::$server
VMysqlDatabase::$username
VMysqlDatabase::$_cerrmsg
VMysqlDatabase::$_cerrno
VMysqlDatabase::$_result

Class: VDatabase

VDatabase::$_connected
VDatabase::$_db_class
VDatabase::$_db_classfile
VDatabase::$_link
VDatabase::$_protected_prefix
VDatabase::$_query
VDatabase::$_tables
VDatabase::$_tables_loaded

Class: VObject

VObject::$_nosave_errors
VObject::$_nosave_original_state

Inherited Constants

Class: VMysqlDatabase

VMysqlDatabase::NS_SCHEMA
VMysqlDatabase::NS_SQLTYPES

Inherited Methods

Class: VMysqlDatabase

VMysqlDatabase::__construct()
Class constructor
VMysqlDatabase::createQuery()
Create Query
VMysqlDatabase::createTable()
Create Table
VMysqlDatabase::getRow()
Get a row from a table
VMysqlDatabase::getTable()
Get database table
VMysqlDatabase::listTables()
List database tables
VMysqlDatabase::loadAssocList()
Get database response as associative list
VMysqlDatabase::loadResult()
Get database response as single data field
VMysqlDatabase::nameQuote()
Quote a database identifier
VMysqlDatabase::query()
Send database query
VMysqlDatabase::quote()
Quote a database value
VMysqlDatabase::__destruct()
Class destructor

Class: VDatabase

VDatabase::__construct()
Class constructor
VDatabase::connect()
Connect to database
VDatabase::createQuery()
Create Query
VDatabase::disconnect()
Disconnect from database
VDatabase::drop()
Drop database
VDatabase::getDBType()
Get database type
VDatabase::getRow()
Get a row from a table
VDatabase::getTable()
Get database table
VDatabase::loadTables()
Load tables
VDatabase::setQuery()
Set database query string
VDatabase::unloadTables()
UnLoad tables

Class: VDBI

VDBI::__construct()
Class constructor
VDBI::createTable()
Create Table
VDBI::getDatabase()
Get a database object
VDBI::getDefaultDatabaseName()
Get default database name
VDBI::getInstance()
Get instance of DBI object
VDBI::getRow()
Get a row from a table
VDBI::getTable()
Get database table
VDBI::isError()
Test if a value is an error
VDBI::isWarning()
Test if a value is a warning
VDBI::listDatabases()
List databases
VDBI::listDBTypes()
Get list of supported database types
VDBI::listTables()
List database tables
VDBI::loadDatabases()
Load databases
VDBI::lock()
Lock a section of code
VDBI::nameQuote()
Quote a database identifier
VDBI::quote()
Quote a database value
VDBI::raiseError()
Generate an error
VDBI::raiseWarning()
Generate a warning
VDBI::unlock()
UnLock a section of code

Class: VObject

VObject::__construct()
Class Constructor
VObject::bind()
Bind values to this object
VObject::delete()
Delete Object
VObject::get()
Get value
VObject::getAll()
Get all object values
VObject::getError()
Get error message
VObject::getErrors()
Get errors
VObject::getMethods()
Get object methods
VObject::getProperties()
Get object properties
VObject::save()
Save Object
VObject::set()
Set a value
VObject::setError()
Set error value
VObject::setProperties()
Set property values
VObject::setProperty()
Set property value
VObject::toString()
Convert object to string
VObject::__destruct()
Class Destructor
VObject::__toString()
Return object as a string

Class Details

Virtual Web Platform - MySQL Table

This class provides the driver for MySQL Table Access.

Tags:

[ Top ]

Class Variables

$columns =  null

[line 113]

Tags:

  • var - Columns
  • access - public

Type: array

Overrides:

[ Top ]

$fields =  null

[line 147]

Fields

Tags:

  • var - Fields
  • access - public

Type: array

Overrides:

[ Top ]

$groupList =  null

[line 138]

Group List

Tags:

  • var - Group List
  • access - public

Type: array

Overrides:

[ Top ]

$infilter =  null

[line 71]

Tags:

  • access - public

Type: VMysqlQueryFilter

Overrides:

[ Top ]

$joinType =  null

[line 106]

Join Type

Tags:

  • var - Join Type
  • access - public

Type: string

Overrides:

[ Top ]

$ordering =  null

[line 89]

Tags:

  • access - public

Type: mixed

Overrides:

[ Top ]

$outfilter =  null

[line 78]

Tags:

  • access - public

Type: VMysqlQueryFilter

Overrides:

[ Top ]

$paging =  null

[line 64]

Tags:

  • access - public

Type: object Filter

Overrides:

[ Top ]

$primary_key =  null

[line 129]

Primary Key

Tags:

  • var - Primary key column
  • access - public

Type: string

Overrides:

[ Top ]

$rows = array()

[line 120]

Tags:

  • var - Rows
  • access - public

Type: array

Overrides:

[ Top ]

$tableMap = array()

[line 87]

Tags:

  • access - public

Type: mixed

Overrides:

[ Top ]

$tableRelationships =  null

[line 97]

Table Relationships

Tags:

  • var - Table Relationships
  • access - public

Type: VDatabaseTableRelationships

Overrides:

[ Top ]

$tables = array()

[line 85]

Tags:

  • access - public

Type: array

Overrides:

[ Top ]

Class Methods

__construct

VMysqlQuery __construct( [ $databaseName = null], string $tableName)

[line 890]

Class constructor

Tags:

  • access - public

Overrides VMysqlDatabase::__construct() (Class constructor)

Parameters:

  • string $tableName - Table name
  • $databaseName -

[ Top ]

__destruct

void __destruct( )

[line 155]

Class destructor

Tags:

  • access - public

Overrides VMysqlDatabase::__destruct() (Class destructor)

Parameters:

[ Top ]

getInFilter

VMysqlQueryFilter &getInFilter( )

[line 167]

Get Input Filter

Tags:

  • return - Input Filter
  • access - public

Parameters:

[ Top ]

getOutFilter

VMysqlQueryFilter &getOutFilter( )

[line 180]

Get Output Filter

Tags:

  • return - Output Filter
  • access - public

Parameters:

[ Top ]

getPaging

object Table &getPaging( )

[line 796]

Get paging object

Tags:

  • return - paging
  • access - public

Parameters:

[ Top ]

getProperties

array getProperties( [boolean $public = true])

[line 375]

Get query properties

Tags:

  • return - Table properties
  • access - public

Overrides VObject::getProperties() (Get object properties)

Parameters:

  • boolean $public - Unused

[ Top ]

getRow

object Row &getRow( mixed $key, [string $tableName = null], [string $databaseName = null])

[line 826]

Get a row from a query

Tags:

  • return - object on success, error or warning on failure

Overrides VMysqlDatabase::getRow() (Get a row from a table)

Parameters:

  • mixed $key - Row identifier (primary key value)
  • string $tableName - Ignored
  • string $databaseName - Ignored

[ Top ]

loadAssocList

array|object Results loadAssocList( )

[line 748]

Get Result as a list of rows indexed by table and field

Tags:

  • return - on success, error or warning otherwise
  • access - public

Overrides VMysqlDatabase::loadAssocList() (Get database response as associative list)

Parameters:

[ Top ]

query

boolean|object True query( )

[line 606]

Run Query

Tags:

  • return - on success, error or warning otherwise
  • access - public

Overrides VMysqlDatabase::query() (Send database query)

Parameters:

[ Top ]

setFields

void setFields( array $fields)

[line 856]

Set Fields

Tags:

  • access - public

Parameters:

  • array $fields -

[ Top ]

setGroups

void setGroups( array $groupList)

[line 868]

Set Groups

Tags:

  • access - public

Parameters:

  • array $groupList - List of grouping fields

[ Top ]

setOrdering

void setOrdering( array $order)

[line 880]

Set Ordering

Tags:

  • access - public

Parameters:

  • array $order - Array of (string)column,(integer)direction arrays

[ Top ]

setPaging

void setPaging( object Table &$paging)

[line 811]

set paging object

Tags:

  • access - public

Parameters:

  • object Table &$paging - paging

[ Top ]

setTables

boolean setTables( array $tableList, [VDatabaseTableRelationships $tableRelationships = null], [string $joinType = 'left'], [boolean $debug = false])

[line 341]

Set Query Tables

Tags:

  • return - True on success, error or warning otherwise
  • access - public

Parameters:

  • array $tableList - Table list
  • VDatabaseTableRelationships $tableRelationships -
  • string $joinType - Join Type
  • boolean $debug - Debug Mode

[ Top ]

validJoin

boolean|object True validJoin( array $tableList, VDatabaseTableRelationships $tableRelationships, string $joinType, [boolean $debug = false])

[line 257]

Valid Join

Tags:

  • return - if valid, error or warning otherwise

Parameters:

  • array $tableList - Table List
  • VDatabaseTableRelationships $tableRelationships - Table Relationships
  • string $joinType - Join Type
  • boolean $debug - Debug Mode

[ Top ]

validJoinType

boolean|object True validJoinType( string $type, [boolean $debug = false])

[line 194]

Test if valid join type

Tags:

  • return - if valid, error or warning otherwise
  • access - public

Parameters:

  • string $type - Type
  • boolean $debug - Debug Mode

[ Top ]

validTableList

boolean validTableList( array $tables, [boolean $debug = false])

[line 215]

Valid table list

Tags:

  • return - True if valid, error or warning otherwise

Parameters:

  • array $tables - Tables
  • boolean $debug - Debug Mode

[ Top ]

_column2sql

void _column2sql( $col, [ $antialias = false])

[line 415]

Field to SQL

Tags:

  • access - protected

Parameters:

  • $col -
  • $antialias -

[ Top ]

_makeFields

string _makeFields( )

[line 552]

Get Fields as SQL

Tags:

  • return - SQL fields
  • access - protected

Parameters:

[ Top ]

Class Constants

Documentation generated on Mon, 17 Jan 2011 01:57:30 -0600 by phpDocumentor 1.4.3