MIOLO20
Carregando...
Procurando...
Nenhuma entrada encontrada
Referência à classe MForm
Diagrama de heranças da classe MForm
MControl MComponent Form MCSSForm MCSSPForm MCompoundForm MIndexedForm MStepByStepForm MTabbedForm MTabbedForm2

Membros públicos

 __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 getShowHints ()
 
static setShowHints ($state)
 
static expansibleText ($labelExpand, $labelCollapse, $text)
 
static normalizaActionParaConsulta ($action)
 

Campos de Dados

 $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
 

Atributos Públicos Estáticos

static $showHints = true
 
static $fieldNum = 0
 
- Atributos Públicos Estáticos herdados de MControl
static $_number = 0
 

Membros protegidos

 getGrid ($campos=array(), $gridName=NULL)
 
 procuraGrid ($field, $gridName)
 
 getCamposConformeContainer ($field)
 
 normalizaCamposCustomizados ($customFields)
 
- Membros protegidos herdados de MControl
 _AddStyle ($name, $value)
 

Descrição detalhada

Brief Class Description. Complete Class Description.

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

Definido na linha 8 do ficheiro mform.class.

Documentação dos Construtores & Destrutor

◆ __construct()

__construct ( $title = '',
$action = '',
$close = '',
$icon = '',
$help = '' )

This is the constructor of the Form class. It takes a title and an action url as optional parameters. The action URL is typically obtained by calling the MIOLO->GetActionURL() method.

Parâmetros
$title(string) the form's title string
$action(string) the URL for the forms ACTION attribute.
Exemplos
/var/docker/solisge-devel/www/solisge/miolo20/classes/ui/controls/mform.class.

Definido na linha 155 do ficheiro mform.class.

Documentação das funções

◆ __get()

__get ( $name)

Brief Description. Complete Description.

Parâmetros
$name(tipo) desc
Retorna
(tipo) desc

Reimplementado de MControl.

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

Definido na linha 236 do ficheiro mform.class.

◆ __set()

__set ( $name,
$value )

Brief Description. Complete Description.

Parâmetros
$name(tipo) desc
$value(tipo) desc
Retorna
(tipo) desc

Reimplementado de MControl.

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

Definido na linha 220 do ficheiro mform.class.

◆ _GetFormFieldValue()

_GetFormFieldValue ( $field)

Brief Description. Complete Description.

Parâmetros
$field(tipo) desc
Retorna
(tipo) desc
Exemplos
/var/docker/solisge-devel/www/solisge/miolo20/classes/ui/controls/mform.class.

Definido na linha 557 do ficheiro mform.class.

◆ AddAlert()

AddAlert ( $alert)

Brief Description. Complete Description.

Parâmetros
$alert(tipo) desc
Retorna
(tipo) desc
Exemplos
/var/docker/solisge-devel/www/solisge/miolo20/classes/ui/controls/mform.class.

Definido na linha 1391 do ficheiro mform.class.

◆ AddButton()

AddButton ( $btn)

Adds a form button. The button is added to the list of form buttons. By default, the form framework arranges the buttons at the bottom of the form container from the left to the right.

Parâmetros
$label(string) the text which will appear on the button
$name(string) the internal button name
$action(string) the action; 'SUBMIT', 'RESET', 'REPORT' for the buttons type attribute or a JavaScript instruction for the button's onClick attribute
Veja também
FormButton Brief Description. Complete Description.
Parâmetros
&$btn(tipo) desc
Retorna
(tipo) desc
Exemplos
/var/docker/solisge-devel/www/solisge/miolo20/classes/ui/controls/mform.class.

Definido na linha 984 do ficheiro mform.class.

◆ addCustomFields()

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

Add the custom fields of the given identifier.

Parâmetros
string$identifierIdentifier.
string$customizedIdPrimary key of the main table (for editing form).
string$suffixSuffix to be added to each field name.
bool$somenteComActionUrl
Retorna
void The custom fields.
Exemplos
/var/docker/solisge-devel/www/solisge/miolo20/classes/ui/controls/mform.class.

Definido na linha 2539 do ficheiro mform.class.

◆ AddError()

AddError ( $err)

Adds the related form error Brief Description. Complete Description.

Parâmetros
$err(tipo) desc
Retorna
(tipo) desc
Exemplos
/var/docker/solisge-devel/www/solisge/miolo20/classes/ui/controls/mform.class.

Definido na linha 1291 do ficheiro mform.class.

◆ AddField()

AddField ( $field,
$hint = false )

