phpPeanuts  2.2.0
phpPeanuts framework
 All Data Structures Namespaces Files Functions Variables
Public Member Functions | Data Fields
PntSqlJoinFilter Class Reference

Inherits PntSqlFilter.

Public Member Functions

 initPropertyDescriptors ()
 
 __clone ()
 
 evaluate ($item)
 
 getPath ()
 
 getLabel ()
 
 getIdColumnIsOnAlias ()
 
 setIdColumnIsOnAlias ($aBoolean)
 
 getValueType ()
 
 getValueProp ()
 
 getNext ()
 
 appliesTo ($type, $persistent=false)
 
 setNext ($value)
 
 setComparatorId ($value)
 
 setValue1 ($value)
 
 setValue2 ($value)
 
 ignoreGlobalFilter ($wheater)
 
 getColumnName ()
 
 getIdPropertyDescriptor ()
 
 getItemTableName ()
 
 getSql ()
 
 getExtraConditionSql ()
 
 addParamsTo ($qh)
 
 addExtraConditionParamsTo ($qh)
 
 generateSqlForJoins (&$aliasCount, &$paramCount, $backTrack=array())
 
 initJoinData (&$aliasCount, &$paramCount, &$backTrack)
 
 initMoreJoinData (&$aliasCount, $currentIdColumn, $nextIdColumnName, $backTrack)
 
initTableJoinData (&$aliasCount, $currentIdColumn, $nextTableName, $nextIdColumnName, $backTrack)
 
 getJoin ($names, $left=true)
 
 getSortSelectExpr ($sortByColumnName)
 
 addSortSelectParamsTo ($qh)
 
 isPreferredFilter ()
 
 getSortSubSelect ($names, $nextSql, $sortByColumnName, $joins, $extraWhere)
 
 initDefaultNext ()
 
 getLast ()
 
 isJoinFilter ()
 
 getPersistArray ()
 
 initFromPersistArray ($array)
 
 getDescription ($conv)
 
 getValue1Peanut ()
 
 generateSql (&$aliasCount, &$paramCount, $backTrack=array())
 
 getSubQueryTemplate ()
 
 mergeTemplate ($sql, $names, $nextSql)
 
- Public Member Functions inherited from PntSqlFilter
 initPropertyDescriptors ()
 
 getId ()
 
 getPath ()
 
 getItemType ()
 
 getPropLabel ()
 
 appliesTo ($type, $persistent=false)
 
 getTableAlias ()
 
 getItemTableName ()
 
 getValueProp ()
 
 getValueType ()
 
 setComparatorId ($value)
 
 setValue1 ($value)
 
 setValue2 ($value)
 
 by ($comparatorId, $value1=null, $value2=null)
 
 andWhere ($path, $comparatorId=null, $value1=null, $value2=null)
 
 orWhere ($path, $comparatorId=null, $value1=null, $value2=null)
 
 sortBy ($path, $direction='ASC')
 
 getFieldMapPrefixed ()
 
 getSqlTemplate ()
 
 addParamsTo ($qh)
 
 getColumnName ()
 
 generateSql (&$aliasCount, &$paramCount, $backTrack=array())
 
 getSql ()
 
 getSqlForGroupBy ()
 
 getGroupBySql ()
 
 getGroupByField ()
 
 getSql_WhereToLimit ($groupBy=true)
 
 getExtraSelectExpressions ()
 
 getDescription ($conv)
 
 initConverter ($conv)
 
 getPersistArray ()
 
 initFromPersistArray ($array)
 
 getNavigation ()
 
 getLast ()
 
 canBeSortSpec ()
 
 ignoreGlobalFilter ($wheater)
 
 evaluate ($item)
 
 evaluateValue ($value)
 
 assocSelectFrom (&$array)
 
 selectFrom (&$array)
 
 compare ($a, $b)
 
 __clone ()
 
- Public Member Functions inherited from PntSqlSpec
 __construct ($id=null)
 
 getId ()
 
 getLabel ()
 
 getQueryHandler ()
 
 getDescription ($conv)
 
 setDescription ($value)
 
 getSqlForJoin ()
 
 generateSqlForJoins (&$aliasCount, &$paramCount, $backTrack=array())
 
 isJoinFilter ()
 
 where ($path, $comparatorId=null, $value1=null, $value2=null)
 
 sortBy ($path, $direction='ASC')
 
 retrieve ()
 
 retrieveFirst ()
 
 retrieveOne ()
 
