Class QReverseReference

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

QReverseReference

Package: Codegen
Located at includes/codegen/QReverseReference.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 QReference`	`$objReference` The peer QReference object for which this object is the reverse reference of The peer QReference object for which this object is the reverse reference of	#
`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 referencing table (the table that owns the column that is the foreign key) Name of the referencing table (the table that owns the column that is the foreign key)	#
`protected string`	`$strColumn` Name of the referencing column (the column that owns the foreign key) Name of the referencing column (the column that owns the foreign key)	#
`protected boolean`	`$blnNotNull` Specifies whether the referencing column is specified as "NOT NULL" Specifies whether the referencing column is specified as "NOT NULL"	#
`protected boolean`	`$blnUnique` Specifies whether the referencing column is unique Specifies whether the referencing column is unique	#
`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`	`$strPropertyName` Property Name of the referencing column (the column that owns the foreign key) in the associated Class. So if this is a reverse reference to the "person" table via the table/column "report.owner_person_id", the PropertyName would be "OwnerPersonId" Property Name of the referencing column (the column that owns the foreign key) in the associated Class. So if this is a reverse reference to the "person" table via the table/column "report.owner_person_id", the PropertyName would be "OwnerPersonId"	#
`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 string`	`$strObjectMemberVariable` A member variable name to be used by classes that contain the local member variable for this unique reverse reference. Only aggregated when blnUnique is true. A member variable name to be used by classes that contain the local member variable for this unique reverse reference. Only aggregated when blnUnique is true.	#
`protected string`	`$strObjectPropertyName` A property name to be used by classes that contain the property for this unique reverse reference. Only aggregated when blnUnique is true. A property name to be used by classes that contain the property for this unique reverse reference. Only aggregated when blnUnique is true.	#
`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 QReference`	`$Reference`
`public string`	`$KeyName`
`public string`	`$Table`
`public string`	`$Column`
`public boolean`	`$NotNull`
`public boolean`	`$Unique`
`public string`	`$VariableName`
`public string`	`$VariableType`
`public string`	`$PropertyName`
`public string`	`$ObjectDescription`
`public string`	`$ObjectDescriptionPlural`
`public string`	`$ObjectMemberVariable`
`public string`	`$ObjectPropertyName`
`public array`	`$Options`

Packages

Classes

Class QReverseReference

Parameters

Returns

Throws

Overrides

Parameters

Returns

Throws

Overrides