WIKINDX API trunk

wikindx

Table of Contents

Packages

core

Classes

API

API hooks

IDEASCOMMON

IDEASCOMMON class

EXPORTCOMMON

EXPORT COMMON class

APP

APP class

CONTENT_TYPES

CONTENT_TYPES class

CORE

CORE class

DOCUMENT

DOCUMENT class

DOCUMENT_XML_RELS

DOCUMENT_XML_RELS class

ENDNOTES

ENDNOTES class

FONT_TABLE

FONT_TABLE class

FOOTER1

FOOTER1 class

FOOTER2

FOOTER2 class

FOOTNOTES

FOOTNOTES class

HEADER1

HEADER1 class

HEADER2

HEADER2 class

NUMBERING

NUMBERING class

RELS

RELS class

SETTINGS

SETTINGS class

STYLES

STYLES class

THEME1

THEME1 class

WEB_SETTINGS

WEB_SETTINGS class

FileManager

FileManager

FileServer

FileServer

Location

Location

EncodeExplorer

EncodeExplorer

HIGHLIGHT

HIGHLIGHT class.

PASSWORD

PASSWORD class.

WkxDbSessionHandler

Custom session handler used when the session is stored inside db

Constants

ABBREVIATION  : mixed = 'W1K1NDXABBREVIATION' . DELIM

BIB  : mixed = 'left width20percent'

BLOCKINDENT  : mixed = 720

BLOCKQUOTEINDENT  : mixed = '40px'

