Symfony 1.0.0 : Vue détaillée de Table.php

Data about a table used in an application.

Constructs a table object with a name

param: string $name table name

Sets up the Rule object based on the attributes that were passed to loadFromXML().

A hook for the SAX XML parser to call when this table has
been fully loaded from the XML, and all nested elements have
been processed.

Performs heavy indexing and naming of elements which weren't
provided with a name.

doHeavyIndexing() X-Ref

Adds extra indices for multi-part primary key columns.

For databases like MySQL, values in a where clause much
match key part order from the left to right. So, in the key
definition <code>PRIMARY KEY (FOO_ID, BAR_ID)</code>,
<code>FOO_ID</code> must be the first element used in
the <code>where</code> clause of the SQL query used against
this table for the primary key index to be used. This feature
could cause problems under MySQL with heavily indexed tables,
as MySQL currently only supports 16 indices per table (i.e. it
might cause too many indices to be created).

See <a href="http://www.mysql.com/doc/E/X/EXPLAIN.html">the
manual</a> for a better description of why heavy indexing is
useful for quickly searchable database tables.

doNaming() X-Ref

Names composing objects which haven't yet been named. This
currently consists of foreign-key and index entities.

acquireConstraintName($nameType, $nbr) X-Ref

Macro to a constraint name.

param: nameType constraint type
param: nbr unique number for this constraint type
return: unique name for constraint

getBaseClass() X-Ref

Gets the value of base class for classes produced from this table.

return: The base class for classes produced from this table.

setBaseClass($v) X-Ref

Set the value of baseClass.

param: v Value to assign to baseClass.

getBasePeer() X-Ref

Get the value of basePeer.

return: value of basePeer.

setBasePeer($v) X-Ref

Set the value of basePeer.

param: v Value to assign to basePeer.

addColumn($data) X-Ref

A utility function to create a new column from attrib and add it to this
table.

param: $coldata xml attributes or Column class for the column to add
return: the added column

addValidator($data) X-Ref

Add a validator to this table.

Supports two signatures:
- addValidator(Validator $validator)
- addValidator(array $attribs)

param: mixed $data Validator object or XML attribs (array) from <validator /> element.
return: Validator The added Validator.

addForeignKey($fkdata) X-Ref

A utility function to create a new foreign key
from attrib and add it to this table.

getChildrenColumn() X-Ref

Gets the column that subclasses of the class representing this
table can be produced from.

return: string

getChildrenNames() X-Ref

Get the subclasses that can be created from this table.

return: array string[] Class names

addReferrer(ForeignKey $fk) X-Ref

Adds the foreign key from another table that refers to this table.

getReferrers() X-Ref

Get list of references to this table.

setContainsForeignPK($b) X-Ref

Set whether this table contains a foreign PK

getContainsForeignPK() X-Ref

Determine if this table contains a foreign PK

getForeignTableNames() X-Ref

A list of tables referenced by foreign keys in this table

requiresTransactionInPostgres() X-Ref

Return true if the column requires a transaction in Postgres

addIdMethodParameter($impdata) X-Ref

A utility function to create a new id method parameter
from attrib or object and add it to this table.

addIndex($idxdata) X-Ref

Adds a new index to the index list and set the
parent table of the column to the current table

addUnique($unqdata) X-Ref

Adds a new Unique to the Unique list and set the
parent table of the column to the current table

getName() X-Ref

Get the name of the Table

setName($newName) X-Ref

Set the name of the Table

getDescription() X-Ref

Get the description for the Table

setDescription($newDescription) X-Ref

Set the description for the Table

param: newDescription description for the Table

getPhpName() X-Ref

Get name to use in PHP sources

return: string

setPhpName($phpName) X-Ref

Set name to use in PHP sources

param: string $phpName

getIdMethod() X-Ref

Get the method for generating pk's
[HL] changing behavior so that Database default
method is returned if no method has been specified
for the table.

return: string

setIdMethod($idMethod) X-Ref

Set the method for generating pk's

isSkipSql() X-Ref

Skip generating sql for this table (in the event it should
not be created from scratch).

return: boolean Value of skipSql.

isReadOnly() X-Ref

Is table read-only, in which case only accessors (and relationship setters)
will be created.

return: boolan Value of readOnly.

setSkipSql($v) X-Ref

