Yioop_V9.5_Source_Code_Documentation

MixcrawlsElement extends Element
in package

Element responsible for displaying info to allow a user to create a crawl mix or edit an existing one

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
Draw form to start a new crawl, has div place holder and ajax code to get info about current crawl
renderMixesTable()  : mixed
Draw the table that displays the currently defined crawl mixes
renderMixForm()  : mixed
Draws the create mix form
renderSearchForm()  : mixed
Draws the search for mixes 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()

Draw form to start a new crawl, has div place holder and ajax code to get info about current crawl

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

form about about a crawl such as its description

Return values
mixed

renderMixesTable()

Draw the table that displays the currently defined crawl mixes

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

info about current users and current mixes, CSRF token

Return values
mixed

renderMixForm()

Draws the create mix form

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

used for CSRF_TOKEN

Return values
mixed

renderSearchForm()

Draws the search for mixes forms

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

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

Return values
mixed

        

Search results