Yioop_V9.5_Source_Code_Documentation

__construct()

Sets up the database manager that will be used and name of the search engine database

Parameters

$db_name : string = CDB_NAME

the name of the database for the search engine

$connect : bool = true

whether to connect to the database by default after making the datasource class

$web_site : mixed = null

Return values

addGroup()

Add a groupname to the database using provided string

Parameters

$group_name : string

the groupname to be added

$user_id : int

user identifier of who owns the group

$register : int = CREQUEST_JOIN

flag that says what kinds of registration are allowed for this group INVITE_ONLY_JOIN, REQUEST_JOIN, PUBLIC_JOIN, or some group fee amount in credits 100, 200, 500, 1000, 2000

$member : int = CGROUP_READ

flag that says how members other than the owner can access this group GROUP_READ, GROUP_READ_COMMENT (can comment on threads but not start. i.e., a blog), GROUP_READ_WRITE, (can read, comment, start threads), GROUP_READ_WIKI, (can read, comment, start threads, and edit the wiki)

$voting : int = CNON_VOTING_GROUP

flag that says how members can vote on each others posts: NON_VOTING_GROUP, UP_VOTING_GROUP, UP_DOWN_VOTING_GROUP

$post_lifetime : int = CFOREVER

specifies the time in seconds that posts should live before they expire and are deleted

$encryption : int

0 means don't encrypt group, 1 means encrypt group

Return values

addGroupItem()

Creates a new group item

Parameters

$parent_id : int

thread id to use for the item

$group_id : int

what group the item should be added to

$user_id : int

of user making the post

$title : string

title of the group feed item

$description : string

actual content of the post

$type : int = CSTANDARD_GROUP_ITEM

flag saying what kind of group item this is. One of STANDARD_GROUP_ITEM, WIKI_GROUP_ITEM (used for threads discussing a wiki page)

$post_time : int

timstamp for when this group item was created default to the current time

$url : string = ""

a url associated with this group item (mainly for search group, otherwise use empty string)

$edit_time : int

timestamp for when this group item was last edited

$ups : int

number of times the item has been upvoted

$downs : int

number of times the item has been down voted

$flag : int

number of times the item has been flagged

Return values

addGroupItemModeration()

Adds a flagged group item to the moderation group

Parameters

$parent_id : int

thread id to use for the item

$group_id : int

what group the item should be added to

$user_id : int

of user making the post

$title : string

title of the group feed item

$description : string

actual content of the post

$flag : mixed

$parent_item_id : mixed

$parent_group_id : mixed

$type : int = CSTANDARD_GROUP_ITEM

flag saying what kind of group item this is. One of STANDARD_GROUP_ITEM, WIKI_GROUP_ITEM (used for threads discussing a wiki page)

$post_time : int

timstamp for when this group item was created default to the current time

$url : string = ""

a url associated with this group item (mainly for search group)

Return values

addUserGroup()

Add an allowed user to an existing group

Parameters

$user_id : string

the id of the user to add

$group_id : string

the group id of the group to add the user to

$status : int = CACTIVE_STATUS

what should be the membership status of the added user. Should be one of ACTIVE_STATUS, INACTIVE_STATUS, SUSPENDED_STATUS, INVITED_STATUS

Return values

alreadyFlagged()

Checks if post is already flagged

Parameters

$user_id : mixed

$post_id : int

to check if the thread is already flagged

Return values

alreadyVoted()

Returns true or false depending on whether a given user has voted on a given post or not

Parameters

$user_id : int

id of user to check if voted

$post_id : int

id of GROUP_ITEM to see if voted on

Return values

approveFlaggedPost()

Moderator approves a flagged post

Parameters

$post_id : int

to fetch the flagged post

Return values

boldKeywords()

Given a string, wraps in bold html tags a set of key words it contains.

Parameters

$text : string

haystack string to look for the key words

$words : array<string|int, mixed>

an array of words to bold face

Return values

cellNameAsRowColumn()

Converts a string of the form letter sequence followed by number sequence to an array of int's of the form [row, column]

Parameters

$cell_name : string

name of spreadsheet cell to convert

Return values

changeOwnerGroup()

To update the OWNER_ID of a group

Parameters

$user_id : string

the id of the user who becomes the admin of group

$group_id : string

the group id to transfer admin privileges

Return values

checkUserGroup()

Check is a user given by $user_id belongs to a group given by $group_id. If the field $status is sent then check if belongs to the group with $status access (active, invited, request, banned)

Parameters

$user_id : int

user to look up

$group_id : int

group to check if member of

$status : int = -1

membership type

Return values

convertSpreadsheetRectangle()

Used to convert a pair of spreadsheet coordinates into a pair of integer rectangular coordinates. For example [A3, B4] into [[0,2], [1, 3]]

Parameters

$spreadsheet_coords : array<string|int, mixed>

a pair of spreadsheet cell coordinates

Return values

copyFileToGroupPageResource()

