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 ()

	loadButtons ()

	finalizeStepByStep ($buttons=NULL, $closeAction=NULL)

	onLoad ()

	isFirstStep ()

	isLastStep ()

	isFirstAccess ($step=NULL)

	cancelButton_click ()

	finalizeButton_click ()

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

	cancelButton ($action=NULL)

	nextStepButton ()

	previousStepButton ()

	finalizeButton ()

	closeButton ($url)

	firstStepButtons ()

	innerStepButtons ()

	lastStepButtons ()

	buttonsDiv ($buttons)

	generate ()

Membros públicos herdados de MForm
	getTitle ()

	setTitle ($title)

	setClose ($action)

	setIcon ($icon)

	getFooter ()

	setFooter ($footer)

	setHelp ($href)

	getData ()

	getAjaxData ()

	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)

	generateFooter ()

	generateInner ()

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

	getCustomFields ($identifier, $customizedId=NULL, $suffix='')

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

	saveCustomFields ($customizedId, $data=null, $identifier=null)

	searchCustomFieldValues ($identifier)

	getCustomFieldValues ()

	deleteCustomFieldValues ($customizedId)

Membros públicos herdados de MBaseForm
	__construct ($action='')

	__set ($name, $value)

	__get ($name)

	isAjaxCall ()

	registerMethod ()

	addValidator ($validator)

	setValidators ($validators)

	setAjaxFields ($fields, $responseControl)

	isSubmitted ()

	setAlternate ($color0, $color1)

	setFocus ($fieldName)

	getFormFields ()

	getFormValue ($name, $value=NULL)

	setFormValue ($name, $value)

	onSubmit ($jscode)

	addJsCode ($jscode)

	setAction ($action)

	setFields ($fields)

	addField ($field, $hint=false)

	addFields ($fields)

	addButton ($button)

	setButtons ($buttons)

	setButtonLabel ( $index, $label)

	showReturn ( $state)

	setShowReturnButton ( $state)

	setShowPostButton ( $state)

	showReset ( $state)

	setShowResetButton ( $state)

	getShowHints ()

	setShowHints ( $state)

	showHints ( $state)

	getFieldList ()

	clearFields ()

	clearField ($name)

	clearButtons ()

	validate ()

	error ( $err)

	addError ($err)

	hasErrors ()

	addInfo ($info)

	hasInfos ()

	addAlert ($alert)

	hasAlerts ()

	collectInput ($data)

	setData (MBusiness $data)

&	getField ($name)

&	getButton ($name)

&	getPage ()

	setResponse ($controls, $element='', $generateFormLayout=false)

	getCloseWindow ()

	setLabelWidth ($width)

	setFieldsReadOnly ($readOnly=true)

	setFieldReadOnly ($field, $readOnly=true)

	submit_button ()

	generateErrors ()

	generateInfos ()

	generateAlerts ()

	generateBody ()

	generateLayoutFields (&$hidden)

	getFieldValidator ($name)

	generateLayoutField ($f, &$hidden=array())

	setJsValidationEnabled ($jsValidationEnabled)

	getJsValidationEnabled ()

	generateButtons ()

	generateHiddenFields ($hidden)

	generateScript ()

Membros públicos herdados de MContainerControl
	__clone ()

	addControl ($control)

	insertControl ($control, $pos=0)

	setControl ($control, $pos=0)

	setControls ($controls)

	getControls ()

	getControl ($pos)

	getControlById ($id)

	findControlById ($id)

	setControlById ($control, $id)

	clearControls ()

Membros públicos herdados de MControl
	setName ($name)

	setId ($id)

	getId ()

	getName ()

	getUniqueId ()

	setClass ($cssClass, $add=TRUE)

	insertClass ( $cssClass)

	addStyleFile ( $styleFile)

	getClass ()

	addStyle ($name, $value)

	setStyle ($style)

	getStyle ()

	getBoxStyle ()

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

	setColor ($value)

	setVisibility ($value)

	setFont ($value)

	getBox ()

	setBoxId ( $id)

	setBoxClass ( $cssClass, $add=true)

	getBoxClass ()

	setBoxAttributes ($attr)

	getBoxAttributes ()

	generateBox ( $content)

	addAttribute ( $name, $value='')

	setAttribute ( $name, $value)

	getAttribute ( $name)

	setAttributes ($attr)

	attributes ( $mergeDuplicates=false)

	getAttributes ( $mergeDuplicates=false)

	setReadOnly ($status)

	setEnabled ($state)

	setJsHint ( $hint)

	setHint ( $hint)

	setCaption ($caption)

	setHTMLTitle ($title)

	addBoxStyle ($name, $value)

	eventHandler ()

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

	addEvent ($event, $handler, $preventDefault=true)

	hasEvent ($event)

	generateEvent ()

	setContent ($inner)

	setInner ($inner)

	getInner ()

	getRender ( $method)

	getInnerToString ()

	getCSSP ()

	__toString ()