Adds a single field to the list of form fields and optionally adds a hint text for the field.

Parâmetros
$field(reference) a reference to a form field object
$hint(string) an optional hint for the form field
Retorna
(nothing) Brief Description. Complete Description.
Parâmetros
$field(tipo) desc
$hint(tipo) desc
Retorna
(tipo) desc

Reimplementado em MTabbedForm.

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

Definido na linha 932 do ficheiro mform.class.

◆ AddFields()

AddFields ( $fields)

Brief Description. Complete Description.

Parâmetros
$fields(tipo) desc
Retorna
(tipo) desc
Exemplos
/var/docker/solisge-devel/www/solisge/miolo20/classes/ui/controls/mform.class.

Definido na linha 953 do ficheiro mform.class.

◆ AddInfo()

AddInfo ( $info)

Register an information related to the form Brief Description. Complete Description.

Parâmetros
$info(tipo) desc
Retorna
(tipo) desc
Exemplos
/var/docker/solisge-devel/www/solisge/miolo20/classes/ui/controls/mform.class.

Definido na linha 1343 do ficheiro mform.class.

◆ AddJsCode()

AddJsCode ( $jscode)

Brief Description. Complete Description.

Parâmetros
$jscode(tipo) desc
Retorna
(tipo) desc
Exemplos
/var/docker/solisge-devel/www/solisge/miolo20/classes/ui/controls/mform.class.

Definido na linha 707 do ficheiro mform.class.

◆ AddValidator()

AddValidator ( $validator)

Brief Description. Complete Description.

Parâmetros
$validator(tipo) desc
Retorna
(tipo) desc
Exemplos
/var/docker/solisge-devel/www/solisge/miolo20/classes/ui/controls/mform.class.

Definido na linha 284 do ficheiro mform.class.

◆ ClearButtons()

◆ ClearFields()

◆ CollectInput()

CollectInput ( $data)

Get form data and put it into the classmembers Brief Description. Complete Description.

Parâmetros
$data(tipo) desc
Retorna
(tipo) desc
Exemplos
/var/docker/solisge-devel/www/solisge/miolo20/classes/ui/controls/mform.class.

Definido na linha 1446 do ficheiro mform.class.

◆ CreateFields()

CreateFields ( )

Brief Description. Complete Description.

Retorna
(tipo) desc
Exemplos
/var/docker/solisge-devel/www/solisge/miolo20/classes/ui/controls/mform.class.

Definido na linha 270 do ficheiro mform.class.

◆ deleteCustomFieldValues()

deleteCustomFieldValues ( $customizedId)

Delete custom field values.

Parâmetros
mixedThe primary key of the related table.
Retorna
boolean Whether was successfully deleted.
Exemplos
/var/docker/solisge-devel/www/solisge/miolo20/classes/ui/controls/mform.class.

Definido na linha 2979 do ficheiro mform.class.

◆ Error()

Error ( $err)

Regiter the error Registers the error related to the form

Parâmetros
$err(tipo) desc
Retorna
(tipo) desc
Exemplos
/var/docker/solisge-devel/www/solisge/miolo20/classes/ui/controls/mform.class.

Definido na linha 1272 do ficheiro mform.class.

◆ expansibleText()

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

Cria uma div com texto expansivel e recuavel pelo usuario.

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

Definido na linha 3003 do ficheiro mform.class.

◆ Generate()

◆ generateAJAXValidators()

generateAJAXValidators ( )

◆ GenerateAlerts()

GenerateAlerts ( )

Brief Description. Complete Description.

Retorna
(tipo) desc
Exemplos
/var/docker/solisge-devel/www/solisge/miolo20/classes/ui/controls/mform.class.

Definido na linha 1882 do ficheiro mform.class.

◆ GenerateBody()

GenerateBody ( )

Brief Description. Complete Description.

Retorna
(tipo) desc

Reimplementado em MIndexedForm, MTabbedForm e MTabbedForm2.

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

Definido na linha 1897 do ficheiro mform.class.

◆ GenerateButtons()

GenerateButtons ( )

Brief Description. Complete Description.

Retorna
(tipo) desc
Exemplos
/var/docker/solisge-devel/www/solisge/miolo20/classes/ui/controls/mform.class.

Definido na linha 2187 do ficheiro mform.class.

◆ generateCustomFields()

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

◆ GenerateErrors()

GenerateErrors ( )

Brief Description. Complete Description.

Retorna
(tipo) desc
Exemplos
/var/docker/solisge-devel/www/solisge/miolo20/classes/ui/controls/mform.class.