Moves a file that has been uploaded via a wiki pages resource form to its correct position in the resources folder so it shows up for that page. For images and video (if FFMPEG configured) thumbs are generated. For video if FFMPEG is configured then a schedule is added to the media_convert folder so that the media_updater can produce mp4 and webm files corresponding to the video file.

Parameters

$tmp_name : string

tmp location that uploaded file initially stored at

$file_name : string

file name of file that has been uploaded

$mime_type : string

mime type of uploaded file

$group_id : int

group identifier of group wiki page belongs to

$page_id : int

identifier for page want copy a page resource for

$sub_path : string = ""

used to specify sub-folder of default resource folder to copy to

$data : string = ""

string data for file to use instead of filename (only used in case run non-empty)

Return values

copyResourceToClipFolder()

Used to copy a resource in the provided folder to the user's clip folder

Parameters

$user_id : int

of user whose clip_folder copying to

$resource_name : string

what to copy

$group_id : int

id of group the file resource belongs to

$page_id : int

id of page the file resource belongs to

$sub_path : string = ""

path within the page resource folder to the folder that contains the resource to copy

Return values

copyThreadResources()

Copies resources associated with a thread post in one group to the resource folders associated with a different group and thread id

Parameters

$from_group_id : int

group resources are coming from

$from_thread_id : int

thread post to get resources from

$to_group_id : int

group that we are copying to

$to_thread_id : int

resource folder of this thread post will be copied to

Return values

countGroupUsers()

Get the number of users which belong to a group and whose user_name matches a filter

Parameters

$group_id : int

id of the group to get a count of

$filter : string = ""

to filter usernames by

Return values

countPageRelationships()

Gets if there is any page related to this particular wiki page.

Parameters

$page_id : int

identifier for the current page

Return values

countUserGroups()

Get a count of the number of groups to which user_id belongs.

Parameters

$user_id : int

to get groups for

$filter : string = ""

to LIKE filter groups

$include_personal : bool = false

whether to include $user_id's personal group

$allowed_statuses : array<string|int, mixed> = [CACTIVE_STATUS]

a list of group membership statuses that to restrict the returned list to

Return values

createIfNecessaryDirectory()

Creates a directory and sets it to world permission if it doesn't already exist

Parameters

$directory : string

name of directory to create

Return values

cullExpiredGroupItems()

Deletes Group Items which are older than the expiry date for posts for that group

Return values

decrypt()

Decrypts data based on provided key.

Parameters

$data : string

what data to decrypt

$key : string

what key to use to decrypt

$cipher_method : string = 'aes-256-cbc'

a cipher encrypt/decrypt method supported by OpenSSL

Return values

decryptFlag()

Decrypts flag value based on provided key.

Parameters

$encrypted_data : mixed

$key : string

what key to use to decrypt

$cipher_method : string = 'AES-256-ECB'

a cipher encrypt/decrypt method supported by OpenSSL

Return values

deletableUser()

Checks if a user belongs to a group but is not the owner of that group Such a user could be deleted from the group

Parameters

$user_id : int

which user to look up

$group_id : int

which group to look up for

Return values

deleteFlaggedPost()

Deletes a flagged post from group items

Parameters

$post_id : int

to fetch the flagged post

$message : string

string to show for the removed post

Return values

deleteGroup()

Delete a group from the database and any associated data in GROUP_ITEM and USER_GROUP tables.

Parameters

$group_id : string

id of the group to delete

Return values

deleteGroupItem()

Removes a group feed item from the GROUP_ITEM table.

Parameters

$post_id : int

of item to remove

$user_id : int

the id of the person trying to perform the removal. If not root, or the original creator of the item, the item won't be removed

Return values

deleteResource()

Deletes a resource (image, video, etc) associated with a wiki page or group feed post belong to a group

Parameters

$resource_name : string

name of resource to delete

$group_id : int

group identifier of group wiki page belongs to

$page_id : int

identifier for page want to delete resource from

$sub_path : string = ""

path to a subfolder of default resource folder if desired

Return values

deleteResources()

Deletes all resources (image, video, etc) associated with a wiki page belonging to a group.

Parameters

$group_id : int

group identifier of group wiki page belongs to

$page_id : int

identifier for page want to delete resource from

$sub_path : string = ""

path to a subfolder of default resource folder if desired

Return values

deleteUserGroup()

Delete a user from a group by userid an groupid

Parameters

$user_id : string

the userid of the user to delete

$group_id : string

the group id of the group to delete

Return values

emptyClipFolder()

Deletes the resources in the clipboard of user with id $user_id

Parameters

$user_id : int

that we want to delete the contents of the clipboard for

Return values

encrypt()

Encrypts data based on provided key.

Parameters

$data : string

what data to encrypt

$key : string

what key to use to encrypt

$cipher_method : string = 'aes-256-cbc'

a cipher encrypt/decrypt method supported by OpenSSL

Return values

encryptFlag()

Encrypts flag value based on provided key.

Parameters

$data : string

what data to encrypt

$key : string

what key to use to encrypt

$cipher_method : string = 'AES-256-ECB'

a cipher encrypt/decrypt method supported by OpenSSL