Membros públicos herdados de MComponent
	getManager ()

Membros públicos estáticos
static	getCurrentStep ()

static	setCurrentStep ($step)

static	getShowImageOnButtons ()

static	setShowImageOnButtons ($showImageOnButtons)

static	setDefaultButtons ($defaultButtons)

static	getDefaultButtons ()

Campos de Dados
	$steps

	$step

	$nextStep

	$stepName

	$prevStep

	$data

	$stepButtons = array()

	$controlButtons

const	BUTTONS_DIV_ID = 'stepButtonsDiv'

const	BUTTONS_DIV_STYLE = 'mStepbystepButtons'

const	BUTTONS_DIV_IMG_STYLE = 'mStepbystepButtonsImg'

const	CANCEL_BUTTON_ID = 'cancelButton'

const	PREVIOUS_STEP_BUTTON_ID = 'previousStepButton'

const	NEXT_STEP_BUTTON_ID = 'nextStepButton'

const	FINALIZE_BUTTON_ID = 'finalizeButton'

const	CLOSE_BUTTON_ID = 'closeButton'

Campos de Dados herdados de MForm
	$formBox

	$title

	$help

	$footer

	$bgColor

	$align = NULL

	$mioloCustomFields

	$mioloCustomizedId

Campos de Dados herdados de MBaseForm
	$method

	$buttons

	$fields = array()

	$return

	$reset

	$styles

	$width

	$enctype

	$validations

	$defaultButton

	$errors = array()

	$infos = array()

	$alerts = array()

	$layout

	$zebra = false

	$labelWidth = NULL

	$focus = ''

	$ajax

	$cp

	$cssForm = false

	$cssButtons

Campos de Dados herdados de MContainerControl
	$controls

	$controlsId

Campos de Dados herdados de MControl
	$id

	$uniqueId

	$enabled

	$style

	$attrs

	$attributes

	$maintainState

	$readonly

	$visible

	$caption

	$jsHint

	$hint

	$cssp

	$inner

	$parent

	$eventHandlers

	$painter

	$event

	$formId

const	ALIGN_CENTER = 'center'

const	ALIGN_LEFT = 'left'

const	ALIGN_RIGHT = 'right'

const	FORM_MODE_WHOLE_ROW = 0

const	FORM_MODE_SHOW_SIDE = 1

const	FORM_MODE_SHOW_ABOVE = 2

const	FORM_MODE_SHOW_NBSP = 3

	$formMode

Campos de Dados herdados de MComponent
	$manager

	$page

	$owner

	$name

	$className

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

static	$fieldNum = 0

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

Membros protegidos herdados de MForm
	normalizaCamposCustomizados ($customFields)

Membros protegidos herdados de MBaseForm
	_getFormFieldValue ($field)

Membros protegidos herdados de MContainerControl
	_AddControl ($control, $pos=0, $op='add')

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

Atributos Protegidos herdados de MBaseForm
	$action

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/11/08

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

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

Reimplementado de MForm.

Documentação das funções

◆ buttonsDiv()

buttonsDiv ( $buttons )

Parâmetros

array $buttons MButton array

Retorna: MDiv Default buttons div

◆ cancelButton()

cancelButton ( $action = NULL )

Retorna: MButton Default cancel button

◆ cancelButton_click()

cancelButton_click ( )

Method called on cancel button action

◆ cleanStepData()

cleanStepData ( $step = null )

Clean the data of one step or of all steps

Parâmetros

integer $step Step number

◆ closeButton()

closeButton ( $url )

Retorna: MButton Default close button.

◆ createFields()

createFields ( )

Brief Description. Complete Description.

Retorna: (tipo) desc

Reimplementado de MBaseForm.

◆ finalizeButton()

finalizeButton ( )

Retorna: MButton Default finalize button

◆ finalizeButton_click()

finalizeButton_click ( )

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

◆ finalizeStepByStep()

