KEYWORD
in package
KEYWORD common routines
Table of Contents
Methods
- __construct() : mixed
- KEYWORD class
- checkExists() : false|int
- Does this keyword already exist in the database?
- checkKeywordGroups() : mixed
- When deleting or merging keywords or deleting resources or metadata, check the consistency of keyword groups.
- grabAll() : array<string|int, mixed>|false
- Get keyword names from keyword.
- removeHanging() : mixed
- Remove resource-less and idea-less keywords from keyword list and keyword groups having the keyword.
- transferArrows() : array<string|int, mixed>
- Make the keyword select transfer arrows to transfer keywords between select boxes with onclick
- writeKeywordTable() : false|int
- Write names to keyword table and return keyword id array ready for adding to resource_keyword.resourcekeywordKeywordId fields.
Methods
__construct()
KEYWORD class
public
__construct() : mixed
checkExists()
Does this keyword already exist in the database?
public
checkExists(string $keyword) : false|int
Parameters
- $keyword : string
Return values
false|int —Existing keyword ID
checkKeywordGroups()
When deleting or merging keywords or deleting resources or metadata, check the consistency of keyword groups.
public
checkKeywordGroups() : mixed
A KG must have at least two keywords or it should be deleted.
grabAll()
Get keyword names from keyword.
public
grabAll([bool $userBib = false ][, mixed $kType = false ][, false|array<string|int, mixed> $typeArray = false ]) : array<string|int, mixed>|false
Parameters
- $userBib : bool = false
-
FALSE (default) or TRUE (return only resource types within current user bibliography)
- $kType : mixed = false
-
FALSE (default) or metadata type or metadata array ('quote', 'paraphrase' etc). Gather only keywords attached to metadata
- $typeArray : false|array<string|int, mixed> = false
-
FALSE (default) or limits keywords to those belonging to these types (only when table == 'resource_keyword')
Return values
array<string|int, mixed>|false —id => keyword
removeHanging()
Remove resource-less and idea-less keywords from keyword list and keyword groups having the keyword.
public
removeHanging() : mixed
transferArrows()
Make the keyword select transfer arrows to transfer keywords between select boxes with onclick
public
transferArrows() : array<string|int, mixed>
Return values
array<string|int, mixed> —(toRightImage, toLeftImage)
writeKeywordTable()
Write names to keyword table and return keyword id array ready for adding to resource_keyword.resourcekeywordKeywordId fields.
public
writeKeywordTable(array<string|int, mixed> $inputArray) : false|int
Parameters
- $inputArray : array<string|int, mixed>
Return values
false|int —Array of keyword IDs