Return values

evalCellNameExpression()

Used to parse an expression of the form letter sequence followed by number sequence corresponding to the name of a spreadsheet cell appearing in a CSV spreadsheet cell formula

Parameters

$cell_expression : string

cell formula to evaluate

$location : int

start offset in cell expression of cell name expression that this method needs to evaluate

$data : array<string|int, mixed>

array of spreadsheet data to be used for evaluation

Return values

evalFunctionInvocation()

Used to evaluate a function call appearing in a CSV spreadsheet cell formula

Parameters

$cell_expression : string

cell formula to evaluate

$location : int

start offset in cell expression of function call that this method needs to evaluate

$data : array<string|int, mixed>

array of spreadsheet data to be used for evaluation

Return values

evalNegatedExpression()

Used to parse expression of the form: -expr appearing in a CSV spreadsheet cell formula

Parameters

$cell_expression : string

cell formula to evaluate

$location : int

start offset in cell expression of negated expression that this method needs to evaluate

$data : array<string|int, mixed>

array of spreadsheet data to be used for evaluation

Return values

evalNumericExpression()

Used to parse a integer or float expression appearing in a CSV spreadsheet cell formula

Parameters

$cell_expression : string

cell formula to evaluate

$location : int

start offset in cell expression of integer or float expression that this method needs to evaluate

$data : array<string|int, mixed>

array of spreadsheet data to be used for evaluation

Return values

evalParenthesizedExpression()

Used to evaluate a spreadsheet expression surrounded by parentheses appearing in a CSV spreadsheet cell formula

Parameters

$cell_expression : string

cell formula to evaluate

$location : int

start offset in cell expression of parentheses expression that this method needs to evaluate

$data : array<string|int, mixed>

array of spreadsheet data to be used for evaluation

Return values

evalRangeExpression()

Used to convert range expressions, cell_name1:cell_name2 into a sequence of cells, cell_name1, ..., cell_name2 so that it may be used as part of an argument list to a function call appearing in a CSV spreadsheet cell formula

Parameters

$cell_expression : string

cell formula to evaluate

$location : int

start offset in cell expression of range expression that this method needs to evaluate

$data : array<string|int, mixed>

array of spreadsheet data to be used for evaluation

Return values

evalStringExpression()

Used to parse a string expression, "some string" or 'some string', appearing in a CSV spreadsheet cell formula

Parameters

$cell_expression : string

cell formula to evaluate

$location : int

start offset in cell expression of string expression that this method needs to evaluate

$data : array<string|int, mixed>

array of spreadsheet data to be used for evaluation

Return values

evaluateArgListExpression()

Used to evaluate the expressions in a list of arguments to a function call appearing in a CSV spreadsheet cell formula

Parameters

$cell_expression : string

cell formula to evaluate

$location : int

start offset in cell expression of argument list that this method needs to evaluate

$data : array<string|int, mixed>

array of spreadsheet data to be used for evaluation

Return values

evaluateCell()

Used to evaluate a cell of a CSV spreadsheet. This code runs on the server. In scripts folder there is almost identical Javascript code in spreadsheet.js that runs on the client.

Parameters

$cell_expression : mixed

$location : mixed

$data : mixed

$operator_pos : mixed

Return values

evaluateFactor()

Used to evaluate the left hand factor of a binary operator appearing in a CSV spreadsheet cell

Parameters

$cell_expression : string

cell formula to evaluate

$location : int

start offset in cell expression of factor protion that this method needs to evaluate

$data : array<string|int, mixed>

array of spreadsheet data to be used for evaluation

Return values

extractResource()

Uncompresses a compressed resource associated with a wiki page or group feed post belong to a group

Parameters

$resource_name : string

name of resource to delete

$group_id : int

group identifier of group wiki page belongs to

$page_id : int

identifier for page want to delete resource from

$sub_path : string = ""

path to a subfolder of default resource folder if desired

Return values

fileGetContents()

Either a wrapper for file_get_contents, or if a WebSite object is being used to serve pages, it reads it in using blocking I/O file_get_contents() and caches it before return its string contents.

Parameters

$filename : string

name of file to get contents of

$force_read : bool = false

whether to force the file to be read from persistent storage rather than the cache

Return values

filePutContents()

Either a wrapper for file_put_contents, or if a WebSite object is being used to serve pages, writes $data to the persistent file with name $filename. Saves a copy in the RAM cache if there is a copy already there.

Parameters

$filename : string

name of file to write to persistent storages

$data : string

string of data to store in file

Return values

flagGroupItem()

Flags a group feed item in the GROUP_ITEM table.

Parameters

$post_id : int

of item to be flagged

$user_id : int

the id of the person trying to flag the item If user does not belong to the group, the item won't be flagged

Return values

formatSinglePageResult()

Given a page summary, extracts snippets which are related to a set of search words. For each snippet, bold faces the search terms, and then creates a new summary array.

Parameters

$page : array<string|int, mixed>

a single search result summary

$words : array<string|int, mixed> = null

keywords (typically what was searched on)

