Diagrama de heranças da classe MStepByStepForm

Membros públicos
	__construct ($title, $steps=NULL, $step=NULL, $nextStep=NULL)

	createFields ()

	nextStepButton_click ()

	previousStepButton_click ()

	gotoStep ($step)

	objectToArray ($object)

	getStepName ()

	setStepName ($stepName)

	setStepData ($data, $step=null)

	getStepData ($step=null, $returnAsObject=true)

	cleanStepData ($step=null)

	prepareData ($data=null, $step=null)

	setAllStepData ($stepData)

	getAllStepData ()

	getButtons ()

	finalizeStepByStep ($buttons=NULL)

	onLoad ()

	isFirstStep ()

	isLastStep ()

	isFirstAccess ($step=NULL)

	cancelButton_click ($args)

	finalizeButton_click ($args)

	redirect ($module, $action, $args=NULL)

	cancelButton ()

	nextStepButton ()

	previousStepButton ()

	finalizeButton ()

	firstStepButtons ()

	innerStepButtons ()

	lastStepButtons ()

	buttonsDiv ($buttons)

Membros públicos herdados de MForm
	__construct ($title='', $action='', $close='', $icon='', $help='')

	getRandomField ()

	setRandomField ()

	__set ($name, $value)

	__get ($name)

	getValidations ()

	setValidations ($validations)

	OnLoad ()

	CreateFields ()

	AddValidator ($validator)

	getFormControlFields ()

	getFieldFromFields ($fieldName, $fields)

	SetValidators ($validators)

	IsSubmitted ()

	GetTitle ()

	SetTitle ($title)

	SetClose ($action)

	SetIcon ($icon)

	SetAlternate ($color0, $color1)

	GetFooter ()

	SetFooter ($footer)

	GetFormFields ()

	_GetFormFieldValue ($field)

	GetFormValue ($name=null, $value=NULL)

	SetFormValue ($name, $value)

	OnSubmit ($jscode)

	AddJsCode ($jscode)

	SetAction ($action)

	setHelp ($help, $module=null, $action=null)

	SetFields (&$fields)

	AddField ($field, $hint=false)

	AddFields ($fields)

	AddButton ($btn)

	SetButtons ($btn)

	setButtonLabel ( $index, $label)

	showReturn ( $state)

	setShowReturnButton ( $state)

	setShowPostButton ( $state)

	showReset ( $state)

	setShowResetButton ( $state)

	showHints ($state)

	GetFieldList ()

	ClearFields ()

	ClearButtons ()

	validateAll ( $assert=true)

	validateRequiredFields ( $assert=true)

	validate ( $required, $assert=true, $args=NULL)

	Error ( $err)

	AddError ($err)

	HasErrors ()

	AddInfo ($info)

	HasInfos ()

	AddAlert ($alert)

	HasAlerts ()

	CollectInput ($data)

	getData ()

	getRequestData ()

	SetData ($data)

	GetFieldValue ($name, $value=false)

	SetFieldValue ($name, $value)

	SetFieldValidator ($name, $value)

&	GetField ($name)

&	GetButton ($name)

&	GetPage ()

	SetPage (&$page)

	SetFieldAttr ($name, $attr, $value)

	GetFieldAttr ($name, $attr, $index=NULL)

	SetButtonAttr ($name, $attr, $value)

	SetFieldCSS ($name, $top, $left, $width=NULL, $position='absolute')

	SetFormCSS ($height=0, $width=0, $top=0, $left=0, $buttons=0, $position='absolute')

	SetBackgroundColor ($bgcolor)

	SetAlign ($value)

	SetWidth ($width=NULL)

	SetHeight ($height=NULL)

	SetLabelWidth ($width)

	GenerateErrors ()

	GenerateInfos ()

	GenerateAlerts ()

	GenerateBody ()

	GenerateFooter ()

	GenerateLayoutFields (&$hidden)

	generateValidators ($fields)

	getFieldValidator ($name)

	getFieldValidators ($name)

	removeAJAXValidator ($fieldId)

	GenerateLayoutField ($field, &$hidden)

	GenerateButtons ()

	GenerateHiddenFields ($hidden)

	GenerateScript ()

	generateAJAXValidators ()

	Generate ()

	getGridQuery ($gridName)

	getGridData ($gridName)

	addCustomFields ($identifier, $customizedId=NULL, $suffix='', $somenteComActionUrl=false)

	getCustomFields ($identifier, $customizedId=NULL, $suffix='', $somenteComActionUrl=false, $step=null)

	generateCustomFields ($mioloCustomFields=array(), $data=null, $suffix=null)

	saveCustomFields ($customizedId, $data=null, $identifier=null, $somenteComActionUrl=false, $cfId=null)

	searchCustomFieldValues ($identifier, $returnSql=false, $onlyCustomizedid=false, $filters=null)

	getCustomFieldValues ()

	deleteCustomFieldValues ($customizedId)

