Class QFormBase

QBaseClass

QFormBase

Direct known subclasses

Indirect known subclasses

AjaxTimingForm, BasicForm, PluginManagerForm, ProjectListForm, RefreshForm, SampleForm, SpeedForm, TestImageBrowser, UrlForm, DataRepeaterExample, ExampleSingleForm, InjectForm, NestedTabForm, PaginatorForm, ParamsForm, PersistentExampleForm, PluginEditForm

Abstract
Package: Controls
Located at includes/base_controls/QFormBase.class.php

Methods summary
`public integer\|mixed\|null\|string`	# `__get( string $strName )` PHP magic method for getting property values of object PHP magic method for getting property values of object Parameters `$strName` Name of the propery Returns integer\|mixed\|null\|string Throws `QCallerException` Overrides `QBaseClass::__get()`
`public mixed\|string`	# `__set( string $strName, string $mixValue )` PHP magic function to set the value of properties of class object PHP magic function to set the value of properties of class object Parameters `$strName` Name of the property `$mixValue` Value of the property Returns mixed\|string Throws `QCallerException` Overrides `QBaseClass::__set()`
`public string`	# `GenerateControlId( )` Generates Control ID used to keep track of those QControls whose ID was not explicitly set. It uses the counter variable to maintain uniqueness for Control IDs during the life of the page Life of the page is untill the time when the formstate expired and is removed by the garbage collection of the formstate handler Generates Control ID used to keep track of those QControls whose ID was not explicitly set. It uses the counter variable to maintain uniqueness for Control IDs during the life of the page Life of the page is untill the time when the formstate expired and is removed by the garbage collection of the formstate handler Returns string the Ajax Action ID
`public string`	# `GenerateAjaxActionId( )` Generates Ajax Action ID used to keep track of Ajax Actions It uses the counter variable to maintain uniqueness for Ajax Action IDs during the life of the page Life of the page is untill the time when the formstate expired and is removed by the garbage collection of the formstate handler Generates Ajax Action ID used to keep track of Ajax Actions It uses the counter variable to maintain uniqueness for Ajax Action IDs during the life of the page Life of the page is untill the time when the formstate expired and is removed by the garbage collection of the formstate handler Returns string the Ajax Action ID
`protected`	# `Form_Run( )` Custom Form Run code. To contain code which should be run 'AFTER' QCubed's QForm run has been completed but 'BEFORE' the custom event handlers are called (In case it is to be used, it should be overriden by a child class) Custom Form Run code. To contain code which should be run 'AFTER' QCubed's QForm run has been completed but 'BEFORE' the custom event handlers are called (In case it is to be used, it should be overriden by a child class)
`protected`	# `Form_Load( )` To contain the code which should be executed after the Form Run and before the custom handlers are called (In case it is to be used, it should be overridden by a child class) In this situation, we are about to process an event, or the user has reloaded the page. Do whatever you need to do before any event processing. To contain the code which should be executed after the Form Run and before the custom handlers are called (In case it is to be used, it should be overridden by a child class) In this situation, we are about to process an event, or the user has reloaded the page. Do whatever you need to do before any event processing.
`protected`	# `Form_Create( )` To contain the code to initialize the QForm on the first call. Once the QForm is created, the state is saved and is reused by the Run method. In short - this function will run only once (the first time the QForm is to be created) (In case it is to be used, it should be overriden by a child class) To contain the code to initialize the QForm on the first call. Once the QForm is created, the state is saved and is reused by the Run method. In short - this function will run only once (the first time the QForm is to be created) (In case it is to be used, it should be overriden by a child class)
`protected`	# `Form_PreRender( )` To contain the code to be executed after Form_Run, Form_Create, Form_Load has been called and the custom defined event handlers have been executed but actual rendering process has not begun. This is a good place to put data into a session variable that you need to send to other forms. To contain the code to be executed after Form_Run, Form_Create, Form_Load has been called and the custom defined event handlers have been executed but actual rendering process has not begun. This is a good place to put data into a session variable that you need to send to other forms.
`protected`	# `Form_Initialize( )` Override this method to set data in your form controls. Appropriate things to do would be to: - Respond to options sent by _GET or _POST variables. - Load data into the control from the database - Initialize controls whose data depends on the state or data in other controls. Override this method to set data in your form controls. Appropriate things to do would be to: - Respond to options sent by _GET or _POST variables. - Load data into the control from the database - Initialize controls whose data depends on the state or data in other controls. When this is called, the controls will have been created by Form_Create, and will have already read their saved state.
`protected boolean`	# `Form_Validate( )` The Form_Validate method. The Form_Validate method. Before we get here, all the controls will first be validated. Override this method to do additional form level validation, and any form level actions needed as part of the validation process, like displaying an error message. This is the last thing called in the validation process, and will always be called if validation is requested, even if prior controls caused a validation error. Return false to prevent validation and cancel the current action. $blnValid will contain the result of control validation. If it is false, you know that validation will fail, regardless of what you return from the function. Returns boolean Return false to prevent validation.
`protected`	# `Form_Invalid( )` If you want to respond in some way to an invalid form that you have not already been able to handle, override this function. For example, you could display a message that an error occurred with some of the controls. If you want to respond in some way to an invalid form that you have not already been able to handle, override this function. For example, you could display a message that an error occurred with some of the controls.
`protected`	# `Form_Exit( )` This function is meant to be overriden by child class and is called when the Form exits (After the form render is complete and just before the Run function completes execution) This function is meant to be overriden by child class and is called when the Form exits (After the form render is complete and just before the Run function completes execution)
`public mixed`	# `VarExport( boolean $blnReturn = true )` VarExport the Controls or var_export the current QForm (well, be ready for huge amount of text) VarExport the Controls or var_export the current QForm (well, be ready for huge amount of text) Parameters `$blnReturn` Returns mixed
`public mixed\|null`	# `CheckableControlValue( $strControlId )` Returns the value of a checkable control. Checkable controls are special, in that the browser only tells us when a control is checked, not when it is unchecked. So, unless we keep track of them specially, we will not know if they are unchecked, or just not there. Returns the value of a checkable control. Checkable controls are special, in that the browser only tells us when a control is checked, not when it is unchecked. So, unless we keep track of them specially, we will not know if they are unchecked, or just not there. Parameters `$strControlId` Returns mixed\|null
`protected static boolean`	# `IsControlModified( QControl $objControl )` Helper function for below GetModifiedControls Helper function for below GetModifiedControls Parameters `$objControl` Returns boolean
`public`	# `GetModifiedControls( )` Return only the controls that have been modified Return only the controls that have been modified
`public static`	# `Run( string $strFormClass, string\|null $strAlternateHtmlFile = null, string\|null $strFormId = null )` This method initializes the actual layout of the form It runs in all cases including initial form (the time when Form_Create is run) as well as on trigger actions (QServerAction, QAjaxAction, QServerControlAction and QAjaxControlAction) This method initializes the actual layout of the form It runs in all cases including initial form (the time when Form_Create is run) as well as on trigger actions (QServerAction, QAjaxAction, QServerControlAction and QAjaxControlAction) It is responsible for implementing the logic and sequence in which page wide checks are done such as running Form_Validate and Control validations for every control of the page and their child controls. Checking for an existing FormState and loading them before trigerring any action is also a responsibility of this method. Parameters `$strFormClass` The class of the form to create when creating a new form. `$strAlternateHtmlFile` location of the alternate HTML template file. `$strFormId` The html id to use for the form. If null, $strFormClass will be used. Throws `QCallerException` `QInvalidFormStateException` Exception
`protected static mixed\|string`	# `UnpackPostVar( $val )` Unpacks a post variable that has been encoded with JSON.stringify. Unpacks a post variable that has been encoded with JSON.stringify. Parameters `$val` Returns mixed\|string
`public`	# `ResetValidationStates( )` Reset all validation states. Reset all validation states.
`public static`	# `InvalidFormState( )` An invalid form state was found. We were handed a formstate, but the formstate could not be interpreted. This could be for a variety of reasons, and is dependent on the formstate handler. Most likely, the user hit the back button past the back button limit of what we remember, or the user lost the session. Or, you simply have not set up the form state handler correctly. In the past, we threw an exception, but that was not a very user friendly response. The response below resubmits the url without a formstate so that a new one will be created. Override if you want a different response. An invalid form state was found. We were handed a formstate, but the formstate could not be interpreted. This could be for a variety of reasons, and is dependent on the formstate handler. Most likely, the user hit the back button past the back button limit of what we remember, or the user lost the session. Or, you simply have not set up the form state handler correctly. In the past, we threw an exception, but that was not a very user friendly response. The response below resubmits the url without a formstate so that a new one will be created. Override if you want a different response.
`public`	# `CallDataBinder( callable $callable, QControl $objPaginatedControl )` Calls a data binder associated with the form. Does this so data binder can be protected. Mostly for legacy code. Calls a data binder associated with the form. Does this so data binder can be protected. Mostly for legacy code. Parameters `$callable` `$objPaginatedControl` Throws `QDataBindException`
`protected string`	# `RenderAjaxHelper( QControlBase $objControl )` Renders the AjaxHelper for the QForm Renders the AjaxHelper for the QForm Parameters `$objControl` Returns string The Ajax helper string (should be JS commands)
`protected`	# `RenderAjax( )` Renders the actual ajax return value as a json object. Since json must be UTF-8 encoded, will convert to UTF-8 if needed. Response is parsed in the "success" function in qcubed.js, and handled there. Renders the actual ajax return value as a json object. Since json must be UTF-8 encoded, will convert to UTF-8 if needed. Response is parsed in the "success" function in qcubed.js, and handled there.
`public static string`	# `Serialize( QForm $objForm )` Saves the formstate using the 'Save' method of FormStateHandler set in configuration.inc.php Saves the formstate using the 'Save' method of FormStateHandler set in configuration.inc.php Parameters `$objForm` Returns string the Serialized QForm
`public static QForm`	# `Unserialize( string $strPostDataState )` Unserializes (extracts) the FormState using the 'Load' method of FormStateHandler set in configuration.inc.php Unserializes (extracts) the FormState using the 'Load' method of FormStateHandler set in configuration.inc.php Parameters `$strPostDataState` The string identifying the FormState to the loaded for Unserialization Returns `QForm` the Form object
`public`	# `AddControl( QControl $objControl )` Add a QControl to the current QForm. Add a QControl to the current QForm. Parameters `$objControl` Throws `QCallerException`
`public null\|QControl`	# `GetControl( string $strControlId )` Returns a control from the current QForm Returns a control from the current QForm Parameters `$strControlId` The Control ID of the control which is needed to be fetched from the current QForm (should be the child of the current QForm). Returns null\|`QControl`
`public`	# `RemoveControl( string $strControlId )` Removes a QControl (and its children) from the current QForm Removes a QControl (and its children) from the current QForm Parameters `$strControlId`
`public mixed\|QControl[]`	# `GetAllControls( )` Returns all controls belonging to the Form as an array. Returns all controls belonging to the Form as an array. Returns mixed\|`QControl[]`
`public`	# `SaveControlState( )` Tell all the controls to save their state. Tell all the controls to save their state.
`protected`	# `RestoreControlState( )` Tell all the controls to read their state. Tell all the controls to read their state.
`public`	# `SetCustomAttribute( string $strName, string $strValue )` Custom Attributes are other html name-value pairs that can be rendered within the form using this method. For example, you can now render the autocomplete tag on the QForm additional javascript actions, etc. $this->SetCustomAttribute("autocomplete", "off"); Will render: [form ...... autocomplete="off"] (replace sqare brackets with angle brackets) Custom Attributes are other html name-value pairs that can be rendered within the form using this method. For example, you can now render the autocomplete tag on the QForm additional javascript actions, etc. $this->SetCustomAttribute("autocomplete", "off"); Will render: [form ...... autocomplete="off"] (replace sqare brackets with angle brackets) Parameters `$strName` Name of the attribute `$strValue` Value of the attribute Throws `QCallerException`
`public mixed`	# `GetCustomAttribute( string $strName )` Returns the requested custom attribute from the form. This attribute must have already been set. Returns the requested custom attribute from the form. This attribute must have already been set. Parameters `$strName` Name of the Custom Attribute Returns mixed Throws `QCallerException`
`public`	# `RemoveCustomAttribute( $strName )`
`public`	# `AddGrouping( QControlGrouping $objGrouping )`
`public`	# `GetGrouping( $strGroupingId )`
`public`	# `RemoveGrouping( $strGroupingId )`
`public mixed`	# `GetAllGroupings( )` Retruns the Groupings Retruns the Groupings Returns mixed
`public QControl[]`	# `GetChildControls( QForm\|QControl\|QFormBase $objParentObject )` Returns the child controls of the current QForm or a QControl object Returns the child controls of the current QForm or a QControl object Parameters `$objParentObject` The object whose child controls are to be searched for Returns `QControl[]` Throws `QCallerException`
`public string`	# `EvaluateTemplate( string $strTemplate )` This function evaluates the QForm Template. It will try to open the Template file specified in the call to 'Run' method for the QForm and then execute it. This function evaluates the QForm Template. It will try to open the Template file specified in the call to 'Run' method for the QForm and then execute it. Parameters `$strTemplate` Path to the HTML template file Returns string The evaluated HTML string
`protected`	# `TriggerMethod( string $strControlId, string $strMethodName, QAction $objAction )` Triggers an event handler method for a given control ID NOTE: Parameters must be already validated and are guaranteed to exist. Triggers an event handler method for a given control ID NOTE: Parameters must be already validated and are guaranteed to exist. Parameters `$strControlId` Control ID triggering the method `$strMethodName` Method name which has to be fired. Includes a control id if a control action. `$objAction` The action object which caused the event
`protected boolean`	# `ValidateControlAndChildren( QControl $objControl )` Calles 'Validate' method on a QControl recursively Calles 'Validate' method on a QControl recursively Parameters `$objControl` Returns boolean
`protected`	# `TriggerActions( null\|string $strControlIdOverride = null )` Runs/Triggers any and all event handling functions for the control on which an event took place Depending on the control's CausesValidation value, it also calls for validation of the control or control and children or entire QForm. Runs/Triggers any and all event handling functions for the control on which an event took place Depending on the control's CausesValidation value, it also calls for validation of the control or control and children or entire QForm. Parameters `$strControlIdOverride` If supplied, the control with the supplied ID is selected Throws Exception\|`QCallerException`
`protected`	# `Render( )` Begins rendering the page Begins rendering the page
`protected null\|string`	# `RenderChildren( boolean $blnDisplayOutput = true )` Render the children of this QForm Render the children of this QForm Parameters `$blnDisplayOutput` Returns null\|string Null when blnDisplayOutput is true
`protected`	# `__construct( )` This exists to prevent inadverant "New" This exists to prevent inadverant "New"
`public null\|string`	# `RenderStyles( boolean $blnDisplayOutput = true, $blnInHead = true )` Renders the tags to include the css style sheets. Call this in your head tag if you want to put these there. Otherwise, the styles will automatically be included just after the form. Renders the tags to include the css style sheets. Call this in your head tag if you want to put these there. Otherwise, the styles will automatically be included just after the form. Parameters `$blnDisplayOutput` `$blnInHead` Returns null\|string
`public null\|string`	# `RenderBegin( boolean $blnDisplayOutput = true )` Initializes the QForm rendering process Initializes the QForm rendering process Parameters `$blnDisplayOutput` Whether the output is to be printed (true) or simply returned (false) Returns null\|string Throws `QCallerException`
`protected string[]`	# `ProcessJavaScriptList( string $strJavaScriptFileList )` Internal helper function used by RenderBegin and by RenderAjax Given a comma-delimited list of javascript files, this will return an array of files that NEED to still be included because (1) it hasn't yet been included and (2) it hasn't been specified to be "ignored". Internal helper function used by RenderBegin and by RenderAjax Given a comma-delimited list of javascript files, this will return an array of files that NEED to still be included because (1) it hasn't yet been included and (2) it hasn't been specified to be "ignored". This WILL update the internal $strIncludedJavaScriptFileArray array. Parameters `$strJavaScriptFileList` array $strJavaScriptFileList Returns string[] array of script files to include or NULL if none
`protected string[]`	# `ProcessStyleSheetList( string $strStyleSheetFileList )` Primarily used by RenderBegin and by RenderAjax Given a comma-delimited list of stylesheet files, this will return an array of file that NEED to still be included because (1) it hasn't yet been included and (2) it hasn't been specified to be "ignored". Primarily used by RenderBegin and by RenderAjax Given a comma-delimited list of stylesheet files, this will return an array of file that NEED to still be included because (1) it hasn't yet been included and (2) it hasn't been specified to be "ignored". This WILL update the internal $strIncludedStyleSheetFileArray array. Parameters `$strStyleSheetFileList` Returns string[] array of stylesheet files to include or NULL if none
`public boolean`	# `IsPostBack( )` Returns whether or not this Form is being run due to a PostBack event (e.g. a ServerAction or AjaxAction) Returns whether or not this Form is being run due to a PostBack event (e.g. a ServerAction or AjaxAction) Returns boolean
`public string[]`	# `GetErrorMessages( boolean $blnErrorsOnly = false )` Will return an array of Strings which will show all the error and warning messages in all the controls in the form. Will return an array of Strings which will show all the error and warning messages in all the controls in the form. Parameters `$blnErrorsOnly` Show only the errors (otherwise, show both warnings and errors) Returns string[] an array of strings representing the (multiple) errors and warnings
`public QControl[]`	# `GetErrorControls( boolean $blnErrorsOnly = false )` Will return an array of QControls from the form which have either an error or warning message. Will return an array of QControls from the form which have either an error or warning message. Parameters `$blnErrorsOnly` Return controls that have just errors (otherwise, show both warnings and errors) Returns `QControl[]` an array of controls representing the (multiple) errors and warnings
`public string`	# `GetJsFileUri( string $strFile )` Gets the JS file URI, given a string input Gets the JS file URI, given a string input Parameters `$strFile` File name to be tested Returns string the final JS file URI
`public string`	# `GetCssFileUri( string $strFile )` Gets the CSS file URI, given a string input Gets the CSS file URI, given a string input Parameters `$strFile` File name to be tested Returns string the final CSS URI
`protected array`	# `GetFormJavaScripts( )` Get high level form javascript files to be included. Default here includes all javascripts needed to run qcubed. Override and add to this list and include javascript and jQuery files and libraries needed for your application. Javascript files included before QCUBED_JS_CORE can refer to jQuery as $. After qcubed.js, $ becomes $j, so add other libraries that need $ in a different context after qcubed.js, and insert jQuery libraries and plugins that refer to $ before qcubed.js file. Get high level form javascript files to be included. Default here includes all javascripts needed to run qcubed. Override and add to this list and include javascript and jQuery files and libraries needed for your application. Javascript files included before QCUBED_JS_CORE can refer to jQuery as $. After qcubed.js, $ becomes $j, so add other libraries that need $ in a different context after qcubed.js, and insert jQuery libraries and plugins that refer to $ before qcubed.js file. Returns array
`public null\|string`	# `RenderEnd( boolean $blnDisplayOutput = true )` Renders the end of the form, including the closing form and body tags. Renders the html for hidden controls. Renders the end of the form, including the closing form and body tags. Renders the html for hidden controls. Parameters `$blnDisplayOutput` should the output be returned or directly printed to screen. Returns null\|string Throws `QCallerException`

