Referência à classe MCustomField

Membros públicos
	__construct ($data=NULL)
	getInputId ()
	setData ($data)
	insert ()
	update ()
	delete ()
	populate ()
	isRequired ()
	isEditable ()
	isVisible ()
	__get ($attr)
	hasSQLParameters ()
	parsePossibleParameters ()
	getParameterArgs ()
	replaceSQLParameters ($sql)
	getListSQL ()
	getFieldHint ()
	getListValues ()

Membros públicos estáticos
static	generateInputId ($identifier, $id, $suffix='')
static	listByIdentifier ($identifier, $actionURL=NULL, $step=null)
static	listForGrid ($identifier='')
static	listFormatFields ()
static	getCustomFieldById ($id)

Campos de Dados
const	FORMAT_TEXT = 'text'
const	FORMAT_LONG_TEXT = 'longText'
const	FORMAT_INTEGER = 'integer'
const	FORMAT_DECIMAL = 'decimal'
const	FORMAT_LIST = 'list'
const	FORMAT_LISTSQL = 'listsql'
const	FORMAT_MTAG = 'mtagselectionsql'
const	FORMAT_MULTI_LIST = 'multList'
const	FORMAT_MULTI_LISTSQL = 'multListsql'
const	FORMAT_DATE = 'date'
const	FORMAT_BOOLEAN = 'boolean'
const	FORMAT_HIDDEN = 'oculto'
const	FORMAT_SESCOLHA = 'sescolha'
const	FORMAT_INTERVAL = 'interval'
const	FORMAT_SESCOLHA_LIST = 'sescolhaList'
const	FORMAT_SESCOLHA_LISTSQL = 'sescolhaListsql'
const	FORMAT_JAVASCRIPT = 'javascript'
const	FORMAT_FILE = 'file'
const	FORMAT_EDITOR = 'editor'
	$id
	$identifier
	$name
	$label
	$fieldFormat
	$possibleValues
	$regexp
	$minLength
	$maxLength
	$required
	$position
	$defaultValue
	$editable
	$visible
	$suffix
	$possibleParameters
	$paramNotFound
	$filtroFormularioBusca
	$visivel
	$objetoreferencia
	$largura
	$altura
	$hint
	$jshint

Descrição detalhada

Class to manage customized fields.

Autor

Daniel Hartmann [danie.nosp@m.l@so.nosp@m.lis.c.nosp@m.oop..nosp@m.br]

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 2011/11/14

Organization:
SOLIS - Cooperativa de Soluções Livres
Copyright:
Copyright (c) 2011 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)

Exemplos

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

Definido na linha 25 do ficheiro mcustomfield.class.

Documentação dos Construtores & Destrutor

__construct()

__construct

(

$data = NULL

)

MCustomField constructor.

Parâmetros

object

$data

A stdClass instance to populate this object.

Definido na linha 171 do ficheiro mcustomfield.class.

Documentação das funções

__get()

__get

(

$attr

)

Method created to allow the aliases sId, sName and sVisible for id, name and visible. This is to avoid problems with subdetail.

Parâmetros

string

$attr

Attribute name.

Retorna

mixed Value.

Definido na linha 527 do ficheiro mcustomfield.class.

delete()

delete

(

)

Delete a custom field.

Retorna

object Result of the removal.

Definido na linha 318 do ficheiro mcustomfield.class.

generateInputId()

static generateInputId ( $identifier, $id, $suffix = '' )

static

Generate the id to use on inputs.

Parâmetros

string	$identifier	The identifier of the field, usually a table or form name.
string	$id	Unique custom field id.
string	$suffix	Suffix to be added to each field name.

Retorna

string Input id.

Definido na linha 204 do ficheiro mcustomfield.class.

getCustomFieldById()

static getCustomFieldById ( $id )

static

Definido na linha 670 do ficheiro mcustomfield.class.

getFieldHint()

getFieldHint

(

)

Definido na linha 645 do ficheiro mcustomfield.class.

getInputId()

getInputId

(

)

Retorna

string Get the id to use on inputs.

Exemplos

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

Definido na linha 191 do ficheiro mcustomfield.class.

getListSQL()

getListSQL

(

)

