Overview

Packages

  • Actions
  • Codegen
  • Controls
    • Base
  • DatabaseAdapters
  • Events
  • None
  • Sessions
  • Tests

Classes

  • JqControlGen
  • QCodeGen
  • QCodeGenBase
  • QConvertNotation
  • QConvertNotationBase
  • QDatabaseCodeGen
  • QIndex
  • QManyToManyReference
  • QReference
  • QRestServiceCodeGen
  • QReverseReference
  • QSqlColumn
  • QSqlTable
  • QTypeTable
  • Overview
  • Package
  • Class

Class QSqlTable

A helper class used by the QCubed Code Generator to describe a database Table

QBaseClass
Extended by QSqlTable
Package: Codegen
Located at includes/codegen/QSqlTable.class.php
Methods summary
public
# __construct( string $strName )

Default Constructor. Simply sets up the TableName and ensures that ReverseReferenceArray is a blank array.

Default Constructor. Simply sets up the TableName and ensures that ReverseReferenceArray is a blank array.

Parameters

$strName
Name of the Table
public QSqlColumn
# GetColumnByName( string $strColumnName )

return the QSqlColumn object related to that column name

return the QSqlColumn object related to that column name

Parameters

$strColumnName
Name of the column

Returns

QSqlColumn
public boolean
# HasColumn( string $strColumnName )

Search within the table's columns for the given column

Search within the table's columns for the given column

Parameters

$strColumnName
Name of the column

Returns

boolean
public string
# LookupColumnPropertyName( string $strColumnName )

Return the property name for a given column name (false if it doesn't exists)

Return the property name for a given column name (false if it doesn't exists)

Parameters

$strColumnName
name of the column

Returns

string
public
# HasImmediateArrayExpansions( )
public
# HasExtendedArrayExpansions( QDatabaseCodeGen $objCodeGen, $objCheckedTableArray = array() )
public mixed
# __get( string $strName )

Override method to perform a property "Get" This will get the value of $strName

Override method to perform a property "Get" This will get the value of $strName

Parameters

$strName
Name of the property to get

Returns

mixed

Throws

Exception
QCallerException

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

Override method to perform a property "Set" This will set the property $strName to be $mixValue

Parameters

$strName
Name of the property to set
$mixValue
New value of the property

Returns

mixed

Throws

Exception
QCallerException

Overrides

QBaseClass::__set()
Methods inherited from QBaseClass
OverrideAttributes(), __call()
Properties summary
protected integer $intOwnerDbIndex

DB Index to which it belongs in the configuration.inc.php and codegen_settings.xml files.

DB Index to which it belongs in the configuration.inc.php and codegen_settings.xml files.

#
protected string $strName

Name of the table (as defined in the database)

Name of the table (as defined in the database)

#
protected string $strClassName

Name as a PHP Class

Name as a PHP Class

#
protected string $strClassNamePlural

Pluralized Name as a collection of objects of this PHP Class

Pluralized Name as a collection of objects of this PHP Class

#
protected QSqlColumn[] $objColumnArray

Array of Column objects (as indexed by Column name)

Array of Column objects (as indexed by Column name)

#
protected QReverseReference[] $objReverseReferenceArray

Array of ReverseReverence objects (indexed numerically)

Array of ReverseReverence objects (indexed numerically)

#
protected QManyToManyReference[] $objManyToManyReferenceArray

Array of ManyToManyReference objects (indexed numerically)

Array of ManyToManyReference objects (indexed numerically)

#
protected QIndex[] $objIndexArray

Array of Index objects (indexed numerically)

Array of Index objects (indexed numerically)

#
protected array $options

developer specified options.

developer specified options.

#
Magic properties summary
public integer $OwnerDbIndex
public string $Name
public string $ClassNamePlural
public string $ClassName
public read-only integer $ReferenceCount
API documentation generated by ApiGen