WIKINDX API 6.9.0

Documentation

Table of Contents

Packages

wikindx

Namespaces

AJAX
BIB
BIBCITE
CITE
CITELOC
COMPONENT
EXPORTFILTER
FILE
FORM
HTML
LOCALES
PAGING
RTF
STYLELOC
TEMPSTORAGE
URL
UTF8
UTILS
XML
LISTSESSION
UPDATE

Classes

API
API hooks
BIBCITEGATEWAY
BIBCITEGATEWAY class.
BIBLIOGRAPHYCOMMON
Common methods for user bibliographies
BROWSECOMMON
Common methods for user bibliographies
CATEGORY
Common methods for categories
COLLECTION
Common methods for collections
CREATOR
Common functions for creators
IDEASCOMMON
IDEASCOMMON class
BIBTEXCONFIG
BibTeX Configuration class -- map characters between bibtex and other formats
BIBTEXCREATORPARSE
Parse BibTeX authors
BIBTEXMONTHPARSE
BibTeX MONTH import class
BIBTEXPAGEPARSE
BibTeX PAGE import class
BIBTEXPARSE
BibTeX PARSE
EXPORTBIBTEX
Export BibTeX
EXPORTCOINS
Export COINS
EXPORTCOMMON
EXPORT COMMON class
EXPORTER
EXPORTER
EXPORTGOOGLESCHOLAR
Make WIKINDX resources available to Google Scholar
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
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
MAIL
MAIL
PARSESTYLEJSON
Parse the bibliographic style's JSON
RecursiveDOMIterator
Recursive Iterator class for the DOM class
SESSION
SESSION
SQL
SQL
SQLSTATEMENTS
SQLSTATEMENTS
STORE
STORE
TEMPLATE
Load the WIKINDX display template system
TINYMCE
TINYMCE
HIGHLIGHT
HIGHLIGHT class.
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
PAGINGDICT
PAGING Dictionary 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
QSEARCH
QSEARCH common functions used by QUICKSEARCH but also by, for example, INSERTCITATION and the soundExplorer plugin
BIBTEXMAP
Map BibTeX fields
COINSMAP
Provides COINS mappings
COLLECTIONDEFAULTMAP
Collection mapping for the collectionDefault column in the collections table
COLLECTIONMAP
Collection mapping
ENDNOTEMAP
Endnote Map class.
FUZZERMAP
FUZZERMAP
GOOGLESCHOLARMAP
Provides mappings for Google Scholar
PUBLISHERMAP
PUBLISHERMAP
RESOURCEMAP
RESOURCEMAP
RISMAP
RIS Map class.
STYLEMAP
Define style mapping
METADATA
METADATA
ATTACHMENT
ATTACHMENT
GATEKEEP
GATEKEEP
STATISTICS
STATISTICS
TAG
TAG
BADINPUT
BADINPUT
MENU
MENU
NAVIGATE
NAVIGATE
PASSWORD
PASSWORD class.
PUBLISHER
PUBLISHER
RESOURCECOMMON
RESOURCECOMMON class
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_AUTHORIZE
FACTORY_AUTHORIZE
FACTORY_DB
FACTORY_DB
FACTORY_SQLSTATEMENTS
FACTORY_SQLSTATEMENTS
FACTORY_TEMPLATE
FACTORY_TEMPLATE
FACTORY_USER
FACTORY_USER
FACTORY_FRONT
FACTORY_FRONT
FACTORY_QUARANTINE
FACTORY_QUARANTINE
FACTORY_CLOSE
FACTORY_CLOSE
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_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_PARSESTYLEJSON
FACTORY_PARSESTYLEJSON
FACTORY_STYLEMAP
FACTORY_STYLEMAP
FACTORY_BROWSECOMMON
FACTORY_BROWSECOMMON
FACTORY_BIBCITEGATEWAY
FACTORY_BIBCITEGATEWAY
FACTORY_ZOOMCOMMON
FACTORY_ZOOMCOMMON
FACTORY_IDEASCOMMON
FACTORY_IDEASCOMMON
FACTORY_LISTCOMMON
FACTORY_LISTCOMMON
FACTORY_LISTSESSION
FACTORY_LISTSESSION
FACTORY_HIGHLIGHT
FACTORY_HIGHLIGHT
FACTORY_QSEARCH
FACTORY_QSEARCH
FACTORY_STORE
FACTORY_STORE
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_PAGINGDICT
FACTORY_PAGINGDICT
FACTORY_EXPORTER
FACTORY_EXPORTER
FACTORY_TINYMCE
FACTORY_TINYMCE
FACTORY_PARSEPHRASE
FACTORY_PARSEPHRASE
FACTORY_ATTACHMENT
FACTORY_ATTACHMENT
FACTORY_DATE
FACTORY_DATE
GLOBALS
GLOBALS
HOUSEKEEPING
HOUSEKEEPING
LOADCONFIG
LOADCONFIG
UPDATEDATABASE
UPDATEDATABASE
UPGRADE_XML2JSONSTYLE
Parse the bibliographic style's XML
TYPE
RESOURCE TYPE
USER
USER
USERTAGS
USERTAGS
ZOOMCOMMON
ZOOMCOMMON class. Common routines for zoom

