API Documentation
Namespaces
Interfaces, Classes and Traits
- BIBFORMAT
- Format a bibliographic resource for output.
- BIBSTYLE
- BIBLIOGRAPHY STYLE class
- CITE
- CITE class.
- CITEFORMAT
- Description of class CITEFORMAT. Format citations.
- CITESTYLE
- CITATION STYLE class. Format citations.
- EXPORTFILTER
- Format a bibliographic resource for output.
- PARSESTYLE
- Parse the bibliographic style
- PARSEXML
- Parse the bibliographic style's XML
- STYLEMAP
- Define style mapping
- BIBLIOGRAPHYCOMMON
- Common methods for user bibliographies
- BROWSECOMMON
- Common methods for user bibliographies
- CATEGORY
- Common methods for categories
- COLLECTION
- Common methods for collections
- COLLECTIONDEFAULTMAP
- Collection mapping for the collectionDefault column in the collections table
- COLLECTIONMAP
- Collection mapping
- CREATOR
- Common functions for creators
- BIBTEXCONFIG
- BibTeX Configuration class -- map characters between bibtex and other formats
- BIBTEXCREATORPARSE
- Parse BibTeX authors
- BIBTEXMAP
- Map BibTeX fields
- BIBTEXMONTHPARSE
- BibTeX MONTH import class
- BIBTEXPAGEPARSE
- BibTeX PAGE import class
- BIBTEXPARSE
- BibTeX PARSE
- COINSMAP
- Provides COINS mappings
- ENDNOTEMAP
- Endnote Map class.
- EXPORTBIBTEX
- Export BibTeX
- EXPORTCOINS
- Export COINS
- EXPORTCOMMON
- EXPORT COMMON class
- EXPORTER
- EXPORTER
- EXPORTGOOGLESCHOLAR
- Make WIKINDX resources available to Google Scholar
- GOOGLESCHOLARMAP
- Provides mappings for Google Scholar
- RICHTEXTFORMAT
- RTF encoding
- RISMAP
- RIS Map class.
- TINYMCETEXTEXPORT
- TINYMCETEXTEXPORT
- KEYWORD
- KEYWORD common routines
- CLOSE
- Close WIKINDX tidily and print footer.
- CLOSENOMENU
- Close WIKINDX tidily (no menu - used for initial logon screen).
- CLOSEPOPUP
- Close WIKINDX tidily. Used for javascript pop-ups such as citation that don't require header, images, menus etc.
- CLOSERAW
- Close WIKINDX by simply printing GLOBALS::buildTplVarString('content') without any more content. Typically used with AJAX to print strings to a DIV within the WIKINDX page
- COOKIE
- COOKIE
- FILETOTEXT
- Convert files of various types to text ready for searching.
- FRONT
- Front page of the system.
- ImageServer
- ImageServer
- FileManager
- FileManager
- FileServer
- FileServer
- Location
- Location
- EncodeExplorer
- EncodeExplorer
- LOADICONS
- Load image icons used throughout WIKINDX
- RecursiveDOMIterator
- Recursive Iterator class for the DOM class
- SESSION
- SESSION
- SQL
- SQL
- SQLSTATEMENTS
- SQLSTATEMENTS
- TEMPLATE
- Load the WIKINDX display template system
- LISTCOMMON
- LISTCOMMON common functions for listing, searching, selecting etc. resources
- PAGING
- PAGING Numeric paging of lists
- PAGINGALPHA
- PAGING Alphabetic paging of lists -- only used when ordering by creator or title or attachment file name
- PARSEPHRASE
- PARSEPHRASE -- break up a search phrase into component parts such as 'exact phrase', AND, OR and NOT
- CONSTANTS
- CONSTANTS class (English)
- ERRORS
- WIKINDX : Bibliographic Management system.
- MESSAGES
- MESSAGES class (English)
- PLUGINMESSAGES
- PLUGINMESSAGES
- SUCCESS
- WIKINDX : Bibliographic Management system.
- METADATA
- METADATA
- ATTACHMENT
- ATTACHMENT
- GATEKEEP
- GATEKEEP
- STATISTICS
- STATISTICS
- TAG
- TAG
- BADINPUT
- BADINPUT
- MENU
- MENU
- NAVIGATE
- NAVIGATE
- PASSWORD
- PASSWORD class.
- PUBLISHER
- PUBLISHER
- PUBLISHERMAP
- PUBLISHERMAP
- RESOURCECOMMON
- RESOURCECOMMON class
- RESOURCEMAP
- RESOURCEMAP
- AUTHORIZE
- AUTHORIZE
- BROWSERTABID
- BROWSERTABID
- CONFIGDBSTRUCTURE
- CONFIGDBSTRUCTURE
- FACTORY_BROWSERTABID
- FACTORY_BROWSERTABID
- FACTORY_HOUSEKEEPING
- FACTORY_HOUSEKEEPING
- FACTORY_PASSWORD
- FACTORY_PASSWORD
- FACTORY_CONFIGDBSTRUCTURE
- FACTORY_CONFIGDBSTRUCTURE
- FACTORY_LOADCONFIG
- FACTORY_LOADCONFIG
- FACTORY_SESSION
- FACTORY_SESSION
- FACTORY_COOKIE
- FACTORY_COOKIE
- FACTORY_AUTHORIZE
- FACTORY_AUTHORIZE
- FACTORY_MESSAGES
- FACTORY_MESSAGES
- FACTORY_ERRORS
- FACTORY_ERRORS
- FACTORY_SUCCESS
- FACTORY_SUCCESS
- FACTORY_CONSTANTS
- FACTORY_CONSTANTS
- FACTORY_DB
- FACTORY_DB
- FACTORY_SQLSTATEMENTS
- FACTORY_SQLSTATEMENTS
- FACTORY_TEMPLATE
- FACTORY_TEMPLATE
- FACTORY_USER
- FACTORY_USER
- FACTORY_CLOSE
- FACTORY_CLOSE
- FACTORY_FRONT
- FACTORY_FRONT
- FACTORY_QUARANTINE
- FACTORY_QUARANTINE
- FACTORY_CLOSENOMENU
- FACTORY_CLOSENOMENU
- FACTORY_CLOSEPOPUP
- FACTORY_CLOSEPOPUP
- FACTORY_CLOSERAW
- FACTORY_CLOSERAW
- FACTORY_STATISTICS
- FACTORY_STATISTICS
- FACTORY_LOADICONS
- FACTORY_LOADICONS
- FACTORY_EXPORTCOMMON
- FACTORY_EXPORTCOMMON
- FACTORY_EXPORTCOINS
- FACTORY_EXPORTCOINS
- FACTORY_EXPORTGOOGLESCHOLAR
- FACTORY_EXPORTGOOGLESCHOLAR
- FACTORY_BIBTEXPARSE
- FACTORY_BIBTEXPARSE
- FACTORY_RICHTEXTFORMAT
- FACTORY_RICHTEXTFORMAT
- FACTORY_COINSMAP
- FACTORY_COINSMAP
- FACTORY_BIBTEXCONFIG
- FACTORY_BIBTEXCONFIG
- FACTORY_BIBTEXMAP
- FACTORY_BIBTEXMAP
- FACTORY_BIBTEXCREATORPARSE
- FACTORY_BIBTEXCREATORPARSE
- FACTORY_BIBTEXMONTHPARSE
- FACTORY_BIBTEXMONTHPARSE
- FACTORY_BIBTEXPAGEPARSE
- FACTORY_BIBTEXPAGEPARSE
- FACTORY_EXPORTBIBTEX
- FACTORY_EXPORTBIBTEX
- FACTORY_PARSEXML
- FACTORY_PARSEXML
- FACTORY_STYLEMAP
- FACTORY_STYLEMAP
- FACTORY_BROWSECOMMON
- FACTORY_BROWSECOMMON
- FACTORY_BIBSTYLE
- FACTORY_BIBSTYLE
- FACTORY_BIBFORMAT
- FACTORY_BIBFORMAT
- FACTORY_CITE
- FACTORY_CITE
- FACTORY_CITESTYLE
- FACTORY_CITESTYLE
- FACTORY_EXPORTFILTER
- FACTORY_EXPORTFILTER
- FACTORY_CITEFORMAT
- FACTORY_CITEFORMAT
- FACTORY_LISTCOMMON
- FACTORY_LISTCOMMON
- FACTORY_METADATA
- FACTORY_METADATA
- FACTORY_TYPE
- FACTORY_TYPE
- FACTORY_CATEGORY
- FACTORY_CATEGORY
- FACTORY_TAG
- FACTORY_TAG
- FACTORY_USERTAGS
- FACTORY_USERTAGS
- FACTORY_KEYWORD
- FACTORY_KEYWORD
- FACTORY_RESOURCEMAP
- FACTORY_RESOURCEMAP
- FACTORY_CREATOR
- FACTORY_CREATOR
- FACTORY_PUBLISHER
- FACTORY_PUBLISHER
- FACTORY_PUBLISHERMAP
- FACTORY_PUBLISHERMAP
- FACTORY_COLLECTION
- FACTORY_COLLECTION
- FACTORY_COLLECTIONMAP
- FACTORY_COLLECTIONMAP
- FACTORY_MENU
- FACTORY_MENU
- FACTORY_BADINPUT
- FACTORY_BADINPUT
- FACTORY_NAVIGATE
- FACTORY_NAVIGATE
- FACTORY_BIBLIOGRAPHYCOMMON
- FACTORY_BIBLIOGRAPHYCOMMON
- FACTORY_GATEKEEP
- FACTORY_GATEKEEP
- FACTORY_RESOURCECOMMON
- FACTORY_RESOURCECOMMON
- FACTORY_MAIL
- FACTORY_MAIL
- FACTORY_PAGING
- FACTORY_PAGING
- FACTORY_PAGINGALPHA
- FACTORY_PAGINGALPHA
- FACTORY_PARSESTYLE
- FACTORY_PARSESTYLE
- FACTORY_EXPORTER
- FACTORY_EXPORTER
- FACTORY_LOADTINYMCE
- FACTORY_LOADTINYMCE
- FACTORY_LOADTINYMCE5
- FACTORY_LOADTINYMCE5
- FACTORY_PARSEPHRASE
- FACTORY_PARSEPHRASE
- FACTORY_ATTACHMENT
- FACTORY_ATTACHMENT
- FACTORY_DATE
- FACTORY_DATE
- GLOBALS
- GLOBALS
- HOUSEKEEPING
- HOUSEKEEPING
- LOADCONFIG
- LOADCONFIG
- LOADPLUGINS
- LOADPLUGINS class for third-party plug-in modules in the WIKINDX_DIR_COMPONENT_PLUGINS directory
- UPDATEDATABASE
- UPDATEDATABASE
- LOADTINYMCE
- LOADTINYMCE
- LOADTINYMCE5
- LOADTINYMCE
- TYPE
- RESOURCE TYPE
- USER
- USER
- USERTAGS
- USERTAGS
Table of Contents
- loadStaticConfig() : array<string|int, mixed>
- Load configuration from config.php
- wkx_session_set_db_handler() : mixed
- Set a db handler for session storage in session table
- wkx_session_set_file_handler() : mixed
- Set the default file handler for session storage
- wkx_session_open() : bool
- wkx_session_close() : bool
- wkx_session_read() : string
- wkx_session_write() : bool
- wkx_session_destroy() : bool
- wkx_session_gc() : bool
Functions
loadStaticConfig()
Load configuration from config.php
loadStaticConfig() : array<string|int, mixed>
Return values
array<string|int, mixed> —Array of error messages
wkx_session_set_db_handler()
Set a db handler for session storage in session table
wkx_session_set_db_handler() : mixed
The creation of the identifiers is left to PHP.
Tags
Return values
mixed —wkx_session_set_file_handler()
Set the default file handler for session storage
wkx_session_set_file_handler() : mixed
Return values
mixed —wkx_session_open()
wkx_session_open(string $savePath, string $sessionName) : bool
Parameters
- $savePath : string
- $sessionName : string
Return values
bool —wkx_session_close()
wkx_session_close() : bool
Return values
bool —wkx_session_read()
wkx_session_read(string $sessionId) : string
Parameters
- $sessionId : string
Return values
string —wkx_session_write()
wkx_session_write(string $sessionId, string $sessionData) : bool
Parameters
- $sessionId : string
- $sessionData : string
Return values
bool —wkx_session_destroy()
wkx_session_destroy(string $sessionId) : bool
Parameters
- $sessionId : string
Return values
bool —wkx_session_gc()
wkx_session_gc(int $maxSessionLifetime) : bool
Parameters
- $maxSessionLifetime : int