• Главная
• Gdn_Form

PHP Класс Gdn_Form, vanilla

Helps with the rendering of form controls that link directly to a data model. Показать файл Открыть проект Примеры использования класса

Открытые свойства

Свойство	Тип	Описание
$Action		Action with which the form should be sent.
$ErrorClass		Class name to assign to form elements with errors when InlineErrors is enabled.
$HiddenInputs		Associative array of hidden inputs with their "Name" attribute as the key.
$IDPrefix		All form-related elements (form, input, select, textarea, [etc] will have this value prefixed on their ID attribute. Default is "Form_". If the id value is overridden with the Attribute collection for an element, this value will not be used.
$Method		Form submit method. Options are 'post' or 'get'.
$_FormValues	array

Защищенные свойства (Protected)

Свойство	Тип	Описание
$_DataArray		Associative array containing the key => value pairs being placed in the controls returned by this object. Assigned by $this->Open() or $this->SetData().
$_InlineErrors		Whether to display inline errors with form elements. Set with ShowErrors() and HideErrors().
$_Model		Model that enforces data rules on $this->_DataArray.
$_ValidationResults		Associative array of $FieldName => $ValidationFunctionName arrays that describe how each field specified failed validation.

Открытые методы

Метод	Описание
__construct ( string $TableName = '', string $style = '' )	Constructor
__get ( strig $name ) : mixed	Backwards compatibility getter.
__set ( string $name, mixed $value )	Backwards compatibility setter.
addError ( $Error, string $FieldName = '' )	Adds an error to the errors collection and optionally relates it to the specified FieldName. Errors added with this method can be rendered with $this->Errors().
addErrorClass ( array &$Attributes )	Add ErrorClass to Attributes['class'].
addHidden ( string $FieldName, string $Value = null, boolean $ForceValue = false )	Adds a hidden input value to the form.
authenticatedPostBack ( boolean $throw = false ) : boolean	Returns a boolean value indicating if the current page has an authenticated postback.
bodyBox ( string $Column = 'Body', array $Attributes = [] ) : string	A special text box for formattable text.
button ( string $ButtonCode, array $Attributes = [] ) : string	Returns XHTML for a button.
buttonExists ( string $ButtonCode ) : boolean	Checks $this->FormValues() to see if the specified button translation code was submitted with the form (helps figuring out what button was pressed to submit the form when there is more than one button available).
calendar ( string $FieldName, array $Attributes = [] ) : string	Returns XHTML for a standard calendar input control.
captcha ( ) : string	Returns Captcha HTML & adds translations to document head.
categoryDropDown ( array $FieldName = 'CategoryID', array $Options = [] ) : string	Returns XHTML for a select list containing categories that the user has permission to use.
checkBox ( string $FieldName, string $Label = '', array $Attributes = [] ) : string	Returns XHTML for a checkbox input element.
checkBoxGrid ( string $FieldName, mixed $DataSet, mixed $ValueDataSet, array $Attributes ) : string	Returns the xhtml for a list of checkboxes; sorted into groups related to the TextField value of the dataset.
checkBoxGridGroup ( $GroupName, $Data, $FieldName ) : string
checkBoxGridGroups ( $Data, $FieldName ) : string
checkBoxList ( string $FieldName, mixed $DataSet, mixed $ValueDataSet = null, array $Attributes = [] ) : string	Returns the XHTML for a list of checkboxes.
clearInputs ( )	Emptys the $this->_FormValues collection so that all form fields will load empty.
close ( string $ButtonCode = '', string $Xhtml = '', $Attributes = [] ) : string	Returns the closing of the form tag with an optional submit button.
color ( string $fieldName ) : string	Builds a color-picker form element. Accepts three-character hex values with or without the leading '#', but the saved value will be coerced into a six-character hex code with the leading '#'.
currentImage ( type $FieldName, type $Attributes = [] )	Returns the current image in a field.
date ( string $FieldName, array $Attributes = [] ) : string	Returns XHTML for a standard date input control.
dropDown ( string $FieldName, mixed $DataSet, array $Attributes = [] ) : string	Returns XHTML for a select list.
dropDownGroup ( string $FieldName, array $Data, string $GroupField, string $TextField, string $ValueField, array $Attributes = [] ) : string	Returns the xhtml for a dropdown list with option groups.
errorCount ( ) : integer	Returns a count of the number of errors that have occurred.
errorString ( )
errors ( ) : string	Returns XHTML for all form-related errors that have occurred.
escapeFieldName ( string $string ) : string	Returns the provided fieldname with improper characters stripped.
escapeID ( string $FieldName, boolean $ForceUniqueID = true ) : string	Returns the provided fieldname with non-alpha-numeric values stripped and $this->IDPrefix prepended.
escapeString ( string $string ) : string
fileUpload ( string $fieldName, array $attributes = [] ) : string	Outputs a stylized file upload input. Requires dashboard.js and dashboard.css to look and work as intended.
fileUploadWrap ( string $fieldName, array $attributes = [] ) : string	Outputs a stylized file upload input with a input wrapper div. Requires dashboard.js and dashboard.css to look and work as intended.
formData ( ) : array	Get form data array
formDataSet ( ) : array
formValues ( $NewValue = null ) : array	If the form has been posted back, this method return an associative array of $FieldName => $Value pairs which were sent in the form.
getCheckBoxGridGroup ( string $GroupName, array $Group, array $Rows, array $Cols )	Returns a checkbox table.
getFormValue ( string $FieldName, mixed $Default = '' ) : unknown	Gets the value associated with $FieldName from the sent form fields.
getHidden ( ) : string	Returns XHTML for all hidden fields.
getStyle ( string $item, null $default = null ) : string	Get a style element for the form.
getValue ( string $FieldName, mixed $Default = false ) : mixed	Gets the value associated with $FieldName.
hidden ( string $FieldName, array $Attributes = [] ) : string	Returns the xhtml for a hidden input.
hideErrors ( )	Disable inline errors (this is the default).
imageUpload ( string $FieldName, array $Attributes = [] ) : string	Return a control for uploading images.
imageUploadPreview ( string $fieldName, string $label = '', string $labelDescription = '', string $currentImageUrl = '', string $removeUrl = '', string $removeText = '', string $removeConfirmText = '', string $tag = 'li', array $attributes = [] ) : string	Outputs the entire form group with both the label and input. Adds an image preview and a link to delete the current image. Handles the ajax clearing of the image preview on removal.
imageUploadWrap ( string $fieldName, array $attributes = [] ) : string	Return a control for uploading images with a wrapper div. The existing image should be displayed by the label.
inlineError ( string $FieldName ) : string	Returns XHTML of inline error for specified field.
input ( string $FieldName, string $Type = 'text', array $Attributes = [] ) : string	Returns the xhtml for a standard input tag.
inputWrap ( $FieldName, $Type = 'text', $Attributes = [] )
isMyPostBack ( ) : boolean	Check if THIS particular form was submitted
isPostBack ( ) : boolean	Examines the sent form variable collection to see if any data was sent via the form back to the server. Returns TRUE on if anything is found.
label ( string $TranslationCode, string $FieldName = '', array $Attributes = [] ) : string	Returns XHTML for a label element.
labelCode ( string | array $Item ) : string	Generate a friendly looking label translation code from a camel case variable name
labelWrap ( $TranslationCode, $FieldName = '', $Attributes = [] )
linkButton ( string $code, string $destination = '', array $attributes = [] )	Return a linked that will look like a button.
open ( array $Attributes = [] ) : string	Returns the xhtml for the opening of the form (the form tag and all hidden elements).
radio ( string $FieldName, string $Label = '', array $Attributes = [] ) : string	Returns XHTML for a radio input element.
radioList ( string $FieldName, mixed $DataSet, array $Attributes = [] ) : string	Returns XHTML for an unordered list of radio button elements.
removeFormValue ( string $FieldName )	Remove an element from a form.
save ( ) : unknown	This is a convenience method so that you don't have to code this every time you want to save a simple model's data.
saveImage ( string $Field, array $Options = [] )	Save an image from a field and delete any old image that's been uploaded.
searchForm ( string $field, string $url, array $textBoxAttributes = [], string $searchInfo = '' ) : string	Renders a search form.
searchInput ( string $field, string $url, array $textBoxAttributes = [], string $searchInfo = '' ) : string	Renders a stylized search field. Requires dashboard.css to look as intended. Use with searchForm() to output an entire search form.
setData ( array $Data )	Assign a set of data to be displayed in the form elements.
setFormValue ( string $FieldName, mixed $Value = null )	Sets the value associated with $FieldName from the sent form fields.
setModel ( Gdn_Model $Model, Ressource $DataSet = false )	Set the name of the model that will enforce data rules on $this->_DataArray.
setStyles ( string $name ) : boolean	Set the styles to use when outputting controls.
setValidationResults ( $ValidationResults )
setValue ( string $FieldName, $Value )	Sets the value associated with $FieldName.
showErrors ( )	Enable inline errors.
simple ( array $Schema, type $Options = [] )	Generates a multi-field form from a schema.
textBox ( string $FieldName, array $Attributes = [] ) : string	Returns the xhtml for a text-based input.
textBoxWrap ( $FieldName, $Attributes = [] )
toggle ( string $fieldName, string $label, array $attributes = [], string $info = '' ) : string	Outputs a checkbox painted as a toggle. Includes label wrap id a label is given.
unescapeFieldName ( string $string ) : string	Unescape strings that were escaped with {@link Gdn_Form::escapeFieldName()}.
validateModel ( ) : integer	If not saving data directly to the model, this method allows you to utilize a model's schema to validate a form's inputs regardless.
validateRule ( string $FieldName, string | array $Rule, string $CustomError = '' ) : boolean	Validates a rule on the form and adds its result to the errors collection.
validationResults ( ) : array	Gets the validation results in the form.

Защищенные методы

Метод	Описание
_attributesToString ( array $Attributes ) : string	Takes an associative array of $Attributes and returns them as a string of param="value" sets to be placed in an input, select, textarea, etc tag.
_idAttribute ( string $FieldName, array $Attributes ) : string	Creates an ID attribute for a form input and returns it in this format: [ id="IDNAME"]
_nameAttribute ( string $FieldName, array $Attributes ) : string	Creates a NAME attribute for a form input and returns it in this format: [ name="NAME"]
_valueAttribute ( string $FieldName, array $Attributes ) : string	Creates a VALUE attribute for a form input and returns it in this format: [ value="VALUE"]

Приватные методы

Метод	Описание
translateClasses ( string | string[] $classes ) : string	Translate old CSS classes using the style array.

Описание методов

Описание свойств