Definido na linha 1855 do ficheiro mform.class.

◆ GenerateFooter()

GenerateFooter ( )

Brief Description. Complete Description.

Retorna
(tipo) desc

Reimplementado em MTabbedForm.

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

Definido na linha 1954 do ficheiro mform.class.

◆ GenerateHiddenFields()

GenerateHiddenFields ( $hidden)

Brief Description. Complete Description.

Parâmetros
$hidden(tipo) desc
Retorna
(tipo) desc
Exemplos
/var/docker/solisge-devel/www/solisge/miolo20/classes/ui/controls/mform.class.

Definido na linha 2220 do ficheiro mform.class.

◆ GenerateInfos()

GenerateInfos ( )

Brief Description. Complete Description.

Retorna
(tipo) desc
Exemplos
/var/docker/solisge-devel/www/solisge/miolo20/classes/ui/controls/mform.class.

Definido na linha 1869 do ficheiro mform.class.

◆ GenerateLayoutField()

GenerateLayoutField ( $field,
& $hidden )

Brief Description. Complete Description.

Parâmetros
$field(tipo) desc
&$hidden(tipo) desc
Retorna
(tipo) desc
Exemplos
/var/docker/solisge-devel/www/solisge/miolo20/classes/ui/controls/mform.class.

Definido na linha 2079 do ficheiro mform.class.

◆ GenerateLayoutFields()

GenerateLayoutFields ( & $hidden)

Brief Description. Complete Description.

Parâmetros
&$hidden(tipo) desc
Retorna
(tipo) desc

Reimplementado em MCSSForm e MCSSPForm.

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

Definido na linha 1968 do ficheiro mform.class.

◆ GenerateScript()

GenerateScript ( )

Generate form specific script code Brief Description. Complete Description.

Retorna
(tipo) desc
Exemplos
/var/docker/solisge-devel/www/solisge/miolo20/classes/ui/controls/mform.class.

Definido na linha 2242 do ficheiro mform.class.

◆ generateValidators()

generateValidators ( $fields)

◆ GetButton()

& GetButton ( $name)

Get a reference for a button

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

Definido na linha 1642 do ficheiro mform.class.

◆ getCamposConformeContainer()

getCamposConformeContainer ( $field)
protected

Pega os campos de um dado objeto se este for um container

Parâmetros
Object$fieldCampo do formulário
Retorna
mixed Array com os campos do container ou NULL se o objeto informado não for um container
Exemplos
/var/docker/solisge-devel/www/solisge/miolo20/classes/ui/controls/mform.class.

Definido na linha 2420 do ficheiro mform.class.

◆ getCustomFields()

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

◆ getCustomFieldValues()

getCustomFieldValues ( )

◆ getData()

getData ( )

Obtains the fields Obtains form fields in a FormData object.

Retorna
(Object) Form fields
Exemplos
/var/docker/solisge-devel/www/solisge/miolo20/classes/ui/controls/mform.class.

Definido na linha 1474 do ficheiro mform.class.

◆ GetField()

& GetField ( $name)

Get a reference for a form field

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

Definido na linha 1633 do ficheiro mform.class.

◆ GetFieldAttr()

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

Get a form field's attribute value Brief Description. Complete Description.

Parâmetros
$name(tipo) desc
$attr(tipo) desc
$index(tipo) desc
Retorna
(tipo) desc
Exemplos
/var/docker/solisge-devel/www/solisge/miolo20/classes/ui/controls/mform.class.

Definido na linha 1717 do ficheiro mform.class.

◆ getFieldFromFields()

getFieldFromFields ( $fieldName,
$fields )

Find a field recursively on an array of MIOLO components by its name.

Parâmetros
string$fieldNameField name.
array$fieldsArray of MIOLO components.
Retorna
object The field, if found.
Exemplos
/var/docker/solisge-devel/www/solisge/miolo20/classes/ui/controls/mform.class.

Definido na linha 326 do ficheiro mform.class.

◆ GetFieldList()

GetFieldList ( )

Returns form fields list. This is a placeholder function to bu the form's field list. It is excpected, that the form returns a scalar list of all defined fields which carry a form field value. Thus, form elements of decorative purpose only should be omitted.

Derived classes such as TabbedForm override this function to provide the list of fields independently of the form's layout.

Retorna
(array) a scalar array of form fields

Reimplementado em MTabbedForm e MTabbedForm2.

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

Definido na linha 1127 do ficheiro mform.class.

◆ getFieldValidator()