Retorna

array

Definido na linha 626 do ficheiro mcustomfield.class.

getListValues()

getListValues

(

)

Retorna

array

Definido na linha 656 do ficheiro mcustomfield.class.

getParameterArgs()

getParameterArgs

(

)

Retorna

array

Definido na linha 555 do ficheiro mcustomfield.class.

hasSQLParameters()

hasSQLParameters

(

)

Retorna

boolean

Definido na linha 537 do ficheiro mcustomfield.class.

insert()

insert

(

)

Insert a custom field.

Retorna

object Result of the insertion.

Definido na linha 245 do ficheiro mcustomfield.class.

isEditable()

isEditable

(

)

Retorna

boolean Whether the editable attribute has the database true value.

Definido na linha 378 do ficheiro mcustomfield.class.

isRequired()

isRequired

(

)

Retorna

boolean Whether the required attribute has the database true value.

Definido na linha 370 do ficheiro mcustomfield.class.

isVisible()

isVisible

(

)

Retorna

boolean Whether the visible attribute has the database true value.

Definido na linha 386 do ficheiro mcustomfield.class.

listByIdentifier()

static listByIdentifier ( $identifier, $actionURL = NULL, $step = null )

static

List the custom fields with the given identifier.

Parâmetros

string

$identifier

The identifier of the field, usually a table or form name.

Retorna

array Array of MCustomField instances.

Exemplos

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

Definido na linha 397 do ficheiro mcustomfield.class.

listForGrid()

static listForGrid ( $identifier = '' )

static

List the custom fields to show them on a grid.

Parâmetros

string

$identifier

The identifier of the field, usually a table or form name.

Retorna

array Matrix of strings with the custom fields data.

Definido na linha 470 do ficheiro mcustomfield.class.

listFormatFields()

static listFormatFields ( )

static

Retorna

array List the possible format fields to use on formatField attribute.

Definido na linha 497 do ficheiro mcustomfield.class.

parsePossibleParameters()

parsePossibleParameters

(

)

Obtem um array com parametros possiveis

Retorna

array

Definido na linha 547 do ficheiro mcustomfield.class.

populate()

populate

(

)

Populate the object querying the database by the id.

Definido na linha 332 do ficheiro mcustomfield.class.

replaceSQLParameters()

replaceSQLParameters

(

$sql

)

Substitui os coringas (?) de parametros do SQL, caso necessario

Retorna

string

Definido na linha 603 do ficheiro mcustomfield.class.

setData()

setData

(

$data

)

Set the object attributes.

Parâmetros

object

$data

A stdClass instance.

Definido na linha 214 do ficheiro mcustomfield.class.

update()

update

(

)

Update a custom field.

Retorna

object Result of the update.

Definido na linha 282 do ficheiro mcustomfield.class.

Documentação dos campos e atributos

$altura

$altura

Definido na linha 160 do ficheiro mcustomfield.class.

$defaultValue

$defaultValue

Definido na linha 110 do ficheiro mcustomfield.class.

$editable

$editable

Definido na linha 115 do ficheiro mcustomfield.class.

$fieldFormat

$fieldFormat

Definido na linha 75 do ficheiro mcustomfield.class.

$filtroFormularioBusca

$filtroFormularioBusca

Definido na linha 140 do ficheiro mcustomfield.class.

$hint

$hint

Definido na linha 162 do ficheiro mcustomfield.class.

$id

$id

Definido na linha 53 do ficheiro mcustomfield.class.

$identifier

$identifier

Definido na linha 58 do ficheiro mcustomfield.class.

$jshint

$jshint

Definido na linha 164 do ficheiro mcustomfield.class.

$label

$label

Definido na linha 70 do ficheiro mcustomfield.class.

$largura

$largura

Definido na linha 155 do ficheiro mcustomfield.class.

$maxLength

$maxLength

Definido na linha 95 do ficheiro mcustomfield.class.

$minLength

$minLength

Definido na linha 90 do ficheiro mcustomfield.class.

$name

$name

Definido na linha 63 do ficheiro mcustomfield.class.

$objetoreferencia

$objetoreferencia

Definido na linha 150 do ficheiro mcustomfield.class.