$description_length : int = self::DEFAULT_DESCRIPTION_LENGTH

length of the description

Return values

fromCallback()

Controls which tables and the names of tables underlie the given model and should be used in a getRows call This defaults to the single table whose name is whatever is before Model in the name of the model. For example, by default on FooModel this method would return "FOO". If a different behavior, this can be overridden in subclasses of Model

Parameters

$args : mixed = null

any additional arguments which should be used to determine these tables (in this case none)

Return values

getClipboardResourceNames()

Get the names of the resources in the clipboard of $user_id

Parameters

$user_id : int

of user we want to get clipboard resource names for

Return values

getDbmsList()

Gets a list of all DBMS that work with the search engine

Return values

getFeedClipboardId()

Get the id of the clipboard thread used for moving around group items for a given user.

Parameters

$user_id : int

id of user to get the clipboard thread for

Return values

getFlagCount()

Retrieves flag column value from the database

Parameters

$post_id : int

of thread whose flag value needs to be fetched

Return values

getGroupBots()

Get an array of bots that belong to a group

Parameters

$group_id : string

the group_id to get bots for

Return values

getGroupById()

Returns information about the group with id $group_id provided that the requesting user $user_id has access to it

Parameters

$group_id : int

id of group to look up

$user_id : int

user asking for group info

$require_root_or_member : bool = false

require the $user_id to be in the group or root

Return values

getGroupId()

Get group id associated with groupname (so groupnames better be unique)

Parameters

$group_name : string

to use to look up a group_id

Return values

getGroupIdPageIdSubPathFromName()

Given the Wiki name in the format GroupName@PageName/sub_path/some_file returns array [group_id, page_id, sub_path, some_file] for the given resource. If one of the components is missing in the above, does its best guess for the value

Parameters

$complete_group_page_name : string

formatted as described in summary

$locale_tag : string = CDEFAULT_LOCALE

language of wiki page

Return values

getGroupItem()

Returns the GROUP_FEED item with the given id

Parameters

$item_id : int

the item to get info about

$is_group_id : mixed = false

Return values

getGroupItemCount()

Gets the number of group feed items visible to a user with $user_id and which match the supplied search criteria found in $search_array

Parameters

$search_array : array<string|int, mixed> = []

each element of this is a quadruple name of a field, what comparison to perform, a value to check, and an order (ascending/descending) to sort by

$user_id : int = CROOT_ID

who is making this request to determine which

$for_group : int = -1

if this value is set it is a assumed that group_items are being returned for only one group and that the count desired is over the number of threads in that group

Return values

getGroupItems()

Gets the group feed items visible to a user with $user_id and which match the supplied search criteria found in $search_array, starting from the $limit'th matching item to the $limit+$num item.

Parameters

$limit : int

starting offset group item to display

$num : int = 100

number of items from offset to display

$search_array : array<string|int, mixed> = []

each element of this is a quadruple name of a field, what comparison to perform, a value to check, and an order (ascending/descending) to sort by

$user_id : int = CROOT_ID

who is making this request to determine which

$for_group : int = -1

if this value is set it is a assumed that group_items are being returned for only one group and that they should be grouped by thread

Return values

getGroupKey()

Get the key of a private/encrypted group.

Parameters

$group_id : int

to get key for

Return values

getGroupName()

Get group id associated with groupname (so groupnames better be unique)

Parameters

$group_id : int

to use to look up a group name

Return values

getGroupPageCount()

Returns the number of non-empty wiki pages a group has (across all locales)

Parameters

$group_id : int

id of group to return the number of wiki pages for

Return values

getGroupPageResourcesFolders()

Returns the folder and thumb folder associated with the resources of a wiki page. Also returns base folders of these which may be different if there is a sub_path.

Parameters

$group_id : int

group identifier of group wiki page belongs to

$page_id : int

identifier for page want folder paths for

$sub_path : string = ""

file system path within the resource folder to get the folder name for

$create : bool = false

if folder doesn't exist whether to create it or not

$check_redirect : bool = true

whether to check the default group page folder for a redirect to a different folder

$check_exists : bool = true

if true and $create false, then check if the file path exists and return false if it doesn't. If false, and prefix path doesn't exist, this flag will cause it to be created

Return values

getGroupPageResourceUrl()

Return the url needed to get a resource of a given resource name that belongs to the provided group and page.

Parameters

$csrf_token : string

a token used to prevent CSRF attacks

$group_id : int

group identifier of group wiki page belongs to

$page_id : int

identifier for page want to get page resources for

$resource_name : string

file name of resource

$sub_path : string = ""

additional path beneath the default folder used for the resource folder

Return values

getGroupPageResourceUrls()

Gets all the urls of resources belonging to a particular groups wiki page.

Parameters

$group_id : int

group identifier of group wiki page belongs to

$page_id : int

identifier for page want to get page resources for

$sub_path : string = ""

additional path beneath the default folder used for the resource folder

$create : bool = false

if folder doesn't exist whether to create it or not

$needs_descriptions_format : mixed = null

