class Index extends XMLElement
Information about indices of a table.
Constants
| DEBUG |
enables debug output |
Methods
|
loadFromXML(array $attributes)
This is the entry point method for loading data from XML. |
from XMLElement | |
| array |
getAttributes()
Returns the assoc array of attributes. |
from XMLElement |
| mixed |
getAttribute(string $name, mixed $defaultValue = null)
Gets a particular attribute by [case-insensitive] name. |
from XMLElement |
| appendXml(DOMNode $node) | ||
| VendorInfo |
addVendorInfo(mixed $data)
Sets an associated VendorInfo object. |
from XMLElement |
| VendorInfo |
getVendorInfoForType($type)
Gets the any associated VendorInfo object. |
from XMLElement |
| string |
getConfiguredBehavior(string $bname)
Find the best class name for a given behavior Looks in build.properties for path like propel.behavior.[bname].class If not found, tries to autoload [Bname]Behavior If no success, returns 'Behavior' |
from XMLElement |
|
toString()
String representation of the current object. |
from XMLElement | |
|
__toString()
Magic string method |
from XMLElement | |
|
__construct(string $name = null)
Creates a new Index instance. |
||
| getIsUnique() | ||
|
isUnique()
Returns the uniqueness of this index. |
||
| getIndexName() | ||
|
getName()
Gets the name of this index. |
||
| setIndexName($name) | ||
|
setName($name)
Set the name of this index. |
||
|
setTable(Table $parent)
Set the parent Table of the index |
||
|
getTable()
Get the parent Table of the index |
||
|
getTableName()
Returns the Name of the table the index is in |
||
|
addColumn(mixed $data)
Adds a new column to an index. |
||
|
setColumns(array $indexColumns)
Sets array of columns to use for index. |
||
| boolean |
hasColumnSize(string $name)
Whether there is a size for the specified column. |
|
| numeric |
getColumnSize(string $name)
Returns the size for the specified column, if given. |
|
|
resetColumnSize()
Reset the column sizes. |
||
| getIndexColumnList() | ||
|
getColumnList()
Return a comma delimited string of the columns which compose this index. |
||
| getIndexColumns() | ||
| boolean |
hasColumnAtPosition(integer $pos, string $name, integer $size = null, boolean $caseInsensitive = false)
Check whether this index has a given column at a given position |
|
| boolean |
hasColumns()
Check whether the index has columns. |
|
| array |
getColumns()
Return the list of local columns. |
Details
in XMLElement at line 47
public
loadFromXML(array $attributes)
This is the entry point method for loading data from XML.
It calls a setupObject() method that must be implemented by the child class.
in XMLElement at line 58
public array
getAttributes()
Returns the assoc array of attributes.
All attribute names (keys) are lowercase.
in XMLElement at line 70
public mixed
getAttribute(string $name, mixed $defaultValue = null)
Gets a particular attribute by [case-insensitive] name.
If attribute is not set then the $defaultValue is returned.
at line 308
public
appendXml(DOMNode $node)
in XMLElement at line 106
public VendorInfo
addVendorInfo(mixed $data)
Sets an associated VendorInfo object.
in XMLElement at line 123
public VendorInfo
getVendorInfoForType($type)
Gets the any associated VendorInfo object.
in XMLElement at line 142
public string
getConfiguredBehavior(string $bname)
Find the best class name for a given behavior Looks in build.properties for path like propel.behavior.[bname].class If not found, tries to autoload [Bname]Behavior If no success, returns 'Behavior'
in XMLElement at line 165
public
toString()
String representation of the current object.
This is an xml representation with the XML declaration removed.
in XMLElement at line 178
public
__toString()
Magic string method
at line 42
public
__construct(string $name = null)
Creates a new Index instance.
at line 82
public
getIsUnique()
at line 90
public
isUnique()
Returns the uniqueness of this index.
at line 99
public
getIndexName()
at line 107
public
getName()
Gets the name of this index.
at line 128
public
setIndexName($name)
at line 136
public
setName($name)
Set the name of this index.
at line 144
public
setTable(Table $parent)
Set the parent Table of the index
at line 152
public
getTable()
Get the parent Table of the index
at line 160
public
getTableName()
Returns the Name of the table the index is in
at line 169
public
addColumn(mixed $data)
Adds a new column to an index.
at line 192
public
setColumns(array $indexColumns)
Sets array of columns to use for index.
at line 206
public boolean
hasColumnSize(string $name)
Whether there is a size for the specified column.
at line 216
public numeric
getColumnSize(string $name)
Returns the size for the specified column, if given.
at line 227
public
resetColumnSize()
Reset the column sizes.
Useful for generated indices for FKs
at line 236
public
getIndexColumnList()
at line 245
public
getColumnList()
Return a comma delimited string of the columns which compose this index.
at line 254
public
getIndexColumns()
at line 270
public boolean
hasColumnAtPosition(integer $pos, string $name, integer $size = null, boolean $caseInsensitive = false)
Check whether this index has a given column at a given position
at line 291
public boolean
hasColumns()
Check whether the index has columns.
at line 300
public array
getColumns()
Return the list of local columns.
You should not edit this list.