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 TSqlMapStatement

TSqlMapStatement class corresponds to <statement> element.

Mapped Statements can hold any SQL statement and can use Parameter Maps and Result Maps for input and output.

The <statement> element is a general "catch all" element that can be used for any type of SQL statement. Generally it is a good idea to use one of the more specific statement-type elements. The more specific elements provided better error-checking and even more functionality. (For example, the insert statement can return a database-generated key.)

TComponent
Extended by TSqlMapStatement

Direct known subclasses

TSqlMapInsert, TSqlMapSelect, TSqlMapSelectKey, TSqlMapUpdate

Indirect known subclasses

TSqlMapDelete
Package: System\Data\SqlMap\Configuration
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/SqlMap/Configuration/TSqlMapStatement.php
Methods summary
public string
# getID( )

Returns

string
name for this statement, unique to each sql map manager.
public
# setID( string $value )

Parameters

$value
string
name for this statement, which must be unique for each sql map manager.
public string
# getParameterMap( )

Returns

string
name of a parameter map.
public
# setParameterMap( string $value )

A Parameter Map defines an ordered list of values that match up with the "?" placeholders of a standard, parameterized query statement.

A Parameter Map defines an ordered list of values that match up with the "?" placeholders of a standard, parameterized query statement.

Parameters

$value
string
parameter map name.
public string
# getParameterClass( )

Returns

string
parameter class name.
public
# setParameterClass( string $value )

If a ParameterMap setParameterMap() property is not specified, you may specify a ParameterClass instead and use inline parameters. The value of the parameterClass attribute can be any existing PHP class name.

If a ParameterMap setParameterMap() property is not specified, you may specify a ParameterClass instead and use inline parameters. The value of the parameterClass attribute can be any existing PHP class name.

Parameters

$value
string
parameter class name.
public string
# getResultMap( )

Returns

string
result map name.
public
# setResultMap( string $value )

A Result Map lets you control how data is extracted from the result of a query, and how the columns are mapped to object properties.

A Result Map lets you control how data is extracted from the result of a query, and how the columns are mapped to object properties.

Parameters

$value
string
result map name.
public string
# getResultClass( )

Returns

string
result class name.
public
# setResultClass( string $value )

If a ResultMap setResultMap() is not specified, you may specify a ResultClass instead. The value of the ResultClass property can be the name of a PHP class or primitives like integer, string, or array. The class specified will be automatically mapped to the columns in the result, based on the result metadata.

If a ResultMap setResultMap() is not specified, you may specify a ResultClass instead. The value of the ResultClass property can be the name of a PHP class or primitives like integer, string, or array. The class specified will be automatically mapped to the columns in the result, based on the result metadata.

Parameters

$value
string
result class name.
public string
# getCacheModel( )

Returns

string
cache mode name.
public
# setCacheModel( string $value )

Parameters

$value
string
cache mode name.
public TSqlMapCacheModel
# getCache( )

Returns

TSqlMapCacheModel
cache implementation instance for this statement.
public
# setCache( TSqlMapCacheModel $value )

Parameters

$value
TSqlMapCacheModel
cache implementation instance for this statement.
public TStaticSql
# getSqlText( )

Returns

TStaticSql
sql text container.
public
# setSqlText( TStaticSql $value )

Parameters

$value
TStaticSql
sql text container.
public string
# getListClass( )

Returns

string
name of a PHP class that implements ArrayAccess.
public
# setListClass( string $value )

An ArrayAccess class can be specified to handle the type of objects in the collection.

An ArrayAccess class can be specified to handle the type of objects in the collection.

Parameters

$value
string
name of a PHP class that implements ArrayAccess.
public string
# getExtends( )

Returns

string
another statement element name.
public
# setExtends( string $value )

Parameters

$value
string
name of another statement element to extend.
public TResultMap
# resultMap( )

Returns

TResultMap
the result map corresponding to the ResultMap getResultMap() property.
public TParameterMap
# parameterMap( )

Returns

TParameterMap
the parameter map corresponding to the ParameterMap getParameterMap() property.
public
# setInlineParameterMap( TInlineParameterMap $map )

Parameters

$map
TInlineParameterMap
parameter extracted from the sql text.
public
# initialize( TSqlMapManager $manager )

Parameters

$manager
TSqlMapManager
initialize the statement, sets the result and parameter maps.
public ArrayAccess
# createInstanceOfListClass( TSqlMapTypeHandlerRegistry $registry )

Parameters

$registry
TSqlMapTypeHandlerRegistry
type handler registry

Returns

ArrayAccess
new instance of list class.
protected mixed
# createInstanceOf( TSqlMapTypeHandlerRegistry $registry, string $type, array $row = null )

Create a new instance of a given type.

Create a new instance of a given type.

Parameters

$registry
TSqlMapTypeHandlerRegistry
type handler registry
$type
string
result class name.
$row
array
result data.

Returns

mixed
result object.
public mixed
# createInstanceOfResultClass( TSqlMapTypeHandlerRegistry $registry, array $row )

Create a new instance of result class.

Create a new instance of result class.

Parameters

$registry
TSqlMapTypeHandlerRegistry
type handler registry
$row
array
result data.

Returns

mixed
result object.
public
# __sleep( )

Returns an array with the names of all variables of that object that should be serialized. Do not call this method. This is a PHP magic method that will be called automatically prior to any serialization.

Returns an array with the names of all variables of that object that should be serialized. Do not call this method. This is a PHP magic method that will be called automatically prior to any serialization.

Overrides

TComponent::__sleep()
Methods inherited from TComponent
__call(), __construct(), __destruct(), __get(), __isset(), __set(), __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 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