"TYPO3 4.0.1: dbIndex Class Reference", "datetime" => "Sat Dec 2 19:24:48 2006", "date" => "2 Dec 2006", "doxygenversion" => "1.4.6", "projectname" => "TYPO3 4.0.1", "projectnumber" => "4.0.1" ); get_header($doxygen_vars); ?>

dbIndex Class Reference

Inheritance diagram for dbIndex:

Inheritance graph
[legend]
Collaboration diagram for dbIndex:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 dbIndex (&$parent, $attributes=NULL)
 _tag_open (&$parser, $tag, $attributes)
 _tag_cdata (&$parser, $cdata)
 _tag_close (&$parser, $tag)
 addField ($name)
 addIndexOpt ($opt)
 create (&$xmls)
 drop ()
 dbIndex (&$parent, $attributes=NULL)
 _tag_open (&$parser, $tag, $attributes)
 _tag_cdata (&$parser, $cdata)
 _tag_close (&$parser, $tag)
 addField ($name)
 addIndexOpt ($opt)
 create (&$xmls)
 drop ()

Public Attributes

 $name
 $opts = array()
 $columns = array()
 $drop = FALSE

Detailed Description

Definition at line 612 of file adodb-xmlschema.inc.php.

Constructor & Destructor Documentation

dbIndex::dbIndex (  &$  parent,
$  attributes = NULL
) 
 

Initializes the new dbIndex object.

Parameters:
object $parent Parent object
array $attributes Attributes

Definition at line 643 of file adodb-xmlschema.inc.php.

References dbObject::$parent, and dbObject::prefix().

dbIndex::dbIndex (  &$  parent,
$  attributes = NULL
) 
 

Initializes the new dbIndex object.

Parameters:
object $parent Parent object
array $attributes Attributes

Definition at line 685 of file adodb-xmlschema03.inc.php.

References dbObject::$parent, and dbObject::prefix().

Member Function Documentation

dbIndex::_tag_cdata (  &$  parser,
$  cdata
) 
 

XML Callback to process CDATA elements

Processes XML cdata.

private

Reimplemented from dbObject.

Definition at line 726 of file adodb-xmlschema03.inc.php.

References addField().

dbIndex::_tag_cdata (  &$  parser,
$  cdata
) 
 

XML Callback to process CDATA elements

Processes XML cdata.

private

Reimplemented from dbObject.

Definition at line 684 of file adodb-xmlschema.inc.php.

References addField().

dbIndex::_tag_close (  &$  parser,
$  tag
) 
 

XML Callback to process end elements

private

Reimplemented from dbObject.

Definition at line 742 of file adodb-xmlschema03.inc.php.

dbIndex::_tag_close (  &$  parser,
$  tag
) 
 

XML Callback to process end elements

private

Reimplemented from dbObject.

Definition at line 700 of file adodb-xmlschema.inc.php.

dbIndex::_tag_open (  &$  parser,
$  tag,
$  attributes
) 
 

XML Callback to process start elements

Processes XML opening tags. Elements currently processed are: DROP, CLUSTERED, BITMAP, UNIQUE, FULLTEXT & HASH.

private

Reimplemented from dbObject.

Definition at line 699 of file adodb-xmlschema03.inc.php.

References addIndexOpt(), and drop().

dbIndex::_tag_open (  &$  parser,
$  tag,
$  attributes
) 
 

XML Callback to process start elements

Processes XML opening tags. Elements currently processed are: DROP, CLUSTERED, BITMAP, UNIQUE, FULLTEXT & HASH.

private

Reimplemented from dbObject.

Definition at line 657 of file adodb-xmlschema.inc.php.

References addIndexOpt(), and drop().

dbIndex::addField (  $  name  ) 
 

Adds a field to the index

Parameters:
string $name Field name
Returns:
string Field list

Definition at line 758 of file adodb-xmlschema03.inc.php.

References $name, and dbObject::FieldID().

dbIndex::addField (  $  name  ) 
 

Adds a field to the index

Parameters:
string $name Field name
Returns:
string Field list

Definition at line 716 of file adodb-xmlschema.inc.php.

References $name, and dbObject::FieldID().

Referenced by _tag_cdata().

dbIndex::addIndexOpt (  $  opt  ) 
 

Adds options to the index

Parameters:
string $opt Comma-separated list of index options.
Returns:
string Option list

Definition at line 771 of file adodb-xmlschema03.inc.php.

dbIndex::addIndexOpt (  $  opt  ) 
 

Adds options to the index

Parameters:
string $opt Comma-separated list of index options.
Returns:
string Option list

Definition at line 729 of file adodb-xmlschema.inc.php.

Referenced by _tag_open().

dbIndex::create (  &$  xmls  ) 
 

Generates the SQL that will create the index in the database

Parameters:
object $xmls adoSchema object
Returns:
array Array containing index creation SQL

Definition at line 784 of file adodb-xmlschema03.inc.php.

References drop().

dbIndex::create (  &$  xmls  ) 
 

Generates the SQL that will create the index in the database

Parameters:
object $xmls adoSchema object
Returns:
array Array containing index creation SQL

Definition at line 742 of file adodb-xmlschema.inc.php.

References drop().

dbIndex::drop (   ) 
 

Marks an index for destruction

Definition at line 802 of file adodb-xmlschema03.inc.php.

References drop().

dbIndex::drop (   ) 
 

Marks an index for destruction

Definition at line 760 of file adodb-xmlschema.inc.php.

Referenced by _tag_open(), create(), and drop().

The documentation for this class was generated from the following files: