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 QReference

Used by the QCubed Code Generator to describe a column reference (aka a Foreign Key)

QBaseClass
Extended by QReference
Package: Codegen
Located at includes/codegen/QReference.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, as defined in the database or create script

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

#
protected string $strTable

Name of the table that is being referenced

Name of the table that is being referenced

#
protected string $strColumn

Name of the column that is being referenced

Name of the column that is being referenced

#
protected string $strPropertyName

Name of the referenced object as an class Property So if the column that this reference points from is named "primary_annual_report_id", it would be PrimaryAnnualReport

Name of the referenced object as an class Property So if the column that this reference points from is named "primary_annual_report_id", it would be PrimaryAnnualReport

#
protected string $strVariableName

Name of the referenced object as an class protected Member object So if the column that this reference poitns from is named "primary_annual_report_id", it would be objPrimaryAnnualReport

Name of the referenced object as an class protected Member object So if the column that this reference poitns from is named "primary_annual_report_id", it would be objPrimaryAnnualReport

#
protected string $strVariableType

The type of the protected member object (should be based off of $this->strTable) So if referencing the table "annual_report", it would be AnnualReport

The type of the protected member object (should be based off of $this->strTable) So if referencing the table "annual_report", it would be AnnualReport

#
protected string $blnIsType

If the table that this reference points to is a type table, then this is true

If the table that this reference points to is a type table, then this is true

#
protected QReverseReference $objReverseReference

The reverse reference pointing back to this reference.

The reverse reference pointing back to this reference.

#
Magic properties summary
public string $KeyName
public string $Table
public string $Column
public string $PropertyName
public string $VariableName
public string $VariableType
public boolean $IsType
API documentation generated by ApiGen