Methods inherited from QBaseClass
`OverrideAttributes(), __call()`

Constants summary
`integer`	`FormStatusUnrendered` Form has not started rendering Form has not started rendering	# `1`
`integer`	`FormStatusRenderBegun` Form has started rendering but has not finished Form has started rendering but has not finished	# `2`
`integer`	`FormStatusRenderEnded` Form rendering has already been started and finished Form rendering has already been started and finished	# `3`

Properties summary
`protected static boolean`	`$blnStylesRendered` True when css scripts get rendered on page. Lets user call RenderStyles in header. True when css scripts get rendered on page. Lets user call RenderStyles in header.	# `false`
`protected string`	`$strFormId` Form ID (usually passed as the first argument to the 'Run' method call) Form ID (usually passed as the first argument to the 'Run' method call)	#
`protected integer`	`$intFormStatus` representational integer value of what state the form currently is in representational integer value of what state the form currently is in	#
`protected QControl[]`	`$objControlArray` Array of QControls with this form as the parent Array of QControls with this form as the parent	#
`protected QControlGrouping`	`$objGroupingArray` List of Groupings in the form (for old drag and drop) Use of this is deprecated in favor of jQueryUI drag and drop, but code remains in case we need it again. List of Groupings in the form (for old drag and drop) Use of this is deprecated in favor of jQueryUI drag and drop, but code remains in case we need it again. Deprecated	#
`protected boolean`	`$blnRenderedBodyTag` Has the body tag already been rendered? Has the body tag already been rendered?	# `false`
`protected array`	`$checkableControlValues`	# `array()`
`protected string`	`$strCallType` The type of call made to the QForm (Ajax, Server or Fresh GET request) The type of call made to the QForm (Ajax, Server or Fresh GET request)	#
`protected null\|QWaitIcon`	`$objDefaultWaitIcon` Default wait icon for the page/QForm Default wait icon for the page/QForm	# `null`
`protected array`	`$strFormAttributeArray`	# `array()`
`protected array`	`$strIncludedJavaScriptFileArray` List of included JavaScript files for this QForm List of included JavaScript files for this QForm	# `array()`
`protected array`	`$strIgnoreJavaScriptFileArray` List of ignored JavaScript files for this QForm List of ignored JavaScript files for this QForm	# `array()`
`protected array`	`$strIncludedStyleSheetFileArray` List of included CSS files for this QForm List of included CSS files for this QForm	# `array()`
`protected array`	`$strIgnoreStyleSheetFileArray` List of ignored CSS files for this QForm List of ignored CSS files for this QForm	# `array()`
`protected boolean`	`$strPreviousRequestMode`	# `false`
`protected string`	`$strHtmlIncludeFilePath` The QForm's template file path. When this value is not supplied, the 'Run' function will try to find and use the .tpl.php file with the same filename as the QForm in the same same directory as the QForm file. The QForm's template file path. When this value is not supplied, the 'Run' function will try to find and use the .tpl.php file with the same filename as the QForm in the same same directory as the QForm file.	#
`protected string`	`$strCssClass` CSS class to be set for the 'form' tag when QCubed Renders the QForm CSS class to be set for the 'form' tag when QCubed Renders the QForm	#
`protected`	`$strCustomAttributeArray`	# `null`
`public static null\|string`	`$EncryptionKey` The key to encrypt the formstate when saving and retrieving from the chosen FormState handler The key to encrypt the formstate when saving and retrieving from the chosen FormState handler	# `null`
`public static string`	`$FormStateHandler` Chosen FormStateHandler default is QFormStateHandler as shown here, however it is read from the configuration.inc.php (in the QForm class) In case something goes wrong with QForm, the default FormStateHandler here will try to take care of the situation. Chosen FormStateHandler default is QFormStateHandler as shown here, however it is read from the configuration.inc.php (in the QForm class) In case something goes wrong with QForm, the default FormStateHandler here will try to take care of the situation.	# `'QFormStateHandler'`
`protected integer`	`$intNextControlId` Counter variable to contain the numerical part of the Control ID value. it is automatically incremented everytime the GenerateControlId() runs Counter variable to contain the numerical part of the Control ID value. it is automatically incremented everytime the GenerateControlId() runs	# `1`
`protected integer`	`$intNextAjaxActionId` Counter variable to contain the numerical part of the AJAX ID value. it is automatically incremented everytime the GenerateAjaxActionId() runs Counter variable to contain the numerical part of the AJAX ID value. it is automatically incremented everytime the GenerateAjaxActionId() runs	# `1`

Magic properties summary
`public string`	`$HtmlIncludeFilePath` (Alternate) path to the template file to be used
`public string`	`$CssClass` Form CSS class.
`public read-only string`	`$FormId` Form ID of the QForm
`public read-only string`	`$CallType` Type of call (useful when the QForm submits due to user action)
`public read-only QWaitIcon`	`$DefaultWaitIcon` Default Ajax wait icon control
`public read-only integer`	`$FormStatus` Status of form (pre-render stage, rendering stage of already rendered stage)

Packages

Classes

Traits

Exceptions

Functions

Class QFormBase

Direct known subclasses

Indirect known subclasses

Parameters

Returns

Throws

Overrides

Parameters

Returns

Throws

Overrides

Returns

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Throws

Parameters

Returns

Parameters

Throws

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Throws

Parameters

Returns

Parameters

Returns

Parameters

Throws

Parameters

Returns

Throws

Returns

Parameters

Returns

Throws

Parameters

Returns

Parameters

Parameters

Returns

Parameters

Throws

Parameters

Returns

Parameters

Returns

Parameters

Returns

Throws

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns