Class: VDBIQueryType_Filter

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

Class Overview [line 29]

VType
   |
   --VObject
      |
      --VDBIQueryType_Filter

VWP - DBI Query Filter 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 Filter Type

This class provides the query filter type

Tags:

[ Top ]

Class Variables

$baseCondition =  null

[line 37]

Base Condition

Tags:

  • var - Base condition
  • access - protected

Type: boolean

Overrides:

[ Top ]

$rules = array()

[line 45]

Rules

Tags:

  • var - Rules
  • access - protected

Type: array

Overrides:

[ Top ]

Class Methods

addCondition

boolean|object True addCondition( string $ruleId, string $leftValue, string $op, string $rightValue)

[line 57]

Add Condition

Tags:

  • return - on success, error or warning otherwise

Parameters:

  • string $ruleId -
  • string $leftValue -
  • string $op -
  • string $rightValue -

[ Top ]

addRule

boolean|object True addRule( string $ruleId, [boolean $base = false], [string $logic = null])

[line 102]

Add Rule

Tags:

  • return - on success, error or warning otherwise

Parameters:

  • string $ruleId - Rule Id
  • boolean $base - Is Base Rule
  • string $logic - Logic Function

[ Top ]

getLogicOperator

string|object Operator getLogicOperator( string $ruleId)

[line 157]

Get Logic Operator

Tags:

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

Parameters:

  • string $ruleId - Rule Id

[ Top ]

isBaseRule

boolean isBaseRule( string $ruleId)

[line 173]

Is Base Rule

Tags:

  • return - True if provided rule is the base rule

Parameters:

  • string $ruleId - Rule Id

[ Top ]

listConditions

array listConditions( string $ruleId)

[line 85]

List Conditions

Tags:

  • return - Conditions
  • access - public

Parameters:

  • string $ruleId - Rule Id

[ Top ]

listRules

array listRules( )

[line 185]

List Rules

Tags:

  • return - Rule Id List
  • access - public

Parameters:

[ Top ]

removeRule

boolean removeRule( string $ruleId)

[line 136]

Remove Rule

Tags:

  • return - True on success, error or warning otherwise

Parameters:

  • string $ruleId -

[ Top ]

Class Constants

Documentation generated on Sun, 06 Mar 2011 02:21:58 -0600 by phpDocumentor 1.4.3