finalizeStepByStep	(		$buttons = NULL,
			$closeAction = 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
string	$closeAction	Close button action.

◆ firstStepButtons()

firstStepButtons ( )

Retorna: array Default buttons for the first step

◆ generate()

generate ( )

Reimplementado de MDiv.

◆ getAllStepData()

getAllStepData ( )

Gets steps data from session and unserialize it

Retorna: array Unserialized data array

◆ getCurrentStep()

static getCurrentStep ( )

static

Retorna: integer Returns the current step

◆ getDefaultButtons()

static getDefaultButtons ( )

static

Retorna: boolean Returns if the default buttons must be shown

◆ getShowImageOnButtons()

static getShowImageOnButtons ( )

static

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

◆ 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

◆ getStepName()

getStepName ( )

Retorna: string Returns the step name

◆ gotoStep()

gotoStep ( $step )

Redirects the user to the given step

Parâmetros

integer $step Step number

◆ innerStepButtons()

innerStepButtons ( )

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

◆ 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

◆ isFirstStep()

isFirstStep ( )

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

◆ isLastStep()

isLastStep ( )

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

◆ lastStepButtons()

lastStepButtons ( )

Retorna: array Default buttons for the last step

◆ loadButtons()

loadButtons ( )

Create control buttons based on the current step

◆ nextStepButton()

nextStepButton ( )

Retorna: MButton Default next step button

◆ nextStepButton_click()

nextStepButton_click ( )

Saves the step data and redirects to the next step

◆ objectToArray()

objectToArray ( $object )

Converts an object to array

Parâmetros

object Object

Retorna: array Array

◆ onLoad()

onLoad ( )

Loads the data automatically It is called after createFields

Reimplementado de MBaseForm.

◆ 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

◆ previousStepButton()

previousStepButton ( )

Retorna: MButton Default previous step button

◆ previousStepButton_click()

previousStepButton_click ( )

Saves the step data and redirects to the previous step

◆ 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

◆ setAllStepData()

setAllStepData ( $stepData )

Saves data from all steps on session

Parâmetros

array $stepData Data from all the steps

◆ setCurrentStep()

static setCurrentStep ( $step )

static

Parâmetros

integer $step Sets the current step

◆ setDefaultButtons()

static setDefaultButtons ( $defaultButtons )

static

Parâmetros

boolean $defaultButtons Sets if the default buttons must be shown

◆ setShowImageOnButtons()

static setShowImageOnButtons ( $showImageOnButtons )

static

Parâmetros

boolean $showImageOnButtons Sets to show image on buttons or not

◆ setStepData()

setStepData	(		$data,
			$step = null )

Sets data on the given step

Parâmetros

object	$data	Data object
integer	$step	Step number

◆ setStepName()

setStepName ( $stepName )

Parâmetros

string $stepName Sets the step name

Documentação dos campos e atributos

◆ $controlButtons

$controlButtons

◆ $data

$data

◆ $nextStep

$nextStep

◆ $prevStep

$prevStep

◆ $step

$step

◆ $stepButtons

$stepButtons = array()

◆ $stepName

$stepName

◆ $steps

$steps

◆ BUTTONS_DIV_ID

const BUTTONS_DIV_ID = 'stepButtonsDiv'

◆ BUTTONS_DIV_IMG_STYLE

const BUTTONS_DIV_IMG_STYLE = 'mStepbystepButtonsImg'

◆ BUTTONS_DIV_STYLE

const BUTTONS_DIV_STYLE = 'mStepbystepButtons'

◆ CANCEL_BUTTON_ID

const CANCEL_BUTTON_ID = 'cancelButton'

Ids for buttons.

◆ CLOSE_BUTTON_ID

const CLOSE_BUTTON_ID = 'closeButton'

◆ FINALIZE_BUTTON_ID

const FINALIZE_BUTTON_ID = 'finalizeButton'

◆ NEXT_STEP_BUTTON_ID

const NEXT_STEP_BUTTON_ID = 'nextStepButton'

◆ PREVIOUS_STEP_BUTTON_ID

const PREVIOUS_STEP_BUTTON_ID = 'previousStepButton'

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

classes/ui/controls/mstepbystepform.class.php

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()

◆ closeButton()

◆ createFields()

◆ finalizeButton()

◆ finalizeButton_click()

◆ finalizeStepByStep()

◆ firstStepButtons()

◆ generate()

◆ getAllStepData()

◆ getCurrentStep()

◆ getDefaultButtons()

◆ getShowImageOnButtons()

◆ getStepData()

◆ getStepName()

◆ gotoStep()

◆ innerStepButtons()

◆ isFirstAccess()

◆ isFirstStep()

◆ isLastStep()

◆ lastStepButtons()

◆ loadButtons()

◆ nextStepButton()

◆ nextStepButton_click()

◆ objectToArray()

◆ onLoad()

◆ prepareData()

◆ previousStepButton()

◆ previousStepButton_click()

◆ redirect()

◆ setAllStepData()

◆ setCurrentStep()

◆ setDefaultButtons()

◆ setShowImageOnButtons()

◆ setStepData()

◆ setStepName()

Documentação dos campos e atributos

◆ $controlButtons

◆ $data

◆ $nextStep

◆ $prevStep

◆ $step

◆ $stepButtons

◆ $stepName

◆ $steps

◆ BUTTONS_DIV_ID

◆ BUTTONS_DIV_IMG_STYLE

◆ BUTTONS_DIV_STYLE

◆ CANCEL_BUTTON_ID

◆ CLOSE_BUTTON_ID

◆ FINALIZE_BUTTON_ID

◆ NEXT_STEP_BUTTON_ID

◆ PREVIOUS_STEP_BUTTON_ID