Return values

getGroupPostCount()

Returns the number of posts to a group

Parameters

$group_id : int

id of the group to get post count for

$timestamp : int

only post with value pubdate greater or EDIT_DATE than this will be counted

Return values

getGroupThreadCount()

Returns the number of distinct threads in a group's feed

Parameters

$group_id : int

id of the group to get thread count for

Return values

getGroupThreadId()

Get the PARENT_ID of a thread based on the group-id opf group thread is in, the user_id of the user posting the thread and the exact thread title

Parameters

$group_id : int

id of group thread is in

$user_id : int

id of user posting to thread

$title : string

exact title of thread

Return values

getGroupUserIds()

Get user id's of all members of a group determined by a group_id

Parameters

$group_id : int

id of group to get members for

Return values

getGroupUsers()

Get an array of users that belong to a group

Parameters

$group_id : string

the group_id to get users for

$filter : string = ""

to LIKE filter users

$sorts : array<string|int, mixed> = []

directions on how to sort the columns of the results format is column_name => direction

$limit : int = ""

first user to get

$num : int = CNUM_RESULTS_PER_PAGE

number of users to return

Return values

getHistoryPage()

Returns an historical revision of a wiki page

Parameters

$page_id : int

identifier of wiki page want revision for

$pubdate : int

timestamp of revision desired

Return values

getMessagesThreadTitle()

Messages use the same storage mechanism as group posts, so need a title, The title used is always computed as the `-` concatenation of the sorted id's of the participants in the message session. This method computes such a title string from an array of message participants.

Parameters

$thread_follower_ids : array<string|int, mixed>

message chat participants

Return values

getMostRecentGroupPost()

Returns the most recent post posted to a group

Parameters

$group_id : int

id of the group to get the most recent post for

Return values

getPageHistoryList()

Returns a list of revision history info for a wiki page.

Parameters

$page_id : int

identifier for page want revision history of

$limit : int

first row we want from the result set

$num : int

number of rows we want starting from the first row in the result set

Return values

getPageId()

Looks up the page_id of a wiki page based on the group it belongs to, its title, and the language it is in (these three things together should uniquely fix a page).

Parameters

$group_id : int

group identifier of group wiki page belongs to

$page_name : string

title of wiki page to look up

$locale_tag : string

IANA language tag of page to lookup

Return values

getPageInfoByName()

Return the page id, page string, and discussion thread id of the most recent revision of a wiki page

Parameters

$group_id : int

group identifier of group wiki page belongs to

$name : string

title of wiki page to look up

$locale_tag : string

IANA language tag of page to lookup

$mode : string

if "edit" we assume we are looking up the page so that it can be edited and so we return the most recent non-parsed revision of the page. Otherwise, we assume the page is meant to be read and so we return the variant of the page where wiki markup has already been replaced with HTML

Return values

getPageInfoByPageId()

Returns the group_id, language, and page name of a wiki page corresponding to $page_id

Parameters

$page_id : int

to look up page info for

Return values

getPageInfoByThread()

Returns the group_id, language, page name, last modified date of a wiki pagecorresponding to a page discussion thread with id $page_thread_id

Parameters

$page_thread_id : int

the id of a wiki page discussion thread to look up page info for

Return values

getPageList()

Returns a list of applicable wiki pages of a group

Parameters

$group_id : int

of group want list of wiki pages for

$locale_tag : string

language want wiki page list for

$filter : string

string we want to filter wiki page title by

$sort : string

one of name_asc, name_desc, date_asc, date_desc specifying how the page list should be sorted

$limit : string

first row we want from the result set

$num : string

number of rows we want starting from the first row in the result set

Return values

getPageResource()

Reads in and returns as a string the contents of a resource that has been associated to a page.

Parameters

$file_name : string

file name of page resource desired

$group_id : int

group identifier of group wiki page belongs to

$page_id : int

identifier for page want copy a page resource for

$sub_path : string = ""

subpath with the resource folder that should be used to look up filename in

$raw : bool = false

if csv file don't content to array of rows

Return values

getPageType()

Returns the page type of an unparsed wiki page

Parameters

$unparsed_page : string

an unparsed wiki page (i.e., so has the configuration parameters in its head)

Return values

getParentGroupId()

Get the group id of the parent thread

Parameters

$post_id : int

denotes the thread

Return values

getParentIdOfParentPost()

Get parent_id of the parent thread of a given post

Parameters

$post_id : int

denotes the post

Return values

getParentPostById()

Get the id of the parent thread of a post

Parameters

$post_id : int

denotes the thread

Return values

getPersonalGroupId()

Get group id of personal group of a User.

Parameters

$user_id : string

to use to look up a group_id

Return values

getRegisterType()

Return the type of the registration for a group given by $group_id This says who is allowed to register for the group (i.e., is it by invitation only, by request, or anyone can join)

Parameters

$group_id : int

which group to find the type of

Return values

getRelationshipId()

Returns the id of the relationship between wiki pages with the given name

Parameters

$relationship_type : string

the relationship type to get id about

Return values

getRelationshipsToFromPage()

Gets all the relationship types between this particular wiki page and all other pages that it is linked to.

Parameters

$page_id : int

identifier for the current page

$limit : string

first row we want from the result set

$num : string

number of rows we want starting from the first row in the result set

Return values

getResourceDescription()

Gets the text description file of a resource

Parameters

$resource_name : string

name of resource to set description for

$group_id : int

group identifier of group wiki page belongs to

$page_id : int

identifier for page want to delete resource from

$sub_path : string = ""

path to a subfolder of default resource folder if desired

Return values

getRows()

Gets a range of rows which match the provided search criteria from $th provided table

Parameters

$limit : int

starting row from the potential results to return

$num : int

number of rows after start row to return

$total : int

gets set with the total number of rows that can be returned by the given database query

$search_array : array<string|int, mixed> = []

each element of this is a quadruple name of a field, what comparison to perform, a value to check, and an order (ascending/descending) to sort by

$args : array<string|int, mixed> = null

additional values which may be used to get rows (what these are will typically depend on the subclass implementation)

Return values

getSnippets()

Given a string, extracts a snippets of text related to a given set of key words. For a given word a snippet is a window of characters to its left and right that is less than a maximum total number of characters.

Parameters

$text : string

haystack to extract snippet from

$words : array<string|int, mixed>

keywords used to make look in haystack

$description_length : string

length of the description desired

Return values

getTemplateMap()

Returns an array page_id => page_name of all templates for a given Group for a given language

Parameters

$group_id : int

id of group to produce template map for

$locale_tag : string

of language to produce template map for

Return values

getThreadFollowers()

Returns an array of user information about users who have contributed to a thread or own the group a thread belongs to

Parameters

$thread_id : int

the id of the thread that want users for

$owner_id : int = -1

usually owner of group thread belongs to however could be id of any additional user want info for. If left a default value (-1) than only user's who have contributed to thread will be returned

$exclude_id : int = -1

an id of a user to exclude from the array returned

Return values

getThreadPostCount()

Returns the number of posts to a thread

Parameters

$thread_id : int

id of the thread to get post count for

$timestamp : int

only post with value pubdate greater or EDIT_DATE than this will be counted

Return values

getThresholdValue()

Get the minimum number of times a post has to be flagged to be reviewed by the moderator

Parameters

$group_id : int

to get threshold value for the given group

Return values

getUserGroups()

Get a list of all groups which user_id belongs to. Group names are not localized since these are created by end user admins of the search engine

Parameters

$user_id : int

to get groups for

$filter : string

to LIKE filter groups

$sorts : array<string|int, mixed>

directions on how to sort the columns of the results format is column_name => direction

$limit : int

first user to get

$num : int = CNUM_RESULTS_PER_PAGE

number of users to return

$include_personal : bool = false

whether to include $user_id's personal group

$allowed_statuses : array<string|int, mixed> = [CACTIVE_STATUS]

a list of group membership statuses that to restrict the returned list to

Return values

getUserId()

Get the user_id associated with a given username (In base class as used as an internal method in both signin and user models)

Parameters

$username : string

the username to look up

Return values

getUserPostCount()

Returns the number of posts to groups that a user belongs to since a timestamp

Parameters

$user_id : int

id of the user to get posts for

$timestamp : int

only post with value pubdate greater than this will be counted

Return values

insertResourcesParsePage()

Given a wiki page that has been parsed to html except for wiki syntax related to resources, this method adds the html to include these resources

Parameters

$group_id : int

group identifier of group wiki page belongs to

$page_id : int

identifier for page want to parse resources for

$locale_tag : string

the locale of the parsed page.

$parsed_page : string

the parsed wiki page before resources added

$csrf_token : string = ""

to prevent cross-site request forgery

$controller : string = 'admin'

name of controller (admin or group) that inserted urls should be for

$include_charts_and_spreadsheets : string = false

Return values

insertVideoImageResourceParsePage()

Auxiliary method for @see insertResourcesParsePage used to insert video and image resources into an otherwise parsed to HTML wiki page.

Parameters

$mime_type : string

of resource to insert

$parsed_page : string

partiall parsed wiki page to insert resources into

$thumb_resource : bool

whether this is a thumbnail image resource.

$nolink_resource : bool

whether this is a nolink image resource (one not enclosed is a link to the resource).

$resource_name : string

name of resource that is being inserted

$resource_url : string

url of resource that's being inserted

$resource_description : string

human description of resource to be inserted

$autoplay : string

html code for attribute saying whether or not this is an autoplay resource

$current_folder : string

folder in which resource lives, so can check if there is an associated vtt transscript of audio

$data_resource : string

if the Video or Image resource is a data url, then the string of that data url. If this case we use this only to know if should pother with auxiliary source or track tags

$match_string : string

code string that was used to make the portion of the partially parsed wiki page to be replaced with htm for the resource to be inserted

$locale_tag : string

tag name language of wiki page

$csrf_token : string

cross site request forgery token to be used in links

$group_id : int

