[ Index ]
 

Code source de Symfony 1.0.0
Accédez au Source d'autres logiciels libres • Soutenez Angelica Josefina !

title

Body

[fermer]

/lib/vendor/propel/map/ -> TableMap.php (sommaire)

[Code source] [Imprimer] [Statistiques]

(pas de description)

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

Définit 1 class

TableMap:: (25 méthodes):
  __construct()
  normalizeColName()
  containsColumn()
  getDatabaseMap()
  getName()
  getPhpName()
  setPhpName()
  getPrefix()
  setPrefix()
  isUseIdGenerator()
  getPrimaryKeyMethodInfo()
  getColumns()
  getColumn()
  addPrimaryKey()
  addForeignKey()
  addForeignPrimaryKey()
  addConfiguredColumn()
  addColumn()
  addValidator()
  setUseIdGenerator()
  setPrimaryKeyMethodInfo()
  hasPrefix()
  removePrefix()
  removeUnderScores()
  firstLetterCaps()


Classe: TableMap  - X-Ref

TableMap is used to model a table in a database.

GENERAL NOTE
------------
The propel.map classes are abstract building-block classes for modeling
the database at runtime.  These classes are similar (a lite version) to the
propel.engine.database.model classes, which are build-time modeling classes.
These classes in themselves do not do any database metadata lookups, but instead
are used by the MapBuilder classes that were generated for your datamodel. The
MapBuilder that was created for your datamodel build a representation of your
database by creating instances of the DatabaseMap, TableMap, ColumnMap, etc.
classes. See propel/templates/om/php5/MapBuilder.tpl and the classes generated
by that template for your datamodel to further understand how these are put
together.

__construct($tableName, DatabaseMap $containingDB)   X-Ref
Construct a new TableMap.

param: string $tableName The name of the table.
param: DatabaseMap $containingDB A DatabaseMap that this table belongs to.

normalizeColName($name)   X-Ref
Normalizes the column name, removing table prefix and uppercasing.

param: string $name
return: string Normalized column name.

containsColumn($name)   X-Ref
Does this table contain the specified column?

param: string $name name of the column
return: boolean True if the table contains the column.

getDatabaseMap()   X-Ref
Get the DatabaseMap containing this TableMap.

return: DatabaseMap A DatabaseMap.

getName()   X-Ref
Get the name of the Table.

return: string A String with the name of the table.

getPhpName()   X-Ref
Get the PHP name of the Table.

return: string A String with the name of the table.

setPhpName($phpName)   X-Ref
Set the PHP name of the Table.

param: string $phpName The PHP Name for this table

getPrefix()   X-Ref
Get table prefix name.

return: string A String with the prefix.

setPrefix($prefix)   X-Ref
Set table prefix name.

param: string $prefix The prefix for the table name (ie: SCARAB for
return: void

isUseIdGenerator()   X-Ref
Whether to use Id generator for primary key.

return: boolean

getPrimaryKeyMethodInfo()   X-Ref
Get the information used to generate a primary key

return: An Object.

getColumns()   X-Ref
Get a ColumnMap[] of the columns in this table.

return: array A ColumnMap[].

getColumn($name)   X-Ref
Get a ColumnMap for the named table.

param: string $name A String with the name of the table.
return: ColumnMap A ColumnMap.

addPrimaryKey($columnName, $phpName, $type, $creoleType, $isNotNull = false, $size = null)   X-Ref
Add a primary key column to this Table.

param: string $columnName A String with the column name.
param: string $type A string specifying the PHP native type.
param: int $creoleType The integer representing the Creole type.
param: boolean $isNotNull Whether column does not allow NULL values.
param: $size An int specifying the size.
return: ColumnMap Newly added PrimaryKey column.

addForeignKey($columnName, $phpName, $type, $creoleType, $fkTable, $fkColumn, $isNotNull = false, $size = 0)   X-Ref
Add a foreign key column to the table.

param: string $columnName A String with the column name.
param: string $type A string specifying the PHP native type.
param: int $creoleType The integer representing the Creole type.
param: string $fkTable A String with the foreign key table name.
param: string $fkColumn A String with the foreign key column name.
param: boolean $isNotNull Whether column does not allow NULL values.
param: int $size An int specifying the size.
param: string $defaultValue The default value for this column.
return: ColumnMap Newly added ForeignKey column.

addForeignPrimaryKey($columnName, $phpName, $type, $creoleType, $fkTable, $fkColumn, $isNotNull = false, $size = 0)   X-Ref
Add a foreign primary key column to the table.

param: string $columnName A String with the column name.
param: string $type A string specifying the PHP native type.
param: int $creoleType The integer representing the Creole type.
param: string $fkTable A String with the foreign key table name.
param: string $fkColumn A String with the foreign key column name.
param: boolean $isNotNull Whether column does not allow NULL values.
param: int $size An int specifying the size.
param: string $defaultValue The default value for this column.
return: ColumnMap Newly created foreign pkey column.

addConfiguredColumn($cmap)   X-Ref
Add a pre-created column to this table.  It will replace any
existing column.

param: ColumnMap $cmap A ColumnMap.
return: ColumnMap The added column map.

addColumn($name, $phpName, $type, $creoleType, $isNotNull = false, $size = null, $pk = null, $fkTable = null, $fkColumn = null)   X-Ref
Add a column to the table.

param: string name A String with the column name.
param: string $type A string specifying the PHP native type.
param: int $creoleType The integer representing the Creole type.
param: boolean $isNotNull Whether column does not allow NULL values.
param: int $size An int specifying the size.
param: boolean $pk True if column is a primary key.
param: string $fkTable A String with the foreign key table name.
param: $fkColumn A String with the foreign key column name.
param: string $defaultValue The default value for this column.
return: ColumnMap The newly created column.

addValidator($columnName, $name, $classname, $value, $message)   X-Ref
Add a validator to a table's column

param: string $columnName The name of the validator's column
param: string $name The rule name of this validator
param: string $classname The dot-path name of class to use (e.g. myapp.propel.MyValidator)
param: string $value
param: string $message The error message which is returned on invalid values
return: void

setUseIdGenerator($bit)   X-Ref
Set whether or not to use Id generator for primary key.

param: boolean $bit

setPrimaryKeyMethodInfo($pkInfo)   X-Ref
Sets the pk information needed to generate a key

param: $pkInfo information needed to generate a key

hasPrefix($data)   X-Ref
Tell me if i have PREFIX in my string.

param: data A String.
return: boolean True if prefix is contained in data.

removePrefix($data)   X-Ref
Removes the PREFIX.

param: string $data A String.
return: string A String with data, but with prefix removed.

removeUnderScores($data)   X-Ref
Removes the PREFIX, removes the underscores and makes
first letter caps.

SCARAB_FOO_BAR becomes FooBar.

param: data A String.
return: string A String with data processed.

firstLetterCaps($data)   X-Ref
Makes the first letter caps and the rest lowercase.

param: string $data A String.
return: string A String with data processed.


Généré le : Fri Mar 16 22:42:14 2007 par Balluche grâce à PHPXref 0.7