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 QIndex

Used by the QCubed Code Generator to describe a table Index

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

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

#
protected boolean $blnUnique

Specifies whether or not the index is unique

Specifies whether or not the index is unique

#
protected boolean $blnPrimaryKey

Specifies whether or not the column is the Primary Key index

Specifies whether or not the column is the Primary Key index

#
protected string[] $strColumnNameArray

Array of strings containing the names of the columns that this index indexes (indexed numerically)

Array of strings containing the names of the columns that this index indexes (indexed numerically)

#
Magic properties summary
public string $KeyName
public boolean $Unique
public boolean $PrimaryKey
API documentation generated by ApiGen