getFieldValidator ( $name)

◆ getFieldValidators()

getFieldValidators ( $name)

Obtem todos validadores do campo passado

Retorna
array Array de objetos MValidator
Exemplos
/var/docker/solisge-devel/www/solisge/miolo20/classes/ui/controls/mform.class.

Definido na linha 2038 do ficheiro mform.class.

◆ GetFieldValue()

GetFieldValue ( $name,
$value = false )

Obtains a form field's value Brief Description. Complete Description.

Parâmetros
$name(tipo) desc
$value(tipo) desc
Retorna
(tipo) desc
Exemplos
/var/docker/solisge-devel/www/solisge/miolo20/classes/ui/controls/mform.class.

Definido na linha 1573 do ficheiro mform.class.

◆ GetFooter()

GetFooter ( )

Obtains the content title of this form's footer. Observe, that this can be anything other as a simple text string too, such as array of strings and an object implementing the Generate() method.

Retorna
(Mixed &) a reference to the footer of the form Brief Description. Complete Description.
(tipo) desc
Exemplos
/var/docker/solisge-devel/www/solisge/miolo20/classes/ui/controls/mform.class.

Definido na linha 513 do ficheiro mform.class.

◆ getFormControlFields()

getFormControlFields ( )

◆ GetFormFields()

GetFormFields ( )

Obtains a submitted form fields's values and sets the array fields Uses $page->Request Brief Description. Complete Description.

Retorna
(tipo) desc
Exemplos
/var/docker/solisge-devel/www/solisge/miolo20/classes/ui/controls/mform.class.

Definido na linha 542 do ficheiro mform.class.

◆ GetFormValue()

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

Obtains a submitted form field's value. This is a static function.

Retorna
(mixed) value of field contained in $HTTP_POST_VARS Brief Description. Complete Description.
Parâmetros
$name(tipo) desc
$value(tipo) desc
Retorna
(tipo) desc
Exemplos
/var/docker/solisge-devel/www/solisge/miolo20/classes/ui/controls/mform.class.

Definido na linha 603 do ficheiro mform.class.

◆ getGrid()

getGrid ( $campos = array(),
$gridName = NULL )
protected

Método responsável por fazer a navegação entre os campos doo formulário e achar a grid

Parâmetros
Array$camposCampos do formulário
String$gridNameNome da grid
Retorna
mixed Grid encontrada, NULL caso esta não exista
Exemplos
/var/docker/solisge-devel/www/solisge/miolo20/classes/ui/controls/mform.class.

Definido na linha 2359 do ficheiro mform.class.

◆ getGridData()

getGridData ( $gridName)

◆ getGridQuery()

getGridQuery ( $gridName)

◆ GetPage()

& GetPage ( )

Get a reference for page

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

Definido na linha 1657 do ficheiro mform.class.

◆ getRandomField()

getRandomField ( )

Obtém campo oculto referente ao randomid, necessário para o correto funcionamento do componente msubdetail

Retorna
\MHiddenField
Exemplos
/var/docker/solisge-devel/www/solisge/miolo20/classes/ui/controls/mform.class.

Definido na linha 186 do ficheiro mform.class.

◆ getRequestData()

getRequestData ( )
Retorna
object Get request data in a stdClass object.
Exemplos
/var/docker/solisge-devel/www/solisge/miolo20/classes/ui/controls/mform.class.

Definido na linha 1482 do ficheiro mform.class.

◆ getShowHints()

static getShowHints ( )
static

Form's hints visibility. This function returns the visibility of the form's hint texts.

Veja também
ShowHints
Exemplos
/var/docker/solisge-devel/www/solisge/miolo20/classes/ui/controls/mform.class.

Definido na linha 1086 do ficheiro mform.class.

◆ GetTitle()

GetTitle ( )

Obtains the content of this form's title. Observe, that this can be anything other as a simple text string too, such as array of strings and an object implementing the Generate() method.

Retorna
(Mixed &) a reference to the title of the form Brief Description. Complete Description.
(tipo) desc
Exemplos
/var/docker/solisge-devel/www/solisge/miolo20/classes/ui/controls/mform.class.

Definido na linha 427 do ficheiro mform.class.

◆ getValidations()

getValidations ( )

◆ HasAlerts()

HasAlerts ( )

Returns the number of alert messages or 0, if no alert exist Brief Description. Complete Description.

Retorna
(tipo) desc
Exemplos
/var/docker/solisge-devel/www/solisge/miolo20/classes/ui/controls/mform.class.