Set whether this table should have its creation sql generated.

param: boolean $v Value to assign to skipSql.

getAlias() X-Ref

PhpName of om object this entry references.

return: value of external.

isAlias() X-Ref

Is this table specified in the schema or is there just
a foreign key reference to it.

return: value of external.

setAlias($v) X-Ref

Set whether this table specified in the schema or is there just
a foreign key reference to it.

param: v Value to assign to alias.

getInterface() X-Ref

Interface which objects for this table will implement

return: value of interface.

setInterface($v) X-Ref

Interface which objects for this table will implement

param: v Value to assign to interface.

isAbstract() X-Ref

When a table is abstract, it marks the business object class that is
generated as being abstract. If you have a table called "FOO", then the
Foo BO will be <code>public abstract class Foo</code>
This helps support class hierarchies

return: value of abstractValue.

setAbstract($v) X-Ref

When a table is abstract, it marks the business object
class that is generated as being abstract. If you have a
table called "FOO", then the Foo BO will be
<code>public abstract class Foo</code>
This helps support class hierarchies

param: v Value to assign to abstractValue.

getPackage() X-Ref

Get the value of package.

return: value of package.

setPackage($v) X-Ref

Set the value of package.

param: v Value to assign to package.

getColumns() X-Ref

Returns an Array containing all the columns in the table

getNumColumns() X-Ref

Utility method to get the number of columns in this table

getNumLazyLoadColumns() X-Ref

Utility method to get the number of columns in this table

getValidators() X-Ref

Returns an Array containing all the validators in the table

getForeignKeys() X-Ref

Returns an Array containing all the FKs in the table

getIdMethodParameters() X-Ref

Returns a Collection of parameters relevant for the chosen
id generation method.

getSequenceName() X-Ref

A name to use for creating a sequence if one is not specified.

getIndices() X-Ref

Returns an Array containing all the FKs in the table

getUnices() X-Ref

Returns an Array containing all the UKs in the table

getColumn($name) X-Ref

Returns a specified column.

return: Return a Column object or null if it does not exist.

getColumnByPhpName($phpName) X-Ref

Returns a specified column.

return: Return a Column object or null if it does not exist.

getForeignKey($col) X-Ref

Return the first foreign key that includes col in it's list
of local columns. Eg. Foreign key (a,b,c) refrences tbl(x,y,z)
will be returned of col is either a,b or c.

param: string $col
return: Return a Column object or null if it does not exist.

containsColumn($col) X-Ref

Returns true if the table contains a specified column

param: mixed $col Column or column name.

setDatabase($parent) X-Ref

Set the parent of the table

param: parent the parant database

getDatabase() X-Ref

Get the parent of the table

return: the parant database

isForReferenceOnly() X-Ref

Flag to determine if code/sql gets created for this table.
Table will be skipped, if return true.

return: value of forReferenceOnly.

setForReferenceOnly($v) X-Ref

Flag to determine if code/sql gets created for this table.
Table will be skipped, if set to true.

param: v Value to assign to forReferenceOnly.

isTree() X-Ref

Flag to determine if tree node class should be generated for this table.

return: valur of isTree

setIsTree($v) X-Ref

Flag to determine if tree node class should be generated for this table.

param: v Value to assign to isTree.

toString() X-Ref

Returns a XML representation of this table.

return: XML representation of this table

getPrimaryKey() X-Ref

Returns the collection of Columns which make up the single primary
key for this table.

return: array A list of the primary key parts.

hasPrimaryKey() X-Ref

Determine whether this table has a primary key.

return: boolean Whether this table has any primary key parts.

hasAutoIncrementPrimaryKey() X-Ref

Determine whether this table has any auto-increment primary key(s).

return: boolean Whether this table has a non-"none" id method and has a primary key column that is auto-increment.

printPrimaryKey() X-Ref

Returns all parts of the primary key, separated by commas.

return: A CSV list of primary key parts.

printList($list) X-Ref

Returns the elements of the list, separated by commas.

param: array $list
return: A CSV list.

Poids:	1151 lignes (34 kb)
Inclus ou requis:	0 fois
Référencé:	0 fois
Nécessite:	0 fichiers

Code source de Symfony 1.0.0

/lib/vendor/propel-generator/classes/propel/engine/database/model/ -> Table.php (sommaire)

Définit 1 class