Class QHtmlTable_CodeGenerator

This is a base class to support classes that are derived from QHtmlTable. The methods here support the use of QHtmlTable derived classes as a list connector, something that displays a list of records from a database, and optionally allows the user to do CRUD operations on individual records.

AbstractControl_CodeGenerator

QControlBase_CodeGenerator

QControl_CodeGenerator

QHtmlTable_CodeGenerator implements QDataList_CodeGenerator_Interface

Direct known subclasses

QDataGridBase_CodeGenerator

Indirect known subclasses

QDataGrid_CodeGenerator

Abstract
Located at includes/codegen/controls/QHtmlTable_CodeGenerator.class.php

Methods summary
`public string`	# `VarName( string $strPropName )` dtg stands for "DataGrid", a QCubed historical name for tables displaying data. Override if you want something else. dtg stands for "DataGrid", a QCubed historical name for tables displaying data. Override if you want something else. Parameters `$strPropName` Returns string Throws `QCallerException` Overrides `QControlBase_CodeGenerator::VarName()`
`public string`	# `DataListConnectorComments( QCodeGenBase $objCodeGen, QSqlTable $objTable )` Generate the text to insert into the "ConnectorGen" class comments. This would typically be "property" PHPDoc declarations for __get and __set properties declared in the class. Generate the text to insert into the "ConnectorGen" class comments. This would typically be "property" PHPDoc declarations for __get and __set properties declared in the class. Parameters `$objCodeGen` `$objTable` Returns string Implementation of `QDataList_CodeGenerator_Interface::DataListConnectorComments()`
`public`	# `DataListConnector( QCodeGenBase $objCodeGen, QSqlTable $objTable )` The main entry point for generating all the "ConnectorGen" code that defines the generated list connector in the generated/connector_base directory. The main entry point for generating all the "ConnectorGen" code that defines the generated list connector in the generated/connector_base directory. Parameters `$objCodeGen` `$objTable` Implementation of `QDataList_CodeGenerator_Interface::DataListConnector()`
`protected string`	# `DataListMembers( QCodeGenBase $objCodeGen, QSqlTable $objTable )` Generate the member variables for the "ConnectorGen" class. Generate the member variables for the "ConnectorGen" class. Parameters `$objCodeGen` `$objTable` Returns string
`protected string`	# `DataListColumnDeclarations( QCodeGenBase $objCodeGen, QSqlTable $objTable )` Generate member variables for the columns that will be created later. This implementation makes the columns public so that classes can easily manipulate the columns further after construction. Generate member variables for the columns that will be created later. This implementation makes the columns public so that classes can easily manipulate the columns further after construction. Parameters `$objCodeGen` `$objTable` Returns string Throws Exception
`protected`	# `DataListConstructor( QCodeGenBase $objCodeGen, QSqlTable $objTable )` Generate a constructor for a subclass of itself. Generate a constructor for a subclass of itself. Parameters `$objCodeGen` `$objTable`
`public string`	# `DataListCreatePaginator( QCodeGenBase $objCodeGen, QSqlTable $objTable )` Parameters `$objCodeGen` `$objTable` Returns string
`public string`	# `DataListCreateColumns( QCodeGenBase $objCodeGen, QSqlTable $objTable )` Creates the columns as part of the datagrid subclass. Creates the columns as part of the datagrid subclass. Parameters `$objCodeGen` `$objTable` Returns string Throws Exception
`protected string`	# `DataListDataBinder( QCodeGenBase $objCodeGen, QSqlTable $objTable )` Generates a data binder that can be called from the parent control, or called directly by this control. Generates a data binder that can be called from the parent control, or called directly by this control. Parameters `$objCodeGen` `$objTable` Returns string
`protected string`	# `DataListGetCondition( QCodeGenBase $objCodeGen, QSqlTable $objTable )` Parameters `$objCodeGen` `$objTable` Returns string
`protected string`	# `DataListGetClauses( QCodeGenBase $objCodeGen, QSqlTable $objTable )` Parameters `$objCodeGen` `$objTable` Returns string
`protected string`	# `DataListGet( QCodeGenBase $objCodeGen, QSqlTable $objTable )` Parameters `$objCodeGen` `$objTable` Returns string
`protected string`	# `DataListSet( QCodeGenBase $objCodeGen, QSqlTable $objTable )` Parameters `$objCodeGen` `$objTable` Returns string
`public boolean`	# `DataListHasFilter( )` Return true if the data list has its own build-in filter. False will mean that a filter field will be created by default. This is still controllable by the model connector. Return true if the data list has its own build-in filter. False will mean that a filter field will be created by default. This is still controllable by the model connector. Returns boolean Implementation of `QDataList_CodeGenerator_Interface::DataListHasFilter()`
`public mixed`	# `DataListInstantiate( QCodeGenBase $objCodeGen, QSqlTable $objTable )` Returns the code that creates the list object. This would be embedded in the pane or form that is using the list object. Returns the code that creates the list object. This would be embedded in the pane or form that is using the list object. Parameters `$objCodeGen` $objTable `$objTable` Returns mixed Implementation of `QDataList_CodeGenerator_Interface::DataListInstantiate()`
`public`	# `DataListRefresh( QCodeGenBase $objCodeGen, QSqlTable $objTable )` Generate the code that refreshes the control after a change in the filter. The default redraws the entire control. If your control can refresh just a part of itself, insert that code here. Generate the code that refreshes the control after a change in the filter. The default redraws the entire control. If your control can refresh just a part of itself, insert that code here. Parameters `$objCodeGen` `$objTable` Implementation of `QDataList_CodeGenerator_Interface::DataListRefresh()`
`public string`	# `DataListHelperMethods( QCodeGenBase $objCodeGen, QSqlTable $objTable )` Generate additional methods for the enclosing control to interact with this generated control. Generate additional methods for the enclosing control to interact with this generated control. Parameters `$objCodeGen` `$objTable` Returns string Implementation of `QDataList_CodeGenerator_Interface::DataListHelperMethods()`
`protected string`	# `DataListParentCreate( QCodeGenBase $objCodeGen, QSqlTable $objTable )` Generates code for the enclosing control to create this control. Generates code for the enclosing control to create this control. Parameters `$objCodeGen` `$objTable` Returns string
`protected string`	# `DataListParentCreateColumns( QCodeGenBase $objCodeGen, QSqlTable $objTable )` Generates a function to add columns to the list. Generates a function to add columns to the list. Parameters `$objCodeGen` `$objTable` Returns string
`protected string`	# `DataListParentMakeEditable( QCodeGenBase $objCodeGen, QSqlTable $objTable )` Generates a typical action to respond to row clicks. Generates a typical action to respond to row clicks. Parameters `$objCodeGen` `$objTable` Returns string
`protected string`	# `DataListGetRowParams( QCodeGenBase $objCodeGen, QSqlTable $objTable )` Generates the row param callback that will enable row clicks to know what row was clicked on. Generates the row param callback that will enable row clicks to know what row was clicked on. Parameters `$objCodeGen` `$objTable` Returns string
`public string`	# `DataListSubclassOverrides( QCodeGenBase $objCodeGen, QSqlTable $objTable )` Generates an alternate create columns function that could be used by the list panel to create the columns directly. This is designed to be added as commented out code in the list panel override class that the user can choose to use. Generates an alternate create columns function that could be used by the list panel to create the columns directly. This is designed to be added as commented out code in the list panel override class that the user can choose to use. Parameters `$objCodeGen` `$objTable` Returns string Implementation of `QDataList_CodeGenerator_Interface::DataListSubclassOverrides()`

Methods inherited from QControlBase_CodeGenerator
`ConnectorCreate(), ConnectorCreateOptions(), ConnectorGet(), ConnectorPropertyComments(), ConnectorRefresh(), ConnectorSet(), ConnectorUpdate(), ConnectorUpdateMethod(), ConnectorVariableDeclaration()`

Methods inherited from AbstractControl_CodeGenerator
`GetControlClass(), __construct()`

Properties inherited from AbstractControl_CodeGenerator
`$strControlClassName`

Packages

Classes

Interfaces

Traits

Exceptions

Functions

Class QHtmlTable_CodeGenerator

Direct known subclasses

Indirect known subclasses

Parameters

Returns

Throws

Overrides

Parameters

Returns

Implementation of

Parameters

Implementation of

Parameters

Returns

Parameters

Returns

Throws

Parameters

Parameters

Returns

Parameters

Returns

Throws

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Implementation of

Parameters

Returns

Implementation of

Parameters

Implementation of

Parameters

Returns

Implementation of

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Implementation of