Definido na linha 1427 do ficheiro mform.class.

◆ HasErrors()

HasErrors ( )

returns the number of error messages or 0, if no errors exist Brief Description. Complete Description.

Retorna
(tipo) desc
Exemplos
/var/docker/solisge-devel/www/solisge/miolo20/classes/ui/controls/mform.class.

Definido na linha 1325 do ficheiro mform.class.

◆ HasInfos()

HasInfos ( )

Returns the number of info messages or 0, if no info exist Brief Description. Complete Description.

Retorna
(tipo) desc
Exemplos
/var/docker/solisge-devel/www/solisge/miolo20/classes/ui/controls/mform.class.

Definido na linha 1377 do ficheiro mform.class.

◆ IsSubmitted()

IsSubmitted ( )

Detects if a form has been submitted.

Retorna
(boolean) true if the form has been submitted otherwise false Brief Description. Complete Description.
(tipo) desc
Exemplos
/var/docker/solisge-devel/www/solisge/miolo20/classes/ui/controls/mform.class.

Definido na linha 399 do ficheiro mform.class.

◆ normalizaActionParaConsulta()

static normalizaActionParaConsulta ( $action)
static

Acrescenta parametros no action quando for genericReports, generateReports ou formulário dinâmico

Parâmetros
type$action
Retorna
string
Exemplos
/var/docker/solisge-devel/www/solisge/miolo20/classes/ui/controls/mform.class.

Definido na linha 3032 do ficheiro mform.class.

◆ normalizaCamposCustomizados()

normalizaCamposCustomizados ( $customFields)
protected

Função criada para ser sobrescrita em classes filhas.

Parâmetros
array$customFields
Retorna
array
Exemplos
/var/docker/solisge-devel/www/solisge/miolo20/classes/ui/controls/mform.class.

Definido na linha 2590 do ficheiro mform.class.

◆ OnLoad()

OnLoad ( )

Brief Description. Complete Description.

Retorna
(tipo) desc
Exemplos
/var/docker/solisge-devel/www/solisge/miolo20/classes/ui/controls/mform.class.

Definido na linha 258 do ficheiro mform.class.

◆ OnSubmit()

OnSubmit ( $jscode)

Adds JavaScript code which is to be executed, when the form is submitted. when the form is generated, and any JS code has been registered using this function, an OnSubmit handler is dynamically generated where the code is placed.

The generated code looks like the following where stmt stands for the registered statments Brief Description. Complete Description.

Parâmetros
$jscode(tipo) desc
Retorna
(tipo) desc
Exemplos
/var/docker/solisge-devel/www/solisge/miolo20/classes/ui/controls/mform.class.

Definido na linha 692 do ficheiro mform.class.

◆ procuraGrid()

procuraGrid ( $field,
$gridName )
protected

Procura a grid no campo

Parâmetros
Object$fieldCampo do formulário
String$gridNameNome da grid
Retorna
mixed Objeto da grid ou NULL
Exemplos
/var/docker/solisge-devel/www/solisge/miolo20/classes/ui/controls/mform.class.

Definido na linha 2390 do ficheiro mform.class.

◆ removeAJAXValidator()

removeAJAXValidator ( $fieldId)

Remove a validator created via Ajax. It doesn't throw any error if validator doesn't exist.

Parâmetros
string$fieldIdField id.
Exemplos
/var/docker/solisge-devel/www/solisge/miolo20/classes/ui/controls/mform.class.

Definido na linha 2059 do ficheiro mform.class.

◆ saveCustomFields()

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

Save the custom field values.

Parâmetros
mixed$customizedIdThe primary key of the related table.
null$dataData (customValue) to be saved to the miolo_custom_value table
Retorna
boolean Whether was successfully saved.
Exemplos
/var/docker/solisge-devel/www/solisge/miolo20/classes/ui/controls/mform.class.

Definido na linha 2823 do ficheiro mform.class.

◆ searchCustomFieldValues()

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

Search the custom field values through the identifier and the form data.

Parâmetros
string$identifierCustom field identifier.
Retorna
array Values saved at the database.
Exemplos
/var/docker/solisge-devel/www/solisge/miolo20/classes/ui/controls/mform.class.

Definido na linha 2919 do ficheiro mform.class.

◆ SetAction()

SetAction ( $action)

Sets the action URL for this form. This is the URL to which the form data will be submitted. Usually, the URL is obtained by the GetActionURL of the MIOLO class. Brief Description. Complete Description.

