WIKINDX API trunk

API Documentation

Table of Contents

Namespaces

AJAX
BIB
BIBCITE
CITE
CITELOC
COMPONENT
DATE
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.
PUBLICATIONLISTS
Common methods for publication lists
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_PUBLICATIONLISTS
FACTORY_PUBLICATIONLISTS
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

Constants

BR  : mixed = "<br>"
CONSTANTS
CR  : mixed = "\r"
CRLF  : mixed = "\r\n"
LF  : mixed = "\n"
TAB  : mixed = "\t"
WIKINDX_ATOM_PAGE  : mixed = '/index.php?action=rss_RSS_CORE&method=atom10'
WIKINDX_AUTHGATE_MESSAGE_DEFAULT  : mixed = ''
WIKINDX_AUTHGATE_RESET_DEFAULT  : mixed = \FALSE
WIKINDX_AUTHGATE_USE_DEFAULT  : mixed = \FALSE
WIKINDX_BIN_FOLDER_BIBUTILS_DEFAULT  : mixed = ''
CONSTANTS_OPTIONS_DEFAULT
WIKINDX_BIN_FOLDER_CATDVI_DEFAULT  : mixed = ''
WIKINDX_BIN_FOLDER_DJVUTXT_DEFAULT  : mixed = ''
WIKINDX_BIN_FOLDER_PS2PDF_DEFAULT  : mixed = ''
WIKINDX_BROWSEBIBLIOGRAPHY_DEFAULT  : mixed = \FALSE
WIKINDX_BROWSER_TAB_ID  : mixed = $value
WIKINDX_BROWSER_TAB_ID_DEFAULT  : mixed = \FALSE
WIKINDX_BYPASS_SMARTY_COMPILATION_DEFAULT  : mixed = \FALSE
WIKINDX_CATEGORYEDIT_ALLOW_DEFAULT  : mixed = \FALSE
WIKINDX_CHARSET  : mixed = 'UTF-8'
Default charset
WIKINDX_CMS_ALLOW_DEFAULT  : mixed = \FALSE
WIKINDX_CMS_BIBSTYLE_DEFAULT  : mixed = \WIKINDX_STYLE_DEFAULT
WIKINDX_CMS_PAGE  : mixed = '/cmsprint.php'
WIKINDX_COMPONENTS_COMPATIBLE_VERSION  : mixed = [ 'plugin' => 20, // Must be an integer 'style'...
Components compatibility
WIKINDX_COMPONENTS_STYLE_JSON_FIRST_VERSION  : mixed = 29
First version of Json style components
WIKINDX_COMPONENTS_UPDATE_SERVER_DEFAULT  : mixed = 'https://wikindx.sourceforge.io/cus/index.php'
WIKINDX_CONTACT_EMAIL_DEFAULT  : mixed = ''
WIKINDX_COPYRIGHT_YEAR  : mixed = "2003-2026"
WIKINDX copyright
WIKINDX_CURRENT_DB_ENGINE_NAME  : mixed = $EngineName
WIKINDX_CURRENT_DB_ENGINE_VERSION  : mixed = $aEngineVersion
WIKINDX_DB_CHARSET  : mixed = 'utf8mb4'
MySQL CHARSET/NAMES option
WIKINDX_DB_COLLATION  : mixed = 'utf8mb4_unicode_520_ci'
MySQL COLLATE/COLLATION option
WIKINDX_DB_DEFAULT  : mixed = 'wikindx'
Default name of the MariaDB/MySQL database (case-sensitive)
WIKINDX_DB_ENGINE  : mixed = 'InnoDB'
MySQL engine option
WIKINDX_DB_GROUP_CONCAT_MAX_LEN  : mixed = 4294967295
MySQL SESSION group_concat_max_len option
WIKINDX_DB_HOST_DEFAULT  : mixed = 'localhost'
Default name of the MariaDB/MySQL host server (case-insensitive)
WIKINDX_DB_MAX_ALLOWED_PACKET  : mixed = 1073741824
MySQL GLOBAL max_allowed_packet option
WIKINDX_DB_PASSWORD_DEFAULT  : mixed = 'wikindx'
Default password of the user required to connect to and open the database (case-sensitive)
WIKINDX_DB_SQL_MODE  : mixed = 'TRADITIONAL'
MySQL SESSION sql_mode option
WIKINDX_DB_TIMEZONE  : mixed = '+00:00'
MySQL timezone option
WIKINDX_DB_USER_DEFAULT  : mixed = 'wikindx'
Default username required to connect to and open the database (case-sensitive)
WIKINDX_DEACTIVATE_RESOURCE_TYPES_DEFAULT  : mixed = ""
WIKINDX_DEBUG_ERRORS_DEFAULT  : mixed = \FALSE
WIKINDX_DEBUG_PSEUDOLOCALIZATION_DEFAULT  : mixed = \FALSE
WIKINDX_DEBUG_SQL_DEFAULT  : mixed = \FALSE
WIKINDX_DENY_READONLY_DEFAULT  : mixed = \FALSE
WIKINDX_DESCRIPTION_DEFAULT  : mixed = 'My WIKINDX'
WIKINDX_DIR_BASE  : mixed = \realpath(\implode(\DIRECTORY_SEPARATOR, [__DIR...
WIKINDX_DIR_CACHE  : mixed = 'cache'
WIKINDX_DIR_CACHE_ATTACHMENTS  : mixed = \implode(\DIRECTORY_SEPARATOR, [\WIKINDX_DIR_CA...
WIKINDX_DIR_CACHE_FILES  : mixed = \implode(\DIRECTORY_SEPARATOR, [\WIKINDX_DIR_CA...
WIKINDX_DIR_CACHE_PLUGINS  : mixed = \implode(\DIRECTORY_SEPARATOR, [\WIKINDX_DIR_CA...
WIKINDX_DIR_CACHE_STYLES  : mixed = \implode(\DIRECTORY_SEPARATOR, [\WIKINDX_DIR_CA...
WIKINDX_DIR_CACHE_TEMPLATES  : mixed = \implode(\DIRECTORY_SEPARATOR, [\WIKINDX_DIR_CA...
WIKINDX_DIR_COMPONENT  : mixed = 'components'
WIKINDX_DIR_COMPONENT_PLUGINS  : mixed = \implode(\DIRECTORY_SEPARATOR, [\WIKINDX_DIR_CO...
WIKINDX_DIR_COMPONENT_STYLES  : mixed = \implode(\DIRECTORY_SEPARATOR, [\WIKINDX_DIR_CO...
WIKINDX_DIR_COMPONENT_TEMPLATES  : mixed = \implode(\DIRECTORY_SEPARATOR, [\WIKINDX_DIR_CO...
WIKINDX_DIR_CORE  : mixed = 'core'
WIKINDX_DIR_CORE_LANGUAGES  : mixed = \implode(\DIRECTORY_SEPARATOR, [\WIKINDX_DIR_CO...
WIKINDX_DIR_DATA  : mixed = 'data'
WIKINDX_DIR_DATA_ATTACHMENTS  : mixed = \implode(\DIRECTORY_SEPARATOR, [\WIKINDX_DIR_DA...
WIKINDX_DIR_DATA_IMAGES  : mixed = \implode(\DIRECTORY_SEPARATOR, [\WIKINDX_DIR_DA...
WIKINDX_DIR_DATA_PLUGINS  : mixed = \implode(\DIRECTORY_SEPARATOR, [\WIKINDX_DIR_DA...
WIKINDX_DIR_DB_SCHEMA  : mixed = 'dbschema'
Root folder storing SQL Scripts used for a full db schema creation or an upgrades
WIKINDX_DIR_DOCS  : mixed = 'docs'
PhpDocumentor default directory
WIKINDX_DIR_LOG  : mixed = 'log'
Log files folder
WIKINDX_DIR_PUBLIC  : mixed = 'public'
Folder of public files that can be directly called by a browser without checking permissions (usually JS and CSS files)
WIKINDX_DISPLAY_CMS_LINK_DEFAULT  : mixed = \FALSE
WIKINDX_DISPLAY_RESOURCE_STATISTICS_DEFAULT  : mixed = \FALSE
WIKINDX_DISPLAY_STATISTICS_DEFAULT  : mixed = \FALSE
WIKINDX_DISPLAY_USER_STATISTICS_DEFAULT  : mixed = \FALSE
WIKINDX_DOMAIN_NAME  : mixed = $domain_name
WIKINDX_DOUBLEQUOTE_WIKINDX  : mixed = 'WIKINDXDOUBLEQUOTEWIKINDX'
Special constants used to do replacements required for SQL and similar.
WIKINDX_EMAIL_NEW_REGISTRATIONS_DEFAULT  : mixed = ''
WIKINDX_EMAIL_NEWS_DEFAULT  : mixed = \FALSE
WIKINDX_EMAIL_STATISTICS_DEFAULT  : mixed = \FALSE
WIKINDX_FILE_ATTACH_ALLOW_DEFAULT  : mixed = \FALSE
WIKINDX_FILE_ATTACH_SIZE_UPPER_LIMIT  : mixed = 4000
Max file size of an attachment
WIKINDX_FILE_ATTACH_UPLOAD_MAX_SIZE_DEFAULT  : mixed = 5
WIKINDX_FILE_DELETE_SECONDS_DEFAULT  : mixed = 3600
WIKINDX_FILE_REPAIRKIT_DB_SCHEMA  : mixed = \implode(\DIRECTORY_SEPARATOR, [\WIKINDX_DIR_DB...
Database schema description file for RepairKit component
WIKINDX_FILE_VIEW_LOGGEDON_ONLY_DEFAULT  : mixed = \FALSE
WIKINDX_GLOBAL_EDIT_DEFAULT  : mixed = \FALSE
WIKINDX_GS_ATTACHMENT_DEFAULT  : mixed = \FALSE
WIKINDX_GS_DISALLOW_DEFAULT  : mixed = \FALSE
WIKINDX_HEADER_SESSION_COOKIE_SECURE_ATTRIBUTE_DEFAULT  : mixed = \FALSE
WIKINDX_HEADER_STRICT_TRANSPORT_SECURITY_DEFAULT  : mixed = \FALSE
WIKINDX_HOMEBIB_DEFAULT  : mixed = \FALSE
WIKINDX_IMG_ALLOW_DEFAULT  : mixed = \FALSE
WIKINDX_IMG_HEIGHT_LIMIT_DEFAULT  : mixed = 400
WIKINDX_IMG_SIZE_UPPER_LIMIT  : mixed = 200
Max file size of an 8K 24 bits colors bmp image
WIKINDX_IMG_UPLOAD_MAX_SIZE_DEFAULT  : mixed = 5
WIKINDX_IMG_WIDTH_LIMIT_DEFAULT  : mixed = 400
WIKINDX_IMPORT_BIB_DEFAULT  : mixed = \FALSE
WIKINDX_IMPRESSUM_DEFAULT  : mixed = ''
WIKINDX_INTERNAL_PUBLIC_VERSION_MAPPING  : mixed = ["153" => "6.13.0", "151" => "6.12.1", "139" =>...
WIKINDX internal-official/public version mapping
WIKINDX_INTERNAL_VERSION  : mixed = 158.0
WIKINDX internal version information
WIKINDX_INTERNAL_VERSION_UPGRADE_MIN  : mixed = 5.1
WIKINDX minimum internal version upgradable
WIKINDX_IS_TRUNK_DEFAULT  : mixed = \FALSE
WIKINDX_LANGUAGE_DEFAULT  : mixed = 'en'
WIKINDX_LANGUAGE_DOMAIN_DEFAULT  : mixed = 'wikindx'
Translation domain name of the core part
WIKINDX_LANGUAGE_NAME_DEFAULT  : mixed = 'English (United Kingdom)'
Default language
WIKINDX_LAST_CHANGES_DAY_LIMIT_DEFAULT  : mixed = 10
WIKINDX_LAST_CHANGES_DEFAULT  : mixed = 10
WIKINDX_LAST_CHANGES_TYPE_DEFAULT  : mixed = 'number'
WIKINDX_LDAP_DEBUG_LEVEL  : mixed = 7
WIKINDX_LDAP_GROUP_DN_DEFAULT  : mixed = ''
WIKINDX_LDAP_GROUP_TYPE_FILTER  : mixed = '(|(sAMAccountType=268435456)(sAMAccountType=26...
WIKINDX_LDAP_PORT_DEFAULT  : mixed = 389
WIKINDX_LDAP_SEARCH_METHOD_DEFAULT  : mixed = 'tree'
WIKINDX_LDAP_SEARCH_METHOD_LIST  : mixed = ['list' => 'list', 'tree' => 'tree']
WIKINDX_LDAP_SEARCH_OPERATOR_DEFAULT  : mixed = 'and'
WIKINDX_LDAP_SEARCH_OPERATOR_LIST  : mixed = ['or' => 'or', 'and' => 'and']
WIKINDX_LDAP_SERVER_BIND_DOMAIN_DEFAULT  : mixed = ''
WIKINDX_LDAP_SERVER_BIND_DOMAIN_FORMAT_DEFAULT  : mixed = 'upn'
WIKINDX_LDAP_SERVER_BIND_DOMAIN_FORMAT_LIST  : mixed = ['none' => 'none', 'sam' => 'sam', 'upn' => 'upn']
WIKINDX_LDAP_SERVER_BIND_LOGIN_DEFAULT  : mixed = ''
WIKINDX_LDAP_SERVER_BIND_PASSWORD_DEFAULT  : mixed = ''
WIKINDX_LDAP_SERVER_BIND_TYPE_DEFAULT  : mixed = 'anonymous'
WIKINDX_LDAP_SERVER_BIND_TYPE_LIST  : mixed = ['anonymous' => 'anonymous', 'binduser' => 'bin...
WIKINDX_LDAP_SERVER_DEFAULT  : mixed = 'localhost'
WIKINDX_LDAP_SERVER_ENCRYPTION_DEFAULT  : mixed = 'none'
WIKINDX_LDAP_SERVER_ENCRYPTION_LIST  : mixed = ['none' => 'none', 'ssl' => 'ssl', 'starttls' =...
WIKINDX_LDAP_SERVER_NETWORK_TIMEOUT  : mixed = 10
WIKINDX_LDAP_SERVER_RESPONSE_TIMEOUT  : mixed = 15
WIKINDX_LDAP_USE_DEFAULT  : mixed = \FALSE
WIKINDX_LDAP_USE_REFERRALS  : mixed = 0
WIKINDX_LDAP_USER_ATTRIBUTE_EMAIL  : mixed = 'mail'
WIKINDX_LDAP_USER_ATTRIBUTE_FULLNAME  : mixed = 'displayname'
WIKINDX_LDAP_USER_ATTRIBUTE_LOGIN_DEFAULT  : mixed = 'sAMAccountName'
WIKINDX_LDAP_USER_ATTRIBUTE_LOGIN_LIST  : mixed = ['CN' => 'CN', 'sAMAccountName' => 'sAMAccountN...
WIKINDX_LDAP_USER_CREATE_DEFAULT  : mixed = \TRUE
WIKINDX_LDAP_USER_OU_DEFAULT  : mixed = ''
WIKINDX_LDAP_USER_TYPE_FILTER  : mixed = '(sAMAccountType=805306368)'
WIKINDX_LIST_CONFIG_OPTIONS  : mixed = ["configAuthGate" => ["constname" => "WIKINDX_A...
CONSTANTS_OPTIONS
WIKINDX_LIST_LINK_DEFAULT  : mixed = \FALSE
WIKINDX_LOCALE_DEFAULT  : mixed = 'en_GB'
Default language
WIKINDX_MAIL_BACKEND_DEFAULT  : mixed = 'sendmail'
WIKINDX_MAIL_FROM_DEFAULT  : mixed = ''
WIKINDX_MAIL_REPLYTO_DEFAULT  : mixed = 'noreply@noreply.org'
WIKINDX_MAIL_RETURN_PATH_DEFAULT  : mixed = ''
WIKINDX_MAIL_SENDMAIL_PATH_DEFAULT  : mixed = '/usr/sbin/sendmail'
WIKINDX_MAIL_SMTP_AUTHTYPE_DEFAULT  : mixed = 'none'
WIKINDX_MAIL_SMTP_ENCRYPT_DEFAULT  : mixed = 'none'
WIKINDX_MAIL_SMTP_PASSWORD_DEFAULT  : mixed = ''
WIKINDX_MAIL_SMTP_PERSIST_DEFAULT  : mixed = \FALSE
WIKINDX_MAIL_SMTP_PORT_DEFAULT  : mixed = 25
WIKINDX_MAIL_SMTP_SERVER_DEFAULT  : mixed = 'localhost'
WIKINDX_MAIL_SMTP_USERNAME_DEFAULT  : mixed = ''
WIKINDX_MAIL_USE_DEFAULT  : mixed = \FALSE
WIKINDX_MARIADB_VERSION_MIN  : mixed = '10.11'
Minimum required PHP version
WIKINDX_MAX_EXECUTION_TIMEOUT_DEFAULT  : mixed = 60
Default max execution time of a script/page (in seconds, or FALSE)
WIKINDX_MAX_MULTIUPDATES  : mixed = \WIKINDX_DB_MAX_ALLOWED_PACKET - 1000000
This can be used to control the number of SET statements in SQL::multUpdate() and SQL::multiUpdateNull() statements by triggering the statement only when the number of bytes in the update array sent to the statement is larger than this constant.
WIKINDX_MAX_PASTE_DEFAULT  : mixed = 10
WIKINDX_MEMORY_LIMIT_DEFAULT  : mixed = '1G'
Default custom value for PHP memory_limit option (interger, string, or FALSE)
WIKINDX_MENU_DESKTOP_CONFIG_DEFAULT  : mixed = \serialize(['main' => []])
WIKINDX_MENU_MOBILE_CONFIG_DEFAULT  : mixed = \serialize(['main' => []])
WIKINDX_METADATA_ALLOW_DEFAULT  : mixed = \TRUE
WIKINDX_METADATA_USERONLY_DEFAULT  : mixed = \FALSE
WIKINDX_MIMETYPE_ABW  : mixed = 'application/x-abiword'
WIKINDX_MIMETYPE_ATOM  : mixed = 'application/atom+xml'
WIKINDX_MIMETYPE_BIB  : mixed = 'application/x-bibtex'
WIKINDX_MIMETYPE_CSV  : mixed = 'text/csv'
WIKINDX_MIMETYPE_DJV  : mixed = 'image/vnd.djvu'
WIKINDX_MIMETYPE_DOC  : mixed = 'application/msword'
WIKINDX_MIMETYPE_DOCM  : mixed = 'application/vnd.ms-word.document.macroEnabled.12'
WIKINDX_MIMETYPE_DOCX  : mixed = 'application/vnd.openxmlformats-officedocument....
WIKINDX_MIMETYPE_DOTM  : mixed = 'application/vnd.ms-word.template.macroEnabled.12'
WIKINDX_MIMETYPE_DOTX  : mixed = 'application/vnd.openxmlformats-officedocument....
WIKINDX_MIMETYPE_DVI  : mixed = 'application/x-dvi'
WIKINDX_MIMETYPE_ENDNOTE  : mixed = 'application/vnd.openxmlformats-officedocument....
WIKINDX_MIMETYPE_EPUB  : mixed = 'application/epub+zip'
WIKINDX_MIMETYPE_FB  : mixed = 'application/x-fictionbook'
WIKINDX_MIMETYPE_HTML  : mixed = 'text/html'
WIKINDX_MIMETYPE_JS  : mixed = 'application/javascript'
WIKINDX_MIMETYPE_JSON  : mixed = 'application/json'
WIKINDX_MIMETYPE_KWD  : mixed = 'application/vnd.kde.kword'
WIKINDX_MIMETYPE_LWP  : mixed = 'application/vnd.lotus-wordpro'
WIKINDX_MIMETYPE_MD  : mixed = 'text/markdown'
WIKINDX_MIMETYPE_MHT_ALT  : mixed = 'message/alternative'
WIKINDX_MIMETYPE_MHT_APP  : mixed = 'application/x-mimearchive'
WIKINDX_MIMETYPE_MHT_MIX  : mixed = 'message/mixed'
WIKINDX_MIMETYPE_MHT_MUL  : mixed = 'multipart/related'
WIKINDX_MIMETYPE_MHT_RFC  : mixed = 'message/rfc822'
WIKINDX_MIMETYPE_ODP  : mixed = 'application/vnd.oasis.opendocument.presentation'
WIKINDX_MIMETYPE_ODT  : mixed = 'application/vnd.oasis.opendocument.text'
WIKINDX_MIMETYPE_OTP  : mixed = 'application/vnd.oasis.opendocument.presentatio...
WIKINDX_MIMETYPE_OTT  : mixed = 'application/vnd.oasis.opendocument.text-template'
WIKINDX_MIMETYPE_OXPS  : mixed = 'application/oxps'
WIKINDX_MIMETYPE_PDF  : mixed = 'application/pdf'
WIKINDX_MIMETYPE_PHP  : mixed = 'application/x-httpd-php'
WIKINDX_MIMETYPE_POTM  : mixed = 'application/vnd.ms-powerpoint.template.macroEn...
WIKINDX_MIMETYPE_POTX  : mixed = 'application/vnd.openxmlformats-officedocument....
WIKINDX_MIMETYPE_PPT  : mixed = 'application/vnd.ms-powerpoint'
WIKINDX_MIMETYPE_PPTM  : mixed = 'application/vnd.ms-powerpoint.presentation.mac...
WIKINDX_MIMETYPE_PPTX  : mixed = 'application/vnd.openxmlformats-officedocument....
WIKINDX_MIMETYPE_PS  : mixed = 'application/postscript'
WIKINDX_MIMETYPE_RIS  : mixed = 'application/x-research-info-systems'
WIKINDX_MIMETYPE_RSS  : mixed = 'application/rss+xml'
WIKINDX_MIMETYPE_RTF_APP  : mixed = 'application/rtf'
WIKINDX_MIMETYPE_RTF_TEXT  : mixed = 'text/rtf'
WIKINDX_MIMETYPE_SCRIBUS  : mixed = 'application/vnd.scribus'
WIKINDX_MIMETYPE_STI  : mixed = 'application/vnd.sun.xml.impress.template'
WIKINDX_MIMETYPE_STW  : mixed = 'application/vnd.sun.xml.writer.template'
WIKINDX_MIMETYPE_SXI  : mixed = 'application/vnd.sun.xml.impress'
WIKINDX_MIMETYPE_SXW  : mixed = 'application/vnd.sun.xml.writer'
WIKINDX_MIMETYPE_TEI  : mixed = 'application/tei+xml'
WIKINDX_MIMETYPE_TROFF  : mixed = 'text/troff'
WIKINDX_MIMETYPE_TXT  : mixed = 'text/plain'
WIKINDX_MIMETYPE_WML  : mixed = 'text/vnd.wap.wml'
WIKINDX_MIMETYPE_WMLC  : mixed = 'application/vnd.wap.wmlc'
WIKINDX_MIMETYPE_WPD  : mixed = 'application/vnd.wordperfect'
WIKINDX_MIMETYPE_WPD51  : mixed = 'application/wordperfect5.1'
WIKINDX_MIMETYPE_WPS  : mixed = 'application/vnd.ms-works'
WIKINDX_MIMETYPE_WRI  : mixed = 'application/mswrite'
WIKINDX_MIMETYPE_XHTML  : mixed = 'application/xml+html'
WIKINDX_MIMETYPE_XML_APP  : mixed = 'application/xml'
WIKINDX_MIMETYPE_XML_TEXT  : mixed = 'text/xml'
WIKINDX_MIMETYPE_XPDF  : mixed = 'application/x-pdf'
WIKINDX_MIMETYPE_XPS  : mixed = 'application/vnd.ms-xpsdocument'
WIKINDX_MIMETYPE_ZIP  : mixed = 'application/zip'
WIKINDX_MULTIUSER_DEFAULT  : mixed = \FALSE
WIKINDX_MYSQL_VERSION_MIN  : mixed = '8.4.0'
Minimum required PHP version
WIKINDX_NO_SORT_DEFAULT  : mixed = \implode(",", ['an', 'a', 'the', 'der', 'die',...
WIKINDX_NOTIFY_DEFAULT  : mixed = \FALSE
WIKINDX_OFFICE_API_VERSION  : mixed = 2
Office add-ins API version
WIKINDX_ORIGINATOR_EDIT_ONLY_DEFAULT  : mixed = \FALSE
WIKINDX_PACKAGE_HASH_ALGO  : mixed = 'sha256'
Algo used for hashing the packages released by the project
WIKINDX_PAGING_DEFAULT  : mixed = 20
WIKINDX_PAGING_MAXLINKS_DEFAULT  : mixed = 11
WIKINDX_PAGING_TAG_CLOUD_DEFAULT  : mixed = 100
WIKINDX_PASSWORD_SIZE_DEFAULT  : mixed = 6
WIKINDX_PASSWORD_STRENGTH_DEFAULT  : mixed = 'strong'
WIKINDX_PATH_AUTO_DETECTION_DEFAULT  : mixed = \TRUE
Default value of path auto detection feature (for Virtual Host Apache config)
WIKINDX_PHP_TIMEZONE  : mixed = 'UTC'
Timezone for PHP defaults
WIKINDX_PHP_VERSION_MAX  : mixed = '8.5.99'
Maximum required PHP version
WIKINDX_PHP_VERSION_MIN  : mixed = '8.2.0'
Minimum required PHP version
WIKINDX_PHPMAILER_BACKENDS  : mixed = ['smtp' => 'SMTP', 'sendmail' => 'Sendmail']
WIKINDX_PHPMAILER_SMTP_AUTHTYPE  : mixed = ['none' => 'None', '' => 'Auto', 'CRAM-MD5' =>...
Mapping list of SMTP auth methods of PHPMailer with Wikindx options
WIKINDX_PHPMAILER_SMTP_ENCRYPT  : mixed = ['none' => 'none', 'tls' => 'tls', 'ssl' => 'ssl']
Mapping list of SMTP encryption methods of PHPMailer with Wikindx options
WIKINDX_POPULARITY_DOWNLOADS_WEIGHT  : mixed = 0.75
STATISTICS WEIGHTS
WIKINDX_POPULARITY_VIEWS_WEIGHT  : mixed = 0.25
STATISTICS WEIGHTS
WIKINDX_PUBLIC_VERSION  : mixed = '6.16.1'
WIKINDX official/public version information
WIKINDX_QUARANTINE_DEFAULT  : mixed = \FALSE
WIKINDX_READ_ONLY_ACCESS_DEFAULT  : mixed = \TRUE
WIKINDX_RELEASE_DATE  : mixed = "2026-05-11"
WIKINDX release date
WIKINDX_RELEASE_TIMESTAMP  : mixed = (new \DateTime(\WIKINDX_RELEASE_DATE))->getTime...
WIKINDX release timestamp
WIKINDX_RESOURCE_URL_PREFIX_DEFAULT  : mixed = ''
WIKINDX_RESTRICT_USERID_DEFAULT  : mixed = 0
WIKINDX_RSS_DESCRIPTION_DEFAULT  : mixed = \WIKINDX_DESCRIPTION_DEFAULT
WIKINDX_RSS_DISALLOW_DEFAULT  : mixed = \FALSE
WIKINDX_RSS_DISPLAY_EDITED_RESOURCES_DEFAULT  : mixed = \FALSE
WIKINDX_RSS_LIMIT_DEFAULT  : mixed = 50
WIKINDX_RSS_PAGE  : mixed = '/index.php?action=rss_RSS_CORE&method=rss20'
WIKINDX_RSS_TITLE_DEFAULT  : mixed = \WIKINDX_TITLE_DEFAULT
WIKINDX_SEARCH_CONJUNCTION_DEFAULT  : mixed = 'OR'
WIKINDX_SEARCH_FILTER_DEFAULT  : mixed = \implode(",", ['an', 'a', 'the', 'and', 'to', '...
WIKINDX_SESSION_AUTH_MAXLIFETIME_DEFAULT  : mixed = 86400
WIKINDX_SESSION_AUTH_MAXLIFETIME_UPPER_LIMIT  : mixed = 86400
WIKINDX_SESSION_AUTH_REMEMBERME_MAXLIFETIME_DEFAULT  : mixed = 2678400
WIKINDX_SESSION_AUTH_REMEMBERME_MAXLIFETIME_UPPER_LIMIT  : mixed = 2678400
WIKINDX_SESSION_GC_DIVISOR  : mixed = 10
WIKINDX_SESSION_GC_FREQUENCY  : mixed = 300
WIKINDX_SESSION_GC_LASTEXEC_TIMESTAMP_DEFAULT  : mixed = \time()
WIKINDX_SESSION_GC_MAXLIFETIME  : mixed = 60
WIKINDX_SESSION_GC_PROBABILITY  : mixed = 1
WIKINDX_SESSION_NAME  : mixed = 'WKXSESSID'
WIKINDX_SESSION_NOTAUTH_MAXLIFETIME_DEFAULT  : mixed = 3600
WIKINDX_SESSION_NOTAUTH_MAXLIFETIME_UPPER_LIMIT  : mixed = 86400
WIKINDX_SINGLEQUOTE_WIKINDX  : mixed = 'WIKINDXSINGLEQUOTEWIKINDX'
Special constants used to do replacements required for SQL and similar.
WIKINDX_SITEMAP_DISALLOW_DEFAULT  : mixed = \FALSE
WIKINDX_SITEMAP_MAX_SIZE  : mixed = 500
Max number of url by page in a sitemap (50000 max. allowed in the standard and 10 Mo max.)
WIKINDX_SITEMAP_PAGE  : mixed = '/index.php?action=sitemap_SITEMAP_CORE'
URL of the website sitemap
WIKINDX_STATISTICS_COMPILED_DEFAULT  : mixed = '2018-01-01 01:01:01'
WIKINDX_STRING_LIMIT_DEFAULT  : mixed = 40
WIKINDX_STYLE_DEFAULT  : mixed = 'apa'
WIKINDX_SUPERADMIN_ID  : mixed = 1
WIKINDX_TAG_FACTOR_MAX  : mixed = 200
WIKINDX_TAG_FACTOR_MIN  : mixed = 50
WIKINDX_TAG_FACTOR_STEP  : mixed = 5
WIKINDX_TAG_HIGH_COLOUR_DEFAULT  : mixed = 'ff0000'
WIKINDX_TAG_HIGH_FACTOR_DEFAULT  : mixed = 200
WIKINDX_TAG_LOW_COLOUR_DEFAULT  : mixed = 'a0a0a0'
WIKINDX_TAG_LOW_FACTOR_DEFAULT  : mixed = 100
WIKINDX_TEMPLATE_DEFAULT  : mixed = 'default'
WIKINDX_TEMPLATE_MENU_DEFAULT  : mixed = 0
WIKINDX_TIMEZONE_DEFAULT  : mixed = 'UTC'
Default time zone (UTC)
WIKINDX_TITLE_DEFAULT  : mixed = 'WIKINDX'
WIKINDX_UNIX_PERMS_DEFAULT  : mixed = 0777
WIKINDX_URL  : mixed = 'https://wikindx.sourceforge.io'
WIKINDX SF url
WIKINDX_URL_BASE_DEFAULT  : mixed = ""
Default base URL of WIKINDX
WIKINDX_URL_CACHE  : mixed = \str_replace(\DIRECTORY_SEPARATOR, "/", \WIKIND...
WIKINDX_URL_CACHE_ATTACHMENTS  : mixed = \str_replace(\DIRECTORY_SEPARATOR, "/", \WIKIND...
WIKINDX_URL_CACHE_FILES  : mixed = \str_replace(\DIRECTORY_SEPARATOR, "/", \WIKIND...
WIKINDX_URL_CACHE_PLUGINS  : mixed = \str_replace(\DIRECTORY_SEPARATOR, "/", \WIKIND...
WIKINDX_URL_CACHE_STYLES  : mixed = \str_replace(\DIRECTORY_SEPARATOR, "/", \WIKIND...
WIKINDX_URL_CACHE_TEMPLATES  : mixed = \str_replace(\DIRECTORY_SEPARATOR, "/", \WIKIND...
WIKINDX_URL_COMPONENT  : mixed = \str_replace(\DIRECTORY_SEPARATOR, "/", \WIKIND...
WIKINDX_URL_COMPONENT_PLUGINS  : mixed = \str_replace(\DIRECTORY_SEPARATOR, "/", \WIKIND...
WIKINDX_URL_COMPONENT_STYLES  : mixed = \str_replace(\DIRECTORY_SEPARATOR, "/", \WIKIND...
WIKINDX_URL_COMPONENT_TEMPLATES  : mixed = \str_replace(\DIRECTORY_SEPARATOR, "/", \WIKIND...
WIKINDX_URL_DATA  : mixed = \str_replace(\DIRECTORY_SEPARATOR, "/", \WIKIND...
WIKINDX_URL_DATA_ATTACHMENTS  : mixed = \str_replace(\DIRECTORY_SEPARATOR, "/", \WIKIND...
WIKINDX_URL_DATA_IMAGES  : mixed = \str_replace(\DIRECTORY_SEPARATOR, "/", \WIKIND...
WIKINDX_URL_DATA_PLUGINS  : mixed = \str_replace(\DIRECTORY_SEPARATOR, "/", \WIKIND...
WIKINDX_URL_HELP_TOPICS  : mixed = 'https://wikindx.sourceforge.io/web/' . \WIKIND...
URL of the Help Topics on the website
WIKINDX_USE_BIBTEX_KEY_DEFAULT  : mixed = \FALSE
WIKINDX_USE_WIKINDX_KEY_DEFAULT  : mixed = \FALSE
WIKINDX_USER_LANGUAGE_DEFAULT  : mixed = 'auto'
WIKINDX_USER_PAGING_DEFAULTLINKS  : mixed = 11
WIKINDX_USER_PAGING_DEFAULTPAGING  : mixed = 20
WIKINDX_USER_PAGING_MINLINKS  : mixed = 4
WIKINDX_USER_PAGING_MINPAGING  : mixed = 2
WIKINDX_USER_PAGING_STYLE_DEFAULT  : mixed = 'N'
WIKINDX_USER_REGISTRATION_DEFAULT  : mixed = \FALSE
WIKINDX_USER_REGISTRATION_MODERATE_DEFAULT  : mixed = \FALSE
WIKINDX_USER_STRING_MINLENGTH  : mixed = 10
WIKINDX_USER_TIMEZONE_DEFAULT  : mixed = 'auto'
WIKINDX_WP_DOCX_EXPORTER_VERSION  : mixed = '1.0'
WordProcessor Docx Exporter Version

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_shutdown_handler()  : mixed
Shutdown Handler
wkx_exception_handler()  : mixed
Custom handler for uncaught exceptions
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

Constants

WIKINDX_ATOM_PAGE

public mixed WIKINDX_ATOM_PAGE = '/index.php?action=rss_RSS_CORE&method=atom10'

WIKINDX_BIN_FOLDER_BIBUTILS_DEFAULT

CONSTANTS_OPTIONS_DEFAULT

public mixed WIKINDX_BIN_FOLDER_BIBUTILS_DEFAULT = ''

Declare the default values of global config options.

Each default value is a constant where the name is the name of the corresponding constant and the suffix "_DEFAULT".

WIKINDX_BROWSEBIBLIOGRAPHY_DEFAULT

public mixed WIKINDX_BROWSEBIBLIOGRAPHY_DEFAULT = \FALSE

WIKINDX_BROWSER_TAB_ID

public mixed WIKINDX_BROWSER_TAB_ID = $value

WIKINDX_CHARSET

Default charset

public mixed WIKINDX_CHARSET = 'UTF-8'
Tags
global

string WIKINDX_CHARSET

WIKINDX_CMS_PAGE

public mixed WIKINDX_CMS_PAGE = '/cmsprint.php'

WIKINDX_COMPONENTS_COMPATIBLE_VERSION

Components compatibility

public mixed WIKINDX_COMPONENTS_COMPATIBLE_VERSION = [ 'plugin' => 20, // Must be an integer 'style' => 31, // Must be an integer 'template' => 8, ]

This array is used by LOADPLUGINS class and \COMPONENT\checkComponentIntegrity() to check components compatibility with the core.

Each type of component has its own compatibility version because they do not have the same lifecycle.

Tags
global

int[] WIKINDX_COMPONENTS_COMPATIBLE_VERSION

WIKINDX_COMPONENTS_STYLE_JSON_FIRST_VERSION

First version of Json style components

public mixed WIKINDX_COMPONENTS_STYLE_JSON_FIRST_VERSION = 29

After this version the style components are automatically updated on loading by class PARSESTYLEJSON.

Tags
global

int WIKINDX_COMPONENTS_STYLE_JSON_FIRST_VERSION

WIKINDX_COMPONENTS_UPDATE_SERVER_DEFAULT

public mixed WIKINDX_COMPONENTS_UPDATE_SERVER_DEFAULT = 'https://wikindx.sourceforge.io/cus/index.php'

WIKINDX_COPYRIGHT_YEAR

WIKINDX copyright

public mixed WIKINDX_COPYRIGHT_YEAR = "2003-2026"
Tags
global

string WIKINDX_COPYRIGHT_YEAR

WIKINDX_CURRENT_DB_ENGINE_NAME

public mixed WIKINDX_CURRENT_DB_ENGINE_NAME = $EngineName

WIKINDX_CURRENT_DB_ENGINE_VERSION

public mixed WIKINDX_CURRENT_DB_ENGINE_VERSION = $aEngineVersion

WIKINDX_DB_HOST_DEFAULT

Default name of the MariaDB/MySQL host server (case-insensitive)

public mixed WIKINDX_DB_HOST_DEFAULT = 'localhost'
Tags
global

string WIKINDX_DB_HOST_DEFAULT

WIKINDX_DB_MAX_ALLOWED_PACKET

MySQL GLOBAL max_allowed_packet option

public mixed WIKINDX_DB_MAX_ALLOWED_PACKET = 1073741824

Support the largest fields size used (LONGTEXT)

According to https://dev.mysql.com/doc/refman/8.0/en/blob.html, max_allowed_packet need to be as large as the largest type of column stored and we use LONGTEXT so we need the maximum value allowed 1G (in the absence of 4G).

Tags
see
https://dev.mysql.com/doc/refman/8.0/en/server-system-variables.html#sysvar_max_allowed_packet
global

int WIKINDX_DB_MAX_ALLOWED_PACKET

WIKINDX_DB_PASSWORD_DEFAULT

Default password of the user required to connect to and open the database (case-sensitive)

public mixed WIKINDX_DB_PASSWORD_DEFAULT = 'wikindx'
Tags
global

string WIKINDX_DB_PASSWORD_DEFAULT

WIKINDX_DB_TIMEZONE

MySQL timezone option

public mixed WIKINDX_DB_TIMEZONE = '+00:00'

The database always stores data in UTC, and it is up to PHP to perform the conversion when necessary, depending on the global configuration and user preferences.

The "time difference" notation is preferred to the "time zone name" notation because the name resolution functionality is optional in the MySQL/MariaDB engine.

Tags
see
https://dev.mysql.com/doc/refman/8.4/en/time-zone-support.html
global

string WIKINDX_DB_TIMEZONE

WIKINDX_DB_USER_DEFAULT

Default username required to connect to and open the database (case-sensitive)

public mixed WIKINDX_DB_USER_DEFAULT = 'wikindx'
Tags
global

string WIKINDX_DB_USER_DEFAULT

WIKINDX_DIR_BASE

public mixed WIKINDX_DIR_BASE = \realpath(\implode(\DIRECTORY_SEPARATOR, [__DIR__, '..', '..']))

WIKINDX_DIR_CACHE

public mixed WIKINDX_DIR_CACHE = 'cache'

WIKINDX_DIR_CACHE_ATTACHMENTS

public mixed WIKINDX_DIR_CACHE_ATTACHMENTS = \implode(\DIRECTORY_SEPARATOR, [\WIKINDX_DIR_CACHE, 'attachments'])

WIKINDX_DIR_CACHE_FILES

public mixed WIKINDX_DIR_CACHE_FILES = \implode(\DIRECTORY_SEPARATOR, [\WIKINDX_DIR_CACHE, 'files'])

WIKINDX_DIR_CACHE_PLUGINS

public mixed WIKINDX_DIR_CACHE_PLUGINS = \implode(\DIRECTORY_SEPARATOR, [\WIKINDX_DIR_CACHE, 'plugins'])

WIKINDX_DIR_CACHE_STYLES

public mixed WIKINDX_DIR_CACHE_STYLES = \implode(\DIRECTORY_SEPARATOR, [\WIKINDX_DIR_CACHE, 'styles'])

WIKINDX_DIR_CACHE_TEMPLATES

public mixed WIKINDX_DIR_CACHE_TEMPLATES = \implode(\DIRECTORY_SEPARATOR, [\WIKINDX_DIR_CACHE, 'templates'])

WIKINDX_DIR_COMPONENT

public mixed WIKINDX_DIR_COMPONENT = 'components'

WIKINDX_DIR_COMPONENT_PLUGINS

public mixed WIKINDX_DIR_COMPONENT_PLUGINS = \implode(\DIRECTORY_SEPARATOR, [\WIKINDX_DIR_COMPONENT, 'plugins'])

WIKINDX_DIR_COMPONENT_STYLES

public mixed WIKINDX_DIR_COMPONENT_STYLES = \implode(\DIRECTORY_SEPARATOR, [\WIKINDX_DIR_COMPONENT, 'styles'])

WIKINDX_DIR_COMPONENT_TEMPLATES

public mixed WIKINDX_DIR_COMPONENT_TEMPLATES = \implode(\DIRECTORY_SEPARATOR, [\WIKINDX_DIR_COMPONENT, 'templates'])

WIKINDX_DIR_CORE

public mixed WIKINDX_DIR_CORE = 'core'

WIKINDX_DIR_CORE_LANGUAGES

public mixed WIKINDX_DIR_CORE_LANGUAGES = \implode(\DIRECTORY_SEPARATOR, [\WIKINDX_DIR_CORE, 'messages'])

WIKINDX_DIR_DATA

public mixed WIKINDX_DIR_DATA = 'data'

WIKINDX_DIR_DATA_ATTACHMENTS

public mixed WIKINDX_DIR_DATA_ATTACHMENTS = \implode(\DIRECTORY_SEPARATOR, [\WIKINDX_DIR_DATA, 'attachments'])

WIKINDX_DIR_DATA_IMAGES

public mixed WIKINDX_DIR_DATA_IMAGES = \implode(\DIRECTORY_SEPARATOR, [\WIKINDX_DIR_DATA, 'images'])

WIKINDX_DIR_DATA_PLUGINS

public mixed WIKINDX_DIR_DATA_PLUGINS = \implode(\DIRECTORY_SEPARATOR, [\WIKINDX_DIR_DATA, 'plugins'])

WIKINDX_DIR_DB_SCHEMA

Root folder storing SQL Scripts used for a full db schema creation or an upgrades

public mixed WIKINDX_DIR_DB_SCHEMA = 'dbschema'
Tags
global

string WIKINDX_DIR_DB_SCHEMA

WIKINDX_DIR_DOCS

PhpDocumentor default directory

public mixed WIKINDX_DIR_DOCS = 'docs'
Tags
global

string WIKINDX_DIR_DOCS

WIKINDX_DIR_LOG

Log files folder

public mixed WIKINDX_DIR_LOG = 'log'
Tags
global

string WIKINDX_DIR_LOG

WIKINDX_DIR_PUBLIC

Folder of public files that can be directly called by a browser without checking permissions (usually JS and CSS files)

public mixed WIKINDX_DIR_PUBLIC = 'public'
Tags
global

string WIKINDX_DIR_PUBLIC

WIKINDX_DISPLAY_CMS_LINK_DEFAULT

public mixed WIKINDX_DISPLAY_CMS_LINK_DEFAULT = \FALSE

WIKINDX_DISPLAY_RESOURCE_STATISTICS_DEFAULT

public mixed WIKINDX_DISPLAY_RESOURCE_STATISTICS_DEFAULT = \FALSE

WIKINDX_DOUBLEQUOTE_WIKINDX

Special constants used to do replacements required for SQL and similar.

public mixed WIKINDX_DOUBLEQUOTE_WIKINDX = 'WIKINDXDOUBLEQUOTEWIKINDX'

Typically used to temporarily replace literal characters in strings to protect them from incorrect interpretation.

Tags
global

string WIKINDX_DOUBLEQUOTE_WIKINDX

WIKINDX_FILE_ATTACH_SIZE_UPPER_LIMIT

Max file size of an attachment

public mixed WIKINDX_FILE_ATTACH_SIZE_UPPER_LIMIT = 4000
Tags
global

int WIKINDX_FILE_ATTACH_SIZE_UPPER_LIMIT

WIKINDX_FILE_REPAIRKIT_DB_SCHEMA

Database schema description file for RepairKit component

public mixed WIKINDX_FILE_REPAIRKIT_DB_SCHEMA = \implode(\DIRECTORY_SEPARATOR, [\WIKINDX_DIR_DB_SCHEMA, 'repairkit.schema.json'])
Tags
global

string WIKINDX_DIR_PUBLIC

WIKINDX_HEADER_SESSION_COOKIE_SECURE_ATTRIBUTE_DEFAULT

public mixed WIKINDX_HEADER_SESSION_COOKIE_SECURE_ATTRIBUTE_DEFAULT = \FALSE

WIKINDX_HEADER_STRICT_TRANSPORT_SECURITY_DEFAULT

public mixed WIKINDX_HEADER_STRICT_TRANSPORT_SECURITY_DEFAULT = \FALSE

WIKINDX_HOMEBIB_DEFAULT

public mixed WIKINDX_HOMEBIB_DEFAULT = \FALSE

WIKINDX_IMG_SIZE_UPPER_LIMIT

Max file size of an 8K 24 bits colors bmp image

public mixed WIKINDX_IMG_SIZE_UPPER_LIMIT = 200
Tags
global

int WIKINDX_IMG_SIZE_UPPER_LIMIT

WIKINDX_INTERNAL_PUBLIC_VERSION_MAPPING

WIKINDX internal-official/public version mapping

public mixed WIKINDX_INTERNAL_PUBLIC_VERSION_MAPPING = ["153" => "6.13.0", "151" => "6.12.1", "139" => "6.12.0", "138" => "6.11.0", "128" => "6.8.0", "114" => "6.7.1", "113" => "6.6.8", "112" => "6.6.6", "111" => "6.6.4", "74" => "6.6.0", "73" => "6.4.14", "72" => "6.4.11", "70" => "6.4.10", "65" => "6.4.9", "59" => "6.4.8", "57" => "6.4.7", "55" => "6.4.6", "54" => "6.4.5", "46" => "6.4.4", "42" => "6.4.2", "38" => "6.4.1", "23" => "6.4.0", "15" => "6.3.8", "12" => "6.2.2", "11" => "6.2.1", "10" => "6.0.8", "9" => "6.0.6", "8" => "6.0.5", "7" => "6.0.4", "6" => "6.0.0", "5.9" => "5.9.1", "5.8" => "5.8.2", "5.5" => "5.7.0", "5.4" => "5.3.1", "5.3" => "5.2.2", "5.2" => "5.2.0", "5.1" => "5.1"]

This array (internal version => "public version", ...) is used to find the minimum public version upgraded by an internal version.

Add an entry when an internal version is added, but if you have to add many internal versions for a single public version, add only the lowest.

Tags
global

array WIKINDX_INTERNAL_PUBLIC_VERSION_MAPPING

WIKINDX_INTERNAL_VERSION

WIKINDX internal version information

public mixed WIKINDX_INTERNAL_VERSION = 158.0

This number MUST be a positive integer (written as a float), and should be incremented by one each time an upgrade need to be triggered. Before the value 6, this number was a float corresponding (or not) to part X.Y of the public version number.

Tags
global

float WIKINDX_INTERNAL_VERSION

WIKINDX_INTERNAL_VERSION_UPGRADE_MIN

WIKINDX minimum internal version upgradable

public mixed WIKINDX_INTERNAL_VERSION_UPGRADE_MIN = 5.1

The syntax is the same as for WIKINDX_INTERNAL_VERSION.

A database with a lower version number cannot be upgraded.

Tags
global

float WIKINDX_INTERNAL_VERSION_UPGRADE_MIN

WIKINDX_LANGUAGE_DOMAIN_DEFAULT

Translation domain name of the core part

public mixed WIKINDX_LANGUAGE_DOMAIN_DEFAULT = 'wikindx'

WIKINDX_LANGUAGE_NAME_DEFAULT

Default language

public mixed WIKINDX_LANGUAGE_NAME_DEFAULT = 'English (United Kingdom)'

WIKINDX_LDAP_DEBUG_LEVEL

public mixed WIKINDX_LDAP_DEBUG_LEVEL = 7

WIKINDX_LDAP_GROUP_TYPE_FILTER

public mixed WIKINDX_LDAP_GROUP_TYPE_FILTER = '(|(sAMAccountType=268435456)(sAMAccountType=268435457))'

WIKINDX_LDAP_SEARCH_METHOD_LIST

public mixed WIKINDX_LDAP_SEARCH_METHOD_LIST = ['list' => 'list', 'tree' => 'tree']

WIKINDX_LDAP_SEARCH_OPERATOR_LIST

public mixed WIKINDX_LDAP_SEARCH_OPERATOR_LIST = ['or' => 'or', 'and' => 'and']

WIKINDX_LDAP_SERVER_BIND_DOMAIN_FORMAT_DEFAULT

public mixed WIKINDX_LDAP_SERVER_BIND_DOMAIN_FORMAT_DEFAULT = 'upn'

WIKINDX_LDAP_SERVER_BIND_DOMAIN_FORMAT_LIST

public mixed WIKINDX_LDAP_SERVER_BIND_DOMAIN_FORMAT_LIST = ['none' => 'none', 'sam' => 'sam', 'upn' => 'upn']

WIKINDX_LDAP_SERVER_BIND_TYPE_LIST

public mixed WIKINDX_LDAP_SERVER_BIND_TYPE_LIST = ['anonymous' => 'anonymous', 'binduser' => 'binduser', 'user' => 'user']

WIKINDX_LDAP_SERVER_ENCRYPTION_LIST

public mixed WIKINDX_LDAP_SERVER_ENCRYPTION_LIST = ['none' => 'none', 'ssl' => 'ssl', 'starttls' => 'starttls']

WIKINDX_LDAP_SERVER_NETWORK_TIMEOUT

public mixed WIKINDX_LDAP_SERVER_NETWORK_TIMEOUT = 10

WIKINDX_LDAP_SERVER_RESPONSE_TIMEOUT

public mixed WIKINDX_LDAP_SERVER_RESPONSE_TIMEOUT = 15

WIKINDX_LDAP_USE_REFERRALS

public mixed WIKINDX_LDAP_USE_REFERRALS = 0

WIKINDX_LDAP_USER_ATTRIBUTE_EMAIL

public mixed WIKINDX_LDAP_USER_ATTRIBUTE_EMAIL = 'mail'

WIKINDX_LDAP_USER_ATTRIBUTE_FULLNAME

public mixed WIKINDX_LDAP_USER_ATTRIBUTE_FULLNAME = 'displayname'

WIKINDX_LDAP_USER_ATTRIBUTE_LOGIN_DEFAULT

public mixed WIKINDX_LDAP_USER_ATTRIBUTE_LOGIN_DEFAULT = 'sAMAccountName'

WIKINDX_LDAP_USER_ATTRIBUTE_LOGIN_LIST

public mixed WIKINDX_LDAP_USER_ATTRIBUTE_LOGIN_LIST = ['CN' => 'CN', 'sAMAccountName' => 'sAMAccountName', 'uid' => 'uid', 'userPrincipalName' => 'userPrincipalName']

WIKINDX_LDAP_USER_TYPE_FILTER

public mixed WIKINDX_LDAP_USER_TYPE_FILTER = '(sAMAccountType=805306368)'

WIKINDX_LIST_CONFIG_OPTIONS

CONSTANTS_OPTIONS

public mixed WIKINDX_LIST_CONFIG_OPTIONS = ["configAuthGate" => ["constname" => "WIKINDX_AUTHGATE_USE", "type" => "configBoolean"], "configAuthGateMessage" => ["constname" => "WIKINDX_AUTHGATE_MESSAGE", "type" => "configVarchar"], "configBinFolderBibutils" => ["constname" => "WIKINDX_BIN_FOLDER_BIBUTILS", "type" => "configVarchar"], "configBinFolderCatdvi" => ["constname" => "WIKINDX_BIN_FOLDER_CATDVI", "type" => "configVarchar"], "configBinFolderDjvutxt" => ["constname" => "WIKINDX_BIN_FOLDER_DJVUTXT", "type" => "configVarchar"], "configBinFolderPs2pdf" => ["constname" => "WIKINDX_BIN_FOLDER_PS2PDF", "type" => "configVarchar"], "configBrowserTabID" => ["constname" => "WIKINDX_BROWSER_TAB_ID", "type" => "configBoolean"], "configBypassSmartyCompile" => ["constname" => "WIKINDX_BYPASS_SMARTY_COMPILATION", "type" => "configBoolean"], "configCategoryEditAllow" => ["constname" => "WIKINDX_CATEGORYEDIT_ALLOW", "type" => "configBoolean"], "configCmsAllow" => ["constname" => "WIKINDX_CMS_ALLOW", "type" => "configBoolean"], "configCmsBibstyle" => ["constname" => "WIKINDX_CMS_BIBSTYLE", "type" => "configVarchar"], "configComponentsUpdateServer" => ["constname" => "WIKINDX_COMPONENTS_UPDATE_SERVER", "type" => "configVarchar"], "configContactEmail" => ["constname" => "WIKINDX_CONTACT_EMAIL", "type" => "configVarchar"], "configDeactivateResourceTypes" => ["constname" => "WIKINDX_DEACTIVATE_RESOURCE_TYPES", "type" => "configText"], "configDebugPseudolocalization" => ["constname" => "WIKINDX_DEBUG_PSEUDOLOCALIZATION", "type" => "configBoolean"], "configDebugSql" => ["constname" => "WIKINDX_DEBUG_SQL", "type" => "configBoolean"], "configDenyReadOnly" => ["constname" => "WIKINDX_DENY_READONLY", "type" => "configBoolean"], "configDescription" => ["constname" => "WIKINDX_DESCRIPTION", "type" => "configText"], "configDisplayStatistics" => ["constname" => "WIKINDX_DISPLAY_STATISTICS", "type" => "configBoolean"], "configDisplayUserStatistics" => ["constname" => "WIKINDX_DISPLAY_USER_STATISTICS", "type" => "configBoolean"], "configEmailNewRegistrations" => ["constname" => "WIKINDX_EMAIL_NEW_REGISTRATIONS", "type" => "configVarchar"], "configEmailNews" => ["constname" => "WIKINDX_EMAIL_NEWS", "type" => "configBoolean"], "configEmailStatistics" => ["constname" => "WIKINDX_EMAIL_STATISTICS", "type" => "configBoolean"], "configErrorReport" => ["constname" => "WIKINDX_DEBUG_ERRORS", "type" => "configBoolean"], "configFileAttachAllow" => ["constname" => "WIKINDX_FILE_ATTACH_ALLOW", "type" => "configBoolean"], "configFileAttachUploadMaxSize" => ["constname" => "WIKINDX_FILE_ATTACH_UPLOAD_MAX_SIZE", "type" => "configInt"], "configFileDeleteSeconds" => ["constname" => "WIKINDX_FILE_DELETE_SECONDS", "type" => "configInt"], "configFileViewLoggedOnOnly" => ["constname" => "WIKINDX_FILE_VIEW_LOGGEDON_ONLY", "type" => "configBoolean"], "configGlobalEdit" => ["constname" => "WIKINDX_GLOBAL_EDIT", "type" => "configBoolean"], "configGsAttachment" => ["constname" => "WIKINDX_GS_ATTACHMENT", "type" => "configBoolean"], "configGsDisallow" => ["constname" => "WIKINDX_GS_DISALLOW", "type" => "configBoolean"], "configImgAllow" => ["constname" => "WIKINDX_IMG_ALLOW", "type" => "configBoolean"], "configImgHeightLimit" => ["constname" => "WIKINDX_IMG_HEIGHT_LIMIT", "type" => "configInt"], "configImgUploadMaxSize" => ["constname" => "WIKINDX_IMG_UPLOAD_MAX_SIZE", "type" => "configInt"], "configImgWidthLimit" => ["constname" => "WIKINDX_IMG_WIDTH_LIMIT", "type" => "configInt"], "configImportBib" => ["constname" => "WIKINDX_IMPORT_BIB", "type" => "configBoolean"], "configImpressum" => ["constname" => "WIKINDX_IMPRESSUM", "type" => "configText"], "configIsTrunk" => ["constname" => "WIKINDX_IS_TRUNK", "type" => "configBoolean"], "configLastChanges" => ["constname" => "WIKINDX_LAST_CHANGES", "type" => "configInt"], "configLastChangesDayLimit" => ["constname" => "WIKINDX_LAST_CHANGES_DAY_LIMIT", "type" => "configInt"], "configLastChangesType" => ["constname" => "WIKINDX_LAST_CHANGES_TYPE", "type" => "configVarchar"], "configLdapGroupDn" => ["constname" => "WIKINDX_LDAP_GROUP_DN", "type" => "configVarchar"], "configLdapPort" => ["constname" => "WIKINDX_LDAP_PORT", "type" => "configInt"], "configLdapSearchMethod" => ["constname" => "WIKINDX_LDAP_SEARCH_METHOD", "type" => "configVarchar"], "configLdapSearchOperator" => ["constname" => "WIKINDX_LDAP_SEARCH_OPERATOR", "type" => "configVarchar"], "configLdapServer" => ["constname" => "WIKINDX_LDAP_SERVER", "type" => "configVarchar"], "configLdapServerBindDomain" => ["constname" => "WIKINDX_LDAP_SERVER_BIND_DOMAIN", "type" => "configVarchar"], "configLdapServerBindDomainFormat" => ["constname" => "WIKINDX_LDAP_SERVER_BIND_DOMAIN_FORMAT", "type" => "configVarchar"], "configLdapServerBindLogin" => ["constname" => "WIKINDX_LDAP_SERVER_BIND_LOGIN", "type" => "configVarchar"], "configLdapServerBindPassword" => ["constname" => "WIKINDX_LDAP_SERVER_BIND_PASSWORD", "type" => "configVarchar"], "configLdapServerBindType" => ["constname" => "WIKINDX_LDAP_SERVER_BIND_TYPE", "type" => "configVarchar"], "configLdapServerEncryption" => ["constname" => "WIKINDX_LDAP_SERVER_ENCRYPTION", "type" => "configVarchar"], "configLdapUse" => ["constname" => "WIKINDX_LDAP_USE", "type" => "configBoolean"], "configLdapUserAttributLogin" => ["constname" => "WIKINDX_LDAP_USER_ATTRIBUTE_LOGIN", "type" => "configVarchar"], "configLdapUserCreate" => ["constname" => "WIKINDX_LDAP_USER_CREATE", "type" => "configBoolean"], "configLdapUserOu" => ["constname" => "WIKINDX_LDAP_USER_OU", "type" => "configVarchar"], "configListLink" => ["constname" => "WIKINDX_LIST_LINK", "type" => "configBoolean"], "configMailBackend" => ["constname" => "WIKINDX_MAIL_BACKEND", "type" => "configVarchar"], "configMailFrom" => ["constname" => "WIKINDX_MAIL_FROM", "type" => "configVarchar"], "configMailReplyTo" => ["constname" => "WIKINDX_MAIL_REPLYTO", "type" => "configVarchar"], "configMailReturnPath" => ["constname" => "WIKINDX_MAIL_RETURN_PATH", "type" => "configVarchar"], "configMailSmPath" => ["constname" => "WIKINDX_MAIL_SENDMAIL_PATH", "type" => "configVarchar"], "configMailSmtpAuthType" => ["constname" => "WIKINDX_MAIL_SMTP_AUTHTYPE", "type" => "configVarchar"], "configMailSmtpEncrypt" => ["constname" => "WIKINDX_MAIL_SMTP_ENCRYPT", "type" => "configVarchar"], "configMailSmtpPassword" => ["constname" => "WIKINDX_MAIL_SMTP_PASSWORD", "type" => "configVarchar"], "configMailSmtpPersist" => ["constname" => "WIKINDX_MAIL_SMTP_PERSIST", "type" => "configBoolean"], "configMailSmtpPort" => ["constname" => "WIKINDX_MAIL_SMTP_PORT", "type" => "configInt"], "configMailSmtpServer" => ["constname" => "WIKINDX_MAIL_SMTP_SERVER", "type" => "configVarchar"], "configMailSmtpUsername" => ["constname" => "WIKINDX_MAIL_SMTP_USERNAME", "type" => "configVarchar"], "configMailUse" => ["constname" => "WIKINDX_MAIL_USE", "type" => "configBoolean"], "configMaxPaste" => ["constname" => "WIKINDX_MAX_PASTE", "type" => "configInt"], "configMenuDesktopConfig" => ["constname" => "WIKINDX_MENU_DESKTOP_CONFIG", "type" => "configText"], "configMenuMobileConfig" => ["constname" => "WIKINDX_MENU_MOBILE_CONFIG", "type" => "configText"], "configMetadataAllow" => ["constname" => "WIKINDX_METADATA_ALLOW", "type" => "configBoolean"], "configMetadataUserOnly" => ["constname" => "WIKINDX_METADATA_USERONLY", "type" => "configBoolean"], "configMultiUser" => ["constname" => "WIKINDX_MULTIUSER", "type" => "configBoolean"], "configNoSort" => ["constname" => "WIKINDX_NO_SORT", "type" => "configText"], "configNotify" => ["constname" => "WIKINDX_NOTIFY", "type" => "configBoolean"], "configOriginatorEditOnly" => ["constname" => "WIKINDX_ORIGINATOR_EDIT_ONLY", "type" => "configBoolean"], "configPaging" => ["constname" => "WIKINDX_PAGING", "type" => "configInt"], "configPagingMaxLinks" => ["constname" => "WIKINDX_PAGING_MAXLINKS", "type" => "configInt"], "configPagingTagCloud" => ["constname" => "WIKINDX_PAGING_TAG_CLOUD", "type" => "configInt"], "configPasswordSize" => ["constname" => "WIKINDX_PASSWORD_SIZE", "type" => "configInt"], "configPasswordStrength" => ["constname" => "WIKINDX_PASSWORD_STRENGTH", "type" => "configVarchar"], "configQuarantine" => ["constname" => "WIKINDX_QUARANTINE", "type" => "configBoolean"], "configReadOnlyAccess" => ["constname" => "WIKINDX_READ_ONLY_ACCESS", "type" => "configBoolean"], "configResourceUrlPrefix" => ["constname" => "WIKINDX_RESOURCE_URL_PREFIX", "type" => "configVarchar"], "configRestrictUserId" => ["constname" => "WIKINDX_RESTRICT_USERID", "type" => "configInt"], "configRssDescription" => ["constname" => "WIKINDX_RSS_DESCRIPTION", "type" => "configVarchar"], "configRssDisallow" => ["constname" => "WIKINDX_RSS_DISALLOW", "type" => "configBoolean"], "configRssDisplayEditedResources" => ["constname" => "WIKINDX_RSS_DISPLAY_EDITED_RESOURCES", "type" => "configBoolean"], "configRssLimit" => ["constname" => "WIKINDX_RSS_LIMIT", "type" => "configInt"], "configRssTitle" => ["constname" => "WIKINDX_RSS_TITLE", "type" => "configVarchar"], "configSearchConjunction" => ["constname" => "WIKINDX_SEARCH_CONJUNCTION", "type" => "configVarchar"], "configSearchFilter" => ["constname" => "WIKINDX_SEARCH_FILTER", "type" => "configText"], "configSessionAuthMaxlifetime" => ["constname" => "WIKINDX_SESSION_AUTH_MAXLIFETIME", "type" => "configInt"], "configSessionAuthMememberMeMaxlifetime" => ["constname" => "WIKINDX_SESSION_AUTH_REMEMBERME_MAXLIFETIME", "type" => "configInt"], "configSessionGCLastExecTimestamp" => ["constname" => "WIKINDX_SESSION_GC_LASTEXEC_TIMESTAMP", "type" => "configInt"], "configSessionNotAuthMaxlifetime" => ["constname" => "WIKINDX_SESSION_NOTAUTH_MAXLIFETIME", "type" => "configInt"], "configSiteMapDisallow" => ["constname" => "WIKINDX_SITEMAP_DISALLOW", "type" => "configBoolean"], "configStatisticsCompiled" => ["constname" => "WIKINDX_STATISTICS_COMPILED", "type" => "configDatetime"], "configStringLimit" => ["constname" => "WIKINDX_STRING_LIMIT", "type" => "configInt"], "configStyle" => ["constname" => "WIKINDX_STYLE", "type" => "configVarchar"], "configTagHighColour" => ["constname" => "WIKINDX_TAG_HIGH_COLOUR", "type" => "configVarchar"], "configTagHighFactor" => ["constname" => "WIKINDX_TAG_HIGH_FACTOR", "type" => "configInt"], "configTagLowColour" => ["constname" => "WIKINDX_TAG_LOW_COLOUR", "type" => "configVarchar"], "configTagLowFactor" => ["constname" => "WIKINDX_TAG_LOW_FACTOR", "type" => "configInt"], "configTemplate" => ["constname" => "WIKINDX_TEMPLATE", "type" => "configVarchar"], "configTimezone" => ["constname" => "WIKINDX_TIMEZONE", "type" => "configVarchar"], "configTitle" => ["constname" => "WIKINDX_TITLE", "type" => "configVarchar"], "configUserRegistration" => ["constname" => "WIKINDX_USER_REGISTRATION", "type" => "configBoolean"], "configUserRegistrationModerate" => ["constname" => "WIKINDX_USER_REGISTRATION_MODERATE", "type" => "configBoolean"], "configHeaderSessionCookieSecureAttribute" => ["constname" => "WIKINDX_HEADER_SESSION_COOKIE_SECURE_ATTRIBUTE", "type" => "configBoolean"], "configHeaderStrictTransportSecurity" => ["constname" => "WIKINDX_HEADER_STRICT_TRANSPORT_SECURITY", "type" => "configBoolean"]]

Define a mapping between the name of global options in db and their PHP constant counterpart.

"option db name" => ["constname" => "constant option name", "type" => "db column name"]"

db column names could be :

  • configBoolean
  • configDatetime
  • configInt
  • configText
  • configVarchar
Tags
global

array WIKINDX_LIST_CONFIG_OPTIONS

WIKINDX_MARIADB_VERSION_MIN

Minimum required PHP version

public mixed WIKINDX_MARIADB_VERSION_MIN = '10.11'
Tags
see
MariaDB

EOL https://endoflife.date/mariadb

global

string WIKINDX_MARIADB_VERSION_MIN

WIKINDX_MAX_EXECUTION_TIMEOUT_DEFAULT

Default max execution time of a script/page (in seconds, or FALSE)

public mixed WIKINDX_MAX_EXECUTION_TIMEOUT_DEFAULT = 60
Tags
global

bool|int WIKINDX_MAX_EXECUTION_TIMEOUT_DEFAULT

WIKINDX_MAX_MULTIUPDATES

This can be used to control the number of SET statements in SQL::multUpdate() and SQL::multiUpdateNull() statements by triggering the statement only when the number of bytes in the update array sent to the statement is larger than this constant.

public mixed WIKINDX_MAX_MULTIUPDATES = \WIKINDX_DB_MAX_ALLOWED_PACKET - 1000000

1_000_000 bytes is a sensible margin.

Tags
global

int WIKINDX_MAX_MULTIUPDATES

WIKINDX_MEMORY_LIMIT_DEFAULT

Default custom value for PHP memory_limit option (interger, string, or FALSE)

public mixed WIKINDX_MEMORY_LIMIT_DEFAULT = '1G'
Tags
global

bool|int WIKINDX_MEMORY_LIMIT_DEFAULT

WIKINDX_MENU_DESKTOP_CONFIG_DEFAULT

public mixed WIKINDX_MENU_DESKTOP_CONFIG_DEFAULT = \serialize(['main' => []])

WIKINDX_MENU_MOBILE_CONFIG_DEFAULT

public mixed WIKINDX_MENU_MOBILE_CONFIG_DEFAULT = \serialize(['main' => []])

WIKINDX_MIMETYPE_ABW

public mixed WIKINDX_MIMETYPE_ABW = 'application/x-abiword'

WIKINDX_MIMETYPE_ATOM

public mixed WIKINDX_MIMETYPE_ATOM = 'application/atom+xml'

WIKINDX_MIMETYPE_BIB

public mixed WIKINDX_MIMETYPE_BIB = 'application/x-bibtex'

WIKINDX_MIMETYPE_CSV

public mixed WIKINDX_MIMETYPE_CSV = 'text/csv'

WIKINDX_MIMETYPE_DJV

public mixed WIKINDX_MIMETYPE_DJV = 'image/vnd.djvu'

WIKINDX_MIMETYPE_DOC

public mixed WIKINDX_MIMETYPE_DOC = 'application/msword'

WIKINDX_MIMETYPE_DOCM

public mixed WIKINDX_MIMETYPE_DOCM = 'application/vnd.ms-word.document.macroEnabled.12'

WIKINDX_MIMETYPE_DOCX

public mixed WIKINDX_MIMETYPE_DOCX = 'application/vnd.openxmlformats-officedocument.wordprocessingml.document'

WIKINDX_MIMETYPE_DOTM

public mixed WIKINDX_MIMETYPE_DOTM = 'application/vnd.ms-word.template.macroEnabled.12'

WIKINDX_MIMETYPE_DOTX

public mixed WIKINDX_MIMETYPE_DOTX = 'application/vnd.openxmlformats-officedocument.wordprocessingml.template'

WIKINDX_MIMETYPE_DVI

public mixed WIKINDX_MIMETYPE_DVI = 'application/x-dvi'

WIKINDX_MIMETYPE_ENDNOTE

public mixed WIKINDX_MIMETYPE_ENDNOTE = 'application/vnd.openxmlformats-officedocument.wordprocessingml.endnotes+xml'

WIKINDX_MIMETYPE_EPUB

public mixed WIKINDX_MIMETYPE_EPUB = 'application/epub+zip'

WIKINDX_MIMETYPE_FB

public mixed WIKINDX_MIMETYPE_FB = 'application/x-fictionbook'

WIKINDX_MIMETYPE_HTML

public mixed WIKINDX_MIMETYPE_HTML = 'text/html'

WIKINDX_MIMETYPE_JS

public mixed WIKINDX_MIMETYPE_JS = 'application/javascript'

WIKINDX_MIMETYPE_JSON

public mixed WIKINDX_MIMETYPE_JSON = 'application/json'

WIKINDX_MIMETYPE_KWD

public mixed WIKINDX_MIMETYPE_KWD = 'application/vnd.kde.kword'

WIKINDX_MIMETYPE_LWP

public mixed WIKINDX_MIMETYPE_LWP = 'application/vnd.lotus-wordpro'

WIKINDX_MIMETYPE_MD

public mixed WIKINDX_MIMETYPE_MD = 'text/markdown'

WIKINDX_MIMETYPE_MHT_ALT

public mixed WIKINDX_MIMETYPE_MHT_ALT = 'message/alternative'

WIKINDX_MIMETYPE_MHT_APP

public mixed WIKINDX_MIMETYPE_MHT_APP = 'application/x-mimearchive'

WIKINDX_MIMETYPE_MHT_MIX

public mixed WIKINDX_MIMETYPE_MHT_MIX = 'message/mixed'

WIKINDX_MIMETYPE_MHT_MUL

public mixed WIKINDX_MIMETYPE_MHT_MUL = 'multipart/related'

WIKINDX_MIMETYPE_MHT_RFC

public mixed WIKINDX_MIMETYPE_MHT_RFC = 'message/rfc822'

WIKINDX_MIMETYPE_ODP

public mixed WIKINDX_MIMETYPE_ODP = 'application/vnd.oasis.opendocument.presentation'

WIKINDX_MIMETYPE_ODT

public mixed WIKINDX_MIMETYPE_ODT = 'application/vnd.oasis.opendocument.text'

WIKINDX_MIMETYPE_OTP

public mixed WIKINDX_MIMETYPE_OTP = 'application/vnd.oasis.opendocument.presentation-template'

WIKINDX_MIMETYPE_OTT

public mixed WIKINDX_MIMETYPE_OTT = 'application/vnd.oasis.opendocument.text-template'

WIKINDX_MIMETYPE_OXPS

public mixed WIKINDX_MIMETYPE_OXPS = 'application/oxps'

WIKINDX_MIMETYPE_PDF

public mixed WIKINDX_MIMETYPE_PDF = 'application/pdf'

WIKINDX_MIMETYPE_PHP

public mixed WIKINDX_MIMETYPE_PHP = 'application/x-httpd-php'

WIKINDX_MIMETYPE_POTM

public mixed WIKINDX_MIMETYPE_POTM = 'application/vnd.ms-powerpoint.template.macroEnabled.12'

WIKINDX_MIMETYPE_POTX

public mixed WIKINDX_MIMETYPE_POTX = 'application/vnd.openxmlformats-officedocument.presentationml.template'

WIKINDX_MIMETYPE_PPT

public mixed WIKINDX_MIMETYPE_PPT = 'application/vnd.ms-powerpoint'

WIKINDX_MIMETYPE_PPTM

public mixed WIKINDX_MIMETYPE_PPTM = 'application/vnd.ms-powerpoint.presentation.macroEnabled.12'

WIKINDX_MIMETYPE_PPTX

public mixed WIKINDX_MIMETYPE_PPTX = 'application/vnd.openxmlformats-officedocument.presentationml.presentation'

WIKINDX_MIMETYPE_PS

public mixed WIKINDX_MIMETYPE_PS = 'application/postscript'

WIKINDX_MIMETYPE_RIS

public mixed WIKINDX_MIMETYPE_RIS = 'application/x-research-info-systems'

WIKINDX_MIMETYPE_RSS

public mixed WIKINDX_MIMETYPE_RSS = 'application/rss+xml'

WIKINDX_MIMETYPE_RTF_APP

public mixed WIKINDX_MIMETYPE_RTF_APP = 'application/rtf'

WIKINDX_MIMETYPE_RTF_TEXT

public mixed WIKINDX_MIMETYPE_RTF_TEXT = 'text/rtf'

WIKINDX_MIMETYPE_SCRIBUS

public mixed WIKINDX_MIMETYPE_SCRIBUS = 'application/vnd.scribus'

WIKINDX_MIMETYPE_STI

public mixed WIKINDX_MIMETYPE_STI = 'application/vnd.sun.xml.impress.template'

WIKINDX_MIMETYPE_STW

public mixed WIKINDX_MIMETYPE_STW = 'application/vnd.sun.xml.writer.template'

WIKINDX_MIMETYPE_SXI

public mixed WIKINDX_MIMETYPE_SXI = 'application/vnd.sun.xml.impress'

WIKINDX_MIMETYPE_SXW

public mixed WIKINDX_MIMETYPE_SXW = 'application/vnd.sun.xml.writer'

WIKINDX_MIMETYPE_TEI

public mixed WIKINDX_MIMETYPE_TEI = 'application/tei+xml'

WIKINDX_MIMETYPE_TROFF

public mixed WIKINDX_MIMETYPE_TROFF = 'text/troff'

WIKINDX_MIMETYPE_TXT

public mixed WIKINDX_MIMETYPE_TXT = 'text/plain'

WIKINDX_MIMETYPE_WML

public mixed WIKINDX_MIMETYPE_WML = 'text/vnd.wap.wml'

WIKINDX_MIMETYPE_WMLC

public mixed WIKINDX_MIMETYPE_WMLC = 'application/vnd.wap.wmlc'

WIKINDX_MIMETYPE_WPD

public mixed WIKINDX_MIMETYPE_WPD = 'application/vnd.wordperfect'

WIKINDX_MIMETYPE_WPD51

public mixed WIKINDX_MIMETYPE_WPD51 = 'application/wordperfect5.1'

WIKINDX_MIMETYPE_WPS

public mixed WIKINDX_MIMETYPE_WPS = 'application/vnd.ms-works'

WIKINDX_MIMETYPE_WRI

public mixed WIKINDX_MIMETYPE_WRI = 'application/mswrite'

WIKINDX_MIMETYPE_XHTML

public mixed WIKINDX_MIMETYPE_XHTML = 'application/xml+html'

WIKINDX_MIMETYPE_XML_APP

public mixed WIKINDX_MIMETYPE_XML_APP = 'application/xml'

WIKINDX_MIMETYPE_XML_TEXT

public mixed WIKINDX_MIMETYPE_XML_TEXT = 'text/xml'

WIKINDX_MIMETYPE_XPDF

public mixed WIKINDX_MIMETYPE_XPDF = 'application/x-pdf'

WIKINDX_MIMETYPE_XPS

public mixed WIKINDX_MIMETYPE_XPS = 'application/vnd.ms-xpsdocument'

WIKINDX_MIMETYPE_ZIP

public mixed WIKINDX_MIMETYPE_ZIP = 'application/zip'

WIKINDX_MYSQL_VERSION_MIN

Minimum required PHP version

public mixed WIKINDX_MYSQL_VERSION_MIN = '8.4.0'
Tags
see
MySQL

EOL https://endoflife.date/mysql

global

string WIKINDX_MYSQL_VERSION_MIN

WIKINDX_NO_SORT_DEFAULT

public mixed WIKINDX_NO_SORT_DEFAULT = \implode(",", ['an', 'a', 'the', 'der', 'die', 'das', 'ein', 'eine', 'einer', 'eines', 'le', 'la', 'las', 'il', 'les', 'une', 'un', 'una', 'uno', 'lo', 'los', 'i', 'gli', 'de', 'het', 'um', 'uma', 'o', 'os', 'as', 'den', 'det', 'en', 'et', 'du', 'des'])

WIKINDX_OFFICE_API_VERSION

Office add-ins API version

public mixed WIKINDX_OFFICE_API_VERSION = 2

In each add-in (Word, Google Docs, LibreOffice etc.) the compatibility variable must equal this.

Tags
global

int WIKINDX_OFFICE_API_VERSION

WIKINDX_PACKAGE_HASH_ALGO

Algo used for hashing the packages released by the project

public mixed WIKINDX_PACKAGE_HASH_ALGO = 'sha256'
Tags
global

string WIKINDX_COMPONENTS_UPDATE_SERVER

WIKINDX_PATH_AUTO_DETECTION_DEFAULT

Default value of path auto detection feature (for Virtual Host Apache config)

public mixed WIKINDX_PATH_AUTO_DETECTION_DEFAULT = \TRUE
Tags
global

bool WIKINDX_PATH_AUTO_DETECTION_DEFAULT

WIKINDX_PHP_TIMEZONE

Timezone for PHP defaults

public mixed WIKINDX_PHP_TIMEZONE = 'UTC'

Just like the database (see WIKINDX_DB_TIMEZONE), PHP is configured by default to use UTC.

It is the responsibility of the display or form processing code to convert UTC dates to the user's preferred timezone (and vice versa), or failing that, the one defined by the administrator.

Use \DATE\determine_timezone() to get the user preferred timezone.

Tags
global

string WIKINDX_PHP_TIMEZONE

WIKINDX_PHP_VERSION_MAX

Maximum required PHP version

public mixed WIKINDX_PHP_VERSION_MAX = '8.5.99'
Tags
global

string WIKINDX_PHP_VERSION_MAX

WIKINDX_PHP_VERSION_MIN

Minimum required PHP version

public mixed WIKINDX_PHP_VERSION_MIN = '8.2.0'
Tags
global

string WIKINDX_PHP_VERSION_MIN

WIKINDX_PHPMAILER_BACKENDS

public mixed WIKINDX_PHPMAILER_BACKENDS = ['smtp' => 'SMTP', 'sendmail' => 'Sendmail']

WIKINDX_PHPMAILER_SMTP_AUTHTYPE

Mapping list of SMTP auth methods of PHPMailer with Wikindx options

public mixed WIKINDX_PHPMAILER_SMTP_AUTHTYPE = ['none' => 'None', '' => 'Auto', 'CRAM-MD5' => 'CRAM-MD5', 'LOGIN' => 'LOGIN', 'PLAIN' => 'PLAIN']

NB: 'None' is used for PHPMailer\PHPMailer->SMTPAuth and others for PHPMailer\SMTP->AuthType.

Tags
see
https://phpmailer.github.io/PHPMailer/classes/PHPMailer-PHPMailer-PHPMailer.html#property_SMTPAuth
https://phpmailer.github.io/PHPMailer/classes/PHPMailer-PHPMailer-PHPMailer.html#property_AuthType
global

array WIKINDX_PHPMAILER_SMTP_AUTHTYPE_LIST

WIKINDX_POPULARITY_DOWNLOADS_WEIGHT

STATISTICS WEIGHTS

public mixed WIKINDX_POPULARITY_DOWNLOADS_WEIGHT = 0.75

This value is relative to WIKINDX_POPULARITY_VIEWS_WEIGHT and should total 1.0.

Tags
global

float WIKINDX_POPULARITY_DOWNLOADS_WEIGHT

WIKINDX_POPULARITY_VIEWS_WEIGHT

STATISTICS WEIGHTS

public mixed WIKINDX_POPULARITY_VIEWS_WEIGHT = 0.25

This value is relative to WIKINDX_POPULARITY_DOWNLOADS_WEIGHT and should total 1.0.

Tags
global

float WIKINDX_POPULARITY_VIEWS_WEIGHT

WIKINDX_PUBLIC_VERSION

WIKINDX official/public version information

public mixed WIKINDX_PUBLIC_VERSION = '6.16.1'

This number is the official release version used by the update server to download the components.

It can be of the form X.Y.Z or X.Y.Z-rcN (with X, Y, Z, and N positive integers).

Tags
global

string WIKINDX_PUBLIC_VERSION

WIKINDX_RELEASE_DATE

WIKINDX release date

public mixed WIKINDX_RELEASE_DATE = "2026-05-11"
Tags
global

string WIKINDX_RELEASE_DATE

WIKINDX_RELEASE_TIMESTAMP

WIKINDX release timestamp

public mixed WIKINDX_RELEASE_TIMESTAMP = (new \DateTime(\WIKINDX_RELEASE_DATE))->getTimestamp()

The release script use it to change the date of files and make archives reproducible.

Tags
global

int WIKINDX_RELEASE_TIMESTAMP

WIKINDX_RSS_DESCRIPTION_DEFAULT

public mixed WIKINDX_RSS_DESCRIPTION_DEFAULT = \WIKINDX_DESCRIPTION_DEFAULT

WIKINDX_RSS_DISPLAY_EDITED_RESOURCES_DEFAULT

public mixed WIKINDX_RSS_DISPLAY_EDITED_RESOURCES_DEFAULT = \FALSE

WIKINDX_RSS_PAGE

public mixed WIKINDX_RSS_PAGE = '/index.php?action=rss_RSS_CORE&method=rss20'

WIKINDX_SEARCH_FILTER_DEFAULT

public mixed WIKINDX_SEARCH_FILTER_DEFAULT = \implode(",", ['an', 'a', 'the', 'and', 'to', 'und', 'et'])

WIKINDX_SESSION_AUTH_MAXLIFETIME_UPPER_LIMIT

public mixed WIKINDX_SESSION_AUTH_MAXLIFETIME_UPPER_LIMIT = 86400

WIKINDX_SESSION_AUTH_REMEMBERME_MAXLIFETIME_DEFAULT

public mixed WIKINDX_SESSION_AUTH_REMEMBERME_MAXLIFETIME_DEFAULT = 2678400

WIKINDX_SESSION_AUTH_REMEMBERME_MAXLIFETIME_UPPER_LIMIT

public mixed WIKINDX_SESSION_AUTH_REMEMBERME_MAXLIFETIME_UPPER_LIMIT = 2678400

WIKINDX_SESSION_GC_DIVISOR

public mixed WIKINDX_SESSION_GC_DIVISOR = 10

WIKINDX_SESSION_GC_FREQUENCY

public mixed WIKINDX_SESSION_GC_FREQUENCY = 300

WIKINDX_SESSION_GC_LASTEXEC_TIMESTAMP_DEFAULT

public mixed WIKINDX_SESSION_GC_LASTEXEC_TIMESTAMP_DEFAULT = \time()

WIKINDX_SESSION_GC_MAXLIFETIME

public mixed WIKINDX_SESSION_GC_MAXLIFETIME = 60

WIKINDX_SESSION_GC_PROBABILITY

public mixed WIKINDX_SESSION_GC_PROBABILITY = 1

WIKINDX_SESSION_NAME

public mixed WIKINDX_SESSION_NAME = 'WKXSESSID'

WIKINDX_SESSION_NOTAUTH_MAXLIFETIME_DEFAULT

public mixed WIKINDX_SESSION_NOTAUTH_MAXLIFETIME_DEFAULT = 3600

WIKINDX_SESSION_NOTAUTH_MAXLIFETIME_UPPER_LIMIT

public mixed WIKINDX_SESSION_NOTAUTH_MAXLIFETIME_UPPER_LIMIT = 86400

WIKINDX_SINGLEQUOTE_WIKINDX

Special constants used to do replacements required for SQL and similar.

public mixed WIKINDX_SINGLEQUOTE_WIKINDX = 'WIKINDXSINGLEQUOTEWIKINDX'

Typically used to temporarily replace literal characters in strings to protect them from incorrect interpretation.

Tags
global

string WIKINDX_SINGLEQUOTE_WIKINDX

WIKINDX_SITEMAP_MAX_SIZE

Max number of url by page in a sitemap (50000 max. allowed in the standard and 10 Mo max.)

public mixed WIKINDX_SITEMAP_MAX_SIZE = 500

For a response time and analysis of the response 500 links per page seems reasonable, ie below the second, as the search engines expect..

Tags
global

int WIKINDX_SITEMAP_MAX_SIZE

WIKINDX_SITEMAP_PAGE

URL of the website sitemap

public mixed WIKINDX_SITEMAP_PAGE = '/index.php?action=sitemap_SITEMAP_CORE'
Tags
global

string WIKINDX_SITEMAP_PAGE

WIKINDX_STATISTICS_COMPILED_DEFAULT

public mixed WIKINDX_STATISTICS_COMPILED_DEFAULT = '2018-01-01 01:01:01'

WIKINDX_SUPERADMIN_ID

public mixed WIKINDX_SUPERADMIN_ID = 1

WIKINDX_TAG_FACTOR_MAX

public mixed WIKINDX_TAG_FACTOR_MAX = 200

WIKINDX_TAG_FACTOR_MIN

public mixed WIKINDX_TAG_FACTOR_MIN = 50

WIKINDX_TAG_FACTOR_STEP

public mixed WIKINDX_TAG_FACTOR_STEP = 5

WIKINDX_TEMPLATE_MENU_DEFAULT

public mixed WIKINDX_TEMPLATE_MENU_DEFAULT = 0

WIKINDX_UNIX_PERMS_DEFAULT

public mixed WIKINDX_UNIX_PERMS_DEFAULT = 0777

WIKINDX_URL

WIKINDX SF url

public mixed WIKINDX_URL = 'https://wikindx.sourceforge.io'
Tags
global

WIKINDX_URL

WIKINDX_URL_BASE_DEFAULT

Default base URL of WIKINDX

public mixed WIKINDX_URL_BASE_DEFAULT = ""
Tags
global

string WIKINDX_URL_BASE_DEFAULT

WIKINDX_URL_CACHE

public mixed WIKINDX_URL_CACHE = \str_replace(\DIRECTORY_SEPARATOR, "/", \WIKINDX_DIR_CACHE)

WIKINDX_URL_CACHE_ATTACHMENTS

public mixed WIKINDX_URL_CACHE_ATTACHMENTS = \str_replace(\DIRECTORY_SEPARATOR, "/", \WIKINDX_DIR_CACHE_ATTACHMENTS)

WIKINDX_URL_CACHE_FILES

public mixed WIKINDX_URL_CACHE_FILES = \str_replace(\DIRECTORY_SEPARATOR, "/", \WIKINDX_DIR_CACHE_FILES)

WIKINDX_URL_CACHE_PLUGINS

public mixed WIKINDX_URL_CACHE_PLUGINS = \str_replace(\DIRECTORY_SEPARATOR, "/", \WIKINDX_DIR_CACHE_PLUGINS)

WIKINDX_URL_CACHE_STYLES

public mixed WIKINDX_URL_CACHE_STYLES = \str_replace(\DIRECTORY_SEPARATOR, "/", \WIKINDX_DIR_CACHE_STYLES)

WIKINDX_URL_CACHE_TEMPLATES

public mixed WIKINDX_URL_CACHE_TEMPLATES = \str_replace(\DIRECTORY_SEPARATOR, "/", \WIKINDX_DIR_CACHE_TEMPLATES)

WIKINDX_URL_COMPONENT

public mixed WIKINDX_URL_COMPONENT = \str_replace(\DIRECTORY_SEPARATOR, "/", \WIKINDX_DIR_COMPONENT)

WIKINDX_URL_COMPONENT_PLUGINS

public mixed WIKINDX_URL_COMPONENT_PLUGINS = \str_replace(\DIRECTORY_SEPARATOR, "/", \WIKINDX_DIR_COMPONENT_PLUGINS)

WIKINDX_URL_COMPONENT_STYLES

public mixed WIKINDX_URL_COMPONENT_STYLES = \str_replace(\DIRECTORY_SEPARATOR, "/", \WIKINDX_DIR_COMPONENT_STYLES)

WIKINDX_URL_COMPONENT_TEMPLATES

public mixed WIKINDX_URL_COMPONENT_TEMPLATES = \str_replace(\DIRECTORY_SEPARATOR, "/", \WIKINDX_DIR_COMPONENT_TEMPLATES)

WIKINDX_URL_DATA

public mixed WIKINDX_URL_DATA = \str_replace(\DIRECTORY_SEPARATOR, "/", \WIKINDX_DIR_DATA)

WIKINDX_URL_DATA_ATTACHMENTS

public mixed WIKINDX_URL_DATA_ATTACHMENTS = \str_replace(\DIRECTORY_SEPARATOR, "/", \WIKINDX_DIR_DATA_ATTACHMENTS)

WIKINDX_URL_DATA_IMAGES

public mixed WIKINDX_URL_DATA_IMAGES = \str_replace(\DIRECTORY_SEPARATOR, "/", \WIKINDX_DIR_DATA_IMAGES)

WIKINDX_URL_DATA_PLUGINS

public mixed WIKINDX_URL_DATA_PLUGINS = \str_replace(\DIRECTORY_SEPARATOR, "/", \WIKINDX_DIR_DATA_PLUGINS)

WIKINDX_URL_HELP_TOPICS

URL of the Help Topics on the website

public mixed WIKINDX_URL_HELP_TOPICS = 'https://wikindx.sourceforge.io/web/' . \WIKINDX_PUBLIC_VERSION . '/help-topics'
Tags
global

string WIKINDX_URL_HELP_TOPICS

WIKINDX_USE_BIBTEX_KEY_DEFAULT

public mixed WIKINDX_USE_BIBTEX_KEY_DEFAULT = \FALSE

WIKINDX_USE_WIKINDX_KEY_DEFAULT

public mixed WIKINDX_USE_WIKINDX_KEY_DEFAULT = \FALSE

WIKINDX_USER_LANGUAGE_DEFAULT

public mixed WIKINDX_USER_LANGUAGE_DEFAULT = 'auto'

WIKINDX_USER_PAGING_DEFAULTLINKS

public mixed WIKINDX_USER_PAGING_DEFAULTLINKS = 11

WIKINDX_USER_PAGING_DEFAULTPAGING

public mixed WIKINDX_USER_PAGING_DEFAULTPAGING = 20

WIKINDX_USER_PAGING_MINLINKS

public mixed WIKINDX_USER_PAGING_MINLINKS = 4

WIKINDX_USER_PAGING_MINPAGING

public mixed WIKINDX_USER_PAGING_MINPAGING = 2

WIKINDX_USER_PAGING_STYLE_DEFAULT

public mixed WIKINDX_USER_PAGING_STYLE_DEFAULT = 'N'

WIKINDX_USER_STRING_MINLENGTH

public mixed WIKINDX_USER_STRING_MINLENGTH = 10

WIKINDX_USER_TIMEZONE_DEFAULT

public mixed WIKINDX_USER_TIMEZONE_DEFAULT = 'auto'

WIKINDX_WP_DOCX_EXPORTER_VERSION

WordProcessor Docx Exporter Version

public mixed WIKINDX_WP_DOCX_EXPORTER_VERSION = '1.0'

This value is written in the 'AppVersion' element of the app.xml file to distinguish the version that generated a Word document.

Tags
global

string WIKINDX_WP_DOCX_EXPORTER_VERSION

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_shutdown_handler()

Shutdown Handler

wkx_shutdown_handler() : mixed

Vérifie si la dernière erreur était fatal, et dans ce cas inscrit les informations de débogage dans la trace global car le script ne peut pas intercepter ce genre d'erreur lui-même.

Check if the last error was fatal on shutdown, and if so, log the debugging information to the global trace, as the script cannot intercept this type of error itself.

cf. https://www.php.net/manual/en/function.register-shutdown-function.php cf. https://www.php.net/manual/en/function.set-error-handler.php

wkx_exception_handler()

Custom handler for uncaught exceptions

wkx_exception_handler(Throwable $exception) : mixed

This will trigger instead of the PHP one, if the script has not intercepted it itself.

Then PHP terminates the script on its own.

cf. https://www.php.net/manual/en/function.set-exception-handler.php

Parameters
$exception : Throwable

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 

        

        
    




    

    

                                

                

                            
    

        On this page

        
    


                

                            

            

    

        

            
Search results