Yioop_V9.5_Source_Code_Documentation

models

Namespaces

datasources

Interfaces, Classes, Traits and Enums

ActivityModel

This is class is used to handle db results related to Administration Activities

AdvertisementModel

This class is used to handle database statements related to Advertisements

BotModel

BotModel is used to handle database statements related to Bot User stories A Bot User Story consists of a sequence of patterns for what a bot should do when another user posts a request to the bot (a message beginning with @bot_name) in a discussion group.

CaptchaModel

This is class is used to handle the captcha settings for Yioop

CrawlModel

This is class is used to handle getting/setting crawl parameters, CRUD operations on current crawls, start, stop, status of crawls, getting cache files out of crawls, determining what is the default index to be used, marshalling/unmarshalling crawl mixes, and handling data from suggest-a-url forms

CreditModel

This class is used to manage Advertising Credits a user may purchase or spend

CronModel

Used to remember the last time the web app ran periodic activities

GroupModel

This is class is used to handle db results related to Group Administration.

ImpressionModel

Model used to keep track for analytic and user experience activities that users carry out on a Yioop web site. For analytics things that might tracked are wiki page views, queries, query outcomes. For UX things that the impression model allows is to keep track of recent group a user has visited to provide better bread crumb drop downs, make the manage account landing page list more relevant groups, determine start of whether a media item has been watched, completely watched, etc.

LocaleModel

Used to encapsulate information about a locale (data about a language in a given region).

MachineModel

This is class is used to handle db results related to Machine Administration

Model

This is a base class for all models in the SeekQuarry search engine. It provides support functions for formatting search results

ParallelModel

Base class of models that need access to data from multiple queue servers Subclasses include @see CrawlModel and @see PhraseModel.

PhraseModel

This is class is used to handle results for a given phrase search

ProfileModel

This is class is used to handle getting and saving the Profile.php of the current search engine instance

RoleModel

This is class is used to handle db results related to Role Administration

ScraperModel

Used to manage data related to the SCRAPER database table.

SearchverticalsModel

This class manages the editing of search verticals. This includes allowing one to specify a search result should be filtered from the results of a query, it also includes alterning the title and description of a result from how it is stored in a particular index and it finally includes creating, updating, deleting knowledge wiki results To handle these activities this class leverages the existing group wiki system of Yioop. Edited and filtered search results correspond to group feed entries in a Search Group. Edited knowledge wiki entries correspond to wiki entries in the Search Group.

SigninModel

This is class is used to handle db results needed for a user to login

SourceModel

Used to manage data related to video, news, and other search sources Also, used to manage data about available subsearches seen in SearchView

TrendingModel

This is class is used to handle db results related to Group Administration. Groups are collections of users who might access a common blog/news feed and set of pages. This method also controls adding and deleting entries to a group feed and does limited access control checks of these operations.

UserModel

This class is used to handle database statements related to User Administration

VisitorModel

Used to keep track of ip address of failed account creation and login attempts

Table of Contents

lessThanLocale()  : int

Function for comparing two locale arrays by locale tag so can sort