Parâmetros
$action(tipo) desc
Retorna
(tipo) desc
Exemplos
/var/docker/solisge-devel/www/solisge/miolo20/classes/ui/controls/mform.class.

Definido na linha 727 do ficheiro mform.class.

◆ SetAlign()

SetAlign ( $value)

◆ SetAlternate()

SetAlternate ( $color0,
$color1 )

◆ SetBackgroundColor()

SetBackgroundColor ( $bgcolor)

◆ SetButtonAttr()

SetButtonAttr ( $name,
$attr,
$value )

Set a form field's attribute a value Brief Description. Complete Description.

Parâmetros
$name(tipo) desc
$attr(tipo) desc
$value(tipo) desc
Retorna
(tipo) desc
Exemplos
/var/docker/solisge-devel/www/solisge/miolo20/classes/ui/controls/mform.class.

Definido na linha 1747 do ficheiro mform.class.

◆ setButtonLabel()

setButtonLabel ( $index,
$label )

Set the buttons labels. This function is mainly used, to change the labels of the form's default buttons for submit and return.

Parâmetros
$index(integer) the 0 based index of the button
$label(string) the new button label
Exemplos
/var/docker/solisge-devel/www/solisge/miolo20/classes/ui/controls/mform.class.

Definido na linha 1026 do ficheiro mform.class.

◆ SetButtons()

SetButtons ( $btn)

Brief Description. Complete Description.

Parâmetros
&$btn(tipo) desc
Retorna
(tipo) desc
Exemplos
/var/docker/solisge-devel/www/solisge/miolo20/classes/ui/controls/mform.class.

Definido na linha 1003 do ficheiro mform.class.

◆ SetClose()

SetClose ( $action)

Sets the form's close action Brief Description. Complete Description.

Parâmetros
$action(tipo) desc
Retorna
(tipo) desc
Exemplos
/var/docker/solisge-devel/www/solisge/miolo20/classes/ui/controls/mform.class.

Definido na linha 464 do ficheiro mform.class.

◆ SetData()

◆ SetFieldAttr()

SetFieldAttr ( $name,
$attr,
$value )

Set a form field's attribute a value Brief Description. Complete Description.

Parâmetros
$name(tipo) desc
$attr(tipo) desc
$value(tipo) desc
Retorna
(tipo) desc
Exemplos
/var/docker/solisge-devel/www/solisge/miolo20/classes/ui/controls/mform.class.

Definido na linha 1695 do ficheiro mform.class.

◆ SetFieldCSS()

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

CSS Brief Description. Complete Description.

Parâmetros
$name(tipo) desc
$top(tipo) desc
$left(tipo) desc
$width(tipo) desc
$position=absolute'(tipo) desc
Retorna
(tipo) desc
Exemplos
/var/docker/solisge-devel/www/solisge/miolo20/classes/ui/controls/mform.class.

Definido na linha 1770 do ficheiro mform.class.

◆ SetFields()

SetFields ( & $fields)

This function is used to set an array of fields for the form. Brief Description. Complete Description.

Parâmetros
&$fields(tipo) desc
Retorna
(tipo) desc
Exemplos
/var/docker/solisge-devel/www/solisge/miolo20/classes/ui/controls/mform.class.

Definido na linha 803 do ficheiro mform.class.

◆ SetFieldValidator()

SetFieldValidator ( $name,
$value )

Set a form field's validator Brief Description. Complete Description.

Parâmetros
$name(tipo) desc
$value(tipo) desc
Retorna
(tipo) desc
Exemplos
/var/docker/solisge-devel/www/solisge/miolo20/classes/ui/controls/mform.class.

Definido na linha 1617 do ficheiro mform.class.

◆ SetFieldValue()

SetFieldValue ( $name,
$value )

Set a form field's value Brief Description. Complete Description.

Parâmetros
$name(tipo) desc
$value(tipo) desc
Retorna
(tipo) desc
Exemplos
/var/docker/solisge-devel/www/solisge/miolo20/classes/ui/controls/mform.class.

Definido na linha 1593 do ficheiro mform.class.

◆ SetFooter()

SetFooter ( $footer)

Form's footer. Sets the form's footer content.

Parâmetros
$footer(tipo) desc
Exemplos
/var/docker/solisge-devel/www/solisge/miolo20/classes/ui/controls/mform.class.

Definido na linha 525 do ficheiro mform.class.

◆ SetFormCSS()

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

Brief Description. Complete Description.

