[ Index ]
 

Code source de Symfony 1.0.0

Accédez au Source d'autres logiciels libresSoutenez Angelica Josefina !

title

Body

[fermer]

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

(pas de description)

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

Définit 1 class

Column:: (68 méthodes):
  __construct()
  makeList()
  setupObject()
  getDomain()
  getFullyQualifiedName()
  getName()
  setName()
  getDescription()
  setDescription()
  getPhpName()
  setPhpName()
  getPeerName()
  setPeerName()
  getPhpType()
  getPosition()
  setPosition()
  setTable()
  getTable()
  getTableName()
  addInheritance()
  getChildren()
  isInheritance()
  isEnumeratedClasses()
  isNotNull()
  setNotNull()
  getNotNullString()
  setPrimaryKey()
  isPrimaryKey()
  setNodeKey()
  isNodeKey()
  setNodeKeySep()
  getNodeKeySep()
  setUnique()
  isUnique()
  requiresTransactionInPostgres()
  isForeignKey()
  isMultipleFK()
  getForeignKey()
  getRelatedTableName()
  getRelatedColumnName()
  addReferrer()
  getReferrers()
  setType()
  getType()
  getPropelType()
  isLob()
  isString()
  toString()
  getSize()
  setSize()
  getScale()
  setScale()
  printSize()
  getDefaultSetting()
  setDefaultValue()
  getDefaultValue()
  getPhpDefaultValue()
  getInputValidator()
  isAutoIncrement()
  isLazyLoad()
  getAutoIncrementString()
  setAutoIncrement()
  setTypeFromString()
  getPhpNative()
  isPrimitive()
  isPrimitiveNumeric()
  getPlatform()
  getSqlString()


Classe: Column  - X-Ref

A Class for holding data about a column used in an Application.

__construct($name = null)   X-Ref
Creates a new column and set the name

param: name column name

makeList($columns, Platform $platform)   X-Ref
Return a comma delimited string listing the specified columns.

param: columns Either a list of <code>Column</code> objects, or

setupObject()   X-Ref
Sets up the Column object based on the attributes that were passed to loadFromXML().


getDomain()   X-Ref
Gets domain for this column.

return: Domain

getFullyQualifiedName()   X-Ref
Returns table.column


getName()   X-Ref
Get the name of the column


setName($newName)   X-Ref
Set the name of the column


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


getPeerName()   X-Ref
Get the Peer constant name that will identify this column.

return: string

setPeerName($name)   X-Ref
Set the Peer constant name that will identify this column.

param: $name string

getPhpType()   X-Ref
Get type to use in PHP sources.
If no type has been specified, then uses results
of getPhpNative().

The distinction between getPhpType() and getPhpNative()
is not as salient in PHP as it is in Java, but we'd like to leave open the
option of specifying complex types (objects) in the schema.  While we can
always cast to PHP native types, we can't cast objects (in PHP) -- hence the
importance of maintaining this distinction.

return: string The type name.

getPosition()   X-Ref
Get the location of this column within the table (one-based).

return: int value of position.

setPosition($v)   X-Ref
Get the location of this column within the table (one-based).

param: int $v Value to assign to position.

setTable(Table $parent)   X-Ref
Set the parent Table of the column


getTable()   X-Ref
Get the parent Table of the column


getTableName()   X-Ref
Returns the Name of the table the column is in


addInheritance($inhdata)   X-Ref
Adds a new inheritance definition to the inheritance list and set the
parent column of the inheritance to the current column

param: mixed $inhdata Inheritance or XML data.

getChildren()   X-Ref
Get the inheritance definitions.


isInheritance()   X-Ref
Determine if this column is a normal property or specifies a
the classes that are represented in the table containing this column.


isEnumeratedClasses()   X-Ref
Determine if possible classes have been enumerated in the xml file.


isNotNull()   X-Ref
Return the isNotNull property of the column


setNotNull($status)   X-Ref
Set the isNotNull property of the column


