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 TSqlMapConfig

TSqlMapConfig module configuration class.

Database connection and TSqlMapManager configuration.

TComponent
Extended by TApplicationComponent
Extended by TModule implements IModule
Extended by TDataSourceConfig
Extended by TSqlMapConfig
Package: System\Data\SqlMap
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/TSqlMapConfig.php
Methods summary
public
# clearCache( )

Deletes the configuration cache.

Deletes the configuration cache.

public TSqlMapManager
# getSqlMapManager( )

Create and configure the data mapper using sqlmap configuration file. Or if cache is enabled and manager already cached load from cache. If cache is enabled, the data mapper instance is cached.

Create and configure the data mapper using sqlmap configuration file. Or if cache is enabled and manager already cached load from cache. If cache is enabled, the data mapper instance is cached.

Returns

TSqlMapManager
SqlMap manager instance

Since

3.1.7
protected boolean
# cacheSqlMapManager( mixed $manager )

Saves the current SqlMap manager to cache.

Saves the current SqlMap manager to cache.

Returns

boolean
true if SqlMap manager was cached, false otherwise.
protected TSqlMapManager
# loadCachedSqlMapManager( )

Loads SqlMap manager from cache.

Loads SqlMap manager from cache.

Returns

TSqlMapManager
SqlMap manager intance if load was successful, null otherwise.
public string
# getConfigFile( )

Returns

string
SqlMap configuration file.
public
# setConfigFile( string $value )

Parameters

$value
string
external configuration file in namespace format. The file extension must be '.xml'.

Throws

TConfigurationException
if the file is invalid.
public
# setEnableCache( boolean $value )

Set true to cache sqlmap instances.

Set true to cache sqlmap instances.

Parameters

$value
boolean
true to cache sqlmap instance.
public boolean
# getEnableCache( )

Returns

boolean
true if configuration should be cached, false otherwise.
protected TSqlMapGateway
# createSqlMapGateway( )

Returns

TSqlMapGateway
SqlMap gateway instance.
public TSqlMapGateway
# getClient( )

Initialize the sqlmap if necessary, returns the TSqlMapGateway instance.

Initialize the sqlmap if necessary, returns the TSqlMapGateway instance.

Returns

TSqlMapGateway
SqlMap gateway instance.
Methods inherited from TDataSourceConfig
findConnectionByID(), getConnectionClass(), getConnectionID(), getDatabase(), getDbConnection(), init(), setConnectionClass(), setConnectionID()
Methods inherited from TModule
getID(), setID()
Methods inherited from TApplicationComponent
getApplication(), getRequest(), getResponse(), getService(), getSession(), getUser(), publishAsset(), publishFilePath()
Methods inherited from TComponent
__call(), __construct(), __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
string CONFIG_FILE_EXT '.xml'
#

File extension of external configuration file

File extension of external configuration file

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