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 QManyToManyReference

Used by the QCubed Code Generator to describe a column reference from the table's perspective (aka a Foreign Key from the referenced Table's point of view)

QBaseClass
Extended by QManyToManyReference
Package: Codegen
Located at includes/codegen/QManyToManyReference.class.php
Methods summary
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 string $strKeyName

Name of the foreign key object itself, as defined in the database or create script

Name of the foreign key object itself, as defined in the database or create script

#
protected string $strTable

Name of the association table, itself (the many-to-many table that maps the relationshipfor this ManyToManyReference)

Name of the association table, itself (the many-to-many table that maps the relationshipfor this ManyToManyReference)

#
protected string $strColumn

Name of the referencing column (the column that owns the foreign key to this table)

Name of the referencing column (the column that owns the foreign key to this table)

#
protected string $strPropertyName

Name of property corresponding to this column as used in the node.

Name of property corresponding to this column as used in the node.

#
protected string $strOppositeColumn

Name of the opposite column (the column that owns the foreign key to the related table)

Name of the opposite column (the column that owns the foreign key to the related table)

#
protected string $strOppositeVariableType

Type of the opposite column (the column that owns the foreign key to the related table) as a Variable type (for example, to be used to define the input parameter type to a Load function)

Type of the opposite column (the column that owns the foreign key to the related table) as a Variable type (for example, to be used to define the input parameter type to a Load function)

#
protected string $strOppositeDbType

Database type of the opposite column (the column that owns the foreign key to the related table) as a DbType (for example, to be used to define the input parameter type to a Node)

Database type of the opposite column (the column that owns the foreign key to the related table) as a DbType (for example, to be used to define the input parameter type to a Node)

#
protected string $strOppositeVariableName

Name of the opposite column (the column that owns the foreign key to the related table) as a Variable name (for example, to be used as an input parameter to a Load function)

Name of the opposite column (the column that owns the foreign key to the related table) as a Variable name (for example, to be used as an input parameter to a Load function)

#
protected string $strOppositePropertyName

Name of the opposite column (the column that owns the foreign key to the related table) as a Property name (for example, to be used as a QQAssociationNode parameter name for the column itself)

Name of the opposite column (the column that owns the foreign key to the related table) as a Property name (for example, to be used as a QQAssociationNode parameter name for the column itself)

#
protected string $strOppositeObjectDescription

Name of the opposite column (the column that owns the foreign key to the related table) as an Object Description (see "ObjectDescription" below)

Name of the opposite column (the column that owns the foreign key to the related table) as an Object Description (see "ObjectDescription" below)

#
protected string $strAssociatedTable

The name of the associated table (the table that the OTHER column in the association table points to)

The name of the associated table (the table that the OTHER column in the association table points to)

#
protected string $strVariableName

Name of the reverse-referenced object as an function parameter. So if this is a reverse reference to "person" via "report.person_id", the VariableName would be "objReport"

Name of the reverse-referenced object as an function parameter. So if this is a reverse reference to "person" via "report.person_id", the VariableName would be "objReport"

#
protected string $strVariableType

Type of the reverse-referenced object as a class. So if this is a reverse reference to "person" via "report.person_id", the VariableName would be "Report"

Type of the reverse-referenced object as a class. So if this is a reverse reference to "person" via "report.person_id", the VariableName would be "Report"

#
protected string $strObjectDescription

Singular object description used in the function names for the reverse reference. See documentation for more details.

Singular object description used in the function names for the reverse reference. See documentation for more details.

#
protected string $strObjectDescriptionPlural

Plural object description used in the function names for the reverse reference. See documentation for more details.

Plural object description used in the function names for the reverse reference. See documentation for more details.

#
protected QSqlColumn[] $objColumnArray

Array of non-FK Column objects (as indexed by Column name)

Array of non-FK Column objects (as indexed by Column name)

#
protected boolean $blnIsTypeAssociation

Array of non-FK Column objects (as indexed by Column name)

Array of non-FK Column objects (as indexed by Column name)

#
protected array $options

Keyed array of overrides read from the override file

Keyed array of overrides read from the override file

#
Magic properties summary
public string $KeyName
public string $Table
public string $Column
public string $PropertyName
public string $OppositeColumn
public string $OppositeVariableType
public string $OppositeDbType
public string $OppositeVariableName
public string $OppositePropertyName
public string $OppositeObjectDescription
public string $AssociatedTable
public string $VariableName
public string $VariableType
public string $ObjectDescription
public string $ObjectDescriptionPlural
public boolean $IsTypeAssociation
public array $Options
API documentation generated by ApiGen