PRADO Component Framework for PHP 5
  • Home
  • About
  • Testimonials
  • Demos
  • Download
  • Documentation
  • Forum
  • Development
  • Tutorials
  • Class Docs
  • API Manual
  • Wiki

Packages

  • None
  • System
    • Caching
    • Collections
    • Data
      • ActiveRecord
        • Relations
        • Scaffold
          • InputBuilder
      • Commom
        • Sqlite
      • Common
        • Mssql
        • Mysql
        • Oracle
        • Pgsql
        • Sqlite
      • DataGateway
      • SqlMap
        • Configuration
        • Statements
    • Exceptions
    • I18N
    • IO
    • Security
    • Util
    • Web
      • Javascripts
      • Services
      • UI
        • ActiveControls
        • WebControls
    • Xml
  • Wsat
    • pages
  • Overview
  • Package
  • Class
  • Tree
  • Deprecated
  • Todo

Class TDbTableColumn

TDbTableColumn class describes the column meta data of the schema for a database table.

TComponent
Extended by TDbTableColumn

Direct known subclasses

TMssqlTableColumn, TMysqlTableColumn, TOracleTableColumn, TPgsqlTableColumn, TSqliteTableColumn
Package: System\Data\Common
Copyright: Copyright © 2005-2014 PradoSoft
License: http://www.pradosoft.com/license/
Author: Wei Zhuo <weizho[at]gmail[dot]com>
Since: 3.1
Located at Data/Common/TDbTableColumn.php
Methods summary
public
# __construct( array $columnInfo )

Sets the table column meta data.

Sets the table column meta data.

Parameters

$columnInfo
array
table column information.

Overrides

TComponent::__construct()
protected mixed
# getInfo( string $name, mixed $default = null )

Parameters

$name
string
information array key name
$default
mixed
default value if information array value is null

Returns

mixed
information array value.
protected
# setInfo( string $name, mixed $value )

Parameters

$name
string
information array key name
$value
mixed
new information array value.
public string
# getPHPType( )

Returns the derived PHP primitive type from the db type. Default returns 'string'.

Returns the derived PHP primitive type from the db type. Default returns 'string'.

Returns

string
derived PHP primitive type from the column db type.
public
# getPdoType( )
public string
# getColumnName( )

Returns

string
name of the column in the table (identifier quoted).
public string
# getColumnId( )

Returns

string
name of the column with quoted identifier.
public string
# getColumnSize( )

Returns

string
size of the column.
public integer
# getColumnIndex( )

Returns

integer
zero-based ordinal position of the column in the table.
public string
# getDbType( )

Returns

string
column type.
public boolean
# getAllowNull( )

Returns

boolean
specifies whether value Null is allowed, default is false.
public mixed
# getDefaultValue( )

Returns

mixed
default column value if column value was null.
public string
# getNumericPrecision( )

Returns

string
precision of the column data, if the data is numeric.
public string
# getNumericScale( )

Returns

string
scale of the column data, if the data is numeric.
public
# getMaxiumNumericConstraint( )
public boolean
# getIsPrimaryKey( )

Returns

boolean
whether this column is a primary key for the table, default is false.
public boolean
# getIsForeignKey( )

Returns

boolean
whether this column is a foreign key, default is false.
public
# getSequenceName( )
public boolean
# hasSequence( )

Returns

boolean
whether the column is a sequence.
public boolean
# getIsExcluded( )

Returns

boolean
whether this column is excluded from insert and update.
Methods inherited from TComponent
__call(), __destruct(), __get(), __isset(), __set(), __sleep(), __unset(), __wakeup(), addParsedObject(), asa(), attachBehavior(), attachBehaviors(), attachClassBehavior(), attachEventHandler(), canGetProperty(), canSetProperty(), clearBehaviors(), createdOnTemplate(), detachBehavior(), detachBehaviors(), detachClassBehavior(), detachEventHandler(), disableBehavior(), disableBehaviors(), enableBehavior(), enableBehaviors(), evaluateExpression(), evaluateStatements(), fxAttachClassBehavior(), fxDetachClassBehavior(), getAutoGlobalListen(), getBehaviorsEnabled(), getClassHierarchy(), getEventHandlers(), getListeningToGlobalEvents(), getSubProperty(), hasEvent(), hasEventHandler(), hasProperty(), isa(), listen(), raiseEvent(), setSubProperty(), unlisten()
Constants summary
float UNDEFINED_VALUE INF
#
Constants inherited from TComponent
GLOBAL_RAISE_EVENT_LISTENER
Terms of Service | Contact Us
PRADO v3.2.4 API Manual API documentation generated by ApiGen 2.8.0
Copyright © 2006-2014 by the PRADO Group.
Powered by PRADO