- Public Member Functions inherited from PntObject
 __construct ()
 
 copy ()
 
 getClass ()
 
 getClassDescriptor ()
 
 initPropertyDescriptors ()
 
 getOid ()
 
 addFieldProp ($name, $type, $readOnly=false, $minValue=null, $maxValue=null, $minLength=0, $maxLength=null, $classDir=null, $persistent=true)
 
 addDerivedProp ($name, $type, $readOnly=true, $minValue=null, $maxValue=null, $minLength=0, $maxLength=null, $classDir=null)
 
 addMultiValueProp ($name, $type, $readOnly=true, $minValue=null, $maxValue=null, $minLength=0, $maxLength=null, $classDir=null)
 
 getPropertyDescriptor ($propertyName)
 
 get ($propertyName, $filter=true)
 
 set ($propertyName, $value)
 
 getOptions ($name, $filter=true)
 
 getValueValidator ($prop)
 
 validateGetErrorString ($prop, $value, $validateReadOnly=true)
 
 basicGetLabel ()
 
 getLabel ()
 
 __toString ()
 
 release ()
 
 getEditInfo ()
 
 toString ()
 
 _getValueValidator ($prop)
 

Data Fields

 $next = null
 
- Data Fields inherited from PntSqlFilter
 $comparatorId = 0
 
 $valueType
 
 $tableAlias
 
 $itemTableName
 
 $key
 
 $value1
 
 $value2
 
 $columnName
 
 $sqlTemplate
 
 $navigation
 
 $visible = true
 
- Data Fields inherited from PntSqlSpec
 $label
 
 $propLabel
 
 $itemType
 

Additional Inherited Members

- Static Public Member Functions inherited from PntSqlFilter
static getInstance ($itemType, $path, $comparatorId=null, $value1=null, $value2=null)
 
static getInstanceForNav ($nav)
 
static instanceFromPersistArray ($array)
 

Member Function Documentation

__clone ( )

clones the next filter

addExtraConditionParamsTo (   $qh)

Add the extra condition parameter values from this to $qh

Parameters
PntDao$qh
addParamsTo (   $qh)

Add the parameter values from this to $qh

Parameters
PntDao$qh
addSortSelectParamsTo (   $qh)

Add the parameter values for the SortSelectExpression to $qh

Parameters
PntDao$qh
appliesTo (   $type,
  $persistent = false 
)

Both this and next must apply

Returns
boolean wheather the filter applies to the itemType
Parameters
string$typetype name
booleanwheather using ::getSql
evaluate (   $item)
generateSql ( $aliasCount,
$paramCount,
  $backTrack = array() 
)
generateSqlForJoins ( $aliasCount,
$paramCount,
  $backTrack = array() 
)
getColumnName ( )
getDescription (   $conv)
getExtraConditionSql ( )
getIdColumnIsOnAlias ( )

true if column 'id' is on the aliased table (relation is n to 1) false if column 'id' is on the own table (relation is 1 to n) The value of this property is calculated by getIdPropertyDescriptor

getIdPropertyDescriptor ( )
getItemTableName ( )

The name of the table, used for creating join condition by previous JoinFilter.

getJoin (   $names,
  $left = true 
)
getLabel ( )
getLast ( )
getNext ( )
getPath ( )
getPersistArray ( )
getSortSelectExpr (   $sortByColumnName)
getSortSubSelect (   $names,
  $nextSql,
  $sortByColumnName,
  $joins,
  $extraWhere 
)
getSql ( )
getSubQueryTemplate ( )
getValue1Peanut ( )

$this is last

getValueProp ( )
getValueType ( )
ignoreGlobalFilter (   $wheater)

Normal filters do not apply global filters, but ValidVersionFilters do, unless this method is called with true as the argument

initDefaultNext ( )
initFromPersistArray (   $array)
initJoinData ( $aliasCount,
$paramCount,
$backTrack 
)
initMoreJoinData ( $aliasCount,
  $currentIdColumn,
  $nextIdColumnName,
  $backTrack 
)
initPropertyDescriptors ( )
& initTableJoinData ( $aliasCount,
  $currentIdColumn,
  $nextTableName,
  $nextIdColumnName,
  $backTrack 
)
isJoinFilter ( )
isPreferredFilter ( )
mergeTemplate (   $sql,
  $names,
  $nextSql 
)
setComparatorId (   $value)
setIdColumnIsOnAlias (   $aBoolean)

if columnName has been explicitly set, this property must be set too (default is true).

setNext (   $value)
setValue1 (   $value)
setValue2 (   $value)

Field Documentation

$next = null

The documentation for this class was generated from the following file: