Yioop_V9.5_Source_Code_Documentation

SearchsourcesElement extends Element
in package

This element renders the forms for managing search sources for news, etc.

Also, contains form for managing subsearches which appear in SearchView

Tags
author

Chris Pollett

Table of Contents

$view  : object
The View on which this Element is drawn
__construct()  : mixed
constructor stores a reference to the view this element will reside on
formatHref()  : string
Used to slightly clean up hypertext links before drawing them (get rid of empty queries, avoid double encoding)
render()  : mixed
Renders search source, subsearch forms or renders the results of testing a search source
renderFeedTestResults()  : mixed
Renders the results of testing a search source
renderFormsAndTables()  : mixed
Renders search source and subsearch forms
renderMediaSearchForm()  : mixed
Draws the search for media source forms
renderMediaSourceForm()  : mixed
Draws the Media Source form used to add and edit media sources that that are automatically downloaded by Yioop from news and podcast feeds
renderSubsearchForm()  : mixed
Draws the Subsearch element used to configure subsearches that are choosable on landing page and elsewhere
renderSubsearchSearchForm()  : mixed
Draws the search for media source forms

Properties

$view

The View on which this Element is drawn

public object $view

Methods

__construct()

constructor stores a reference to the view this element will reside on

public __construct([object $view = null ]) : mixed
Parameters
$view : object = null

object this element will reside on

Return values
mixed

formatHref()

Used to slightly clean up hypertext links before drawing them (get rid of empty queries, avoid double encoding)

public formatHref(string $url) : string
Parameters
$url : string

to clean up

Return values
string

cleaned url

render()

Renders search source, subsearch forms or renders the results of testing a search source

public render(array<string|int, mixed> $data) : mixed
Parameters
$data : array<string|int, mixed>

available Search sources and subsearches or feed test results

Return values
mixed

renderFeedTestResults()

Renders the results of testing a search source

public renderFeedTestResults(array<string|int, mixed> $data) : mixed
Parameters
$data : array<string|int, mixed>

available Search sources and subsearches or feed test results

Return values
mixed

renderFormsAndTables()

Renders search source and subsearch forms

public renderFormsAndTables(array<string|int, mixed> $data) : mixed
Parameters
$data : array<string|int, mixed>

available Search sources and subsearches

Return values
mixed

renderMediaSearchForm()

Draws the search for media source forms

public renderMediaSearchForm(array<string|int, mixed> $data) : mixed
Parameters
$data : array<string|int, mixed>

consists of values of search source fields set so far as well as values of the drops downs on the form

Return values
mixed

renderMediaSourceForm()

Draws the Media Source form used to add and edit media sources that that are automatically downloaded by Yioop from news and podcast feeds

public renderMediaSourceForm(array<string|int, mixed> $data) : mixed
Parameters
$data : array<string|int, mixed>

consists of values of media source fields set so far as well as values of the drops downs on the form

Return values
mixed

renderSubsearchForm()

Draws the Subsearch element used to configure subsearches that are choosable on landing page and elsewhere

public renderSubsearchForm(array<string|int, mixed> $data) : mixed
Parameters
$data : array<string|int, mixed>

consists of values of search source fields set so far as well as values of the drops downs on the form

Return values
mixed

renderSubsearchSearchForm()

Draws the search for media source forms

public renderSubsearchSearchForm(array<string|int, mixed> $data) : mixed
Parameters
$data : array<string|int, mixed>

consists of values of search source fields set so far as well as values of the drops downs on the form

Return values
mixed

        

Search results