Membros públicos herdados de MControl
	__construct ( $name=NULL)

	__clone ()

	setReadOnly ($status)

	setEnabled ($state)

	setName ($name)

	setId ($id)

	setNameAndId ($name)

	getId ()

	getName ()

	getUniqueId ()

	setClass ( $cssClass, $add=true)

	addStyleFile ( $styleFile)

	getClass ()

	addStyle ($name, $value)

	setStyle ($style)

	getStyle ()

	addAttribute ( $name, $value='')

	setTooltip ($title, $placement=self::TOOLTIP_PLACEMENT_AUTO)

	setAttribute ( $name, $value)

	setAttributes ($attr)

	attributes ( $mergeDuplicates=false)

	getAttributes ( $mergeDuplicates=false)

	setFormMode ( $mode)

	setJsHint ( $hint)

	setPosition ($left, $top, $position='absolute')

	setWidth ($value)

	setHeight ($value)

	setColor ($value)

	setVisibility ($value)

	setFont ($value)

	setCaption ($caption)

	setInner ($inner)

	getInner ()

	addControl ($control)

	insertControl ($control, $pos=0, $width=null, $float=null)

	setControl ($control, $pos=0)

	setControls ($controls)

	getControls ()

	getControl ($pos)

	getControlById ($id)

	findControlById ($id)

	setControlById ($control, $id)

	clearControls ()

	eventHandler ()

	attachEventHandler ( $name, $handler, $param=NULL)

	getBox ()

	setBoxId ( $id)

	setBoxClass ( $cssClass, $add=true)

	getBoxClass ()

	setBoxAttributes ($attr)

	getBoxAttributes ()

	addBoxStyle ($name, $value='')

	generateBox ( $content)

	getRender ( $method)

	getInnerToString ()

	generateInner ()

	generate ()

Membros públicos herdados de MComponent
	SetName ($name)

	GetName ()

	AddComponent ($component)

	InsertComponent ($component, $pos=0)

	SetComponent ($component, $pos)

	SetComponents ($components)

	GetComponents ()

	GetComponent ($pos)

	ClearComponents ()

Membros públicos estáticos
static	getCurrentStep ()

static	setCurrentStep ($step)

static	getShowImageOnButtons ()

static	setShowImageOnButtons ($showImageOnButtons)

static	setDefaultButtons ($defaultButtons)

static	getDefaultButtons ()

Membros públicos estáticos herdados de MForm
static	getShowHints ()

static	setShowHints ($state)

static	expansibleText ($labelExpand, $labelCollapse, $text)

static	normalizaActionParaConsulta ($action)

Campos de Dados
	$steps

	$step

	$nextStep

	$stepName

	$prevStep

	$data

const	BUTTONS_DIV_ID = 'stepButtonsDiv'

const	BUTTONS_DIV_STYLE = 'm-stepbystep-buttons'

const	BUTTONS_DIV_IMG_STYLE = 'm-stepbystep-buttons-img'

Campos de Dados herdados de MForm
	$title

	$action

	$method

	$buttons

	$fields =array()

	$return

	$reset

	$styles

	$help

	$footer

	$width

	$enctype

	$validations

	$defaultButton

	$errors

	$infos

	$alerts

	$box

	$layout

	$cssForm = false

	$cssButtons

	$zebra = false

	$labelWidth = NULL

	$bgColor = NULL

	$align = NULL

	$mioloCustomFields

	$mioloCustomizedId

Campos de Dados herdados de MControl
const	FORM_MODE_WHOLE_ROW = 0

const	FORM_MODE_SHOW_SIDE = 1

const	FORM_MODE_SHOW_ABOVE = 2

const	FORM_MODE_SHOW_NBSP = 3

