Class QQNode

The abstract QQNode base class. This represents an "object" in a SQL join tree. There are a number of different subclasses of the QQNode, depending on the kind of object represented. The top of the join tree is generally a table node, and the bottom is generally a column node, but that depends on the context in which the node is being used.

The properties begin with underscores to prevent name conflicts with codegenerated subclasses.

QBaseClass

QQNode

Direct known subclasses

QQAssociationNode, QQColumnNode, QQNamedValue, QQTableNode

Indirect known subclasses

QQFunctionNode, QQMathNode, QQNoParentNode, QQReverseReferenceNode, QQSubQueryCountNode, QQSubQueryNode, QQSubQuerySqlNode, QQVirtualNode

Abstract
Located at includes/framework/QQuery.class.php

Methods summary
`abstract public`	# `Join( QQueryBuilder $objBuilder, $blnExpandSelection = false, QQCondition $objJoinCondition = null, QQSelect $objSelect = null )`
`public string`	# `GetType( )` Return the variable type. Should be a QDatabaseFieldType enum. Return the variable type. Should be a QDatabaseFieldType enum. Returns string
`public`	# `SetAlias( $strAlias )` Change the alias of the node, primarily for joining the same table more than once. Change the alias of the node, primarily for joining the same table more than once. Parameters `$strAlias` Throws Exception `QCallerException`
`public string`	# `FullAlias( )` Aid to generating full aliases. Recursively gets and sets the parent alias, eventually creating, caching and returning an alias for itself. Aid to generating full aliases. Recursively gets and sets the parent alias, eventually creating, caching and returning an alias for itself. Returns string
`public string[]`	# `Fields( )` Returns the fields in this node. Assumes its a table node. Returns the fields in this node. Assumes its a table node. Returns string[]
`public string[]`	# `PrimaryKeyFields( )` Returns the primary key fields in this node. Assumes its a table node. Returns the primary key fields in this node. Assumes its a table node. Returns string[]
`public`	# `_MergeExpansionNode( QQNode $objNewNode )` Merges a node tree into this node, building the child nodes. The node being received is assumed to be specially built node such that only one child node exists, if any, and the last node in the chain is designated as array expansion. The goal of all of this is to set up a node chain where intermediate nodes can be designated as being array expansion nodes, as well as the leaf nodes. Merges a node tree into this node, building the child nodes. The node being received is assumed to be specially built node such that only one child node exists, if any, and the last node in the chain is designated as array expansion. The goal of all of this is to set up a node chain where intermediate nodes can be designated as being array expansion nodes, as well as the leaf nodes. Parameters `$objNewNode` Throws `QCallerException`
`public`	# `PutSelectFields( QQueryBuilder $objBuilder, null\|string $strPrefix = null, null\|QQSelect $objSelect = null )` Puts the "Select" clause fields for this node into builder. Puts the "Select" clause fields for this node into builder. Parameters `$objBuilder` `$strPrefix` `$objSelect`
`public QQNode\|null`	# `FirstChild( )` Returns `QQNode`\|null
`public string`	# `GetTable( )` Returns the extended table associated with the node. Returns the extended table associated with the node. Returns string
`public static string`	# `GetValue( mixed $mixValue, QQueryBuilder $objBuilder, boolean $blnEqualityType = null )` Parameters `$mixValue` `$objBuilder` `$blnEqualityType` can be null (for no equality), true (to add a standard "equal to") or false (to add a standard "not equal to") Returns string Throws Exception `QCallerException`
`public mixed`	# `__get( string $strName )` Override method to perform a property "Get" This will get the value of $strName All inhereted objects that call __get() should always fall through to calling parent::__get() in a try/catch statement catching for CallerExceptions. Override method to perform a property "Get" This will get the value of $strName All inhereted objects that call __get() should always fall through to calling parent::__get() in a try/catch statement catching for CallerExceptions. Parameters `$strName` Name of the property to get Returns mixed the returned property Throws `QUndefinedPropertyException` Overrides `QBaseClass::__get()`
`public mixed`	# `__set( string $strName, string $mixValue )` Override method to perform a property "Set" This will set the property $strName to be $mixValue All inhereted objects that call __set() should always fall through to calling parent::__set() in a try/catch statement catching for CallerExceptions. Override method to perform a property "Set" This will set the property $strName to be $mixValue All inhereted objects that call __set() should always fall through to calling parent::__set() in a try/catch statement catching for CallerExceptions. Parameters `$strName` Name of the property to set `$mixValue` New value of the property Returns mixed the property that was set Throws `QUndefinedPropertyException` Overrides `QBaseClass::__set()`
`public string`	# `GetDataGridHtml( )` Returns string Throws Exception
`public`	# `GetDataGridOrderByNode( )`
`public`	# `SetFilteredDataGridColumnFilter( QDataGridLegacyColumn $col )`