Functions

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
The open callback works like a constructor in classes and is executed when the session is being opened.
wkx_session_close()  : bool
The close callback works like a destructor in classes and is executed after the session write callback has been called.
wkx_session_read()  : string
The read callback must always return a session encoded (serialized) string, or an empty string if there is no data to read.
wkx_session_write()  : bool
The write callback is called when the session needs to be saved and closed.
wkx_session_destroy()  : bool
This callback is executed when a session is destroyed with session_destroy() or with session_regenerate_id() with the destroy parameter set to true.
wkx_session_gc()  : bool
The garbage collector callback is invoked internally by PHP periodically in order to purge old session data.
wkx_error_handler()  : bool
Custom PHP errors handler
wkx_error_log()  : void
Write a message to the application log
wkx_clear_error_log()  : mixed
Remove expired error logs (14 days max) and limit their size to 25 MB by file
buildUpgradePage()  : mixed

Functions

loadStaticConfig()

Load configuration from config.php

loadStaticConfig() : array<string|int, mixed>

This function die() if a config parameter is wrong.

Return values
array<string|int, mixed>

Array of error messages

wkx_session_set_file_handler()

Set the default file handler for session storage

wkx_session_set_file_handler() : mixed

wkx_session_open()

The open callback works like a constructor in classes and is executed when the session is being opened.

wkx_session_open(string $savePath, string $sessionName) : bool

It is the first callback function executed when the session is started automatically or manually with session_start(). Return value is true for success, false for failure.

Parameters
$savePath : string
$sessionName : string
Return values
bool

wkx_session_close()

The close callback works like a destructor in classes and is executed after the session write callback has been called.

wkx_session_close() : bool

It is also invoked when session_write_close() is called. Return value should be true for success, false for failure.

Return values
bool

wkx_session_read()

The read callback must always return a session encoded (serialized) string, or an empty string if there is no data to read.

wkx_session_read(string $sessionId) : string

This callback is called internally by PHP when the session starts or when session_start() is called. Before this callback is invoked PHP will invoke the open callback.

The value this callback returns must be in exactly the same serialized format that was originally passed for storage to the write callback. The value returned will be unserialized automatically by PHP and used to populate the $_SESSION superglobal. While the data looks similar to serialize() please note it is a different format which is specified in the session.serialize_handler ini setting.

Parameters
$sessionId : string
Return values
string

wkx_session_write()

The write callback is called when the session needs to be saved and closed.

wkx_session_write(string $sessionId, string $sessionData) : bool

This callback receives the current session ID a serialized version the $_SESSION superglobal. The serialization method used internally by PHP is specified in the session.serialize_handler ini setting.

The serialized session data passed to this callback should be stored against the passed session ID. When retrieving this data, the read callback must return the exact value that was originally passed to the write callback.

This callback is invoked when PHP shuts down or explicitly when session_write_close() is called. Note that after executing this function PHP will internally execute the close callback.

Parameters
$sessionId : string
$sessionData : string
Return values
bool

wkx_session_destroy()

This callback is executed when a session is destroyed with session_destroy() or with session_regenerate_id() with the destroy parameter set to true.

wkx_session_destroy(string $sessionId) : bool

Return value should be true for success, false for failure.

Parameters
$sessionId : string
Return values
bool

wkx_session_gc()

The garbage collector callback is invoked internally by PHP periodically in order to purge old session data.

wkx_session_gc(int $maxSessionLifetime) : bool

The frequency is controlled by WIKINDX_SESSION_GC_FREQUENCY. The value of lifetime which is passed to this callback is a fallback set in session.gc_maxlifetime.

The real value of lifetime is:

  • WIKINDX_SESSION_AUTH_MAXLIFETIME for sessions which have been authenticated at least once.
  • WIKINDX_SESSION_AUTH_REMEMBERME_MAXLIFETIME for sessions which have been authenticated at least once with a "Remember Me" flag.
  • WIKINDX_SESSION_NOTAUTH_MAXLIFETIME for sessions which have never been authenticated.

Return value should be true for success, false for failure.

Parameters
$maxSessionLifetime : int

(in seconds)

Return values
bool

wkx_error_handler()

Custom PHP errors handler

wkx_error_handler(int $errno, string $errstr, string $errfile, int $errline) : bool

cf. https://www.php.net/manual/fr/function.set-error-handler.php

The $errcontext parameter is not used because it is deprecated since PHP 7.2 It is no longer possible to know the context of the error. Instead we use the debug_print_backtrace() function.

NB: fatal errors like ‘parse error’ are still written in the log defined by error_log php.ini option because this handler cannot be called in that case.

Parameters
$errno : int

PHP error code

$errstr : string

PHP error message

$errfile : string

File or script where the error occurred

$errline : int

Error line number

Return values
bool

wkx_error_log()

Write a message to the application log

wkx_error_log(mixed $Message) : void

When the application is not yet configured, the message is written to the log defined by php.ini.

Parameters
$Message : mixed

Message

wkx_clear_error_log()

Remove expired error logs (14 days max) and limit their size to 25 MB by file

wkx_clear_error_log() : mixed

buildUpgradePage()

buildUpgradePage(string $body) : mixed
Parameters
$body : string

Search results