const	CLASS_CAPTION = 'm-caption'

const	CLASS_CAPTION_REQUIRED = 'm-caption-required'

const	TOOLTIP_PLACEMENT_BOTTOM = 'bottom'

const	TOOLTIP_PLACEMENT_TOP = 'top'

const	TOOLTIP_PLACEMENT_LEFT = 'left'

const	TOOLTIP_PLACEMENT_RIGHT = 'right'

const	TOOLTIP_PLACEMENT_AUTO = 'auto'

	$id

	$uniqueId

	$cssClass

	$enabled

	$style

	$visible

	$attrs

	$attributes

	$formMode

	$maintainState

	$readonly

	$caption

	$jsHint

	$inner

	$controlBox

	$box

	$cssp

	$parent

	$controls

	$controlsId

	$eventHandlers

	$painter

Campos de Dados herdados de MComponent
	$manager

	$page

	$owner

	$components

	$componentCount

	$name

	$className

Outros membros herdados
Atributos Públicos Estáticos herdados de MForm
static	$showHints = true

static	$fieldNum = 0

Atributos Públicos Estáticos herdados de MControl
static	$_number = 0

Membros protegidos herdados de MForm
	getGrid ($campos=array(), $gridName=NULL)

	procuraGrid ($field, $gridName)

	getCamposConformeContainer ($field)

	normalizaCamposCustomizados ($customFields)

Membros protegidos herdados de MControl
	_AddStyle ($name, $value)

Descrição detalhada

MStepByStep Class Form with a step by step logic

Autor: Daniel Hartmann [danie.nosp@m.l@so.nosp@m.lis.c.nosp@m.oop..nosp@m.br]; Jonas Guilherme Dahmer [jonas.nosp@m.@sol.nosp@m.is.co.nosp@m.op.b.nosp@m.r]

Versão: $id$

Maintainers:
Armando Taffarel Neto [taffa.nosp@m.rel@.nosp@m.solis.nosp@m..coo.nosp@m.p.br] Daniel Hartmann [danie.nosp@m.l@so.nosp@m.lis.c.nosp@m.oop..nosp@m.br]

Desde: Creation date 2010/09/23