BORDER_STYLES  : mixed = [ // We only use those available in tinyMCE. I'...

BORDER_THICKNESS_MAX  : mixed = 96

BORDER_THICKNESS_MIN  : mixed = 2

BORDERCEILING  : mixed = 75

BQEND  : mixed = DELIM . 'W1K1NDXENDBQ'

BQFACTOR  : mixed = 2

BQSTART  : mixed = 'W1K1NDXSTARTBQ' . DELIM

BR  : mixed = "<br>"

CONSTANTS

CB  : mixed = 'left center width10percent'

CELL_DEFAULTS  : mixed = [ 'BorderStyle' => 's', // Solid 'BorderWidth'...

CELL_EMPTY  : mixed = '\intbl' . LF . '{}' . LF . '\cell\pard' . LF . LF

CELL_STUB  : mixed = [ 'Border' => 'clbrdr', // Begin cell border de...

CELL_USETABLEBORDER  : mixed = 'brdrtbl'

CELL_VALIGN  : mixed = ['top' => 'top', 'middle' => 'center', 'bottom'...

CELL_VALIGN  : mixed = ['top' => 't', 'middle' => 'c', 'bottom' => 'b']

CELL_VERTICALMERGE  : mixed = ['start' => 'clvmgf', 'continue' => 'clvmrg']

CELLBORDER_STYLES  : mixed = [ // We only use those available in tinyMCE. I'...

CELLPADDING  : mixed = 'clpad'

CELLPADDING_DEFAULT  : mixed = 55

CELLPADDING_UNIT  : mixed = 'clpadf'

CELLWIDTH_DEFAULT  : mixed = 300

CHARWIDTH  : mixed = 18

CITATION  : mixed = 'W1K1NDXCITATION' . DELIM

COLOUR_NAMES  : mixed = ["aliceblue" => "F0F8FF", "antiquewhite" => "FA...

COLOUR_NAMES  : mixed = ["aliceblue" => "F0F8FF", "antiquewhite" => "FA...

COLOURS  : mixed = [ '\red0\green0\blue0', // Black (text by defau...

CONSECUTIVE  : mixed = 'W1K1NDXCONSECUTIVE' . DELIM

CR  : mixed = "\r"

CREATORS  : mixed = 'W1K1NDXCREATORS' . DELIM

CRLF  : mixed = "\r\n"

CV1  : mixed = 'left width30percent'

CV2  : mixed = 'left width30percent'

DEFAULT_BACKGROUND_COLOUR  : mixed = 'auto'

DEFAULT_BORDER_COLOUR  : mixed = 'auto'

DEFAULT_BORDER_STYLE  : mixed = 'nil'

DEFAULT_BORDER_THICKNESS  : mixed = 2

Border thickness: "Specifies the width of the border. Table borders are line borders (see the val attribute below), and so the width is specified in eighths of a point, with a minimum value of two (1/4 of a point) and a maximum value of 96 (twelve points)." From: http://officeopenxml.com/WPtableCellProperties-Borders.php

DEFAULT_CELL_PADDING  : mixed = 0

DEFAULT_CELL_SPACING  : mixed = 0

DEFAULT_COLOUR  : mixed = '000000'

DEFAULT_COLOUR_CODE  : mixed = 'lightGray'

DEFAULT_COLOUR_HIGHLIGHT  : mixed = FALSE

DEFAULT_ENDNOTE_INDENT  : mixed = 'indentNone'

DEFAULT_ENDNOTE_POS  : mixed = 'docEnd'

DEFAULT_ENDNOTE_RESTART  : mixed = 'continuous'

DEFAULT_ENDNOTE_SIZE  : mixed = 12

DEFAULT_ENDNOTE_SPACING  : mixed = 240

DEFAULT_FONT  : mixed = 'arial'

DEFAULT_FONT_CODE  : mixed = 'courier new'

DEFAULT_FOOTNOTE_INDENT  : mixed = 'indentNone'

DEFAULT_FOOTNOTE_RESTART  : mixed = 'continuous'

DEFAULT_FOOTNOTE_SIZE  : mixed = 12

DEFAULT_FOOTNOTE_SPACING  : mixed = 240

DEFAULT_HEADING_SIZE  : mixed = 14

DEFAULT_HEADING_STYLE  : mixed = 'Heading3'

DEFAULT_LINE_SPACING  : mixed = 240

DEFAULT_PAGENUM_ALIGN  : mixed = 0

DEFAULT_PAGENUM_LOC  : mixed = 0

DEFAULT_PAGENUM_RESTART  : mixed = FALSE

DEFAULT_SECTION  : mixed = 'A4'

DEFAULT_SIZE  : mixed = 12

DELIM  : mixed = '>'

DELSPACE  : mixed = 'W1K1NDXDELSPACE'

DIALOGUEQUOTE  : mixed = 'W1K1NDXDIALOGUEQUOTE' . DELIM

DOCDEFAULTS  : mixed = "\\f1\\fs24\n\\s1\\cf1\\ql\\li1\\fi1"

ENDELLIPSES  : mixed = DELIM . 'W1K1NDXENDELLIPSES'

ENDFACTOR  : mixed = 1

ENDSPACE  : mixed = DELIM . 'W1K1NDXENDSPACE'

FB  : mixed = 'left width15percent'

FONTS  : mixed = ['andale mono' => [ "ePrefix" => "w", "eName" =...

FONTS  : mixed = ["andale mono", "arial", "arial black", "book a...

FONTSIZES  : mixed = ['xx-small' => 16, 'x-small' => 20, 'small' =>...

FORM_CLASS  : mixed = 'formElements'

FORM widgets class

FORM_CLASS  : mixed = 'formElements'

FORM_EXTENDED widgets class

FTFACTOR  : mixed = 1

HANGING  : mixed = 360

HARDPUNC  : mixed = 'W1K1NDXHARDPUNC' . DELIM

HEADINGS  : mixed = ['h6' => 8, 'h5' => 10, 'h4' => 12, 'h3' => 14,...

HEADINGS_STYLE  : mixed = ['h6' => 'Heading6', 'h5' => 'Heading5', 'h4' =...

HEADINGS_STYLE_SIZE  : mixed = ['h6' => 16, 'h5' => 20, 'h4' => 24, 'h3' => 28...

HIDDENPARASTART  : mixed = "W1K1NDXHIDDENPARASTART" . DELIM

HTML_BR  : mixed = 'W1K1NDXBR'

HTML_END_FT  : mixed = DELIM . 'W1K1NDXENDFT'

HTML_END_P  : mixed = DELIM . 'W1K1NDXENDP'

HTML_END_TAGELEMENT  : mixed = DELIM . 'W1K1NDXENDTAGELEMENT'

HTML_HEADINGS  : mixed = ['<h1>', '<h2>', '<h3>', '<h4>', '<h5>', '<h6>']

HTML_START_ENTITY  : mixed = 'W1K1NDXSTARTENTITY' . DELIM

HTML_START_FT  : mixed = 'W1K1NDXSTARTFT' . DELIM

HTML_START_HTML  : mixed = 'W1K1NDXSTARTHTML' . DELIM

HTML_START_P  : mixed = 'W1K1NDXSTARTP' . DELIM

HTML_START_TABLE  : mixed = 'WIKINDXSTARTTABLE' . DELIM

HTML_START_TAGELEMENT  : mixed = 'W1K1NDXSTARTTAGELEMENT' . DELIM

HTMLSENTENCEENDINGS  : mixed = [HTML_END_P, HTML_BR, '</td>', '</li>', 'W1K1ND...

HTMLTOARRAYKEY  : mixed = [ // Translate some HTML attributes to keys use...

IGNOREDTAGS  : mixed = [ // Document metadata "base", "head", "link",...

IGNOREDTAGS  : mixed = [ // Document metadata "base", "head", "link",...

INDENT  : mixed = '40px'

INDENT  : mixed = 720

INDENT  : mixed = 18

INDENTS  : mixed = ['indentNone' => '', 'indentAll' => '\li' . BLO...

JUSTIFICATIONS  : mixed = [ // WIKINDX => DOCX 'center' => 'center', 'lef...

JUSTIFY  : mixed = ['center' => 'c', 'left' => 'l', 'right' => 'r'...

LEFTCELL  : mixed = 'generalTable borderStyleSolid left width60perc...

Styling, particularly width, for TD containers

LF  : mixed = "\n"

LINE_SPACING  : mixed = ['singleSpace' => 240, 'oneSixthSpace' => 276,...

LINESPACINGS  : mixed = ['singleSpace' => '\sl240\slmult1', 'oneSixthSp...

LINESPACINGSNUM  : mixed = ['1' => '\sl240\slmult1', '1.15' => '\sl276\slm...

LISTBULLETS  : mixed = ['bullet', 'circle', 'square']

LISTBULLETS_RTF  : mixed = ['\ls1\fi-360\li', '\ls2\fi-360\li', '\ls3\fi-3...

LISTINDENT  : mixed = 720

LISTINDENT_EXTRA  : mixed = 360

LISTORDERS  : mixed = ['arabic', 'lower-alpha', 'lower-roman']

LISTORDERS_RTF  : mixed = ['0', '4', '2']

LISTTYPES  : mixed = ['aa' => '\ls5\fi-360', 'a' => '\ls0\fi-360', '...

MAX_LEVEL  : mixed = 8

OL_LIST  : mixed = [0 => 'decimal', 1 => 'lowerLetter', 2 => 'lowe...

OPT  : mixed = 'left width60percent'

PAPERSIZES  : mixed = ['A4' => '\paperh16838\paperw11906\margl1134\ma...

PIXELSTOPOINTS  : mixed = 0.75

POINTSTOBORDERWIDTH  : mixed = 0.125

QEND  : mixed = DELIM . 'W1K1NDXENDQUOTE'

QENDNEST  : mixed = DELIM . 'W1K1NDXENDNESTEDQUOTE'

QSTART  : mixed = 'W1K1NDXSTARTQUOTE' . DELIM

QSTARTNEST  : mixed = 'W1K1NDXSTARTNESTEDQUOTE' . DELIM

RB1  : mixed = 'small left top width8percent'

RB2  : mixed = 'small left top width8percent'

RB3  : mixed = 'left top width8percent'

RECONSTITUTE_REMOVE_1  : mixed = [HARDPUNC, URL, SOFTPUNC, BQSTART, BQEND, QSTAR...

RECONSTITUTE_REMOVE_2  : mixed = ['W1K1NDXHARDPUNC', 'W1K1NDXURL', 'W1K1NDXSOFTP...

REPLACEHARDPUNC  : mixed = 'W1K1NDXREPLACEHARDPUNC'

ROWBORDER  : mixed = 'trbrdr'

ROWHEIGHT  : mixed = 'trrh'

ROWPADDING  : mixed = 'trpadd'

ROWPADDING_DEFAULT  : mixed = 55

ROWPADDING_UNIT  : mixed = 'trpaddf'

ROWSPACING  : mixed = 'trspd'

ROWSPACING_DEFAULT  : mixed = 0

ROWSPACING_UNIT  : mixed = 'trspdf'

ROWSTART_DEFAULT  : mixed = 0

SB1  : mixed = 'left center width20percent'

SB2  : mixed = 'left center width20percent'

SCHEMA_MAIN_2006  : mixed = "http://schemas.openxmlformats.org/drawingml/20...

SCHEMA_MAIN_2010  : mixed = "http://schemas.microsoft.com/office/drawing/20...

SCHEMA_PICTURE  : mixed = "http://schemas.openxmlformats.org/drawingml/20...

SECTIONSIZE  : mixed = ['A4' => ['size' => ['width' => 11906, 'height'...

SOFTPUNC  : mixed = 'W1K1NDXSOFTPUNC' . DELIM

START_LEVEL  : mixed = -1

STARTELLIPSES  : mixed = 'W1K1NDXSTARTELLIPSES' . DELIM

STARTSPACE  : mixed = 'W1K1NDXSTARTSPACE' . DELIM

TA  : mixed = 'left center middle width5percent'

TAB  : mixed = "\t"

TABFACTOR  : mixed = 40

TABLE_UNIT  : mixed = 3

The row definitions must be output for each row. 'x' refers to a variable additiion.

TABLEWIDTH_DEFAULT  : mixed = 100

TWIPSTOPIXELS  : mixed = 0.0666666667

TWIPSTOPIXELS  : mixed = 0.0666666667

TWIPSTOPOINTS  : mixed = 0.05

TWIPSTOPOINTS  : mixed = 0.05

UL_FONTS  : mixed = [0 => ['ascii' => 'Symbol', 'hAnsi' => 'Symbol'...

UL_LIST  : mixed = [ 0 => '•', // Symbol 1 => 'o', // Courier New...

URL  : mixed = 'W1K1NDXURL' . DELIM

USABLEHEIGHT  : mixed = [ // Set to paper height less margin top and ma...

USABLEWIDTH  : mixed = [ // Set to paper width less margin left and ma...

USABLEWIDTHS  : mixed = [ // Set to paper width less margin left and ma...

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_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_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

WT  : mixed = 'left width30percent'

WTAGTAIL  : mixed = DELIM . 'W1K1NDX'

Functions

loadJavascript()  : void

Load the ajax javascript and the user javascript(s) into the HTML page output.

jActionForm()  : string

Create and load the HTML form element insert for the AJAX action and function.

jActionIcon()  : string

Create and load the IMG element insert for the AJAX action and function. Works with core/libs/LOADICONS.php.

encode_jArray()  : string

Convert $jsonArray to JSON string and format any array elements referencing javascript functions.

decode_jString()  : mixed

Convert JSON-formatted $jsonString to an array or object.

_json_error()  : void

echo JSON error or return if none.

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

Get data from citation sentences and return an array of citation data and an array of resource data ready for producing a bibliography from.

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

Create an array of bibliographic data matching the template fields

addCreators()  : void

Add creators

findSubsequentFootnoteTemplates()  : void

Find examples of ibid, idem, and opCit footnote templates.

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

Map a template to the raw values and produce a basic bibliographic/footnote entry

invertFormat()  : string

Invert the format of a title where necessary.

mapSpecialTemplate()  : string

Map a special template (no partial, creator fields etc.—e.g., runningTimeTemplate) to the raw values and produce a string

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

Make sure we don't have multiple punctuation characters after a field —NOT CURRENTLY USED (see cleanItems())

addLinks()  : string

Add link items such as URL and DOI

addLinksFt()  : string

Find any links in footnotes and make active if required

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

Add date: stage 1

addDateStage2()  : string

Add date: stage 2

formatDate()  : string

Format date from days and months

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

Format the day part of a date

addRunningTime()  : string

Add and format running time (films, TV etc.)

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

Add and format pages

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

Find other items in various resource arrays for adding to the $items array

setBookYears()  : void

For WIKINDX, if type is book, book_chapter or book article and there exists both 'year1' and 'year2' in $resource (entered as publication year and reprint year respectively), then switch these around as 'year1' is entered in the style template as 'originalPublicationYear' and 'year2' should be 'publicationYear'.

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

Clean up the $item elements, deal with ordinals, and flatten to final string.

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

Check if the ultimate value should have its first characterf removed (double punctuation)

editorSwitch()  : bool

Set any author/editor re-ordering for book and book_article type.

formatCreators()  : void

Format creator name lists (authors, editors, etc.)

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

Keep only some elements in array if we've exceeded set thresholds and create an etAl string if necessary.

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

Rewrite creator strings

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

Add custom fields.

formatRunningTime()  : string

Format running time for audiovisual bibliography items

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

Add year fields.

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

Add any edition field

formatEdition()  : mixed

Format edition (might not be numeric)

getOrdinalExtensionAlignment()  : array<string|int, string>

Get alignment for ordinal extension

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

Check that the first field of $template exists in $item and has a value.

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

When using a fallback template, ensure the fields are valid for that resource type

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

Check against repeat creator options and amend $items if required If this is footnotes, then $newItems is also ordered correctly.

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

Check against repeat creator options and amend $items if required If this is footnotes, then $newItems is also ordered correctly.

mapTemplateCreatorRepeatString()  : string

Basic map template for creator repeat string

settings()  : mixed

Deal with various settings, setting, getting, incrementing, decrementing etc.

getNameString()  : string

Get the nameString variable

checkInitials()  : string

Handle initials.

hyphenatedInitials()  : string

Deal with hyphenated firstnames as initials

addCreatorDelimiters()  : void

Add delimiters to creators

formatMultiplePages()  : string

Format multiple pages.

titleCapitalization()  : string

Do title capitalization

setEtAl()  : string

Set et al. for multiple creators

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

Find alternate fields dependent on previous or following fields and deal with accordingly.

formatTitle()  : string

Format a resource title

formatShortTitle()  : string

Format a resource shortTitle

formatPubStatus()  : string

Format publication status

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

Deal with __DEPENDENT_ON_PREVIOUS_FIELD__ for pre and post dependent on previous field's existence and __DEPENDENT_ON_NEXT_FIELD__ for pre and post dependent on the next field's existence

mapTemplateIndependents()  : void

Map independent fields of templates.

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

Deal with singular/plural dependencies for fields such as pages and creators

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

Replace ASCII whitespace with locale's whitespace character(s) from elements of an array Callback

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

Strip backticks used in template

ordinals()  : string

format ordinals

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

Identify ambiguous in-text citations and references.

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

Provide empty array elements in resourceData from the adminstyle plugin's preview functions to conform with what BIBCITEGATEWAY expects.

setJustify()  : string|false

Generic code for setting justification

setLineSpace()  : string|false

Generic code for setting line height

setIndentation()  : string|false

Generic code for setting indentation

setFontSize()  : string|false

Generic code for setting font size

exportSettings()  : mixed

Setters and getters for various export preferences (e.g. from word processor)

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

Compile and add the citations to the text

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

Map a template to the raw values and produce a basic citation for inserting into the text

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

Some resource types have specific templates for in-text citations

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

Force the use of ambiguous templates overriding other templates other than subsequentCreatorTemplate

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

Confirm (or not) that a subsequentCreatorTemplate designation is correct.

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

Find required position of citation in sentence. Not all requests are possible so drop through three levels . . . Be careful! 0 => "Unchanged" 1 => "After previous creator name(s)" 2 => "After previous quotation" 3 => "Before end of sentence" 4 => "After end of sentence" 5 => "Before next soft punctuation" 6 => "After next soft punctuation"

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

For multiple citations that are repositioned after soft or hard punctuation, mark them as consecutive citations.

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

Confirm (or not) that a followCreatorTemplate designation is correct (in-text citations).

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

Confirm (or not) that a consecutiveCreatorTemplate designation is correct (in-text citations).

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

Format the citation

hyperlinkCitation()  : void

Hyperlink the citation text

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

Format citation with wrapping characters taking account of consecutive citation runs and their delimiting characters

trueFootnoteWrapping()  : string

Wrapping of true footnotes in the text — only used for endInc, endSameId, and endSameIdOrdered

formatSentence()  : string

Format the sentence with each citation obeying required positions.

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

Position citations in the sentence.

doPageSplit()  : void

Check if a citation page should indeed be split and deal with dependencies.

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

Do some pre-processing of various year fields in the template

formatPages()  : void

Format pages.

formatCreators()  : void

Format creator name lists (authors, editors, etc.)

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

Add replacement years fields to templates

copyYearAlternates()  : void

Copy any alternates relating to pre and post fields from the 'year' field to 'year1' and 'year2' fields

parseIndependent()  : void

Parse independent strings of new templates

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

Compile in-text and endote-style citation templates

addAmbiguity()  : void

Add any ambiguity letter to year field. Only for in-text citations

formatYear()  : void

Format years for citations

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

Conditionally add second year field for formatting citations (e.g. revision year, reprint year etc.)—depends on resource type

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

Split text into sentences.

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

Parse the sentences array for citations and make some initial decisions

findSubsequentTemplates()  : void

Decide if the template for this citation should be the subsequentCreatorTemplate or similar for endnote styles.

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

Find cases for followCreatorTemplate and mark position after creator's name.

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

Create the preg pattern for finding a citation's creator names in the same sentence.

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

end-of-sentence characters have been captured in $split's array elements. These must be appended to the previous part sentence.

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

Add the citation index to relevant quotations.

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

Ensure hard punctuation just before a quotation end marker is treated as marking the end of a complete sentence.

findSpecialQuotes()  : string

Find special quotes such as dialogue and nested quotes—mark them and protect contents of nested quotes

findDialogueQuotes()  : string

Find dialogue quotes and mark them.

findNestedQuotes()  : string

Find and mark nested quotations.

findQuotes()  : string

Mark quotations and protect their content (in case the content has hard punctuation).

blockQuote1()  : string

Mark blockquotes.

blockQuote2()  : string

Format blockquotes and ensure tailend bits are part of it.

blockQuoteSort()  : string

Sort the blockQuote array by length so that the preg_replace works as expected

findEllipses()  : string

Mark ellipses and protect their content (in case the content has hard punctuation).

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

Find and note existence of title and short title in sentences

tidyInputText()  : string

Preliminary tidying of input text.

reconstituteBlockquote()  : string

Reconsitute blockquote

reconstituteQuote()  : string

Reconsitute quotation

reconstituteQuoteCallback()  : string

Reconsitute quotation callback

reconstituteText()  : string

Return sentence temporary markup to original

debugPrint()  : void

Print an array prettily for debugging purposes

getType()  : array<string|int, string>

Return an array containing the most used grammar types of a locale

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

Return array of quotation markers for each locale.

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

Return array of hard punctuation (END of sentence only) for each locale.

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

Return array of soft punctuation (within sentence) for each locale.

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

Return array of all hard and soft punctuation.

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

Return array of abbreviations for each locale.

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

Return array of number abbreviations (ordinals and measurements) for each locale.

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

Return array of ellipses for each locale.

compilePossessives()  : array<string|int, string>

Return array of possessives for each locale.

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

Return array of et al. possibilities for each locale.

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

Return array of creator conjunction possibilities for each locale.

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

Return array of word space characters for each locale.

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

Return array of apostophe for each locale (e.g., in English the "'" of "it's" (short for "it is")

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

Return array of initial punctuation for each locale.

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

Return array of number conjunctions for each locale.

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

Append common (Latin) bibliographic abbreviations

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

Read and return the list of all components installed

writeComponentsList()  : void

Write a list of components from an array

refreshComponentsListCache()  : void

Refresh the components list if needed, or forced by the caller

isBuiltinComponent()  : bool

Is a component builtin?

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

Return a structured list of installed components

computeComponentVersion()  : int

Compute a component version number from the current date

computeComponentSignature()  : string

Compute the hash signature of a component from its installed code

createComponentMetadataFile()  : void

Create the component.json file of a component

enableComponent()  : bool

Enable a component

disableComponent()  : bool

Disable a component

checkComponentIntegrity()  : int

Check the integrity of a component

componentIntegrityErrorMessage()  : string

Return the message of an error code of the function checkComponentIntegrity()

extractComponentPackage()  : bool

Extract a WIKINDX Component Package to a folder

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

Extract the component.json file of a WIKINDX Component Package to an array

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

List all plugins enabled in WIKINDX_DIR_COMPONENT_PLUGINS with a sane configuration

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

List all styles enabled in WIKINDX_DIR_COMPONENT_STYLES with a sane configuration

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

List all templates enabled in WIKINDX_DIR_COMPONENT_TEMPLATES with a sane configuration

checkPluginVersionCompatibility()  : bool

Check version compatibility of a plugin

loadStyleInfo()  : associative

Extract info entries from a JSON bibliographic style file and return an associative array of childnode's value of 'info' node.

timezoneOffsetFromUTC()  : string

Returns the timezone offset from UTC

localeDate2dbDate()  : string

Convert a datetime form the user timezone to the database timezone

dbDate2localeDate()  : string

Convert a datetime form the database timezone to user timezone

dateFormatFromString()  : string

Format dates and times for localization in numeric short format

dateFormatFromTimeStamp()  : string

Format dates and times for localization in numeric short format

getAllTimezones()  : array<string|int, string>

Return a selected list of all time zones recognised by PHP

determine_timezone()  : string

Determine the user's preferred timezone.

determine_timezone_priority_stack()  : array<string|int, string>

Determine the user's preferred timezone.

pkgPaths()  : mixed

Get and set the DOCX package paths, creating the folder in cache/files/

STARTDOM()  : void

Create and traverse the DOM from the HTML file.

traverseDOM()  : mixed

Traverse the DOM and produce DOCX code

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

Convert attributes

calculateTwipsWidth()  : int

Calculate table widths in twips from either % or px values

calculateBorderSize()  : int

Calculate table border size in twips from px values.

domImageToDocxImage()  : void

Images are renamed and copied to

domNodeAttributes2Array()  : array<string|int, string>

Convert attributes of a DOMNode to an array of attributes

colours()  : mixed

Set and write colours.

getColour()  : string

Ensure input colour is in 6-character HEX format

rels()  : mixed

Set and get the rels array and the rId.

endnotes()  : mixed

Various functions related to endnotes

fonts()  : mixed

Set and get the rFonts array and the current font.

sizes()  : mixed

Set and get the rFonts array and the current font.

writeSize()  : void

Convert font size to DOCX (in span and p tags as "style=font-size: xxpt;") and write XML

footnotes()  : mixed

Various functions related to footnotes

formats()  : void

Set and write the rProps array

italics()  : void

Italics (em or i)

underline()  : void

underline (span text-decoration: line-through)

bold()  : void

bold (strong or b)

strikethrough()  : void

strikethrough (span text-decoration: line-through)

superscript()  : void

superscript (sup)

subscript()  : void

subscript (sup)

images()  : void

Set and write images.

floatParams()  : mixed

Set and get image float values.

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

get the default file extention associated to an image mimetype

justify()  : mixed

Set and get the justification and indentation for the current paragraph.

lists()  : mixed

Set and get methods for dealing with lists.

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

Build up the numIds array

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

Build up the abstractNumIds array

startListItem()  : void

Start a list (ul or ol)

listItemProps()  : void

List item (li)

endListItem()  : void

End a list (ul or ol)

needNumbering()  : bool

Set and get the flag indicating if the word/numbering.xml file needs to be written (e.g., for lists, endnotes, and so on)

needTables()  : bool

Set and get the flag indicating if the xml string needs DOM-traversal in order to insert table headers (see \DOCX\format\TABLES\writeTableHeaders())

needSections()  : bool

Set and get the flag indicating if the xml string needs DOM-traversal in order to insert sections (see \DOCX\format\SECTIONS\writeSections())

needFootnotes()  : bool

Set and get the flag indicating if the xml string needs DOM-traversal in order to insert footnotes (see \FOOTNOTES)

needEndnotes()  : bool

Set and get the flag indicating if the xml string needs DOM-traversal in order to insert endnotes (see \ENDNOTES)

hr()  : void

Horizontal ruler (hr)

startHyperlink()  : void

Start a hyperlink (a)

endHyperlink()  : void

End a hyperlink (a)

startHeading()  : void

Start a heading (h1, h2, etc.)

endHeading()  : void

End a heading (h1, h2, etc.)

getXmlRelsId()  : string

Produce an incrementing rId number for the document.xml.rels file.

getDotRelsId()  : string

Produce an incrementing rId number for the .rels file

genHex()  : string

Generate a unique random 8 digit hex value used for paragraph ids, table cell ids, etc.

pxToEmu()  : float

Convert pixels to emus (English Metric Units)

twipToEmu()  : int

Convert twips to emus (English Metric Units)

br()  : void

Add a new line (br)

pStatus()  : bool

Set and get the open/close status of a paragraph. The initial text in a table cell is not enclosed in p tags in the html but must be in a paragrph in DOCX. However, a second paragraph in the cell _is_ enclosed in p tags in the HTML. We must ensure that the initial paragraph of a cell does not itself encapsulate any other paragraphs in the cell. The initial text in a cell will call startP() and set the pStatus to TRUE (open). Any subsequent call to startP() must check if pStatus is TRUE and, if so, close the preceding paragraph.

startP()  : void

Start a paragraph (p).

endP()  : void

End a paragraph (p)

pProps()  : mixed

Set and write the pProps

rProps()  : mixed

Set and write the rProps

sections()  : mixed

Set and get the initial sectPr element

writeSections()  : string

Insert section breaks other than the default (i.e., section breaks have been inserted in the WP).

pageNums()  : mixed

Set and get page number options. These are written as part of the section block.

tables()  : mixed

Set and get and manipulate table settings and elements.

tableHeaders()  : bool

Handle table headers to be written to the XML after all tables' data have been collected.

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

Get the gridArray for the table cells once they have all been parsed and the table properties are ready to be finalised in XML.

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

Calculate the gridArray widths.

startTable()  : void

Start a new table

endTable()  : void

End a table

writeCells()  : bool

Write the table cell widths (for existing cells) and insert vMerge=continue cells after having created the grid.

createVmergeCell()  : DOMNode

Write a vMerge=continue cell.

writeTblGrid()  : void

Write the tblGrid node

createTblProps()  : void

Set up the tblPr node

startRow()  : void

Start a new table row

endRow()  : void

End a table row

startCell()  : void

Start a new table cell

vMergeProps()  : mixed

Set and get and reset the properties of the vMerge=restart cells for use in their vMerge=continue cells

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

Do properties (borders, shading) for table cells

endCell()  : void

End a table cell

text()  : void

Text

writeRunCharacterFormatting()  : void

writeElementAttribute()  : void

Write an array of attributes within an element.

writeElementAttributeNs()  : void

Write an array of NS attributes within an element.

writeElement()  : void

Write one or more elements

writeElementMultAttrNs()  : void

Write an NS element with prefixes and multiple attributes

writeFontDefinition()  : void

Write a font definition (for fontTable.xml header)

endElement()  : void

End an element

format()  : string

Format for HTML or RTF/plain?

notes()  : mixed

Set and get footnote and endnote texts.

bbcode()  : string

Deal with BBCODE

endnoteId()  : string

Format the endnote ID in the endnotes

trueFootnoteId()  : string

Format the true footnote ID in the footnotes section

newline()  : string

Return a newline character.

setHeaders()  : void

Set download headers

readfile_chunked()  : bool

Download file to user

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

create a fileName for this file. If directory based on session ID does not exist, create it.

fileAttachUploadMaxSize()  : int

Get attachment max upload size in bytes

imageUploadMaxSize()  : int

Get image max upload size in bytes

fileUploadMaxSize()  : int

Get file max upload size in bytes

return_bytes()  : int

Convert some ini values to numerical values (to bytes)

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

Enumerate files and subdirectories of a directory except . and .. subdirectories

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

Enumerate subdirectories of a directory except . and .. subdirectories

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

Enumerate files of a directory except . and .. subdirectories

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

Enumerate recursively files and subdirectories of a directory except . and .. subdirectories

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

Enumerate recursively files and subdirectories of a directory except . and .. subdirectories

recurse_dir_copy()  : void

Copy recursively a folder

recurse_rmdir()  : void

Remove recursively a folder

rmfile()  : void

Remove a file

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

Return filename, hash, type and size of an uploaded file or an array of such information for each file uploaded

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

Rearrange the $_FILES array for multiple file uploads

fileStore()  : bool

Store uploaded file in given directory with given name

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

list and HTML format all files for sessionID

tidyFiles()  : void

tidy up the files directory by removing all files and folders older than WIKINDX_FILE_DELETE_SECONDS

zip()  : mixed

Zip up an array of files. File is stored in files dir.

read_json_file()  : mixed

Read a JSON file to a data structure

write_json_file()  : int

Write a data structure to a JSON file

formatSize()  : string

Format a file size in bytes to the greater multiple for display

getMimeType()  : string

Return the mime-type of a file

getExtension()  : string

Return the extension of a file in lowercase (without point)

replaceFileExtension()  : string

Replace the extension of a file by an other

removeFileExtension()  : string

Remove the extension of a file path (and its point)

base64_encode_file()  : void

Encode a file with base64 as an other file

base64_decode_file()  : void

Encode a file with base64 as an other file

bin2hex_encode_file()  : void

Encode a file with bin2hex as an other file

hash_path()  : string

Generates a hash of a file or directory at the given path with the specified algo.

hash_component_dir()  : string

Generates a hash of all files and directories of a component with the specified algo.

imageMimeTypeConstant2extension()  : string

Get the default file extention associated to an image mimetype

imageMimeTypeConstant2ContentType()  : string

Get the default file extention associated to an image mimetype

_inlineHtmlAttribute()  : string

Build a string for insertion of an HTML tag attribute.

formHeader()  : string

print form header with hidden action field

formHeaderVisibleAction()  : string

print form header with visible action field -- typically used for tinyMCE popups

formHeaderName()  : string

print form header with hidden action field and name and id fields

formEnd()  : string

end a form

formMultiHeader()  : string

print form header with hidden action field for multi-part upload forms

formSubmit()  : string

print form footer with submit field

closePopup()  : string

print form footer with close popup button

formSubmitButton()  : string

print form footer with submit button field

formReset()  : string

print form reset button

hidden()  : string

print hidden form input

hiddenNoJSNoId()  : string

print hidden form input without JavaScript action

radioButton()  : string

print radio button

radioButtonGroup()  : string

Print a radio button group.

checkbox()  : string

print checkbox

selectYesNoBox()  : string

create special select box that only provides yes (1) and no (0) as options (values)

selectFBox()  : string

create select boxes for HTML forms

selectedBox()  : string

create select boxes for HTML forms

selectFBoxValue()  : string

create select boxes for HTML forms

selectedBoxValue()  : string

create select boxes for HTML forms

selectFBoxValueMultiple()  : string

create select boxes for HTML forms

selectedBoxValueMultiple()  : string

create select boxes for HTML forms

passwordInput()  : string

password input type

honeypotInput()  : string

A honeypot field made with text input

textInput()  : string

text input type

colorInput()  : string

color input type

textareaInput()  : string

textarea input type

textareaInputmceNoEditor()  : string

textarea input type without MCE editor

textareaReadonly()  : string

textarea readonly

fileUpload()  : string

upload box

fileUploadMultiple()  : string

upload box for multiple files

dateInput()  : string

date input type

label()  : string

Label Form element

getFormAttribute()  : string

Get the form attribute string

formHeaderName()  : string

print form header with hidden action field and name and id fields

hidden()  : string

print hidden form input

hiddenNoJSNoId()  : string

print hidden form input without JavaScript action

textInput()  : string

text input type

checkbox()  : string

print checkbox

radioButton()  : string

print radio button

selectFBoxValue()  : string

create select boxes for HTML forms

selectedBoxValue()  : string

create select boxes for HTML forms

selectFBoxValueMultiple()  : string

create select boxes for HTML forms

selectedBoxValueMultiple()  : string

create select boxes for HTML forms

selectYesNoBox()  : string

create special select box that only provides yes (1) and no (0) as options (values)

filterHTML()  : string

Filter HTML in fields destined for the search_ tables

filterHTMLLinks()  : string

Filter HTML links for LISTCOMMON output

escape()  : mixed

Escape strings inserted in HTML

escapeHTMLTemp()  : mixed

Temporarily escape HTML entities

_inlineHtmlAttribute()  : string

Build a string for insertion of an HTML tag attribute.

h()  : string

<Hx> heading element

div()  : string

<DIV> element

divScrollable()  : string

Scrollable <DIV> element

iframe()  : string

<IFRAME> element

p()  : string

<P> element

pBrowse()  : string

<P> element

pre()  : string

<PRE> element

ul()  : string

<UL> element

ol()  : string

<OL> element

li()  : string

<LI> element

hr()  : string

<HR> element

mark()  : string

<mark> element

object()  : string

<OBJECT> element For display attachment previews

span()  : string

<SPAN> element

color()  : string

<SPAN color> element

strong()  : string

<STRONG> element (Semantic equivalent of <B>)

em()  : string

<EM> element (Semantic equivalent of <I>)

u()  : string

<U> element

img()  : string

<IMG> element

anchor()  : string

<A> element used as internal anchor

a()  : string

<A> element used as hyperlink

aBrowse()  : string

<A> element used as hyperlink

tableStart()  : string

Start a <TABLE> tag

tableEnd()  : string

Close a <TABLE> tag

tableCaption()  : string

provide a table <caption>

tbodyStart()  : string

Provide a <tbody> tag

tbodyEnd()  : string

Provide a </tbody> tag

theadStart()  : string

Provde a <thead> tag

theadEnd()  : string

Provide a </thead> tag

tfootStart()  : string

Provide a <tfoot> tag

tfootEnd()  : string

Provide a </tfoot> tag

trStart()  : string

Provide a <tr> tag

trEnd()  : string

Provide a </tr> tag

tdStart()  : string

Provide a <td> tag without closing it or encapsulating data

tdEnd()  : string

Provide a </td> tag

td()  : string

Provide a <td>...</td> tag

thStart()  : string

Provide a <th> tag without closing it or encapsulating data

thEnd()  : string

Provide a </th> tag

th()  : string

Provide a <th>...</th> tag

cssInlineExternal()  : string

Insert a call to an external CSS file

jsInline()  : string

Inlining JavaScript code

jsInlineExternal()  : string

Insert a call to an external javascript file

successToast()  : string

Format a text as a HTML success toast message (temporary info)

errorToast()  : string

Format a text as a HTML error toast message (temporary info)

nlToHtml()  : string

replace newlines and carriage returns with appropriate HTML code.

htmlToNl()  : mixed

replace HTML newlines and carriage returns in a string or array with appropriate ANSI code.

removeNl()  : string

remove all newlines and replace with single space.

removeNlNoSpace()  : string

remove all newlines with no replacement.

stripHtml()  : mixed

Strip HTML from string or array

clearSortField()  : string

Strip HTML from string

get_core_message()  : string

Translate a message from a domain

get_message()  : string

Translate a message from a domain

translate_message()  : string

Translate a message from a domain

codeISO639a1toName()  : string

Return the name of a language defined by its locale code or its ISO 639-1 (alpha-2) code.

set_locales()  : void

Set the default locale of Intl library with the user's preferred locale

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

Load the translation catalogs of the user's preferred language.

determine_locale()  : string

Determine the user's preferred language.

determine_locale_priority_stack()  : array<string|int, string>

Determine the user's preferred language.

getAllLocales()  : array<string|int, string>

Return a selected list of all locales recognised by Intl and usable for translation and formatting

localetoBCP47()  : string

Return the BCP 47 code that matches the code of a locale.

getTranslatableLocales()  : array<string|int, string>

Get a list of translatable locales sorted by locale name

searchLanguageCode()  : string

Return the language code matching a language name

sort()  : bool

Sort an array according to the current Intl locale in ascending order

asort()  : bool

Sort an array according to the current Intl locale in ascending order and maintain index association

ksort()  : bool

Sort an array according to the current Intl locale in ascending order and maintain index association

rsort()  : bool

Sort an array according to the current Intl locale in descending order

arsort()  : bool

Sort an array according to the current Intl locale in descending order and maintain index association

krsort()  : bool

Sort an array according to the current Intl locale in descending order and maintain index association

messageTranslatorNeeded()  : string

Return a message if the project need translation contribution for the current locale

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

Get the paging start and total

getNum()  : string

Get information on the number or characters being used for alphabetical and dictionary paging

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

Get links for alphabetical and dictionary paging

getZoomSlices()  : void

Get zooming paging slices

calculateZoomSlices()  : mixed

Calculate the zoom slices

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

Get the zoom links

zoomToTop()  : string

Set zoom top link link

zoomUpOneLevel()  : string

Set zoom up one level link

storeZoomData()  : void

Store the zoom session

getRootLink()  : mixed

Get the root link for the paging link

linksInfo()  : string

Format display information string

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

Check for user bibliographies

getBib()  : mixed

Get details about the bibliography being used

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

get data from database

grabCollection()  : void

Grab collection title

grabPublisher()  : void

Grab publisher

grabNames()  : void

grabNames

webFormat()  : string

web_article, URL and accessed date

year2Format()  : string

format YYYY/MM/DD of conference dates etc

year1Format()  : string

format YYYY/MM/DD of publication

timeFormat()  : string

format running time for films

grabNoteAbstract()  : void

grabNoteAbstract

grabKeywords()  : void

grabKeywords

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

Tidy up the output for plain text

header()  : string

Set some defaults and create the RTF opening tag

footer()  : string

Create the RTF closing tag

footnotes()  : mixed

Set RTF headers regarding footnotes/endnotes

citation()  : mixed

Citation stuff The options for $citeStyle are: 'inText' In-text citations (needs bibliography appended) 'ftInc' Footnotes: the footnotes order increments from 1 (needs bibliography appended) 'endInc' Endnotes: the endnotes order increments from 1 'endSameId' Endnotes using the same ID for the same resource: the endnotes order increments from 1 'endSameIdOrdered' Endnotes using the same ID for the same resource: the endnotes order is set in the bibliography settings

documentSettings()  : mixed

Deal with document defaults. This function has various roles depending on the value of $method Must be called before traverseDOM()

cleanHtml()  : string

Clean up HTML before parsing and do some initial conversion

specialCharsToRTF()  : string

Convert special characters.

cleanBlockquotes()  : string

TinyMCE always puts p tags within blockquote—remove them!

fonts()  : mixed

Deal with fonts. This function has various roles depending on the value of $method

colours()  : mixed

Deal with colours. This function has various roles depending on the value of $method

lists()  : mixed

Deal with lists. This function has various roles depending on the value of $method

listToRTF()  : string

Convert lists to RTF (deals with nested lists too and recognizes unordered or ordered)

newListTableItem()  : string

Create new listtable item

textDecoration()  : mixed

text-decoration styling

fontWeight()  : string

Convert font-weight

fontSize()  : string

Convert font size to RTF

traverseDOM()  : string

Traverse the DOM and produce RTF code

nodeAttributes()  : mixed

Convert attributes

tables()  : mixed

Deal with tables and their elements. This function has various roles depending on the value of $method

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

Set cell edge defaults in the table matrix.

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

Convert table cell to RTF cell property string

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

Transfer the parent's border properties to a spanned child

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

Get cell border parameters

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

Update cell edge in the table matrix for one cell. i.e. border has been set for this table cell

cellBordersToString()  : string

Create a string of cell border properties from an array

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

We need to set up a table matrix counting number of rows and number of their children so we can deal with various properties.

getCellWidth()  : string

Get cell width

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

Start the process of converting a td or th element

utf8_2_rtfansicpg1252()  : string

UTF-8 to ANSI Windows 1252 strings for RTF only

domImageToRtfImagePlaceholders()  : string

Replace HTML image src attribute by a placeholder pointing to a cached file on disk

domNodeAttributes2Array()  : array<string|int, string>

Convert attributes of a DOMNode to an array of attributes

arrayMonthAndSeasonNames()  : array<string|int, string>

Return an array of months and season names

monthAndSeasonName()  : string

Return a month or season name

cardinalToOrdinal()  : string

Make an ordinal from a cardinal. Default is English

cardinalToOrdinalWord()  : string

Convert ordinal to word

cardinalToOrdinalWordLatin()  : string

Convert ordinal to word in Latin

cardinalToGreek()  : string

convert cardinal (Arabic) to Greek numerals

cardinalToRoman()  : string

convert cardinal (Arabic) to Roman numerals

getUuid()  : string

Get UUID from database

store()  : bool

Store/merge data.

exists()  : bool

Check a row exists

fetch()  : array<string|int, mixed>|false

Fetch data array

fetchOne()  : mixed

Fetch one array element

delete()  : void

Delete row

deleteKeys()  : bool

Delete keys from the row data array

build_query()  : string

Generate URL-encoded query string according to RFC 3986

escape()  : string

Escape a component of a URL according to RFC 3986

reduceUrl()  : string

Reduce the size of long URL to keep web browser display tidy

getCurrentProtocol()  : string

Return the protocol requested by the HTTP client

getVhost()  : string

Return the vHost name (Virtual Hostname)

URL_exists()  : bool

Check that an internet resource exists

html_numeric_entity_decode()  : string

Convert numeric HTML entities to their corresponding characters

mb_ucfirst()  : string

A unicode aware replacement for ucfirst()

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

Simulate explode() for multibytes strings (as documented for PHP 7.0)

mb_strrev()  : string

Simulate strrev() for multibytes strings

mb_substr_replace()  : string

Simulate substr_replace() for multibytes strings

mb_trim()  : string

Multi-byte safely strip white-spaces (or other characters) from the beginning and end of a string.

mb_ltrim()  : string

Multi-byte safely strip white-spaces (or other characters) from the beginning of a string.

mb_rtrim()  : string

Multi-byte safely strip white-spaces (or other characters) from the end of a string.

listCoreMandatoryPHPExtensions()  : array<string|int, string>

Return an array of mandatory PHP extensions used by the WIKINDX core

listCoreOptionalPHPExtensions()  : array<string|int, string>

Return an array of optional PHP extensions used by the WIKINDX core

OSName()  : string

Return the normalized name of the current os

matchPrefix()  : bool

Check if a prefix match against a string

matchSuffix()  : bool

Check if a suffix match against a string

curl_download_file_http()  : bool

Download a file from an url with HTTP

uuid()  : string

Return a (pseudo) unique string of variable length using random_bytes().

createDataFolders()  : void

Create default data folders used by the application

checkFileSystemPerms()  : mixed

Check the permissions of various folders and files which must be writable

arrayCombinations()  : void

Generate an array of all possible combinations of array values From https://stackoverflow.com/questions/10834393/php-how-to-get-all-possible-combinations-of-1d-array with minor adaptation ($space)

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

Take input from HTML FORM <input type=date> and split into separate fields.

balanceBraces()  : string

Balance braces after removing noSort in resource input/edit of title or for bibTeX input

sumBraces()  : int

Balance braces after removing noSort or for bibTeX input — return result of sum of open - close braces

noSortPattern()  : string

Create a preg pattern for checking presence of a WIKINDX_NO_SORT value at the beginning of a string.

writeUserPassword()  : void

Write a hashed version of a user password in users table

verifyUserPassword()  : bool

Verify that a password matches a password hash of a user

array_value_select()  : mixed

Return the corresponding value of an array key or a default value

createHelpTopicLink()  : string

Create a popup link for a Help Topic on the website

canIResumeExecution()  : bool

Can I resume execution?

command_exists()  : bool

Does an unix command exist?

insertExportImages()  : void

Insert cached images inside exported files, and delete them

reduceLongText()  : string

Reduce the size of long text (in select boxes usually) to keep web browser display tidy.

computeBibtexKeyAuthorYear()  : string

Generate a BibTeX citation key for one resource with format 'AuthorYear'

computeBibtexKeyAuthorID()  : string

Generate a BibTeX citation key for one resource with format 'Author.ResourceId'

clearXmlString()  : string

Clear forbidden characters from an XML string

clearDOI()  : string

Clear a DOI number

validateDOI()  : bool

Validate a DOI number

escape()  : string

Escape strings inserted in XML

handleParams()  : mixed

Handle the params array and act as a gateway to other functions

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

Initialise params for each type of list.

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

Initialise common list parameters

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

Initialise qsearch parameters

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

Initialise cite parameters

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

Initialise basket parameters

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

Initialise browse parameters We only need BibId and that's done in commonInit(9.

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

Initialise list parameters

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

Initialise zoom parameters

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

Initialise listSome parameters

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

Initialise ideas parameters

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

Initialise advsearch parameters

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

Filter parameters

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

Set a parameter. Multiple parameters can be set.

finalize()  : mixed

After completion of listing, save parameters

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

Make the transfer arrows to transfer fields between select boxes with onclick

makeSelectBox()  : string

Make div selected box

makeRadioButtons1()  : string

Create radio buttons for AND and OR and NOT

makeRadioButtons2()  : string

Create radio buttons for AND and OR

wordDiv()  : string

Word search div

categoryDiv()  : string

Category div

subcategoryDiv()  : string

Subcategory div

addedByDiv()  : string

AddedBy div

editedByDiv()  : string

EditedBy div

valueDiv()  : string

Value div for publicationYear, access, maturityIndex

typeDiv()  : string

Resource type div

creatorDiv()  : string

Creator div

keywordDiv()  : string

Keyword div

metaKeywordDiv()  : string

Metadata Keyword div

languageDiv()  : string

Language div

publisherDiv()  : string

Publisher div

collectionDiv()  : string

Collection div

userTagDiv()  : string

UserTag div

tagDiv()  : string

Import Tag div

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

get languages from database

userBibs()  : string

Return select box of user bibliographies for this user. Called from LISTCOMMON when displaying results.

makeRadioButtonsFilter()  : string

Create radio buttons for AND and OR and NOT—specifically for the filter buttons

displayOptions()  : string

Display attachment options. Called from LISTCOMMON when displaying results.

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

Load configuration from config.php

needUpdate()  : bool

Check if the current WIKINDX data (db and files) need an upgrade

existsTableVersion()  : bool

Check if 'version' table that stores the version number of the db schema exists

getCoreInternalVersion()  : float

Return the internal version stored in the database of the core

setCoreInternalVersion()  : mixed

Write an internal version in the database of a component or the core

getComponentInternalVersion()  : float

Return the internal version of a component stored in the database

setComponentInternalVersion()  : mixed

Write an internal version of a component in the database

deleteComponentInternalVersion()  : mixed

Delete an internal version of a component from the database

existsSuperadminAccount()  : bool

Check if 'users' table has not been filled with the superadmin account

getConfigContactEmail()  : float

Return the configContactEmail depending on the software version

logonCheckUpgradeDB()  : bool

Initial logon to the system when upgrading the database.

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