group of page into which resources are being inserted

$current_page_id : int

of page within group

$sub_path : string

of folder structure of wiki page from which resource comes

Return values

isGroupEncrypted()

Check whether group's encryption is enabled or not

Parameters

$group_id : int

to check for encryption value

Return values

isSingleLocalhost()

Used to determine if an action involves just one yioop instance on the current local machine or not

Parameters

$machine_urls : array<string|int, mixed>

urls of yioop instances to which the action applies

$index_timestamp : string = -1

if timestamp exists checks if the index has declared itself to be a no network index.

Return values

isUserIdInContacts()

Checks is a given $user_id is in the list of users of the personcal group of a $contact_user_id

Parameters

$user_id : int

user id to check if in other personal group

$contact_user_id : int

user id to check personal group of

Return values

letterRepresentation()

Converts a decimal number to a base 26 number string using A-Z for 0-25.

Parameters

$number : int

the value to convert to base 26

Return values

linkResourceFolders()

Creates a symlink between two resource folders (and their associate thumb folders)

Parameters

$link_group_id : string

group with page that is going to get the symlink

$link_store_id : string

page_id of page that is going to get the symlink

$target_group_id : string

group whose page resources will be linked to

$target_store_id : string

page whose page resources will be linked to

Return values

loginDbms()

Returns whether the provided dbms needs a login and password or not (sqlite or sqlite3)

Parameters

$dbms : string

the name of a database management system

Return values

makeThumbStripExif()

Makes a thumbnail for files of a type that thumbs can be generated for and strips exif data on jpegs images (only if PHP has exif functions enabled).

Parameters

$file_name : string

name of file to create thumb for

$folder : string

the folder in which the file lives

$thumb_folder : string

the folder in which to save thumbs

$mime_type : string = ""

the mime type of the file

Return values

moveResourceToClipFolder()

Used to move a resource in the provided folder to the user's clip folder

Parameters

$user_id : int

of user whose clip_folder moving to

$resource_name : string

what to move

$group_id : int

id of group the file resource belongs to

$page_id : int

id of page the file resource belongs to

$sub_path : string = ""

path within the page resource folder to the folder that contains the resource to move

Return values

newResource()

Create a new resource in the given group and page's resource folder/sub_path of the type requests.

Parameters

$resource_type : string

either new-file or new-folder

$group_id : int

group identifier of group wiki page belongs to

$page_id : int

identifier for page want to delete resource from

$sub_path : string = ""

path to a subfolder of default resource folder if desired

Return values

pagesLinkedWithRelationship()

Gets all the pages that are linked to a particular wiki page by providing a particular relationship type.

Parameters

$page_id : int

identifier for the current page

$group_id : int

group that wiki page belongs

$page_name : string

