Yioop_V9.5_Source_Code_Documentation

elements

Interfaces, Classes, Traits and Enums

AdminbarElement
Element used to draw the navigation bar on admin pages.
AdminElement
Element used to render the admin interface for a logged in user of Yioop
AdminmenuElement
Element responsible for drawing the side menu portion of an admin page. This allows the user to signout or select from among allowed admin activities
ApiElement
Element responsible for drawing wiki pages in either admin or wiki view It is also responsible for rendering wiki history pages, and listings of wiki pages available for a group
AppearanceElement
Element responsible for drawing the screen used to set up the search engine appearance.
BotstoryElement
Element responsible for displaying the bot story features that someone can use to create for their own chat bot.
ConfigureElement
Element responsible for drawing the screen used to set up the search engine
CrawloptionsElement
Element responsible for displaying options about how a crawl will be performed. For instance, what are the seed sites for the crawl, what sites are allowed to be crawl what sites must not be crawled, etc.
DisplayadvertisementElement
Element responsible for displaying the advertisement on the search results page
EditclassifierElement
This element renders the initial edit page for a classifier, where the user can update the classifier label and find documents to label and add to the training set. The page displays some initial statistics and a form for finding documents in any existing index, but after that it is heavily modified by JavaScript in response to user actions and XmlHttpRequests made to the server.
EditlocalesElement
Element responsible for displaying the form where users can input string translations for a given locale
EditmixElement
Element responsible for displaying info about a given crawl mix
Element
Base Element Class.
FooterElement
Element responsible for drawing footer links on search view and static view pages
GroupbarElement
Element used to draw the navigation bar on group feed and wiki pages.
GroupElement
Element used to present group feed and wiki pages for the Yioop website
GroupfeedElement
Element responsible for draw the feeds a user is subscribed to
GroupmenuElement
Element responsible for drawing the menu side bar for group and wiki pages. These options include recently viewed wiki pages, groups, and threads
HeaderElement
Element responsible for drawing the header on admin, group, and, search views
HelpElement
This element is used to display the list of available activities in the AdminView
LanguageElement
Element used to display available languages in the settings view
MachinelogElement
Element responsible for displaying the queue_server or fetcher log of a machine
ManageaccountElement
Element responsible for displaying the user account features that someone can modify for their own SeekQuarry/Yioop account.
ManageadvertisementsElement
Element responsible for displaying advertisements information that someone can create, view, and modify for their own SeekQuarry/Yioop account.
ManageclassifiersElement
This element renders the page that lists classifiers, provides a form to create new ones, and provides per-classifier action links to edit, finalize, and delete the associated classifier.
ManagecrawlsElement
Element responsible for displaying info about starting, stopping, deleting, and using a crawl. It makes use of the CrawlStatusView
ManagecreditsElement
Element responsible for displaying Ad credits purchase form and recent transaction table
ManagegroupsElement
Used to draw the admin screen on which users can create groups, delete groups and add and delete users and roles to a group
ManagelocalesElement
This Element is responsible for drawing screens in the Admin View related to localization. Namely, the ability to create, delete, and text writing mode for locales as well as the ability to modify translations within a locale.
ManagemachinesElement
Used to draw the admin screen on which admin users can add/delete and manage machines which might act as fetchers or queue_servers.
ManagerolesElement
Used to draw the admin screen on which admin users can create roles, delete roles and add and delete activitiess from roles
ManageusersElement
Element responsible for drawing the activity screen for User manipulation in the AdminView.
MediajobsElement
Element used to draw toggles indicating which jobs the Media Updater will run and letting the user turn these jobs on/off.
MixcrawlsElement
Element responsible for displaying info to allow a user to create a crawl mix or edit an existing one
PageOptionsElement
This element is used to render the Page Options admin activity This activity lets a user control the amount of web pages downloaded, the recrawl frequency, the file types, etc of the pages crawled
PaginationElement
Element responsible for drawing the sequence of available pages for search results.
QuerystatsElement
Element responsible for displaying statistics about recent queries that have been run against the search engine
ResultsEditorElement
Element used to control how urls are filtered out of search results (if desired) after a crawl has already been performed.
ScrapersElement
Contains the forms for managing Web Page Scrapers.
SearchbarElement
Element used to draw the navigation bar on search pages.
SearchcalloutElement
Element responsible for drawing search wiki callouts for search results
SearchElement
Element used to present search results It is also contains the landing page search box for people to types searches into
SearchmenuElement
Element responsible for drawing the side menu with sign in/create account, search source options, search settings, and tool info for search pages
SearchsourcesElement
This element renders the forms for managing search sources for news, etc.
SecurityElement
Element used to handle configurations of Yioop related to authentication, captchas, and recovery of missing passwords
ServersettingsElement
Element used to draw forms to set up the various external servers that might be connected with a Yioop installation
SideadvertisementElement
Element used to draw an external server advertisement (if there is one) as a column on the opposite side of a search results page
StatisticsElement
Draws an element displaying statistical information about a web crawl such as number of hosts visited, distribution of file sizes, distribution of file type, distribution of languages, etc
TopadvertisementElement
This element is used to draw the keyword advertisement above search results (if present)
TrendingElement
Class to draw statistics and charts about trending news feed terms
UsermessagesElement
Element responsible for draw the feeds a user is subscribed to
WelcomemenuElement
Element responsible for drawing the side menu portion of an admin page. This allows the user to signout or select from among allowed admin activities
WikiElement
Element responsible for drawing wiki pages in group view It is also responsible for rendering wiki history pages, and listings of wiki pages available for a group
CrawlcontrolsElement
Used to the control buttons on manage account, manage crawls, etc pages
SocialcontrolsElement
Used to the control buttons on manage account, manage groups, group feed, etc pages

Table of Contents

tl()  : string
Translate the supplied arguments into the current locale.
e()  : mixed
shorthand for echo

Functions

tl()

Translate the supplied arguments into the current locale.

tl() : string

This function is a convenience copy of the same function

Tags
see
tl()

to this subnamespace

Return values
string

translated string

e()

shorthand for echo

e(string $text) : mixed
Parameters
$text : string

string to send to the current output

Return values
mixed

Search results