Documentation TYPO3 par Ameos

dbTable Class Reference

Inheritance diagram for dbTable:
[legend]
Collaboration diagram for dbTable:
[legend]
List of all members.

Public Member Functions

 dbTable (&$parent, $attributes=NULL)
 _tag_open (&$parser, $tag, $attributes)
 _tag_cdata (&$parser, $cdata)
 _tag_close (&$parser, $tag)
addIndex ($attributes)
addData ($attributes)
 addField ($name, $type, $size=NULL, $opts=NULL)
 addFieldOpt ($field, $opt, $value=NULL)
 addTableOpt ($opt)
 create (&$xmls)
 drop ()
 dbTable (&$parent, $attributes=NULL)
 _tag_open (&$parser, $tag, $attributes)
 _tag_cdata (&$parser, $cdata)
 _tag_close (&$parser, $tag)
addIndex ($attributes)
addData ($attributes)
 addField ($name, $type, $size=NULL, $opts=NULL)
 addFieldOpt ($field, $opt, $value=NULL)
 addTableOpt ($opt)
 create (&$xmls)
 drop ()

Public Attributes

 $name
 $fields = array()
 $indexes = array()
 $opts = array()
 $current_field
 $drop_table
 $drop_field = array()
 $currentPlatform = true

Detailed Description

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


Member Function Documentation

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

Iniitializes a new table object.

Parameters:
string $prefix DB Object prefix
array $attributes Array of table attributes.

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

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

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

XML Callback to process start elements. Elements currently processed are: INDEX, DROP, FIELD, KEY, NOTNULL, AUTOINCREMENT & DEFAULT.

private

Reimplemented from dbObject.

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

References addData(), addField(), addFieldOpt(), addIndex(), drop(), and dbObject::supportedPlatform().

dbTable::_tag_cdata ( &$  parser,
cdata 
)

XML Callback to process CDATA elements

private

Reimplemented from dbObject.

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

References addFieldOpt(), and addTableOpt().

dbTable::_tag_close ( &$  parser,
tag 
)

XML Callback to process end elements

private

Reimplemented from dbObject.

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

References dbObject::create(), and dbObject::destroy().

& dbTable::addIndex ( attributes  ) 

Adds an index to a table object

Parameters:
array $attributes Index attributes
Returns:
object dbIndex object

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

References $name.

Referenced by _tag_open().

& dbTable::addData ( attributes  ) 

Adds data to a table object

Parameters:
array $attributes Data attributes
Returns:
object dbData object

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

Referenced by _tag_open().

dbTable::addField ( name,
type,
size = NULL,
opts = NULL 
)

Adds a field to a table object

$name is the name of the table to which the field should be added. $type is an ADODB datadict field type. The following field types are supported as of ADODB 3.40:

Parameters:
string $name Name of the table to which the field will be added.
string $type ADODB datadict field type.
string $size Field size
array $opts Field options array
Returns:
array Field specifier array

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

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

Referenced by _tag_open().

dbTable::addFieldOpt ( field,
opt,
value = NULL 
)

Adds a field option to the current field specifier

This method adds a field option allowed by the ADOdb datadict and appends it to the given field.

Parameters:
string $field Field name
string $opt ADOdb field option
mixed $value Field option value
Returns:
array Field specifier array

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

References dbObject::FieldID().

Referenced by _tag_cdata(), and _tag_open().

dbTable::addTableOpt ( opt  ) 

Adds an option to the table

This method takes a comma-separated list of table-level options and appends them to the table object.

Parameters:
string $opt Table option
Returns:
array Options

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

Referenced by _tag_cdata().

dbTable::create ( &$  xmls  ) 

Generates the SQL that will create the table in the database

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

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

dbTable::drop (  ) 

Marks a field or table for destruction

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

Referenced by _tag_open().

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

Iniitializes a new table object.

Parameters:
string $prefix DB Object prefix
array $attributes Array of table attributes.

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

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

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

XML Callback to process start elements. Elements currently processed are: INDEX, DROP, FIELD, KEY, NOTNULL, AUTOINCREMENT & DEFAULT.

private

Reimplemented from dbObject.

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

References addData(), addField(), addFieldOpt(), addIndex(), drop(), and dbObject::supportedPlatform().

dbTable::_tag_cdata ( &$  parser,
cdata 
)

XML Callback to process CDATA elements

private

Reimplemented from dbObject.

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

References addFieldOpt(), and addTableOpt().

dbTable::_tag_close ( &$  parser,
tag 
)

XML Callback to process end elements

private

Reimplemented from dbObject.

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

References dbObject::create(), and dbObject::destroy().

& dbTable::addIndex ( attributes  ) 

Adds an index to a table object

Parameters:
array $attributes Index attributes
Returns:
object dbIndex object

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

References $name.

& dbTable::addData ( attributes  ) 

Adds data to a table object

Parameters:
array $attributes Data attributes
Returns:
object dbData object

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

dbTable::addField ( name,
type,
size = NULL,
opts = NULL 
)

Adds a field to a table object

$name is the name of the table to which the field should be added. $type is an ADODB datadict field type. The following field types are supported as of ADODB 3.40:

Parameters:
string $name Name of the table to which the field will be added.
string $type ADODB datadict field type.
string $size Field size
array $opts Field options array
Returns:
array Field specifier array

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

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

dbTable::addFieldOpt ( field,
opt,
value = NULL 
)

Adds a field option to the current field specifier

This method adds a field option allowed by the ADOdb datadict and appends it to the given field.

Parameters:
string $field Field name
string $opt ADOdb field option
mixed $value Field option value
Returns:
array Field specifier array

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

References dbObject::FieldID().

dbTable::addTableOpt ( opt  ) 

Adds an option to the table

This method takes a comma-separated list of table-level options and appends them to the table object.

Parameters:
string $opt Table option
Returns:
array Options

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

dbTable::create ( &$  xmls  ) 

Generates the SQL that will create the table in the database

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

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

dbTable::drop (  ) 

Marks a field or table for destruction

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


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


Généré par TYPO3 Ameos avec  doxygen 1.4.6