|
CWIS Developer Documentation
|
Class to create a user interface for editing SearchParameterSets. More...
Public Member Functions | |
| __construct ($FormFieldName, $SearchParams=NULL) | |
| Create a UI for specifing edits to SearchParameterSets. More... | |
| DisplayAsTable ($TableId=NULL, $TableStyle=NULL) | |
| Display editing form elements enclosed in a. More... | |
| DisplayAsRows () | |
| Display the table rows for the editing form, without the surrounding. More... | |
| GetValuesFromFormData () | |
| Extract values from a dynamics field edit/modification form. More... | |
| SearchParameters ($SearchParams=NULL) | |
| Get/Set search parameters. More... | |
| MaxFieldLabelLength ($NewValue=NULL) | |
| Get/set the max number of characters a label of a field option list will be displayed. More... | |
| MaxValueLabelLength ($NewValue=NULL) | |
| Get/set the max number of characters a label of a value option list will be displayed. More... | |
Class to create a user interface for editing SearchParameterSets.
Definition at line 13 of file SearchParameterSetEditingUI.php.
| SearchParameterSetEditingUI::__construct | ( | $FormFieldName, | |
$SearchParams = NULL |
|||
| ) |
Create a UI for specifing edits to SearchParameterSets.
| string | $FormFieldName | HTML 'name' to use for <input> elements created by the UI. If this UI is incorporated into a form containing other input elements, they must have names that differ from this one. |
| SearchParameterSet | $SearchParams | SearchParameterSet to display (OPTIONAL, uses an empty set if unspecified) |
Definition at line 24 of file SearchParameterSetEditingUI.php.
References MetadataSchema\GetAllSchemas(), and MetadataSchema\MDFORDER_ALPHABETICAL.
| SearchParameterSetEditingUI::DisplayAsRows | ( | ) |
Display the table rows for the editing form, without the surrounding.
.
Definition at line 77 of file SearchParameterSetEditingUI.php.
References StdLib\strpos(), and StdLib\substr().
Referenced by DisplayAsTable().

| SearchParameterSetEditingUI::DisplayAsTable | ( | $TableId = NULL, |
|
$TableStyle = NULL |
|||
| ) |
Display editing form elements enclosed in a.
Note that it still must be wrapped in a <form> that has a submit button.
| string | $TableId | HTML identifier to use (OPTIONAL, default NULL). |
| string | $TableStyle | CSS class to attach for this table (OPTIONAL, default NULL). |
Definition at line 64 of file SearchParameterSetEditingUI.php.
References DisplayAsRows().
| SearchParameterSetEditingUI::GetValuesFromFormData | ( | ) |
Extract values from a dynamics field edit/modification form.
Definition at line 180 of file SearchParameterSetEditingUI.php.
References MetadataSchema\MDFTYPE_CONTROLLEDNAME, MetadataSchema\MDFTYPE_DATE, MetadataSchema\MDFTYPE_FLAG, MetadataSchema\MDFTYPE_NUMBER, MetadataSchema\MDFTYPE_OPTION, MetadataSchema\MDFTYPE_PARAGRAPH, MetadataSchema\MDFTYPE_TEXT, MetadataSchema\MDFTYPE_TIMESTAMP, MetadataSchema\MDFTYPE_TREE, MetadataSchema\MDFTYPE_URL, and MetadataSchema\MDFTYPE_USER.
| SearchParameterSetEditingUI::MaxFieldLabelLength | ( | $NewValue = NULL | ) |
Get/set the max number of characters a label of a field option list will be displayed.
| int | $NewValue | Max length of a field option list's label. Use zero for no limit (OPTIONAL, default to no limit). If NULL is passed in, this function will not set a new max length of a field option list. |
Definition at line 387 of file SearchParameterSetEditingUI.php.
Referenced by MaxValueLabelLength().

| SearchParameterSetEditingUI::MaxValueLabelLength | ( | $NewValue = NULL | ) |
Get/set the max number of characters a label of a value option list will be displayed.
| int | $NewValue | Max length of a field option list's label. Use zero for no limit (OPTIONAL, default to no limit). If NULL is passed in, this function will not set a new max length of a value option list. |
Definition at line 406 of file SearchParameterSetEditingUI.php.
References MaxFieldLabelLength(), MetadataSchema\MDFTYPE_FLAG, MetadataSchema\MDFTYPE_OPTION, and MetadataSchema\SCHEMAID_DEFAULT.
| SearchParameterSetEditingUI::SearchParameters | ( | $SearchParams = NULL | ) |
Get/Set search parameters.
| SearchParameterSet | null | $SearchParams | New setting (OPTIONAL) |
Definition at line 367 of file SearchParameterSetEditingUI.php.