Organization:
SOLIS - Cooperativa de Soluções Livres
CopyRight:
Copyright (c) 2010 SOLIS - Cooperativa de Soluções Livres
License:
Licensed under GPLv2 (for further details read the COPYING file or http://www.gnu.org/licenses/gpl.html)

History:
See history in CVS repository: http://www.miolo.org.br

Definido na linha 33 do ficheiro mstepbystepform.class.

Documentação dos Construtores & Destrutor

◆ __construct()

__construct	(	$title,
		$steps = NULL,
		$step = NULL,
		$nextStep = NULL )

MStepByStepForm construct method

Parâmetros

string	$title	Form title
array	$steps	Form steps
integer	$step	Current step
integer	$nextStep	Next step

Definido na linha 56 do ficheiro mstepbystepform.class.

Documentação das funções

◆ buttonsDiv()

buttonsDiv ( $buttons )

Parâmetros

array $buttons MButton array

Retorna: MDiv Default buttons div

Definido na linha 654 do ficheiro mstepbystepform.class.

◆ cancelButton()

cancelButton ( )

Retorna: MButton Default cancel button

Definido na linha 581 do ficheiro mstepbystepform.class.

◆ cancelButton_click()

cancelButton_click ( $args )

Method called on cancel button action

Definido na linha 544 do ficheiro mstepbystepform.class.

◆ cleanStepData()

cleanStepData ( $step = null )

Clean the data of one step or of all steps

Parâmetros

integer $step Step number

Definido na linha 299 do ficheiro mstepbystepform.class.

◆ createFields()

createFields ( )

Definido na linha 71 do ficheiro mstepbystepform.class.

◆ finalizeButton()

finalizeButton ( )

Retorna: MButton Default finalize button

Definido na linha 617 do ficheiro mstepbystepform.class.

◆ finalizeButton_click()

finalizeButton_click ( $args )

Method called on finalize button action This is an example method. You must override it to save the form data

Definido na linha 554 do ficheiro mstepbystepform.class.

◆ finalizeStepByStep()

finalizeStepByStep ( $buttons = NULL )

Finalizes the step by step, by changing the buttons with the specified ones (or with a default close button) and disabling the step buttons

Parâmetros

array $buttons Array with buttons (MButton) to be displayed

Definido na linha 427 do ficheiro mstepbystepform.class.

◆ firstStepButtons()

firstStepButtons ( )

Retorna: MDiv Default buttons for the first step

Definido na linha 629 do ficheiro mstepbystepform.class.

◆ getAllStepData()

getAllStepData ( )

Gets steps data from session and unserialize it

Retorna: array Unserialized data array

Definido na linha 359 do ficheiro mstepbystepform.class.

◆ getButtons()

getButtons ( )

Returns a div with buttons based on the current step

Retorna: MDiv A div with a MButton array

Definido na linha 403 do ficheiro mstepbystepform.class.

◆ getCurrentStep()

static getCurrentStep ( )

static

Retorna: integer Returns the current step

Definido na linha 369 do ficheiro mstepbystepform.class.

◆ getDefaultButtons()

static getDefaultButtons ( )

static

Retorna: boolean Returns if the default buttons must be shown

Definido na linha 471 do ficheiro mstepbystepform.class.

◆ getShowImageOnButtons()

static getShowImageOnButtons ( )

static

Retorna: boolean Returns if it is set to show image on buttons or not

Definido na linha 385 do ficheiro mstepbystepform.class.

◆ getStepData()

getStepData	(		$step = null,
			$returnAsObject = true )

Returns the given step data, or all steps data, if $step is null

Parâmetros

integer	$step	Step number
boolean	$returnAsObject	Sets the return type

Retorna: unknown Returns an object if $returnAsObject is true and an array if false

Definido na linha 256 do ficheiro mstepbystepform.class.

◆ getStepName()

getStepName ( )

Retorna: string Returns the step name

Definido na linha 224 do ficheiro mstepbystepform.class.

◆ gotoStep()

gotoStep ( $step )

Redirects the user to the given step

Parâmetros

integer $step Step number

Definido na linha 192 do ficheiro mstepbystepform.class.

◆ innerStepButtons()

innerStepButtons ( )

Retorna: MDiv Default buttons for steps between the first and the last

Definido na linha 637 do ficheiro mstepbystepform.class.

◆ isFirstAccess()

isFirstAccess ( $step = NULL )

Checks on session if the data of the given step was already set

Parâmetros

$step The step number. If not informed, it uses the current step

Retorna: boolean True if data was already set

Definido na linha 523 do ficheiro mstepbystepform.class.

◆ isFirstStep()

isFirstStep ( )

Retorna: boolean Returns true if current step is the first step

Definido na linha 496 do ficheiro mstepbystepform.class.

◆ isLastStep()

isLastStep ( )

Retorna: boolean Returns true if the current step is the last step

Definido na linha 511 do ficheiro mstepbystepform.class.

◆ lastStepButtons()

lastStepButtons ( )

Retorna: MDiv Default buttons for the last step

Definido na linha 645 do ficheiro mstepbystepform.class.

◆ nextStepButton()

nextStepButton ( )

Retorna: MButton Default next step button

Definido na linha 593 do ficheiro mstepbystepform.class.

◆ nextStepButton_click()

nextStepButton_click ( )

Saves the step data and redirects to the next step

Definido na linha 152 do ficheiro mstepbystepform.class.

◆ objectToArray()

objectToArray ( $object )

Converts an object to array

Parâmetros

object Object

Retorna: array Array

Definido na linha 204 do ficheiro mstepbystepform.class.

◆ onLoad()

onLoad ( )

Loads the data automatically It is called after createFields

Definido na linha 480 do ficheiro mstepbystepform.class.

◆ prepareData()

prepareData	(		$data = null,
			$step = null )

Prepares the step data (current step, if none is informed) to put them on session

Parâmetros

unknown	$data	Array or object
integer	$step	Step number

Definido na linha 320 do ficheiro mstepbystepform.class.

◆ previousStepButton()

previousStepButton ( )

Retorna: MButton Default previous step button

Definido na linha 605 do ficheiro mstepbystepform.class.

◆ previousStepButton_click()

previousStepButton_click ( )

Saves the step data and redirects to the previous step

Definido na linha 169 do ficheiro mstepbystepform.class.

◆ redirect()

redirect	(	$module,
		$action,
		$args = NULL )

Redirects the page to the given action of the given module, with the given arguments

Parâmetros

string	$module	Module
string	$action	Action
array	$args	Arguments

Definido na linha 571 do ficheiro mstepbystepform.class.

◆ setAllStepData()

setAllStepData ( $stepData )

Saves data from all steps on session

Parâmetros

array $stepData Data from all the steps

Definido na linha 347 do ficheiro mstepbystepform.class.

◆ setCurrentStep()

static setCurrentStep ( $step )

static

Parâmetros

integer $step Sets the current step

Definido na linha 377 do ficheiro mstepbystepform.class.

◆ setDefaultButtons()

static setDefaultButtons ( $defaultButtons )

static

Parâmetros

boolean $defaultButtons Sets if the default buttons must be shown

Definido na linha 463 do ficheiro mstepbystepform.class.

◆ setShowImageOnButtons()

static setShowImageOnButtons ( $showImageOnButtons )

static

Parâmetros

boolean $showImageOnButtons Sets to show image on buttons or not

Definido na linha 393 do ficheiro mstepbystepform.class.

◆ setStepData()

setStepData	(		$data,
			$step = null )

Sets data on the given step

Parâmetros

object	$data	Data object
integer	$step	Step number

Definido na linha 243 do ficheiro mstepbystepform.class.

◆ setStepName()

setStepName ( $stepName )

Parâmetros

string $stepName Sets the step name

Definido na linha 232 do ficheiro mstepbystepform.class.

Documentação dos campos e atributos

◆ $data

$data

Definido na linha 40 do ficheiro mstepbystepform.class.

◆ $nextStep

$nextStep

Definido na linha 37 do ficheiro mstepbystepform.class.

◆ $prevStep

$prevStep

Definido na linha 39 do ficheiro mstepbystepform.class.

◆ $step

$step

Definido na linha 36 do ficheiro mstepbystepform.class.

◆ $stepName

$stepName

Definido na linha 38 do ficheiro mstepbystepform.class.

◆ $steps

$steps

Definido na linha 35 do ficheiro mstepbystepform.class.

◆ BUTTONS_DIV_ID

const BUTTONS_DIV_ID = 'stepButtonsDiv'

Definido na linha 44 do ficheiro mstepbystepform.class.

◆ BUTTONS_DIV_IMG_STYLE

const BUTTONS_DIV_IMG_STYLE = 'm-stepbystep-buttons-img'

Definido na linha 46 do ficheiro mstepbystepform.class.

◆ BUTTONS_DIV_STYLE

const BUTTONS_DIV_STYLE = 'm-stepbystep-buttons'

Definido na linha 45 do ficheiro mstepbystepform.class.

A documentação para esta classe foi gerada a partir do seguinte ficheiro:

/var/docker/solisge-devel/www/solisge/miolo20/classes/ui/controls/mstepbystepform.class

Membros públicos

Membros públicos estáticos

Campos de Dados

Outros membros herdados

Descrição detalhada

Documentação dos Construtores & Destrutor

◆ __construct()

Documentação das funções

◆ buttonsDiv()

◆ cancelButton()

◆ cancelButton_click()

◆ cleanStepData()

◆ createFields()

◆ finalizeButton()

◆ finalizeButton_click()

◆ finalizeStepByStep()

◆ firstStepButtons()

◆ getAllStepData()

◆ getButtons()

◆ getCurrentStep()

◆ getDefaultButtons()

◆ getShowImageOnButtons()

◆ getStepData()

◆ getStepName()

◆ gotoStep()

◆ innerStepButtons()

◆ isFirstAccess()

◆ isFirstStep()

◆ isLastStep()

◆ lastStepButtons()

◆ nextStepButton()

◆ nextStepButton_click()

◆ objectToArray()

◆ onLoad()

◆ prepareData()

◆ previousStepButton()

◆ previousStepButton_click()

◆ redirect()

◆ setAllStepData()

◆ setCurrentStep()

◆ setDefaultButtons()

◆ setShowImageOnButtons()

◆ setStepData()

◆ setStepName()

Documentação dos campos e atributos

◆ $data

◆ $nextStep

◆ $prevStep

◆ $step

◆ $stepName

◆ $steps

◆ BUTTONS_DIV_ID

◆ BUTTONS_DIV_IMG_STYLE

◆ BUTTONS_DIV_STYLE