Yioop_V9.5_Source_Code_Documentation

ChatbotComponent extends Component
in package

Provides the AdminController activity that allows users to create Chat Bot Stories. A Chat Bot story is a collection of patterns (expression, trigger state, remote call, result state, responses) that govern how a chat bot will behave under various circumstances

Tags
author

Harika Nukala (simplified and rewritten Chris Pollett)

Table of Contents

$parent  : object
Reference to the controller this component lives on
__construct()  : mixed
Sets up this component by storing in its parent field a reference to controller this component lives on
botStory()  : array<string|int, mixed>
Handles addpattern, editpattern, deletepattern requests for the Chat Bot story of the current user.
initCrawlBadges()  : mixed
Used to compute statistics for badges related for the manage crawls, mix crawls, and manage machine buttons shown typically to admin accounts
initializeWikiEditor()  : mixed
Called to include the Javascript Wiki Editor (wiki.js) on a page and to send any localizations needed from PHP to Javascript-land It is used by both Crawl and SocialComponent
initSocialBadges()  : mixed
Used to compute the impression statistics for badges on the social controls button for $user_id. These badges display the number of unread messages, the number of unread group post and the number of groups the user belongs to

Properties

$parent

Reference to the controller this component lives on

public object $parent = null

Methods

__construct()

Sets up this component by storing in its parent field a reference to controller this component lives on

public __construct(object $parent_controller) : mixed
Parameters
$parent_controller : object

reference to the controller this component lives on

Return values
mixed

botStory()

Handles addpattern, editpattern, deletepattern requests for the Chat Bot story of the current user.

public botStory() : array<string|int, mixed>
Return values
array<string|int, mixed>

$data field variables (FORM_TYPE, CURRENT_PATTERN, PATTERNS) used by BotstoryElement to render the view in which people can see the current pattern to add or edit as well as an array of patterns that have current been added for this bot

initCrawlBadges()

Used to compute statistics for badges related for the manage crawls, mix crawls, and manage machine buttons shown typically to admin accounts

public initCrawlBadges(int $user_id, array<string|int, mixed> &$data) : mixed
Parameters
$user_id : int

of user - used to determin the mix crawl list

$data : array<string|int, mixed>

associative array of data to send to the view. This method adds three new field NUM_MIXES, CRAWL_MANAGER, "NUM_MACHINES, CRAWLS_RUNNING, and NUM_CLOSED_CRAWLS

Return values
mixed

initializeWikiEditor()

Called to include the Javascript Wiki Editor (wiki.js) on a page and to send any localizations needed from PHP to Javascript-land It is used by both Crawl and SocialComponent

public initializeWikiEditor(array<string|int, mixed> &$data[,  $id = "" ]) : mixed
Parameters
$data : array<string|int, mixed>

an asscoiative array of data to be used by the view and layout that the wiki editor will be drawn on This method tacks on to INCLUDE_SCRIPTS to make the layout load wiki.js.

$id : = ""

if "" then all textareas on page will get editor buttons, if -1 then sets up translations, but does not add any button, otherwise, add buttons to textarea $id will. (Can call this method multiple times, if want more than one but not all)

Return values
mixed

initSocialBadges()

Used to compute the impression statistics for badges on the social controls button for $user_id. These badges display the number of unread messages, the number of unread group post and the number of groups the user belongs to

public initSocialBadges(int $user_id, array<string|int, mixed> &$data) : mixed
Parameters
$user_id : int

id of user to compute statistics for

$data : array<string|int, mixed>

associative array of data to send to the view. This method adds three new field NUM_GROUPS, UNREAD_POSTS, and UNREAD_MESSAGES

Return values
mixed

        

Search results