getNotNullString()   X-Ref
Return NOT NULL String for this column

return: "NOT NULL" if null values are not allowed or an empty string.

setPrimaryKey($pk)   X-Ref
Set if the column is a primary key or not


isPrimaryKey()   X-Ref
Return true if the column is a primary key


setNodeKey($nk)   X-Ref
Set if the column is the node key of a tree


isNodeKey()   X-Ref
Return true if the column is a node key of a tree


setNodeKeySep($sep)   X-Ref
Set if the column is the node key of a tree


getNodeKeySep()   X-Ref
Return true if the column is a node key of a tree


setUnique($u)   X-Ref
Set true if the column is UNIQUE


isUnique()   X-Ref
Get the UNIQUE property


requiresTransactionInPostgres()   X-Ref
Return true if the column requires a transaction in Postgres


isForeignKey()   X-Ref
Utility method to determine if this column is a foreign key.


isMultipleFK()   X-Ref
Determine if this column is a foreign key that refers to the
same table as another foreign key column in this table.


getForeignKey()   X-Ref
get the foreign key object for this column
if it is a foreign key or part of a foreign key


getRelatedTableName()   X-Ref
Utility method to get the related table of this column if it is a foreign
key or part of a foreign key


getRelatedColumnName()   X-Ref
Utility method to get the related column of this local column if this
column is a foreign key or part of a foreign key.


addReferrer(ForeignKey $fk)   X-Ref
Adds the foreign key from another table that refers to this column.


getReferrers()   X-Ref
Get list of references to this column.


setType($propelType)   X-Ref
Returns the colunm type


getType()   X-Ref
Returns the column Creole type as a string.

return: string The constant representing Creole type: e.g. "VARCHAR".

getPropelType()   X-Ref
Returns the column type as given in the schema as an object


isLob()   X-Ref
Utility method to know whether column needs Blob/Lob handling.

return: boolean

isString()   X-Ref
Utility method to see if the column is a string


toString()   X-Ref
String representation of the column. This is an xml representation.


getSize()   X-Ref
Returns the size of the column

return: string

setSize($newSize)   X-Ref
Set the size of the column

param: string $newSize

getScale()   X-Ref
Returns the scale of the column

return: string

setScale($newScale)   X-Ref
Set the scale of the column

param: string $newScale

printSize()   X-Ref
Return the size in brackets for use in an sql
schema if the type is String.  Otherwise return an empty string


getDefaultSetting()   X-Ref
Return a string that will give this column a default value.

return: string

setDefaultValue($def)   X-Ref
Set a string that will give this column a default value.


getDefaultValue()   X-Ref
Get the raw string that will give this column a default value.

return: string

getPhpDefaultValue()   X-Ref
Get the default value suitable for use in PHP.

return: mixed

getInputValidator()   X-Ref
Returns the class name to do input validation


isAutoIncrement()   X-Ref
Return auto increment/sequence string for the target database. We need to
pass in the props for the target database!


isLazyLoad()   X-Ref
Return auto increment/sequence string for the target database. We need to
pass in the props for the target database!


getAutoIncrementString()   X-Ref
Gets the auto-increment string.

return: string

setAutoIncrement($value)   X-Ref
Set the auto increment value.
Use isAutoIncrement() to find out if it is set or not.


setTypeFromString($typeName, $size)   X-Ref
Set the column type from a string property
(normally a string from an sql input file)


getPhpNative()   X-Ref
Return a string representation of the native PHP type which corresponds
to the Creole type of this column. Use in the generation of Base objects.

return: string PHP datatype used by propel.

isPrimitive()   X-Ref
Returns true if the column's PHP native type is an
boolean, int, long, float, double, string


isPrimitiveNumeric()   X-Ref
Return true if column's PHP native type is an
boolean, int, long, float, double


getPlatform()   X-Ref
Get the platform/adapter impl.

return: Platform

getSqlString()   X-Ref

return: string



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