$paramNotFound

$paramNotFound

Definido na linha 135 do ficheiro mcustomfield.class.

$position

$position

Definido na linha 105 do ficheiro mcustomfield.class.

$possibleParameters

$possibleParameters

Definido na linha 130 do ficheiro mcustomfield.class.

$possibleValues

$possibleValues

Definido na linha 80 do ficheiro mcustomfield.class.

$regexp

$regexp

Definido na linha 85 do ficheiro mcustomfield.class.

$required

$required

Definido na linha 100 do ficheiro mcustomfield.class.

$suffix

$suffix

Definido na linha 125 do ficheiro mcustomfield.class.

$visible

$visible

Definido na linha 120 do ficheiro mcustomfield.class.

$visivel

$visivel

Definido na linha 145 do ficheiro mcustomfield.class.

FORMAT_BOOLEAN

const FORMAT_BOOLEAN = 'boolean'

Exemplos

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

Definido na linha 40 do ficheiro mcustomfield.class.

FORMAT_DATE

const FORMAT_DATE = 'date'

Exemplos

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

Definido na linha 39 do ficheiro mcustomfield.class.

FORMAT_DECIMAL

const FORMAT_DECIMAL = 'decimal'

Exemplos

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

Definido na linha 33 do ficheiro mcustomfield.class.

FORMAT_EDITOR

const FORMAT_EDITOR = 'editor'

Exemplos

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

Definido na linha 48 do ficheiro mcustomfield.class.

FORMAT_FILE

const FORMAT_FILE = 'file'

Exemplos

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

Definido na linha 47 do ficheiro mcustomfield.class.

FORMAT_HIDDEN

const FORMAT_HIDDEN = 'oculto'

Definido na linha 41 do ficheiro mcustomfield.class.

FORMAT_INTEGER

const FORMAT_INTEGER = 'integer'

Exemplos

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

Definido na linha 32 do ficheiro mcustomfield.class.

FORMAT_INTERVAL

const FORMAT_INTERVAL = 'interval'

Definido na linha 43 do ficheiro mcustomfield.class.

FORMAT_JAVASCRIPT

const FORMAT_JAVASCRIPT = 'javascript'

Exemplos

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

Definido na linha 46 do ficheiro mcustomfield.class.

FORMAT_LIST

const FORMAT_LIST = 'list'

Exemplos

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

Definido na linha 34 do ficheiro mcustomfield.class.

FORMAT_LISTSQL

const FORMAT_LISTSQL = 'listsql'

Exemplos

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

Definido na linha 35 do ficheiro mcustomfield.class.

FORMAT_LONG_TEXT

const FORMAT_LONG_TEXT = 'longText'

Exemplos

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

Definido na linha 31 do ficheiro mcustomfield.class.

FORMAT_MTAG

const FORMAT_MTAG = 'mtagselectionsql'

Exemplos

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

Definido na linha 36 do ficheiro mcustomfield.class.

FORMAT_MULTI_LIST

const FORMAT_MULTI_LIST = 'multList'

Exemplos

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

Definido na linha 37 do ficheiro mcustomfield.class.

FORMAT_MULTI_LISTSQL

const FORMAT_MULTI_LISTSQL = 'multListsql'

Exemplos

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

Definido na linha 38 do ficheiro mcustomfield.class.

FORMAT_SESCOLHA

const FORMAT_SESCOLHA = 'sescolha'

Exemplos

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

Definido na linha 42 do ficheiro mcustomfield.class.

FORMAT_SESCOLHA_LIST

const FORMAT_SESCOLHA_LIST = 'sescolhaList'

Exemplos

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

Definido na linha 44 do ficheiro mcustomfield.class.

FORMAT_SESCOLHA_LISTSQL

const FORMAT_SESCOLHA_LISTSQL = 'sescolhaListsql'

Exemplos

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

Definido na linha 45 do ficheiro mcustomfield.class.

FORMAT_TEXT

const FORMAT_TEXT = 'text'

Constants for field formats.

Exemplos

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

Definido na linha 30 do ficheiro mcustomfield.class.

---

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

• /var/docker/solisge-devel/www/solisge/miolo20/classes/model/mcustomfield.class