Yioop_V9.5_Source_Code_Documentation

ConfigureElement extends Element
in package

Element responsible for drawing the screen used to set up the search engine

This element has form fields to set up the work directory for crawls, the default language, the debug settings and test settings, and the robot identifier information.

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
Draws the forms used to configure the search engine.

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()

Draws the forms used to configure the search engine.

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

This element has two forms on it: One for setting the working directory for crawls, the other to set-up profile information which is mainly stored in the profile.php file in the working directory. The exception is longer data concerning the crawl robot description which is stored in bot.txt.

Parameters
$data : array<string|int, mixed>

holds data on the profile elements which have been filled in as well as data about which form fields to display

Return values
mixed

        

Search results