Class: Doctrine_DataDict_Firebird

Source Location: /Doctrine/DataDict/Firebird.php

Class Doctrine_DataDict_Firebird

Class Overview

Located in /Doctrine/DataDict/Firebird.php [line 34]

Doctrine_Connection_Module
   |
   --Doctrine_DataDict
      |
      --Doctrine_DataDict_Firebird
Author(s): Information Tags:
Version:  $Revision: 1731 $
Link:  www.phpdoctrine.com
Since:  1.0
License:  LGPL

Methods

[ Top ]
Inherited Properties, Constants, and Methods
Inherited Properties Inherited Methods Inherited Constants

Inherited From Doctrine_Connection_Module

Doctrine_Connection_Module::$conn
Doctrine_Connection_Module::$moduleName

Inherited From Doctrine_DataDict

Doctrine_DataDict::compareDefinition()
Obtain an array of changes that may need to applied
Doctrine_DataDict::parseBoolean()
parseBoolean parses a literal boolean value and returns proper sql equivalent

Inherited From Doctrine_Connection_Module

Doctrine_Connection_Module::__construct()
Doctrine_Connection_Module::getConnection()
getConnection returns the connection object this module uses
Doctrine_Connection_Module::getModuleName()
getModuleName returns the name of this module

[ Top ]
Method Summary
string   getCharsetFieldDeclaration()   Obtain DBMS specific SQL code portion needed to set the CHARACTER SET of a field declaration to be used in statements like CREATE TABLE.
string   getCollationFieldDeclaration()   Obtain DBMS specific SQL code portion needed to set the COLLATION of a field declaration to be used in statements like CREATE TABLE.
string   getNativeDeclaration()   Obtain DBMS specific SQL code portion needed to declare an text type field to be used in statements like CREATE TABLE.
array   getPortableDeclaration()   Maps a native array description of a field to a Doctrine datatype and length

[ Top ]
Properties
Methods
getCharsetFieldDeclaration  [line 200]

  string getCharsetFieldDeclaration( string $charset  )

Obtain DBMS specific SQL code portion needed to set the CHARACTER SET of a field declaration to be used in statements like CREATE TABLE.

Parameters:
string   $charset:  name of the charset

API Tags:
Return:  DBMS specific SQL code portion needed to set the CHARACTER SET of a field declaration.
Access:  public


[ Top ]
getCollationFieldDeclaration  [line 212]

  string getCollationFieldDeclaration( string $collation  )

Obtain DBMS specific SQL code portion needed to set the COLLATION of a field declaration to be used in statements like CREATE TABLE.

Parameters:
string   $collation:  name of the collation

API Tags:
Return:  DBMS specific SQL code portion needed to set the COLLATION of a field declaration.
Access:  public


[ Top ]
getNativeDeclaration  [line 58]

  string getNativeDeclaration( array $field  )

Obtain DBMS specific SQL code portion needed to declare an text type field to be used in statements like CREATE TABLE.

Parameters:
array   $field: 

associative array with the name of the properties of the field being declared as array indexes. Currently, the types of supported field properties are as follows:

length Integer value that determines the maximum length of the text field. If this argument is missing the field should be declared to have the longest length allowed by the DBMS.

default Text value to be used as default for this field.

notnull Boolean flag that indicates whether this field is constrained to not be set to null.


API Tags:
Return:  DBMS specific SQL code portion that should be used to declare the specified field.
Access:  public


[ Top ]
getPortableDeclaration  [line 109]

  array getPortableDeclaration( array $field  )

Maps a native array description of a field to a Doctrine datatype and length

Parameters:
array   $field:  native field description

API Tags:
Return:  containing the various possible types, length, sign, fixed
Access:  public


[ Top ]