• 홈
• Habari
• FormControl

PHP 클래스 Habari\FormControl

파일 보기 프로젝트 열기: habari/system

공개 프로퍼티들

프로퍼티	타입	설명
$caption	string
$container	FormContainer	The container that contains this control
$controls_js		True if the controls.init script has been output, false if not
$errors	array	An array of errors that is filled when the control is passed for validation
$has_errors	boolean	True when this control has errors, can be true with $errors isn't when the errors propagate to the container
$helptext	boolean | string	This is help text for the control, if it is set
$initial_value	mixed	This is the intially assigned value of the control, set and used internally
$name	string	The name of the control for the purposes of manipulating it from the container object
$on_enable	array	An array of enable handlers for this control
$on_save	array	An array of save handlers for this control
$on_success	array	An array of success handlers for this control
$properties	array	Contains an array of properties used to assign to the output HTML
$settings	array	Contains an array of settings that control the behavior of this control
$storage	habari\FormStorage | null	The storage object for this form
$validators	array	An array of validators to execute on this control
$value	mixed	This is the value of the control, which will differ depending on at what time you access it
$value_set_manually	boolean	If the value of this control was set manually, this should be true
$vars	array	These vars are added internally to the theme for output by the template

공개 메소드들

메소드	설명
__construct ( string $name, habari\FormStorage | string | null $storage = 'null:null', array $properties = [], array $settings = [] )	Construct a control.
_extend ( )	This function is called after __construct(). It does nothing, but its descendants might do something.
add_class ( array | string $classes ) : FormControl	Add one or more CSS classes to this control
add_input_array ( integer | string $value ) : FormControl	Add a value to the input_array setting
add_template_class ( string $target, array | string $classes ) : FormControl	Add one or more CSS classes to this control's template
add_validator ( mixed $validator, mixed $option = null ) : FormControl	Add a validation function to this control Multiple parameters are passed as parameters to the validation function
clear ( )	Set this control to its initial value
control_id ( ) : string	Obtain a unique identifier for this control that is the same every time the form is generated
control_type ( ) : string	Get the type of control this is (without the "FormControl" and in lower case) Usually used for template selection
controls_js ( string $out ) : string	Render the controls.init script prior to the supplied script only if it hasn't already been rendered
create ( string $name, habari\FormStorage | string | null $storage = 'null:null', array $properties = [], array $settings = [] ) : mixed | FormControl	Create a new instance of this class and return it, use the fluent interface
do_success ( FormUI $form ) : boolean | string	Calls the success callback for the form, and saves the form value to the control's storage location
error_wrap ( string $output, array $errors ) : string	Wrap the output of a control (or some text content) with error content
from_args ( array $arglist ) : FormControl	Take an array of parameters, use the first as the FormControl class/type, and run the constructor with the rest
get ( Theme $theme ) : string	Produce the control for display
get_form ( ) : FormUI	Find the form that holds this control
get_id ( boolean $force_set = true ) : string | null	Produce a unique id (not name) for this control for use with labels and such, only if one is not provided in the control properties
get_id_component ( ) : boolean | string	Get a string that will be used to generate a component of a control's HTML id
get_label ( ) : string	Get a text label for this control
get_setting ( string $name, mixed $default = null ) : mixed	Get the value of a setting
get_template ( ) : array	Get a list of potential templates that can render this control
get_theme ( ) : Theme	Retreive the Theme used to display this form component and its descendants
get_visualizer ( )	Returns the HTML id of the element that the control exposes as a target, for example, for labels
input_name ( ) : string	Get the name to use for the input field
is_enabled ( ) : boolean	Determine if this controls should be enabled
label ( string $label ) : FormControlLabel	Shortcut to wrap this control in a label
load ( )	Load this control's initial data from the initialized storage location
on_save ( mixed $callback ) : FormControl	Set a function to call on form submission success
on_success ( mixed $callback ) : FormControl	Set a function to call on form submission success
pop_input_array ( ) : FormControl	Remove the most recent input_array setting
pre_out ( ) : string	Output this once when the control is first output to the page
prep_theme ( Theme $theme_obj ) : Theme
process ( )	Obtain the value of this control as supplied by the incoming $_POST values
remove_class ( array | string $classes ) : FormControl	Remove one or more CSS classes from this control
remove_validator ( string $name )	Removes a validation function from this control
save ( )	Save this control's data to the initialized storage location
set_container ( FormContainer $container )	Set the container for this control
set_enable ( Callable $enabler ) : FormControl	Set a function to use to determine if this control should be enabled or provided in the form
set_helptext ( string $helptext ) : FormControl
set_properties ( array $properties, boolean $override = false ) : FormControl	Set the HTML-related properties of this control
set_property ( string $name, mixed $value ) : FormControl	Set an HTML-related property of this control
set_setting ( string $name, mixed $value ) : FormControl	Set the value of a single setting
set_settings ( array $settings, boolean $override = false ) : FormControl
set_storage ( habari\FormStorage | string | null $storage ) : FormControl	Set the storage for this control
set_template ( string | array $template ) : FormControl	Set a template for use with this control
set_template_html ( Callable | string $template ) : FormControl	Set an HTML value directly for the output of a control
set_template_properties ( string $target, array $properties, boolean $override = false ) : FormControl	Set the HTML-related properties of this control's template
set_value ( mixed $value, boolean $manually = true ) : FormControl	Set the value of the control
validate ( ) : array	Runs any attached validation functions to check validation of this control.
wrap_by ( Callable | string $wrapper, mixed $thing ) : string	Process a thing either using an sprintf-style string, or a closure

메소드 상세

프로퍼티 상세