Class: VDBI_Query

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

Class Overview [line 47]

VType
   |
   --VObject
      |
      --VDBI_Query

VWP - DBI Query

Author(s):

Version:

Copyright:

  • (c) Ralph Ritoch - All Rights Reserved

Variables

Constants

Methods


Inherited Variables

Inherited Constants

Inherited Methods

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::__get()
VObject::__isset()
VObject::__set()
VObject::__toString()
Return object as a string
VObject::__unset()


Class Details

VWP - DBI Query

This file provides a database independent query interface

Tags:

[ Top ]


Class Variables

$datasources =  null

[line 80]

Datasources (tns:dataSourcesType)

Tags:

  • var - Datasources
  • access - protected

Type: VDBIQueryType_Datasources

Overrides:

[ Top ]

$groupings

[line 120]

Report Groupings (tns:fieldListType)

Tags:

  • var - Report Grouping Fields
  • access - protected

Type: array

Overrides:

[ Top ]

$id =  null

[line 56]

Query Id

Tags:

  • var - Query ID
  • access - public

Type: string

Overrides:

[ Top ]

$input_filters

[line 104]

Input Filters (tns:filterListType)

Tags:

  • var - Input filters
  • access - protected

Type: VDBIQueryType_FilterList

Overrides:

[ Top ]

$labels

[line 136]

Labels (tns:labelListType)

Tags:

  • var - Labels
  • access - protected

Type: array

Overrides:

[ Top ]

$output_filters

[line 128]

Output Filters (tns:filterListType)

Tags:

  • var - Output filters
  • access - protected

Type: VDBIQueryType_FilterList

Overrides:

[ Top ]

$summary_options

[line 112]

Summary Options (tns:summaryOptionsType)

Tags:

  • var - Summary options
  • access - protected

Type: VDBIQueryType_SummaryOptions

Overrides:

[ Top ]

$tables

[line 88]

Database Tables (tns:tablesType)

Tags:

  • var - Tables
  • access - protected

Type: VDBIQueryType_Tables

Overrides:

[ Top ]

$table_relationships

[line 96]

Database Table Relationships (tns:relationshipGroupListType)

Tags:

  • var - Database Table Relationships
  • access - protected

Type: VDBIQueryType_RelationshipGroupList

Overrides:

[ Top ]

$title =  null

[line 72]

Query Title (xsd:string)

Tags:

  • var - Query Title
  • access - protected

Type: string

Overrides:

[ Top ]

$type =  null

[line 64]

Query Type (tns:queryType)

Tags:

  • var - Query Type
  • access - protected

Type: string

Overrides:

[ Top ]

$values

[line 144]

Values (tns:valueListType)

Tags:

  • access - protected

Type: array

Overrides:

[ Top ]

$_helper

[line 153]

Helper

Tags:

  • access - protected

Type: VDBI_QueryHelper

Overrides:

[ Top ]


Class Methods

__construct

VDBI_Query __construct( )

[line 632]

Class Constructor

Tags:

  • access - public

Overrides VObject::__construct() (Class Constructor)

Parameters:

[ Top ]

get

mixed &get( string $property, [mixed $default = null])

[line 294]

Get Property

Tags:

  • return - Value
  • access - public

Overrides VObject::get() (Get value)

Parameters:

  • string $property - Property
  • mixed $default - Default value

[ Top ]

getDOMDocument

object DOM &getDOMDocument( )

[line 609]

Get DOM Document

Tags:

  • return - Document
  • access - public

Parameters:

[ Top ]

getHelper

VDBI_QueryHelper &getHelper( )

[line 621]

Get Helper

Tags:

  • return - Query Helper
  • access - public

Parameters:

[ Top ]

getTitle

string|object Query getTitle( )

[line 174]

Get Query Title

Tags:

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

Parameters:

[ Top ]

getType

string|object Report getType( )

[line 225]

Get Query Type

Tags:

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

Parameters:

[ Top ]

getVar

void getVar( string $name, mixed $default, [string $class = null])

[line 280]

Get Var

Tags:

  • access - public

Parameters:

  • string $name - Variable Name
  • mixed $default - Default Value
  • string $class - Namespace

[ Top ]

runQuery

array|object Results runQuery( )

[line 316]

Run Query

Tags:

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

Parameters:

[ Top ]

setDOMDocument

void setDOMDocument( &$doc, object $doc)

[line 586]

Set DOM Document

Note: Document must be W3C Dom Compliant

Tags:

  • access - public

Parameters:

  • object $doc - DOM Document
  • &$doc -

[ Top ]

setTitle

boolean|object True setTitle( string $title)

[line 206]

Set Query Title

Tags:

  • return - on success, error or warning otherwise

Parameters:

  • string $title - Query Title

[ Top ]

setType

boolean|object True setType( string $type)

[line 246]

Set Query Type

Tags:

  • return - on success, error or warning otherwise

Parameters:

  • string $type - Query type

[ Top ]

setVar

void setVar( string $name, mixed $value, [string $class = null])

[line 266]

Set Var

Tags:

  • access - public

Parameters:

  • string $name - Variable Name
  • mixed $value - Value
  • string $class - Namespace

[ Top ]


Class Constants

NSLOC_QUERY_1_0 =  "http://standards.vnetpublishing.com/schemas/vwp/2011/02/DBI/Query/"

[line 165]

QUERY v1.0 Namespace Location

[ Top ]

NS_QUERY_1_0 =  "http://standards.vnetpublishing.com/schemas/vwp/2011/02/DBI/Query"

[line 159]

QUERY v1.0 Namespace

[ Top ]


Documentation generated on Sun, 06 Mar 2011 02:22:14 -0600 by phpDocumentor 1.4.3