GRIS_WORKLISTS
in package
Class to manage worklists
With this class worklists can be managed
PHP version 8
Copyright (c) 2022, Holger Heuser, GESIS Leibniz Institute for the Social Sciences Unter Sachsenhausen 6-8 50667 Cologne, Germany
Tags
Table of Contents
- settings_group = "worklists"
- The constant for the settings group
- $dbconnection : object
- The database object for managing the connection
- $i18n : object
- The object for translations
- $institute : object
- The object for institutes
- $settings : object
- The object for settings
- $state : object
- The object for logs
- $template : object
- The object for templates
- __construct() : mixed
- The class constructor
- get_address_list() : array<string|int, mixed>
- Get a list of all addresses
- get_city_list() : array<string|int, mixed>
- Get a list of all cities
- get_event_list() : array<string|int, mixed>
- Get a list of all event titles
- get_journal_list() : array<string|int, mixed>
- Get a list of all journal titles
- get_oa_list() : array<string|int, mixed>
- Get a list of all open access participants
- get_person_list() : array<string|int, mixed>
- Get a list of all persons based on a specific list type
- get_publishing_house_list() : array<string|int, mixed>
- Get a list of all publishing houses
- get_tag_list() : array<string|int, mixed>
- Get a list of all tags
- get_journal_reference_count() : int
- Returns the count of references for a given journal ID
Constants
settings_group
The constant for the settings group
public
mixed
settings_group
= "worklists"
Properties
$dbconnection
The database object for managing the connection
private
object
$dbconnection
= NULL
Tags
$i18n
The object for translations
private
object
$i18n
Tags
$institute
The object for institutes
private
object
$institute
Tags
$settings
The object for settings
private
object
$settings
= null
Tags
$state
The object for logs
private
object
$state
Tags
$template
The object for templates
private
object
$template
= NULL
Tags
Methods
__construct()
The class constructor
public
__construct() : mixed
Initializes the objects
Return values
mixed —get_address_list()
Get a list of all addresses
public
get_address_list() : array<string|int, mixed>
Return values
array<string|int, mixed> —The list of addresses
get_city_list()
Get a list of all cities
public
get_city_list() : array<string|int, mixed>
Return values
array<string|int, mixed> —The list of cities
get_event_list()
Get a list of all event titles
public
get_event_list() : array<string|int, mixed>
Return values
array<string|int, mixed> —The list of events
get_journal_list()
Get a list of all journal titles
public
get_journal_list() : array<string|int, mixed>
Return values
array<string|int, mixed> —The list of journals
get_oa_list()
Get a list of all open access participants
public
get_oa_list() : array<string|int, mixed>
Return values
array<string|int, mixed> —The list of OA persons
get_person_list()
Get a list of all persons based on a specific list type
public
get_person_list([string $type = "internal" ], int $offset[, int $limit = 10000 ]) : array<string|int, mixed>
Parameters
- $type : string = "internal"
-
The list type
- $offset : int
-
The offset of hits
- $limit : int = 10000
-
The limit of hits
Return values
array<string|int, mixed> —Returns an array of persons
get_publishing_house_list()
Get a list of all publishing houses
public
get_publishing_house_list() : array<string|int, mixed>
Return values
array<string|int, mixed> —The list of publishing houses
get_tag_list()
Get a list of all tags
public
get_tag_list() : array<string|int, mixed>
Return values
array<string|int, mixed> —The list of tags
get_journal_reference_count()
Returns the count of references for a given journal ID
private
get_journal_reference_count(int $id) : int
Parameters
- $id : int
-
The ID
Return values
int —The count of references