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 TScaffoldBase

Base class for Active Record scaffold views.

Provides common properties for all scaffold views (such as, TScaffoldListView, TScaffoldEditView, TScaffoldListView and TScaffoldView).

During the OnPrRender stage the default css style file (filename style.css) is published and registered. To override the default style, provide your own stylesheet file explicitly.

TComponent
Extended by TApplicationComponent
Extended by TControl implements IRenderable, IBindable
Extended by TCompositeControl implements INamingContainer
Extended by TTemplateControl
Extended by TScaffoldBase

Direct known subclasses

TScaffoldEditView, TScaffoldListView, TScaffoldSearch, TScaffoldView
Abstract
Package: System\Data\ActiveRecord\Scaffold
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/ActiveRecord/Scaffold/TScaffoldBase.php
Methods summary
protected TDbMetaData
# getTableInfo( )

Returns

TDbMetaData
table/view information
protected array
# getRecordPropertyValues( TActiveRecord $record )

Parameters

$record
TActiveRecord
record instance

Returns

array
record property values
protected array
# getRecordPkValues( TActiveRecord $record )

Parameters

$record
TActiveRecord
record instance

Returns

array
record primary key values.
public string
# getRecordClass( )

Name of the Active Record class to be viewed or scaffolded.

Name of the Active Record class to be viewed or scaffolded.

Returns

string
Active Record class name.
public
# setRecordClass( string $value )

Name of the Active Record class to be viewed or scaffolded.

Name of the Active Record class to be viewed or scaffolded.

Parameters

$value
string
Active Record class name.
protected
# copyFrom( TScaffoldBase $obj )

Copy the view details from another scaffold view instance.

Copy the view details from another scaffold view instance.

Parameters

$obj
TScaffoldBase
scaffold view.
protected
# clearRecordObject( )

Unset the current record instance and table information.

Unset the current record instance and table information.

protected TActiveRecord
# getRecordObject( array $pk = null )

Gets the current Active Record instance. Creates new instance if the primary key value is null otherwise the record is fetched from the db.

Gets the current Active Record instance. Creates new instance if the primary key value is null otherwise the record is fetched from the db.

Parameters

$pk
array
primary key value

Returns

TActiveRecord
record instance
protected
# setRecordObject( TActiveRecord $value )

Parameters

$value
TActiveRecord
Active Record instance.
protected TActiveRecord
# getRecordFinder( )

Returns

TActiveRecord
Active Record finder instance
public string
# getDefaultStyle( )

Returns

string
default scaffold stylesheet name
public
# setDefaultStyle( string $value )

Parameters

$value
string
default scaffold stylesheet name
public boolean
# getEnableDefaultStyle( )

Returns

boolean
enable default stylesheet, default is true.
public
# setEnableDefaultStyle( boolean $value )

Parameters

$value
boolean
enable default stylesheet, default is true.
public
# onPreRender( TEventParameter $param )

Publish the default stylesheet file.

Publish the default stylesheet file.

Parameters

$param
TEventParameter
event parameter to be passed to the event handlers

Overrides

TControl::onPreRender()
Methods inherited from TTemplateControl
createChildControls(), getIsSourceTemplateControl(), getMaster(), getMasterClass(), getTemplate(), getTemplateDirectory(), initRecursive(), injectContent(), loadTemplate(), registerContent(), registerContentPlaceHolder(), setMasterClass(), setTemplate()
Methods inherited from TControl
__construct(), __get(), addParsedObject(), addToPostDataLoader(), addedControl(), applyStyleSheetSkin(), autoBindProperty(), autoDataBindProperties(), bindProperty(), broadcastEvent(), bubbleEvent(), clearChildState(), clearControlState(), clearNamingContainer(), clearViewState(), convertUniqueIdToClientId(), createControlCollection(), dataBind(), dataBindChildren(), dataBindProperties(), ensureChildControls(), findControl(), findControlsByID(), findControlsByType(), focus(), getAdapter(), getAllowChildControls(), getAttribute(), getAttributes(), getChildControlsCreated(), getClientID(), getControlStage(), getControlState(), getControls(), getCustomData(), getEnableTheming(), getEnableViewState(), getEnabled(), getHasAdapter(), getHasAttributes(), getHasChildInitialized(), getHasControls(), getHasInitialized(), getHasLoaded(), getHasLoadedPostData(), getHasPreRendered(), getID(), getIsSkinApplied(), getNamingContainer(), getPage(), getParent(), getRegisteredObject(), getSkinID(), getSourceTemplateControl(), getTemplateControl(), getUniqueID(), getViewState(), getVisible(), hasAttribute(), isDescendentOf(), isObjectRegistered(), loadRecursive(), loadState(), loadStateRecursive(), onDataBinding(), onInit(), onLoad(), onUnload(), preRenderRecursive(), raiseBubbleEvent(), registerObject(), removeAttribute(), removedControl(), render(), renderChildren(), renderControl(), saveState(), saveStateRecursive(), setAdapter(), setAttribute(), setChildControlsCreated(), setControlStage(), setControlState(), setCustomData(), setEnableTheming(), setEnableViewState(), setEnabled(), setID(), setPage(), setSkinID(), setTemplateControl(), setViewState(), setVisible(), trackViewState(), traverseChildControls(), unbindProperty(), unloadRecursive(), unregisterObject()
Methods inherited from TApplicationComponent
getApplication(), getRequest(), getResponse(), getService(), getSession(), getUser(), publishAsset(), publishFilePath()
Methods inherited from TComponent
__call(), __destruct(), __isset(), __set(), __sleep(), __unset(), __wakeup(), 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 TTemplateControl
EXT_TEMPLATE
Constants inherited from TControl
AUTOMATIC_ID_PREFIX, CLIENT_ID_SEPARATOR, CS_CHILD_INITIALIZED, CS_CONSTRUCTED, CS_INITIALIZED, CS_LOADED, CS_PRERENDERED, CS_STATE_LOADED, ID_FORMAT, ID_SEPARATOR, IS_CHILD_CREATED, IS_CREATING_CHILD, IS_DISABLE_THEMING, IS_DISABLE_VIEWSTATE, IS_ID_SET, IS_SKIN_APPLIED, IS_STYLESHEET_APPLIED, RF_ADAPTER, RF_AUTO_BINDINGS, RF_CHILD_STATE, RF_CONTROLS, RF_CONTROLSTATE, RF_DATA_BINDINGS, RF_EVENTS, RF_NAMED_CONTROLS, RF_NAMED_CONTROLS_ID, RF_NAMED_OBJECTS, RF_SKIN_ID
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