Class: VDBIQueryType_SummaryOptions

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

Class Overview [line 29]

VType
   |
   --VObject
      |
      --VDBIQueryType_SummaryOptions

VWP - DBI Query Summary Options Type

Author(s):

Version:

Copyright:

  • (c) Ralph Ritoch - All Rights Reserved

Variables

Constants

Methods

Inherited Variables

Class: VObject

VObject::$_nosave_errors
VObject::$_nosave_original_state

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 Summary Options Type

This class provides the Summary Options Type

Tags:

[ Top ]

Class Variables

$query

[line 38]

Query

Tags:

  • access - protected

Type: VDBI_Query

Overrides:

[ Top ]

$_data

[line 47]

Data

Tags:

  • access - protected

Type: array

Overrides:

[ Top ]

$_helper

[line 56]

Helper

Tags:

  • var - Query Helper
  • access - protected

Type: VDBI_QueryHelper

Overrides:

[ Top ]

Class Methods

__construct

VDBIQueryType_SummaryOptions __construct( VDBI_Query $query)

[line 551]

Class Constructor

Tags:

  • access - public

Overrides VObject::__construct() (Class Constructor)

Parameters:

[ Top ]

createRatio

VDBIQueryType_Ratio createRatio( [string $segement = null], [string $segment_type = null], [string $operator = null], [string $domain = null], [string $domain_type = null])

[line 461]

Create Ratio

Tags:

  • return - Ratio
  • access - public

Parameters:

  • string $segement - Segment
  • string $segment_type - Segment type
  • string $operator - Operator
  • string $domain - Domain
  • string $domain_type - Domain type

[ Top ]

getRatio

void &getRatio( string $alias)

[line 433]

Get Ratio

Tags:

  • access - public

Parameters:

  • string $alias - Ratio Id

[ Top ]

getRatiosTableId

string getRatiosTableId( )

[line 539]

Get Ratio Table Id

Tags:

  • return - Ratio Table Id
  • access - public

Parameters:

[ Top ]

getSummaryFieldEnabled

boolean|object True getSummaryFieldEnabled( string $alias)

[line 285]

Get Summary Field Enabled Flag

Tags:

  • return - if Summary Field Enabled, false if not enabled, error or warning on failure
  • access - public

Parameters:

  • string $alias - Summary Id

[ Top ]

getSummaryInfo

void getSummaryInfo( string $alias)

[line 267]

Get Summary Info

Tags:

  • access - public

Parameters:

  • string $alias - Summary Id

[ Top ]

listRatios

array|object Ratio listRatios( )

[line 388]

Get Ratio List

Tags:

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

Parameters:

[ Top ]

listSummaryFields

array|object Summary listSummaryFields( )

[line 228]

List Summary Fields

Tags:

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

Parameters:

[ Top ]

listSummaryTypes

array listSummaryTypes( )

[line 186]

List Summary Types

Tags:

  • return - Summary Types
  • access - public

Parameters:

[ Top ]

setRatio

boolean|object True setRatio( string $alias, &$ratio, VDBIQueryType_Ratio $ratio)

[line 476]

Set Ratio

Note: To remove a ratio set a ratio with it's operator set to a value of null.

Tags:

  • return - on success, error or warning otherwise

Parameters:

[ Top ]

setSummaryFieldEnabled

boolean|object True setSummaryFieldEnabled( $alias, string $field, $sumtype, [boolean $value = true], string $type)

[line 311]

Set Summary Field Enabled Flag

Tags:

  • return - on success, error or warning otherwise
  • todo - Delete node if all fields disabled

Parameters:

  • string $field - Field
  • string $type - Summary Type
  • boolean $value - True to enable, false to disable
  • $alias -
  • $sumtype -

[ Top ]

_getRatioListNode

DOMElement _getRatioListNode( )

[line 94]

Get DOM Report Ratio List Node

Tags:

  • return - Ratio List Node on success, null if not found, error or warning otherwise
  • access - protected

Parameters:

[ Top ]

_getSummaryListNode

DOMElement _getSummaryListNode( )

[line 65]

Get DOM Report Summary List Node

Tags:

  • return - Summary List Node on success, null if not found, error or warning otherwise
  • access - protected

Parameters:

[ Top ]

_makeRatioListNode

DOMElement _makeRatioListNode( )

[line 159]

Make DOM Report Ratio List Node

Tags:

  • return - Ratio List Node on success, null if not found, error or warning otherwise
  • access - protected

Parameters:

[ Top ]

_makeSummaryListNode

DOMElement _makeSummaryListNode( )

[line 123]

Make DOM Report Summary List Node

Tags:

  • return - Summary List Node on success, null if not found, error or warning otherwise
  • access - protected

Parameters:

[ Top ]

Class Constants

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