name of the current page (in case page didn't exist before)

$relationship : string

the type of relationship linking the wiki pages

$limit : string

first row we want from the result set

$num : string

number of rows we want starting from the first row in the result set

Return values

pasteAllClipFolder()

Used to paste all resources from the user's clip folder to the provided folder

Parameters

$user_id : int

of user whose clip_folder copying to

$group_id : int

id of group the file resource belongs to

$page_id : int

id of page the file resource belongs to

$sub_path : string = ""

path within the page resource folder to the folder that contains the resource to copy

Return values

pasteFromClipFolder()

Used to paste a resource from the user's clip folder to the provided folder

Parameters

$user_id : int

of user whose clip_folder copying to

$resource_name : string

what to copy

$group_id : int

id of group the file resource belongs to

$page_id : int

id of page the file resource belongs to

$sub_path : string = ""

path within the page resource folder to the folder that contains the resource to copy

Return values

postQueryCallback()

Called after getRows has retrieved all the rows that it would retrieve but before they are returned to give one last place where they could be further manipulated. For example, in MachineModel this callback is used to make parallel network calls to get the status of each machine returned by getRows. The default for this method is to leave the rows that would be returned unchanged

Parameters

$rows : array<string|int, mixed>

that have been calculated so far by getRows

Return values

renameResource()

Renames a resource (image, video, etc) associated with a wiki page belonging to a group.

Parameters

$old_resource_name : string

name of resource before renaming

$new_resource_name : string

name of resource after renaming

$group_id : int

group identifier of group wiki page belongs to

$page_id : int

identifier for page want to delete resource from

$sub_path : string = ""

path to a subfolder of default resource folder if desired

Return values

revertResources()

Called to revert a wiki pages resources to those that existed for the wiki page at a give time

Parameters

$page_id : int

of page that new version is being made for

$group_id : int

of group wiki page belongs to

$timestamp : int

of when to revert resources back to

Return values

rowCallback()

Called after as row is retrieved by getRows from the database to perform some manipulation that would be useful for this model.

Parameters

$row : array<string|int, mixed>

row as retrieved from database query

$args : mixed

additional arguments that might be used by this callback

Return values

searchArrayToWhereOrderClauses()

Creates the WHERE and ORDER BY clauses for a query of a Yioop table such as USERS, ROLE, GROUP, which have associated search web forms. Searches are case insensitive

Parameters

$search_array : array<string|int, mixed>

each element of this is a quadruple name of a field, what comparison to perform, a value to check, and an order (ascending/descending) to sort by

$any_fields : array<string|int, mixed> = ['status']

these fields if present in search array but with value "-1" will be skipped as part of the where clause but will be used for order by clause

Return values

selectCallback()

Used to determine the select clause for SOCIAL_GROUPS table when do query to marshal group objects for the controller mainly in mangeGroups

Parameters

$args : mixed = null

We use $args[1] to say whether in browse mode or not. browse mode is for groups a user could join rather than ones already joined

Return values

setPageName()

Used to add a wiki page revision by a given user to a wiki page of a given name in a given group viewing the group under a given language. If the page does not exist yet it, and its corresponding discussion thread is created. Two pages are used for storage GROUP_PAGE which contains a parsed to html version of the most recent revision of a wiki page and GROUP_PAGE_HISTORY which contains non-parsed versions of all revisions

Parameters

$user_id : int

identifier of who is adding this revision

$group_id : int

which group the wiki page revision if being done in

$page_name : string

title of page being revised

$page : string

wiki page with potential wiki mark up containing the revision

$locale_tag : string

locale we are adding the revision to

$edit_comment : string

user's reason for making the revision

$thread_title : string

if this is the first revision, then this should contain the title for the discussion thread about the revision

$thread_description : string

if this is the first revision, then this should be the body of the first post in discussion thread

$base_address : string = ""

default url to be used in links on wiki page that use short syntax

$additional_substitutions : array<string|int, mixed> = []

list of pairs additional wiki page rewrites to do when parsing wiki pages

$add_relationship_data : bool = true

whether to add link relationship data for this wiki page or not (default add, typically won't add for knowledge wiki pages for search results generated by configs/TokenTool.php)

Return values

setPageResource()

Saves the string for an page resource that has been updated to the appropriate folder for that wiki page.

Parameters

$file_name : string

file name of page resource desired

$resource_data : string

the data to be saved

$group_id : int

group identifier of group wiki page belongs to

$page_id : int

identifier for page want copy a page resource for

$sub_path : string = ""

subpath with the resource folder that should be add to resource path and filename

Return values

setResourceDescription()

Sets the text description file of a resource

Parameters

$resource_name : string

name of resource to set description for

$resource_description : string

description of the resource

$group_id : int

group identifier of group wiki page belongs to

$page_id : int

identifier for page want to delete resource from

$sub_path : string = ""

path to a subfolder of default resource folder if desired

Return values

skipWhiteSpace()

Finds the next non-whitespace location in the provided spreadsheet $cell_expression after position $location

Parameters

$cell_expression : string

cell formula to search in

$location : int

start offset to bbegin search at

Return values

spreadsheetRectangleData()

Given a pair of coordinates [top-left, bottom-right] in a spreadsheet returns the rectangular portion of the data in the spreadsheet corresponding to these coordinates.

Parameters

$rectangle : array<string|int, mixed>

coordinates to use when getting data out of spreadsheet

$data : mixed

Return values

translateDb()

Used to get the translation of a string_id stored in the database to the given locale.

Parameters

$string_id : string

id to translate

$locale_tag : string

to translate to

Return values

updateGroup()

Takes the passed associated array $group representing changes fields of a SOCIAL_GROUPS row, and executes an UPDATE statement to persist those changes fields to the database.

Parameters

$group : array<string|int, mixed>

associative array with a GROUP_ID as well as the fields to update

Return values

updateGroupItem()

Updates a group feed item's title and description. This assumes the given item already exists.

Parameters

$id : int

which item to change

$title : string

the new title

$description : string

the new description

Return values

updateStatusUserGroup()

Change the status of a user in a group

Parameters

$user_id : int

of user to change

$group_id : int

of group to change status for

$status : int

what the new status should be

Return values

versionGroupPage()

Creates a new version of a wiki page in the GROUP_PAGE_HISTORY without changing the page contents, but with an edit reason. This function might be called when a resource has been added to the page so that one can restore to a variant of the page with earlier resource lists.

Parameters

$user_id : int

of user responsible for version being created

$page_id : int

of page that new version is being made for

$version_reason : mixed

Return values

voteDown()

Casts one up vote by a user to a post

Parameters

$user_id : int

id of user to cast vote for

$post_id : int

id of post on which to cast vote

Return values

voteUp()

Casts one up vote by a user to a post

Parameters

$user_id : int

id of user to cast vote for

$post_id : int

id of post on which to cast vote

Return values

whereCallback()

Used to restrict getRows in which rows it returns. Rows in this case corresponding to Yioop groups. The restrictions added are to restrict to those group available to a given user_id and whether or not the user wants groups subscribed to, or groups that could be subscribed to

Parameters

$args : array<string|int, mixed> = null

first two elements are the $user_id of the user and the $browse flag which says whether or not user is browsing through all groups to which he could subscribe and read or just those groups to which he is already subscribed.

Return values