Parâmetros
$height0(tipo) desc
$width=0(tipo) desc
$top=0(tipo) desc
$left=0(tipo) desc
$buttons=0(tipo) desc
$position=absolute'(tipo) desc
Retorna
(tipo) desc
Exemplos
/var/docker/solisge-devel/www/solisge/miolo20/classes/ui/controls/mform.class.

Definido na linha 1801 do ficheiro mform.class.

◆ SetFormValue()

SetFormValue ( $name,
$value )

Sets the content of a form field to the specified value. The function does this by setting both, the field's value member and the global $_POST to remain consistency between the values.

Parâmetros
$name(string) name of the field
$value(tipo) value to set to
Retorna
(none) this function returns no value
Exemplos
/var/docker/solisge-devel/www/solisge/miolo20/classes/ui/controls/mform.class.

Definido na linha 630 do ficheiro mform.class.

◆ SetHeight()

SetHeight ( $height = NULL)

◆ setHelp()

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

Sets an URL to a help document. This document will be opened via JavaScript in a new window. If this URL is set, the form will display a help button in it's title bar. Brief Description. Complete Description.

Parâmetros
$href(tipo) desc
Retorna
(tipo) desc
Exemplos
/var/docker/solisge-devel/www/solisge/miolo20/classes/ui/controls/mform.class.

Definido na linha 747 do ficheiro mform.class.

◆ SetIcon()

SetIcon ( $icon)

Sets the form's icon Brief Description. Complete Description.

Parâmetros
$icon(tipo) desc
Retorna
(tipo) desc
Exemplos
/var/docker/solisge-devel/www/solisge/miolo20/classes/ui/controls/mform.class.

Definido na linha 485 do ficheiro mform.class.

◆ SetLabelWidth()

SetLabelWidth ( $width)

Renderize Brief Description. Complete Description.

Parâmetros
$width(tipo) desc
Retorna
(tipo) desc
Exemplos
/var/docker/solisge-devel/www/solisge/miolo20/classes/ui/controls/mform.class.

Definido na linha 1843 do ficheiro mform.class.

◆ SetPage()

SetPage ( & $page)

Set reference for page Brief Description. Complete Description.

Parâmetros
&$page(tipo) desc
Retorna
(tipo) desc
Exemplos
/var/docker/solisge-devel/www/solisge/miolo20/classes/ui/controls/mform.class.

Definido na linha 1675 do ficheiro mform.class.

◆ setRandomField()

setRandomField ( )

Adiciona campo oculto para armazenar o randomid gerado da tela, utilizado para não conflitar dados.

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

Definido na linha 203 do ficheiro mform.class.

◆ setShowHints()

static setShowHints ( $state)
static

Set form's hints visibility. This function can be used to show or hide the form's hint texts. Each form element may have a hint text associated with it. Using this method, one can enable/disable the display of the texts. This may be useful for implementing kind of an beginner/expert mode.

Parâmetros
$state(boolean) the visible state of the hint texts
Exemplos
/var/docker/solisge-devel/www/solisge/miolo20/classes/ui/controls/mform.class.

Definido na linha 1100 do ficheiro mform.class.

◆ setShowPostButton()

setShowPostButton ( $state)

Post button visibility. Use this method to set the visibility of the Post Button.

Parâmetros
$state(boolean) the visible state of the Post Button
Exemplos
/var/docker/solisge-devel/www/solisge/miolo20/classes/ui/controls/mform.class.

Definido na linha 1056 do ficheiro mform.class.

◆ setShowResetButton()

setShowResetButton ( $state)

Reset button visibility. This function can be used to show or hide the form's reset button.

Parâmetros
$state(boolean) the visible state of the reset button
Exemplos
/var/docker/solisge-devel/www/solisge/miolo20/classes/ui/controls/mform.class.

Definido na linha 1075 do ficheiro mform.class.

◆ setShowReturnButton()

setShowReturnButton ( $state)

Return button visibility. This function can be used to show or hide the form's return button.

Parâmetros
$state(boolean) the visible state of the return button
Exemplos
/var/docker/solisge-devel/www/solisge/miolo20/classes/ui/controls/mform.class.

Definido na linha 1045 do ficheiro mform.class.

◆ SetTitle()

SetTitle ( $title)

Sets the form's title content Brief Description. Complete Description.

Parâmetros
$title(tipo) desc
Retorna
(tipo) desc
Exemplos
/var/docker/solisge-devel/www/solisge/miolo20/classes/ui/controls/mform.class.

Definido na linha 445 do ficheiro mform.class.

◆ setValidations()

setValidations ( $validations)

