PHP Class Prado\Data\ActiveRecord\Scaffold\TScaffoldEditView

The RecordClass determines the Active Record class to be edited. A particular record can be edited by specifying the {@link setRecordPk RecordPk} value (may be an array for composite keys). The default editor input controls are created based on the column types. The editor layout can be specified by a renderer by set the value of the {@link setEditRenderer EditRenderer} property to the class name of a class that implements TScaffoldEditRenderer. A renderer is an external template control that implements IScaffoldEditRenderer. The Data of the IScaffoldEditRenderer will be set as the current Active Record to be edited. The UpdateRecord() method of IScaffoldEditRenderer is called when request to save the record is requested. Validators in the custom external editor template should have the {@link TBaseValidator::setValidationGroup ValidationGroup} property set to the value of the {@link getValidationGroup} of the TScaffoldEditView instance (the edit view instance is the Parent of the IScaffoldEditRenderer in most cases. Cosmetic changes to the default editor should be done using Cascading Stylesheets. For example, a particular field/property can be hidden by specifying "display:none" for the corresponding style (each field/property has unique Css class name as "property_xxx", where xxx is the property name).
Since: 3.1
Inheritance: extends TScaffoldBase
Afficher le fichier Open project: pradosoft/prado

Méthodes publiques

Méthode Description
bubbleEvent ( $sender, $param ) Bubble the command name event. Stops bubbling when the page validator false.
getCancelButton ( ) : TButton
getClearButton ( ) : TButton
getEditRenderer ( ) : string
getRecordPk ( ) : array
getSaveButton ( ) : TButton
getValidationGroup ( ) : string
initializeEditForm ( ) Initialize the editor form
onLoad ( $param ) Initialize the editor form if it is Visible.
setEditRenderer ( $value )
setRecordPk ( $value )

Méthodes protégées

Méthode Description
createEditRenderer ( $record, $classPath ) Instantiate the external edit renderer.
createRepeaterEditItem ( $sender, $param ) Initialize the default editor using the scaffold input builder.
doSave ( ) : boolean Check the validators, then tries to save the record.
getCurrentRecord ( ) : TActiveRecord
getInputRepeater ( ) : TRepeater
getScaffoldInputBuilder ( $record ) : TScaffoldInputBase Create the default scaffold editor control factory.

Method Details

bubbleEvent() public méthode

Otherwise, the bubble event is continued.
public bubbleEvent ( $sender, $param )

createEditRenderer() protected méthode

Instantiate the external edit renderer.
protected createEditRenderer ( $record, $classPath )

createRepeaterEditItem() protected méthode

Initialize the default editor using the scaffold input builder.
protected createRepeaterEditItem ( $sender, $param )

doSave() protected méthode

Check the validators, then tries to save the record.
protected doSave ( ) : boolean
Résultat boolean true if the validators are true, false otherwise.

getCancelButton() public méthode

public getCancelButton ( ) : TButton
Résultat TButton Button to cancel the edit action (e.g. hide the edit view).

getClearButton() public méthode

public getClearButton ( ) : TButton
Résultat TButton Button to clear the editor inputs.

getCurrentRecord() protected méthode

protected getCurrentRecord ( ) : TActiveRecord
Résultat TActiveRecord current Active Record instance

getEditRenderer() public méthode

public getEditRenderer ( ) : string
Résultat string the class name for scaffold editor. Defaults to empty, meaning not set.

getInputRepeater() protected méthode

protected getInputRepeater ( ) : TRepeater
Résultat TRepeater default editor input controls repeater

getRecordPk() public méthode

public getRecordPk ( ) : array
Résultat array Active Record primary key value.

getSaveButton() public méthode

public getSaveButton ( ) : TButton
Résultat TButton Button triggered to save the Active Record.

getScaffoldInputBuilder() protected méthode

Create the default scaffold editor control factory.
protected getScaffoldInputBuilder ( $record ) : TScaffoldInputBase
Résultat Prado\Data\ActiveRecord\Scaffold\InputBuilder\TScaffoldInputBase scaffold editor control factory.

getValidationGroup() public méthode

public getValidationGroup ( ) : string
Résultat string editor validation group name.

initializeEditForm() public méthode

Initialize the editor form
public initializeEditForm ( )

onLoad() public méthode

Initialize the editor form if it is Visible.
public onLoad ( $param )

setEditRenderer() public méthode

public setEditRenderer ( $value )

setRecordPk() public méthode

public setRecordPk ( $value )