Contentserv PHP API

CSOpenSearchForm
in package
implements IteratorAggregate

Represents an OpenSearch Form.

The Class dictates which fields (and their data) should be displayed. It is only a representation of data/definition. The style/html is handled by client.

Tags
since

CS17.0

access

public

Interfaces, Classes and Traits

IteratorAggregate

Table of Contents

__construct()  : mixed
addSection()  : CSOpenSearchFormSection
Adds a new instance of CSOpenSearchFormSectionField to current field set.
getHeaderLabel()  : null|string
Returns the defined Header Label
getIterator()  : array<string|int, CSOpenSearchFormField>
getSection()  : CSOpenSearchFormSection
Fetches the unique object of Form Section
setHeaderLabel()  : void
Sets the Header label of the form This might be used on different places not necessarily as a Header Title of a form.
toArray()  : array<string|int, mixed>
Transforms this object into an array.

Methods

getHeaderLabel()

Returns the defined Header Label

public getHeaderLabel() : null|string
Tags
Return values
null|string —

Either null if not defined or a string.

setHeaderLabel()

Sets the Header label of the form This might be used on different places not necessarily as a Header Title of a form.

public setHeaderLabel(string $sLabel) : void

For Example in Dialog this will be shows as Dialog Title.

Parameters
$sLabel : string

A translated Label which should be shown as a Header of the Form

Tags
Return values
void —

toArray()

Transforms this object into an array.

public toArray() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> — 

        

        
    




    

    

                

    

        

            
Search results