◆ SetValidators()

SetValidators ( $validators)

Brief Description. Complete Description.

Parâmetros
$validators(tipo) desc
Retorna
(tipo) desc
Exemplos
/var/docker/solisge-devel/www/solisge/miolo20/classes/ui/controls/mform.class.

Definido na linha 368 do ficheiro mform.class.

◆ SetWidth()

SetWidth ( $width = NULL)

◆ showHints()

showHints ( $state)

◆ showReset()

showReset ( $state)

◆ showReturn()

showReturn ( $state)

◆ validate()

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

Validates the form input Validate form data based on an array of required variable names.

Parâmetros
$required(array) field to be validated
$assert(boolean) should the program stop if a error is found
Retorna
(boolean) true if all fields have a value; false if any of the fields has been left empty
Exemplos
/var/docker/solisge-devel/www/solisge/miolo20/classes/ui/controls/mform.class.

Definido na linha 1232 do ficheiro mform.class.

◆ validateAll()

validateAll ( $assert = true)

Validate all form fields. Validates all form fields to have a non-empty content

Parâmetros
$assert(boolean) flag how to handle invalid fields;
if true, an error message will be shown
if false no error message will be shown and the caller can provide an appropriate action based on the return value.
Retorna
(boolean) true if all fields have a value; false if any of the fields has been left empty
Exemplos
/var/docker/solisge-devel/www/solisge/miolo20/classes/ui/controls/mform.class.

Definido na linha 1186 do ficheiro mform.class.

◆ validateRequiredFields()

validateRequiredFields ( $assert = true)

Brief Description. Complete Description.

Parâmetros
$assert(tipo) desc
Retorna
(tipo) desc
Exemplos
/var/docker/solisge-devel/www/solisge/miolo20/classes/ui/controls/mform.class.

Definido na linha 1207 do ficheiro mform.class.

Documentação dos campos e atributos

◆ $action

$action

Attribute Description.

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

Definido na linha 18 do ficheiro mform.class.

◆ $alerts

$alerts

Attribute Description.

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

Definido na linha 99 do ficheiro mform.class.

◆ $align

◆ $bgColor

◆ $box

$box

Attribute Description.

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

Definido na linha 104 do ficheiro mform.class.

◆ $buttons

$buttons

Attribute Description.

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

Definido na linha 28 do ficheiro mform.class.

◆ $cssButtons

◆ $cssForm

$cssForm = false

Attribute Description.

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

Definido na linha 115 do ficheiro mform.class.

◆ $defaultButton

$defaultButton

Attribute Description.

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

Definido na linha 83 do ficheiro mform.class.

◆ $enctype

$enctype

Attribute Description.

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

Definido na linha 73 do ficheiro mform.class.

◆ $errors

$errors

Attribute Description.

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

Definido na linha 88 do ficheiro mform.class.

◆ $fieldNum

$fieldNum = 0
static

◆ $fields

$fields =array()

Attribute Description.

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

Definido na linha 33 do ficheiro mform.class.

◆ $footer

$footer

Attribute Description.

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

Definido na linha 58 do ficheiro mform.class.

◆ $help

$help

Attribute Description.

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

Definido na linha 53 do ficheiro mform.class.

◆ $infos

$infos

Attribute Description.

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

Definido na linha 93 do ficheiro mform.class.

◆ $labelWidth

$labelWidth = NULL

Attribute Description.

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

Definido na linha 124 do ficheiro mform.class.

◆ $layout

$layout

Attribute Description.

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

Definido na linha 110 do ficheiro mform.class.

◆ $method

$method

Attribute Description.

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

Definido na linha 23 do ficheiro mform.class.

◆ $mioloCustomFields

$mioloCustomFields

◆ $mioloCustomizedId

$mioloCustomizedId

◆ $reset

$reset

Attribute Description.

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

Definido na linha 43 do ficheiro mform.class.

◆ $return

$return

Attribute Description.

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

Definido na linha 38 do ficheiro mform.class.

◆ $showHints

◆ $styles

$styles

Attribute Description.

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

Definido na linha 48 do ficheiro mform.class.

◆ $title

$title

Attribute Description.

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

Definido na linha 13 do ficheiro mform.class.

◆ $validations

$validations

Attribute Description.

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

Definido na linha 78 do ficheiro mform.class.

◆ $width

$width

Attribute Description.

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

Definido na linha 63 do ficheiro mform.class.

◆ $zebra

$zebra = false

Attribute Description.

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

Definido na linha 120 do ficheiro mform.class.


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