WIKINDX API trunk

Documentation

Table of Contents

Packages

wikindx

Namespaces

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

Classes

API
API hooks
BIBCITEGATEWAY
BIBCITEGATEWAY class.
BIBLIOGRAPHYCOMMON
Common methods for user bibliographies
BROWSECOMMON
Common methods for user bibliographies
PAGINGBROWSE
PAGINGBROWSE Numeric paging of browsing
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
FACTORY_RELS
FACTORY_RELS
FACTORY_CONTENT_TYPES
FACTORY_CONTENT_TYPES
FACTORY_APP
FACTORY_APP
FACTORY_CORE
FACTORY_CORE
FACTORY_DOCUMENT_XML_RELS
FACTORY_DOCUMENT_XML_RELS
FACTORY_FONT_TABLE
FACTORY_FONT_TABLE
FACTORY_WEB_SETTINGS
FACTORY_WEB_SETTINGS
FACTORY_STYLES
FACTORY_STYLES
FACTORY_THEME1
FACTORY_THEME1
FACTORY_SETTINGS
FACTORY_SETTINGS
FACTORY_DOCUMENT
FACTORY_DOCUMENT
FACTORY_NUMBERING
FACTORY_NUMBERING
FACTORY_FOOTER1
FACTORY_FOOTER1
FACTORY_FOOTER2
FACTORY_FOOTER2
FACTORY_HEADER1
FACTORY_HEADER1
FACTORY_HEADER2
FACTORY_HEADER2
FACTORY_ENDNOTES
FACTORY_ENDNOTES
FACTORY_FOOTNOTES
FACTORY_FOOTNOTES
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
USERACCESS
Access rights for users performing various functions (view, edit, add, delete, . . .).
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
SEARCHCOMMON
Common functions used by QSEARCH and ASEARCH 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
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_SEARCHCOMMON
FACTORY_SEARCHCOMMON
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_RESOURCECOMMON
FACTORY_RESOURCECOMMON
FACTORY_MAIL
FACTORY_MAIL
FACTORY_PAGING
FACTORY_PAGING
FACTORY_PAGINGALPHA
FACTORY_PAGINGALPHA
FACTORY_PAGINGDICT
FACTORY_PAGINGDICT
FACTORY_PAGINGBROWSE
FACTORY_PAGING
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
WkxDbSessionHandler
Custom session handler used when the session is stored inside db
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_error_handler()  : bool
Custom PHP errors handler
wkx_error_log()  : void
Write a message to the application log
wkx_error_function_args()  : void
Prints in tabular format the positional arguments of a function to the logs
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_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_error_function_args()

Prints in tabular format the positional arguments of a function to the logs

wkx_error_function_args(string $func_name, string $func_args) : void

To use this function, add at the top of the traced function body: wkx_error_function_args(FUNCTION, func_get_args()); or wkx_error_function_args(METHOD, func_get_args());

Parameters
$func_name : string

Function name (e.g. pass FUNCTION)

$func_args : string

Function arguments (e.g. pass func_get_args())

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