Methods inherited from QBaseClass
`OverrideAttributes(), __call()`

Properties summary
`protected null\|QQNode\|boolean`	`$objParentNode`	#
`protected string`	`$strType` Type node. SQL type or table type Type node. SQL type or table type	#
`protected string`	`$strName` SQL Name of related object in the database SQL Name of related object in the database	#
`protected string`	`$strAlias` Alias, if one was assigned using QQ::Alias(). Otherwise, same as name. Alias, if one was assigned using QQ::Alias(). Otherwise, same as name.	#
`protected string`	`$strFullAlias` resolved alias that includes parent join tables. resolved alias that includes parent join tables.	#
`protected string`	`$strPropertyName` PHP property name of the related PHP object PHP property name of the related PHP object	#
`protected string`	`$strRootTableName` copy of the root table name at the top of the node tree. copy of the root table name at the top of the node tree.	#
`protected string`	`$strTableName` name of SQL table associated with this node. Generally set by subclasses. name of SQL table associated with this node. Generally set by subclasses.	#
`protected string`	`$strPrimaryKey` SQL primary key, for nodes that have primary keys SQL primary key, for nodes that have primary keys	#
`protected string`	`$strClassName` PHP class name PHP class name	#
`protected boolean`	`$blnExpandAsArray` True if this is an expand as array node point True if this is an expand as array node point	#
`protected QQNode[]`	`$objChildNodeArray` the array of child nodes if this is an expand as array point the array of child nodes if this is an expand as array point	#
`protected boolean`	`$blnIsType` True if this is a Type node True if this is a Type node	#

Magic properties summary
`public boolean`	`$ExpandAsArray` True if this node should be array expanded.
`public read-only QQNode`	`$_ParentNode` // Parent object in tree.
`public read-only string`	`$_Name` // Default SQL name in query, or default alias
`public read-only string`	`$_Alias` // Actual alias. Usually the name, unless changed by QQ::Alias() call
`public read-only string`	`$_PropertyName` // The name as used in PHP
`public read-only string`	`$_Type` // The type of object. A SQL type if referring to a column.
`public read-only string`	`$_RootTableName` // The name of the table at the top of the tree. Rednundant, since it could be found be following the chain.
`public read-only string`	`$_TableName` // The name of the table associated with this node, if its not a column node.
`public read-only string`	`$_PrimaryKey`
`public read-only string`	`$_ClassName`
`public read-only QQNode`	`$_PrimaryKeyNode`
`public read-only boolean`	`$IsType` Is a type table node. For association type arrays.

Packages

Classes

Interfaces

Traits

Exceptions

Functions

Class QQNode

Direct known subclasses

Indirect known subclasses

Returns

Parameters

Throws

Returns

Returns

Returns

Parameters

Throws

Parameters

Returns

Returns

Parameters

Returns

Throws

Parameters

Returns

Throws

Overrides

Parameters

Returns

Throws

Overrides

Returns

Throws