Functions

jtpl_function_text_jfullurl

function plugin : write the full url (with domain name) corresponding to the given jelix action.

« More »

jtpl_block_html_form

a block to display an html form, with data from a jforms.

usage : {form $theformobject,'submit_action', $submit_action_params} here form content {/form} You can add this others parameters :<ul> <li>string $builderName (default is 'html')</li> <li>array $options for the builder. Example, for the 'html' builder : <ul> <li>"errorDecorator"=>"name of your javascript object for error listener"</li> <li>"method" => "post" or "get". default is "post"</li> </ul> </li> </ul>
« More »

jtpl_meta_html_htmlmodule

meta plugin : allow to add css files and js files stored into modules, in an html response object.

« More »

jtpl_modifier_common_jdatetime

modifier plugin : change the format of a date.

It uses jDateTime to convert a date. It takes two optionnal arguments. The first one is the format identifier of the given date (by default, it is db_datetime). The second one is the format identifier of the output date (by default, it is lang_date). Availabled format identifiers are (with the equivalent constant of jDateTime) : <ul> <li>'lang_date' (jDateTime::LANG_DFORMAT)</li> <li>'lang_datetime' => jDateTime::LANG_DTFORMAT)</li> <li>'lang_time' => jDateTime::LANG_TFORMAT)</li> <li>'db_date' => jDateTime::DB_DFORMAT)</li> <li>'db_datetime' => jDateTime::DB_DTFORMAT)</li> <li>'db_time' => jDateTime::DB_TFORMAT)</li> <li>'iso8601' => jDateTime::ISO8601_FORMAT)</li> <li>'timestamp' => jDateTime::TIMESTAMP_FORMAT)</li> <li>'rfc822'=> jDateTime::RFC822_FORMAT)</li> <li>'full_lang_date'=> jDateTime::FULL_LANG_DATE</li></ul> examples : {$mydate|jdatetime} {$mydate|jdatetime:'db_time':'lang_time'}
« More »

jtpl_function_html_breadcrumb

breadcrumb plugin : display breadcrumb trails, ie. user navigation tracking.

« More »

jtpl_meta_xml_xml

meta plugin : modify an xml response object.

« More »

jtpl_function_html_jrooturl

function plugin : write the root url corresponding to the given ressource type If this ressource type is not specified in the config file, returned value will be basePath.

« More »

jtpl_function_html_formreset

function plugin : print the html content of a form reset button.

« More »

jtpl_modifier_html_vardump

Dump any value.

« More »

jtpl_function_text_formdatafull

Display all data of a form without the use of other plugins.

« More »

jtpl_block_html_formcontrols

a block to loop over controls list of a form and to display them.

usage : {formcontrols} here content to display one control {/formcontrols} It accept also some parameters 1) an optional jFormsBase object if the {formcontrols} is outside a {form} block 2) an optional array of control names : only these controls will be displayed
« More »

jtpl_meta_html_html

meta plugin : modify an html response object.

« More »

jtpl_function_html_formdatafull

Display all data of a form without the use of other plugins.

« More »

jtpl_cfunction_common_fetchtpl

fetch the content of a template without template variables of calling template, except private variables setted by some plugins.

It allows to use a template as a recursive way, in a cleaner way than include, because it doesn't inherits of variables from the parent template Meta content must not use template variable given to 'fetch', as they will not be available at the time of meta processing (except if they are a copy of template variable of the parent template) <pre>{fetchtpl 'myModule~foo', array('varname'=>'value) }</pre>
« More »

jtpl_function_html_jlocale

function plugin : write the localized string corresponding to the given locale key.

example : {jlocale 'myModule~my.locale.key'}
« More »

jtpl_cfunction_common_zone

cfunction plugin : include the content of a zone.

<pre> {zone 'myModule~myzone'} {zone 'myModule~myzone',array('foo'=>'bar)}</pre>
« More »

jtpl_function_xml_jlocale

function plugin : write the localized string corresponding to the given locale key.

example : {jlocale 'myModule~my.locale.key'}
« More »

jtpl_function_text_jurl

function plugin : write the url corresponding to the given jelix action.

« More »

jtpl_block_common_ifuserconnected

a special if block to test easily if the current user is connected.

<pre>{ifuserconnected} ..here generated content if the user is connected {/ifuserconnected}</pre>
« More »

jtpl_cfunction_html_swfbiscuit

swfbiscuit plugin : Adds html code to display a swf.

Example : {swfbiscuit 'promobidon.swf', array('id'=>'promo', 'width'=>150, 'height'=>90), array('quality'=>'hight', 'wmode'=>'transparent'), array('longeur'=>150)} Render : <object classid="clsid:D27CDB6E-AE6D-11cf-96B8-444553540000" codebase="http://download.macromedia.com/pub/shockwave/cabs/flash/swflash.cab#version=6,0,29,0" width="150" height="90"> <param name="movie" value="/data/fichiers/promobidon.swf?longeur=150" /> <param name="quality" value="hight" /> <param name="wmode" value="transparent" /> <embed src="/data/fichiers/promobidon.swf?longeur=150" quality="high" wmode="transparent" pluginspage="http://www.macromedia.com/go/getflashplayer" type="application/x-shockwave-flash" width="150" height="90"/> </object> $params[0] url of the swf $params[1]['id'] id of <object .../> $params[1]['class'] class of <object .../> $params[1]['width'] Width final of SWF $params[1]['height'] Height final of SWF $params[2][xx] Parameter of the Flash Player $params[3][xx] Flashvar for the Flash Player
« More »

jtpl_function_html_ctrl_label

function plugin : print the label of a form control. You should use this plugin inside a formcontrols block.

« More »

jtpl_function_ltx2pdf_jurl

function plugin : write the url corresponding to the given jelix action.

« More »

jtpl_function_html_formurlparam

function plugin : write the url corresponding to the given jelix action.

« More »

jtpl_function_html_formsubmit

function plugin : print the html content of a form submit button. You can use this plugin inside a formsubmits block.

« More »

sha1WithSalt

function to use to crypt password. use the password_salt value in the config file of the plugin.

« More »

bcrypt

hash password with blowfish algorithm. use the password_salt value in the config file of the plugin.

« More »

jtpl_function_html_ctrl_rawvalue

function plugin : print the raw value of a form control, without trying to display a corresponding label and without to display values of child controls. You should use this plugin inside a formcontrols block.

« More »

jtpl_function_html_urljsstring

function plugin : write the url corresponding to the given jelix action for javascript.

it creates a javascript string, that contains the url, with dynamic javasript parameters<br/> example : {urljsstring 'jxacl~admin_rightslist',array(),array('grpid'=>'idgroup','__rnd'=>'Math.random()')};<br/> it will produce: "index.php?module=acl&action=admin_rightslist&grpid="+idgroup+"&__rnd="+ Math.random();
« More »

jtpl_cfunction_html_formfull

Display a full form without the use of other plugins.

usage : {formfull $theformobject,'submit_action', $submit_action_params}. You can add this others parameters :<ul> <li>string $builderName (default is 'html')</li> <li>array $options for the builder. Example, for the 'html' builder : <ul> <li>"errorDecorator"=>"name of your javascript object for error listener"</li> <li>"method" => "post" or "get". default is "post"</li> </ul> </li> </ul>
« More »

jtpl_function_html_jfullurl

function plugin : write the full url (with domain name) corresponding to the given jelix action.

« More »

jtpl_function_html_image

image plugin : write the url corresponding to the image.

Add a link to the image, The image is resized, and cached class :string id :string alt :string width :uint height :uint maxwidth :uint only with maxheight maxheight :uint only with maxwidth zoom 1-100 omo :boolean alignh [left|center|right|:int] alignv [top|center|bottom|:int] ext [png|jpg|gif] quality 0-100 if ext = jpg shadow :boolean soffset :uint sangle :uint sblur :uint sopacity :uint scolor #000000 :string background #000000 :string gif -> image/gif jpeg -> image/jpeg jpg -> image/jpeg jpe -> image/jpeg xpm -> image/x-xpixmap xbm -> image/x-xbitmap wbmp -> image/vnd.wap.wbmp png -> image/png other -> image/png
« More »

jtpl_function_xml_jurl

function plugin : write the url corresponding to the given jelix action.

« More »

jtpl_block_common_ifusernotconnected

a special if block to test easily if the current user is not connected.

<pre>{ifusernotconnected} ..here generated content if the user is NOTconnected {/ifusernotconnected}</pre>
« More »

jtpl_cfunction_common_fetchzone

cfunction to fetch the content of a zone into a tpl var.

<pre> {fetchzone 'myVar', 'myModule~myzone', array('foo'=>'bar)} {if $myVar !== ''} <div id="container"> {$myVar} </div> {/if}</pre>
« More »

jtpl_modifier_html_vardump

Dump any value.

« More »

jtpl_block_html_swfjs

swfjs plugin : Adds html and JS code to display a swf.

Example : {swfjs 'promobidon.swf', array('id'=>'promo', 'width'=>150, 'height'=>90, 'detect'=>true), array('quality'=>'hight', 'wmode'=>'transparent'), array('longeur'=>150)} {image 'toupie.png'} {/swfjs} Render after the execution of javascript file : <div id="promo"> <embed width="150" height="90" wmode="transparent" quality="hight" type="application/x-shockwave-flash" src="/data/fichiers/promobidon.swf" pluginspage="http://www.adobe.com/go/getflashplayer" flashvars="longeur=150"/> </div> $params[0] url of the swf $params[1]['id'] id of <object .../> $params[1]['class'] class of <object .../> $params[1]['width'] Width final of SWF $params[1]['height'] Height final of SWF $params[1]['version'] (ex: '6.0.65') Detect specific major, minor and revision versions of the Flash plugin. $params[1]['expressinstall'] (true:Bool) Use Express Install, or show an update message if Flash isn't installed. OR $params[1]['update'] (false:Bool) Or, degrade silently and gracefully. $params[2][xx] Parameter of the Flash Player $params[3][xx] Flashvar for the Flash Player
« More »

jtpl_function_html_ctrl_value

function plugin : print the value of a form control. You should use this plugin inside a formcontrols block.

« More »

jtpl_function_html_jmessage

function plugin : Display messages from jMessage.

« More »

jtpl_block_html_ifctrl

a special if block to test easily the current control name TO BE USED inside a {formcontrols} block.

{ifctrl 'name1','name2',...} some tpl {else} some other tpl {/ifctrl}
« More »

jtpl_function_common_tolog

Dump a value into log files.

« More »

jtpl_function_common_dumptolog

Dump a value into log files.

« More »

jelix_read_ini

« More »

jelix_scan_module_sel

« More »

jelix_scan_action_sel

« More »

jelix_scan_class_sel

« More »

jelix_scan_locale_sel

« More »

jtpl_function_html_jurlpattern

function plugin: write the url corresponding to the given jelix action, inserting placeholder name (between two %) for some parameter, so you can generate the url dynamically in JS by replacing placeholders by javascript values.

example : <pre> <div id="baz" data-url="{jurlpattern 'jxacl~admin_rightslist', array('foo'=>'bar'), array('grpid'=>'idgroup', 'acl'=>'acl') }"> </pre> it may produce something like that (depending how the url is configured for the 'jxacl~admin_rightslist' action): <code>index.php/acl/rightslist/%idgroup%/bar?acl=%acl%</code> Then you can replace placeholders <code> var urlpattern = document.getElementById("baz").dataset.url; var id_group = 45, acl = 'hello'; var url = urlpattern.replace("%idgroup%", id_group); url = url.replace("%acl%", acl); </code>
« More »

jtpl_block_html_formdata

a block to display only data of a form.

usage : {formdata $theformobject} here the form content {/formdata}
« More »

jtpl_function_html_jurl

function plugin : write the url corresponding to the given jelix action.

« More »

jtpl_block_html_ifctrlexists

a special if block to check if a ctrl exist in the form TO BE USED inside a `{form}` or `{formadata}` block.

{ifctrlexists 'name1'} some tpl {else} some other tpl {/ifctrlexists}
« More »

jtpl_function_html_hook

hook plugin.

It allows to retrieve HTML content, coming from responses of an event, and inserting at the place of the hook tag. Example: <code> <div id="hook-content"> {hook 'myevent'} </div> </code> In a Jelix Event listener: <code> function onmyevent($event) { $event->add('<div>html content</div>'); } </code> Result: <code> <div id="hook-content"> <div>html content</div> </div> </code>
« More »

jelix_autoload

function used by php to try to load an unknown class.

« More »

checkAppOpened

check if the application is opened. If not, it displays the yourapp/install/closed.html file with a http error (or lib/jelix/installer/closed.html), and exit.

This function should be called in all entry point, before the creation of the coordinator.
« More »

checkAppNotInstalled

check if the application is not installed. If the app is installed, an error message appears and the scripts ends.

It should be called only by some scripts like an installation wizard, not by an entry point.
« More »

isAppInstalled

« More »

jtpl_modifier_common_datetime

modifier plugin : change the format of a date.

The date can be given as a string, or as a DateTime object. It uses DateTime to convert a date. It takes two optionnal arguments. The first one is the format of the output date. It should be a format understood by DateTime, or one of this format identifier: 'lang_date', 'lang_datetime', 'lang_time', 'lang_long_datetime'. By default, it use the locale datetime format. The second one is the format of the given date, if the date format is not understood by DateTime. examples : {$mydate|datetime} {$mydate|datetime:'dd/mm/YY'}
« More »

jtpl_function_html_formurl

function plugin : write the url corresponding to the given jelix action.

« More »

jtpl_block_html_ifctrl_value

a special if block to test easily the current control value TO BE USED inside a {formcontrols} block.

{ifctrl_value 'name', 'expected-value'} some tpl {else} some other tpl {/ifctrl_value}
« More »

jtpl_block_html_formsubmits

a block to loop over submit button list of a form and to display them.

usage : {formsubmits} here content to display one submit {/formsubmits} It accept also some parameters 1) an optional jFormsBase object if the {formsubmits} is outside a {form} block 2) an optional array of submit control names : only these controls will be displayed
« More »

jtpl_function_ltx2pdf_jlocale

function plugin : write the localized string corresponding to the given locale key.

example : {jlocale 'myModule~my.locale.key'}
« More »

jtpl_function_text_jlocale

function plugin : write the localized string corresponding to the given locale key.

example : {jlocale 'myModule~my.locale.key'}
« More »

jtpl_function_html_ctrl_control

function plugin : print the html content of a form control. You should use this plugin inside a formcontrols block.

« More »

jtpl_function_html_resurl

function plugin : write the url corresponding to a resource stored in a www directory of a module.

« More »

jtpl_function_xml_jfullurl

function plugin : write the full url (with domain name) corresponding to the given jelix action.

« More »

is_resource

Check if the given value is a resource or not.

It take care about internal classes that replaced resources into PHP 8.0, like GdImage, CurlHandle etc..
« More »

Constants

JELIX_VERSION

Version number of Jelix.

« More »

JELIX_NAMESPACE_BASE

« More »

JELIX_LIB_PATH

« More »

JELIX_LIB_CORE_PATH

« More »

JELIX_LIB_UTILS_PATH

« More »

LIB_PATH

« More »

BYTECODE_CACHE_EXISTS

« More »

Classes, interfaces and traits

jInstallerReporterTrait

« More »

CaptchaValidatorInterface

Interface for validators for the captcha widget.

« More »

ConfigCompilerPluginInterface

interface for plugins of jConfigCompiler.

« More »

jIDebugbarPlugin

interface for plugins for the debugbar.

« More »

jIHTMLResponsePlugin

interface for plugins for jResponseBasicHtml or jResponseHtml, which allows to make changes in the response at several step.

« More »

jIKVPersistent

interface for KV driver which store values in a persistent manner (in a file.

..).
« More »

jIKVSet

« More »

jIKVttl

interface for KV driver which support 'time to live' on values useful to use the driver as a cache storage.

« More »

jILogger

interface for loggers.

« More »

jILogMessage

interface for log message. A component which want to log a message can use an object implementing this interface.

Classes that implements it are responsible to format the message. Formatting a message depends on its type.
« More »

jIUrlSignificantHandler

« More »

ParentWidgetInterface

Interface for widgets that can have children widget: main builder, choice etc.

« More »

WidgetInterface

Interface for HTML widgets plugins.

« More »

Console

simple text reporter.

« More »

dbKVDriver

Driver for jKVDB, that uses an SQL table to store key/value data.

« More »

debugbarHTMLResponsePlugin

plugin for jResponseHTML, it displays a debugbar.

« More »

debugbarItemInfo

information for a component a debug bar.

« More »

defaultlogDebugbarPlugin

plugin to show general message logs.

« More »

errorsDebugbarPlugin

native plugin for the debugbar, which displays list of errors, warnings.

..
« More »

file2KVDriver

« More »

fileServer

« More »

ghostInstallReporter

a reporter which reports.

.. nothing.
« More »

HtmlBuilder

Main HTML form builder.

a builder form class is a class which help to generate a form for the output (html form for example)
« More »

jAuthDriverBase

base class for some jAuth drivers.

« More »

jBasicErrorHandler

Error handlers for the framework.

Replace the default PHP error handler.
« More »

jDaoDbMapper

It allows to create tables corresponding to a dao file.

« More »

jDbColumn

« More »

jDbConstraint

« More »

jDbIndex

Represents an index on some columns.

« More »

jDbParameters

allow to normalize & analyse database parameters.

supported parameters in a profile: - driver: the jdb driver name, or "pdo" to use dbo ("pdo" value is deprecated, use usepdo instead) - database: the name of the database (for sqlite: path to the sqlite file) - host: the host of the database - port: the port of the database - user & password: credentials to connect to the database - force_encoding: force the encoding at the connection, using the default encoding of the application - dsn: dsn (pdo, odbc... optional) - usepdo: true if pdo should be used - pdodriver: name of the pdodriver to use. Guessed from dsn - pdoext: name of the pdo extension to use. Guessed from dsn - dbtype: type of the database (so it determines the SQL language) - phpext: name of the php extension to use - persistent: if true, the connection should be persistent - extensions: some informations about extensions to load (For sqlite for example. optional) - single_transaction: indicate to execute all queries into a single transaction (pgsql, optional) - busytimeout: timeout for the connection (sqlite, optional) - timeout: timeout for the connection (pgsql, optional) - search_path: schema for pgsql (optional) - table_prefix: prefix to add to database table. Used by jDao (optional)
« More »

jDbPrimaryKey

used to declare a primary key.

« More »

jDbReference

used to declare a foreign key.

« More »

jDbSchema

« More »

jDbUniqueKey

represents a unique key.

« More »

Jelix17

« More »

jFileLogger

logger storing message into a file.

« More »

jFormsSession

This class acts as a cache proxy during a request processing, for jForms containers. It allows to get and store jForms containers data into an external storage using jCache.

jFormsSession instances can be stored temporarly in session, in order to have the opportunity, at the end of the request processing, so when the session is saved, to store automatically jForms containers data that have been readed, created or modified. A profile for jCache, named 'jforms', may be declared in profiles.ini.php, so you can choose where jforms data are stored. A virtual profile is used if no one is defined, and use files for the cache.
« More »

jInstaller

main class for the installation.

It loads all entry points configurations and all informations about activated modules. jInstaller then constructs a tree dependencies for these activated modules, and launch their installation and the installation of their dependencies. An installation can be an initial installation, or just an upgrade if the module is already installed.
« More »

jInstallerEntryPoint

container for entry points properties.

Object for legacy installers
« More »

jKVDb

main class to access to key-value storage databases.

« More »

jKVDriver

« More »

jLogDumpMessage

class that handles a dump of a php value, for a logger.

« More »

jLogErrorMessage

this class is formatting an error message for a logger.

« More »

jLogMessage

class that handles a simple message for a logger.

« More »

jLogSoapMessage

class that handles a dump of a php value, for a logger.

« More »

jMailLogger

logger sending message by email.

« More »

jResponseHtml4

Response class for HTML 4 or XHTML 1.x.

« More »

jSoapObject

classes that are mapped to soap types could inherits from this object in order to have some helpers and a better mapping than the default soap mapper.

« More »

jSQLLogMessage

class that handles a sql query for a logger.

« More »

jStderrLogger

logger sending message to stderr.

« More »

jStdoutLogger

logger sending message to stdout.

« More »

jSyslogLogger

logger storing message into syslog.

« More »

legacysyslogLogger

logger storing message into syslog using old api.

« More »

mssqlDaoBuilder

driver for jDaoCompiler.

It is called by jDaoCompiler
« More »

mssqlDbConnection

« More »

mssqlDbResultSet

Layer encapsulation resultset mssql.

« More »

ReCaptchaValidator

« More »

RootWidget

« More »

sessiondataDebugbarPlugin

plugin to show content of a session.

« More »

SimpleCaptchaValidator

« More »

SoapClientDebug

« More »

soapfileLogger

logger storing soap message into several xml files.

« More »

soaplogDebugbarPlugin

plugin to show soap message.

« More »

sqllogDebugbarPlugin

plugin to show all sql queries into the debug bar.

« More »

sqlsrvDaoBuilder

driver for jDaoCompiler.

It is called by jDaoCompiler
« More »

sqlsrvDbConnection

« More »

sqlsrvDbResultSet

Layer encapsulation resultset mssql.

« More »

textInstallReporter

reporter echoing simply the messages.

« More »

upload2_htmlFormWidget

Widget to display the selection of a file to upload.

For images upload, some attributes can be set to indicate the url of the image. The url can be forged from a selector or from a base URI. From a selector : action, parameters, and the parameter name that will contain the filename, should be given in attributes uriAction, uriActionParameters, uriActionFileParameter From a base URI : a baseURI attribute should be given, with the URL on which the filename will be append.
« More »

WebAssetsCompiler

« More »

WebAssetsSelection

« More »

WebAssetsUpgrader

« More »

WidgetBase

« More »

Classes, interfaces and traits

jIFormsDatasource

Interface for objects which provides a source of data to fill some controls in a form, like menulist, listbox etc.

..
« More »

jIFormsDatasource2

Interface for objects which provides a source of data to fill some controls in a form, like menulist, listbox etc.

..
« More »

jIFormsDynamicDatasource

Interface for objects which provides a source of data to fill some controls in a form, like menulist, listbox etc.

..
« More »

BuilderBase

base class of all builder form classes generated by the jform compiler.

a builder form class is a class which help to generate a form for the output (html form for example)
« More »

jExceptionForms

exception for jforms.

It handles locale messages. Message property contains the locale key, and a new property contains the localized message.
« More »

jForms

static class to manage and call a form.

A form is identified by a selector, and each instance of a form have a unique id (formId). This id can be the id of a record for example. If it is not given, the id is set to 0.
« More »

jFormsBase

base class of all form classes generated by the jform compiler.

« More »

jFormsBuilderBase

base class of all builder form classes generated by the jform compiler.

a builder form class is a class which help to generate a form for the output (html form for example)
« More »

jFormsBuilderHtml

HTML form builder.

a builder form class is a class which help to generate a form for the output (html form for example)
« More »

jFormsCompiler

Generates form class from an xml file describing the form.

« More »

jFormsCompiler_jf_1_0

generates form class from an xml file describing the form.

« More »

jFormsCompiler_jf_1_1

generates form class from an xml file describing the form.

« More »

jFormsControl

base class for all jforms control.

« More »

jFormsControlButton

base class for all jforms control.

« More »

jFormsControlCaptcha

captcha control.

« More »

jFormsControlCheckbox

base class for all jforms control.

« More »

jFormsControlCheckboxes

Checkboxes control (contains several checkboxes).

« More »

jFormsControlChoice

choice control.

It has a list of choices, called choice items. Each item has a value and a list of child controls. The value of the choice control is the value of the selected item. $this->container->privateData contain the list of items that are deactivated. A deactivated item is not displayed.
« More »

jFormsControlColor

base class for all jforms control.

« More »

jFormsControlDatasource

base class for controls which uses a datasource to fill their contents.

« More »

jFormsControlDate

base class for all jforms control.

« More »

jFormsControlDatetime

base class for all jforms control.

« More »

jFormsControlGroup

group control.

Contains a list of controls. If it has a checkbox, child controls can be disabled by the user. The "value" of the group is then the status of the checkbox "on" or "". if the group is in readonly mode or is deactivated, every children are readonly or deactivated
« More »

jFormsControlGroups

abstract classes for controls which contain other controls.

« More »

jFormsControlHidden

base class for all jforms control.

« More »

jFormsControlHtmlEditor

base class for all jforms control.

« More »

jFormsControlImageUpload

base class for all jforms control.

« More »

jFormsControlInput

base class for all jforms control.

« More »

jFormsControlListbox

listbox.

« More »

jFormsControlMenulist

menulist/combobox.

« More »

jFormsControlOutput

base class for all jforms control.

« More »

jFormsControlRadiobuttons

control which contains several radio buttons.

« More »

jFormsControlRepeat

abstract classes for controls which contain other controls.

« More »

jFormsControlReset

base class for all jforms control.

« More »

jFormsControlSecret

base class for all jforms control.

« More »

jFormsControlSecretConfirm

base class for all jforms control.

« More »

jFormsControlSubmit

base class for controls which uses a datasource to fill their contents.

« More »

jFormsControlSwitch

switch.

It has a list of choices, called choice items. Each item has a value and a list of child controls. The value of the choice control is the value of the selected item. $this->container->privateData contain the list of items that are deactivated. A deactivated item is not displayed.
« More »

jFormsControlTextarea

base class for all jforms control.

« More »

jFormsControlTime

base class for all jforms control.

« More »

jFormsControlUpload

base class for all jforms control.

« More »

jFormsControlUpload2

base class for all jforms control.

« More »

jFormsControlWikiEditor

base class for all jforms control.

« More »

jFormsDaoDatasource

A datasource which is based on a dao.

« More »

jFormsDataContainer

this object is a container for form data.

« More »

jFormsDynamicDatasource

Base class for a datasource which is based on a class and can be used for dynamic listboxes or menulists.

« More »

jFormsStaticDatasource

A datasource which is based on static values.

« More »

Classes, interfaces and traits

button_htmlFormWidget

HTML form builder.

« More »

captcha_htmlFormWidget

HTML form builder.

« More »

checkbox_htmlFormWidget

HTML form builder.

« More »

checkboxes_htmlFormWidget

HTML form builder.

« More »

choice_htmlFormWidget

HTML form builder.

« More »

color_htmlFormWidget

HTML form builder.

« More »

date_htmlFormWidget

HTML form builder.

« More »

datetime_htmlFormWidget

HTML form builder.

« More »

group_htmlFormWidget

HTML form builder.

« More »

htmleditor_htmlFormWidget

HTML form builder.

« More »

htmlFormWidget

« More »

imageupload_htmlFormWidget

HTML form builder.

For images upload, some attributes can be set to indicate the url of the image. The url can be forged from a selector or from a base URI. From a selector : action, parameters, and the parameter name that will contain the filename, should be given in attributes uriAction, uriActionParameters, uriActionFileParameter From a base URI : a baseURI attribute should be given, with the URL on which the filename will be append.
« More »

input_htmlFormWidget

HTML form builder.

« More »

listbox_htmlFormWidget

HTML form builder.

« More »

output_htmlFormWidget

HTML form builder.

« More »

radiobuttons_htmlFormWidget

HTML form builder.

« More »

recaptcha_htmlFormWidget

jForms widget that shows reCaptcha.

in the configuration, sets: ``` [forms] captcha.recaptcha.validator = \jelix\forms\Captcha\ReCaptchaValidator captcha.recaptcha.widgettype = recaptcha [recaptcha] ;see https://developers.google.com/recaptcha/docs/display to know the meaning ; of these configuration parameters. theme=.. type=.. size=.. tabindex=.. ``` in the localconfig.ini.php, set the site key and the secret (see your google recpatcha account to retrieve them) ``` [recaptcha] sitekey= your recaptcha key secret= your secret value ``` then indicate to use recaptcha, in the <captcha> element or in the configuration ``` <captcha validator="recaptcha"/> ``` ``` [forms] captcha=recpatcha ```
« More »

reset_htmlFormWidget

HTML form builder.

« More »

secret_htmlFormWidget

HTML form builder.

« More »

secretconfirm_htmlFormWidget

HTML form builder.

« More »

submit_htmlFormWidget

HTML form builder.

« More »

textarea_htmlFormWidget

HTML form builder.

« More »

upload_htmlFormWidget

HTML form builder.

« More »

wikieditor_htmlFormWidget

HTML form builder.

« More »

Classes, interfaces and traits

jDb

factory for database connector and other db utilities.

« More »

jDbConnection

« More »

jDbFieldProperties

Description of a field of a table.

« More »

jDbPDOConnection

A connection object based on PDO.

« More »

jDbPDOConnectionDebug

A connection object based on PDO, for debugging.

« More »

jDbPDOResultSet

a resultset based on PDOStatement for PHP >= 8.0

« More »

jDbPDOResultSet7

a resultset based on PDOStatement, for PHP < 8.0

« More »

jDbResultSet

represent a statement result set or a prepared statement result set.

« More »

jDbTable

« More »

jDbTools

Provides utilities methods for a database.

« More »

jDbUtils

« More »

jDbWidget

« More »

Classes, interfaces and traits

dbCacheDriver

cache driver for data stored in a database Warning : Beware about the time returned by the DBMS of the server and the server PHP client : possible asynchronous time (particulary in case of use of multiple servers, incoherent data can be involved).

« More »

memcacheCacheDriver

cache driver for data stored in Memcached. Use the memcache extension of PHP.

This plugin should be used with version 3.0.1 or more of the memcache extension.
« More »

redis_extCacheDriver

« More »

Classes, interfaces and traits

jAppManager

utilities to manage a jelix application.

« More »

jBinaryData

« More »

jClassBinding

Services binding for jelix.

« More »

jClasses

This object is responsible to include and instancy some classes stored in the classes directory of modules.

« More »

jCmdUtils

utilities functions for command line.

« More »

jDateTime

Utility to manipulate dates and convert date format.

« More »

jDuration

Utility to manipulate durations between two instants.

« More »

jFile

A class helper to read or create files.

« More »

jFilter

utility class to check values.

« More »

jImageModifier

Utility class to manipulate image.

« More »

jIniFile

utility class to read and write an ini file.

« More »

jIniFileModifier

utility class to modify an ini file by preserving comments, whitespace.

. It follows same behaviors of parse_ini_file, except when there are quotes inside values. it doesn't support quotes inside values, because parse_ini_file is totally bugged, depending cases.
« More »

jIniMultiFilesModifier

utility class to read and modify two ini files at the same time : one master file, and one file which overrides values of the master file, like we have in jelix with mainconfig.ini.php and config.ini.php of an entry point.

« More »

jJsonRpc

object which encode and decode a jsonrpc request and response.

« More »

jMailer

jMailer based on PHPMailer - PHP email transport class.

« More »

jMessage

Utility class to log some message in session in order to be displayed in a template.

« More »

jMethodSniffer

Utility class to "sniff" method calls to a class instance so that those calls may be repeated later on. The sniffed method should not use any of the magic methods used here (namely __get, __set, __call and __toString).

« More »

jProfiles

class to read profiles from the profiles.ini.php.

« More »

jRedis

extends the class Redis from the phpredis extension.

« More »

jSmtp

SMTP is rfc 821 compliant and implements all the rfc 821 SMTP commands except TURN which will always return a not implemented error. SMTP also provides some utility methods for sending mail to an SMTP server.

This class is just a simple wrapper around SMTP.
« More »

jSoapClient

provide a soap client where configuration information are stored in the profile file.

« More »

jXmlRpc

object to encode decode some XMl-RPC request and XMl-RPC response.

« More »

jZipCreator

Class to create a zip file.

« More »

jZone

jZone is a representation of a zone in an response content, in a html page.

A user zone should inherits from jZone. jZone provide a cache mecanism.
« More »

Classes, interfaces and traits

jICoordPlugin

interface that should implement all coordinator plugins.

« More »

jIMultiFileCompiler

interface for compiler which needs many source files The PHP file generated by the compiler should check itself if it is still valid. The file should have a "return" statement with a boolean : true if it is ok, false if it should be recompiled.

« More »

jIRestController

interface for controllers used for RESTFull request/response.

« More »

jISimpleCompiler

interface for compiler which needs only one source file.

The PHP file generated by the compiler should check itself if it is still valid. The file should have a "return" statement with a boolean : true if it is ok, false if it should be recompiled.
« More »

jAutoloader

« More »

jBundle

a bundle contains all readed properties in a given language, and for all charsets.

« More »

jCmdlineCoordinator

The command line version of jCoordinator.

This allows us to handle exit code of commands properly
« More »

jConfig

static class which loads the configuration.

« More »

jConfigAutoloader

« More »

jConfigCompiler

jConfigCompiler merge two ini file in a single array and store it in a temporary file This is a static class.

« More »

jController

class base for controllers.

A controller is used to implement one or many actions, one method for each action.
« More »

jCoordinator

the main class of the jelix core.

this is the "chief orchestra" of the framework. Its goal is to load the configuration, to get the request parameters used to instancie the correspondant controllers and to run the right method.
« More »

jCoordinatorDebug

the main class of the jelix core.

this is the "chief orchestra" of the framework. Its goal is to load the configuration, to get the request parameters used to instancie the correspondant controllers and to run the right method.
« More »

jException

Jelix Exception.

It handles locale messages. Message property contains the locale key, and a new property contains the localized message.
« More »

jHttp401UnauthorizedException

Jelix Exception to generate an HTTP 401 error.

Unauthorized. The user must be authenticated to access to the resource.
« More »

jHttp403ForbiddenException

Jelix Exception to generate an HTTP 403 error.

Forbidden. The user must have the right to access to the resource.
« More »

jHttp404NotFoundException

Jelix Exception to generate an HTTP 404 error.

Resource not found. There is nothing at the current url.
« More »

jHttpErrorException

Jelix Exception to generate an HTTP error.

« More »

jHttpResponseException

Jelix Exception to generate an HTTP error. Deprecated class.

« More »

jIncluder

This object is responsible to load cache files.

Some jelix files needs to be compiled in PHP (templates, daos etc..) and their correspondant php content are stored in a cache file. jIncluder verify that cache file exists, and if not, it calls the correspondant compiler. Finally, it includes the cache.
« More »

jInstallCheck

check an installation of a jelix application.

« More »

jLocale

static class to get a localized string.

« More »

jServer

Static class providing some utilities to retrieve informations about the server.

« More »

jSession

session management class of the jelix core.

« More »

sessionConfigCompilerPlugin

« More »

webassetsConfigCompilerPlugin

« More »

Classes, interfaces and traits

jDbMysqlTools

Provides utilities methods for a mysql database.

« More »

jDbOciTools

Provides utilities methods for a database.

« More »

jDbPgsqlTools

Provides utilities methods for a database.

« More »

jDbSqliteTools

tools to manage a sqlite database.

« More »

jDbSqlsrvTools

Provides utilities methods for a database.

« More »

mssqlDbSchema

« More »

mssqlDbTable

« More »

mysqliDbConnection

« More »

mysqliDbResultSet

Object to fetch result, wrapping the underlaying result object of mysqli.

« More »

mysqliDbSchema

« More »

mysqliDbTable

« More »

ociDbConnection

« More »

ociDbResultSet

represent a statement result set or a prepared statement result set.

« More »

ociDbSchema

« More »

ociDbTable

« More »

pgsqlDbConnection

« More »

pgsqlDbResultSet

represent a statement result set or a prepared statement result set.

« More »

pgsqlDbSchema

« More »

pgsqlDbTable

« More »

sqlite3DbConnection

« More »

sqlite3DbResultSet

Couche d'encapsulation des resultset sqlite.

« More »

sqlite3DbSchema

« More »

sqlite3DbTable

« More »

sqlsrvDbSchema

« More »

sqlsrvDbTable

« More »

Classes, interfaces and traits

jISelector

interface of selector classes.

« More »

jExceptionSelector

Exception for selector errors.

It handles locale messages. Message property contains the locale key, and a new property contains the localized message.
« More »

jSelectorAct

Generic Action selector.

main syntax: "module~action@requestType". module should be a valid module name or # (#=says to get the module of the current request). action should be an action name (controller:method or controller_method). all part are optional, but it should have one part at least.
« More »

jSelectorActFast

Special Action selector for jcoordinator Don't use it ! Only for internal purpose.

General syntax for them : "module~resource". Syntax of resource depend on the selector type. module is optional.
« More »

jSelectorAppCfg

Selector for files stored in the app/system directory.

« More »

jSelectorCfg

Selector for files stored in the var/config directory.

« More »

jSelectorClass

selector for business class.

business class is a class stored in classname.class.php file in the classes/ module directory or one of its subdirectory. syntax : "module~classname" or "module~classname.
« More »

jSelectorDao

Selector for dao file syntax : "module~daoName".

file : daos/daoName.dao.xml.
« More »

jSelectorDaoDb

see jISelector.iface.php for documentation about selectors.

file : daos/daoName.dao.xml.
« More »

jSelectorDaoRecord

Selector for dao file syntax : "module~daoRecordName".

file : daos/daoRecordName.daorecord.php.
« More »

jSelectorFactory

Create instance of selectors object.

« More »

jSelectorForm

Form selector.

syntax : "module~formName". file : forms/formName.form.xml .
« More »

jSelectorIface

selector for interface.

interface is stored in interfacename.iface.php file in the classes/ module directory or one of its subdirectory. syntax : "iface:module~ifacename" or "module~ifacename.
« More »

jSelectorLib

Selector for files stored in the lib directory.

« More »

jSelectorLoc

selector for localisation string.

localisation string are stored in file properties. syntax : "module~prefixFile.keyString". Corresponding file : locales/xx_XX/prefixFile.CCC.properties. xx_XX and CCC are lang and charset set in the configuration
« More »

jSelectorLog

Selector for files stored in the log directory.

« More »

jSelectorModule

base class for all selector concerning module files.

General syntax for them : "module~resource". Syntax of resource depend on the selector type. module is optional.
« More »

jSelectorSimpleFile

base class for simple file selector.

« More »

jSelectorTmp

Selector for files stored in the temp directory.

« More »

jSelectorTpl

Template selector.

syntax : "module~tplName". file : templates/tplName.tpl .
« More »

jSelectorVar

Selector for files stored in the var directory.

« More »

jSelectorZone

Zone selector.

syntax : "module~zoneName". file : zones/zoneName.zone.php .
« More »

Classes, interfaces and traits

jClassicRequest

handle "classical" request it just gets parameters from the url query and the post content. And responses can be in many format : text, html, xml.

..
« More »

jCmdLineRequest

a request object for scripts used in a command line.

.).
« More »

jCssRequest

handle classical request but only to control and produce css content.

.).
« More »

jJsonRpcRequest

handle a JSON-rpc call. The response has to be a json rpc response.

.).
« More »

jRequest

base class for object which retrieve all parameters of an http request. The process depends on the type of request (ex: xmlrpc.

.).
« More »

jResponse

base class for response object A response object is responsible to generate a content in a specific format.

« More »

jXmlRpcRequest

handle XML-rpc call. The response has to be a xml-rpc response.

.).
« More »

Classes, interfaces and traits

jIInstallerComponent

« More »

jIInstallReporter

interface for classes used as reporter for installation or check etc.

.. This classes are responsible to show informations to the user.
« More »

jInstallerApplication

Application configuration reader and manager.

« More »

jInstallerException

Installer Exception.

It handles installer messages.
« More »

jInstallerMessageProvider

message provider for jInstallCheck and jInstaller.

« More »

jInstallerModule

A class that does processing to configure and install a module into an application. A module should have a class that inherits from it in order to configure itself into the application.

« More »

Classes, interfaces and traits

dbaKVDriver

« More »

memcacheKVDriver

« More »

redis_extKVDriver

« More »

Classes, interfaces and traits

jResponseBasicHtml

Basic HTML response. the HTML content should be provided by a simple php file.

« More »

jResponseBinary

Response use to send a binary file to the browser.

« More »

jResponseCmdline

Command line response.

« More »

jResponseCss

Send CSS content.

« More »

jResponseHtml

HTML5 response.

« More »

jResponseHtmlError

HTML5 response to display HTTP errors.

« More »

jResponseHtmlFragment

Send Html part.

« More »

jResponseJson

Json response.

« More »

jResponseJsonRpc

Response for jsonrpc protocol.

« More »

jResponseRedirect

Response To redirect to an action.

« More »

jResponseRedirectUrl

Response To redirect to an URL.

« More »

jResponseText

plain Text response.

« More »

jResponseXml

XML response generator.

« More »

jResponseXmlRpc

xmlrpc response.

« More »

jResponseZip

generate a zip content and send it to the browser.

« More »

Classes, interfaces and traits

jIAuthDriver

interface for auth drivers.

« More »

jIAuthDriver2

interface for auth drivers.

« More »

jAuth

This is the main class for authentification process.

« More »

jAuthDummyUser

internal use.

this is only a data container. In fact, auth drivers can provide other object to embed user data.
« More »

jAuthUser

default object to represent a user.

this is only a data container. In fact, auth drivers can provide other object to embed user data.
« More »

jAuthUserLDAP

object which represent a user for LDAP driver.

this is only a data container. In fact, auth drivers can provide other object to embed user data.
« More »

Classes, interfaces and traits

mysqlDaoBuilder

driver for jDaoCompiler.

It is called by jDaoCompiler
« More »

ociDaoBuilder

driver for jDaoCompiler.

It is called by jDaoCompiler
« More »

pgsqlDaoBuilder

driver for jDaoCompiler.

It is called by jDaoCompiler
« More »

sqliteDaoBuilder

driver for jDaoCompiler.

It is called by jDaoCompiler
« More »

Classes, interfaces and traits

debugbarConfigCompilerPlugin

« More »

localesConfigCompilerPlugin

« More »

nsautoloaderConfigCompilerPlugin

« More »

responsesConfigCompilerPlugin

« More »

Classes, interfaces and traits

jLog

utility class to log some message into a file into yourapp/var/log.

« More »

Classes, interfaces and traits

jIAcl2Driver

interface for jAcl2 drivers.

« More »

jIAcl2Driver2

interface for jAcl2 drivers.

« More »

jAcl2

Main class to query the acl system, and to know value of a right.

you should call this class (all method are static) when you want to know if the current user have a right
« More »

jAcl2Db

Utility class for all classes used for the db driver of jAcl2.

« More »

jAcl2DbAdminCheckAuthorizations

Allow to verify admin rights when a change occurs in the authorizations.

« More »

jAcl2DbUserGroup

Use this class to register or unregister users in the acl system, and to manage user groups.

Works only with db driver of jAcl2.
« More »

Classes, interfaces and traits

jIAuthDriverClass

interface for classes used with the jAuthDriverClass.

« More »

classAuthDriver

Driver for a class which implement an authentification.

« More »

dbAuthDriver

authentification driver for authentification information stored in a database.

« More »

ldapAuthDriver

LDAP authentification driver for authentification information stored in LDAP server.

« More »

Classes, interfaces and traits

jDao

Factory to create DAO objects.

« More »

jDaoCompiler

The compiler for the DAO xml files. it is used by jIncluder It produces some php classes.

« More »

jDaoCondition

content a sub group of conditions.

« More »

jDaoConditions

container for all criteria of a query.

« More »

jDaoFactoryBase

base class for all factory classes generated by the dao compiler.

« More »

jDaoGenerator

This is a generator which creates php class from dao xml file.

It is called by jDaoCompiler
« More »

jDaoMethod

containers for properties of dao method.

« More »

jDaoParser

extract data from a dao xml content.

« More »

jDaoProperty

Container for properties of a dao property.

« More »

jDaoRecordBase

Base class for all record classes generated by the dao compiler.

« More »

jDaoXmlException

Exception for Dao compiler.

It handles locale messages. Message property contains the locale key, and a new property contains the localized message.
« More »

Classes, interfaces and traits

jTpl

template engine.

« More »

jTplCompiler

This is the compiler of templates: it converts a template into a php file.

« More »

Classes, interfaces and traits

jUrl

Object that contains url data, and which provides static method helpers.

« More »

jUrlAction

A container to store url data for an action.

« More »

jUrlBase

base class for jUrl and jUrlAction.

« More »

Classes, interfaces and traits

AuthCoordPlugin

« More »

AutoLocaleCoordPlugin

plugin for language auto detection.

« More »

historyCoordPlugin

« More »

traceexecCoordPlugin

« More »

Classes, interfaces and traits

jEvent

Class which represents an event in the event system.

« More »

jEventCompiler

« More »

jEventListener

base class for event listeners.

« More »

Classes, interfaces and traits

firebugLogger

« More »

Classes, interfaces and traits

jIFilteredDatatype

interface for datatypes which can filter value.

« More »

jDatatype

« More »

jDatatypeBoolean

Datatype Booléen.

« More »

jDatatypeColor

Datatype Color.

« More »

jDatatypeDate

Datatype date.

Possible facets are: 'maxValue', 'minValue'
« More »

jDatatypeDateTime

Datatype datetime.

Possible facets are: 'maxValue', 'minValue'
« More »

jDatatypeDecimal

Datatype Decimal.

Possible facets are: 'maxValue', 'minValue'
« More »

jDatatypeEmail

Datatype mail.

« More »

jDatatypeHexadecimal

Datatype Hexa.

Possible facets are: 'maxValue', 'minValue'
« More »

jDatatypeHtml

Datatype HTML String.

Possible facets are: 'length','minLength','maxLength'
« More »

jDatatypeInteger

Datatype Integer.

Possible facets are: 'maxValue', 'minValue'
« More »

jDatatypeIPv4

Datatype ipv4.

« More »

jDatatypeIPv6

Datatype ipv6.

« More »

jDatatypeLocaleDate

Datatype localedate.

Possible facets are: 'maxValue', 'minValue'
« More »

jDatatypeLocaleDateTime

Datatype localedatetime.

Possible facets are: 'maxValue', 'minValue'
« More »

jDatatypeLocaleTime

Datatype localetime.

Possible facets are: 'maxValue', 'minValue'
« More »

jDatatypeLocaleTimeShort

Datatype localetime.

Possible facets are: 'maxValue', 'minValue'
« More »

jDatatypeString

Datatype String.

Possible facets are: 'length','minLength','maxLength', 'pattern'
« More »

jDatatypeTime

Datatype time.

Possible facets are: 'maxValue', 'minValue'
« More »

jDatatypeUrl

Datatype url.

Possible facets are: 'schemeRequired','hostRequired','pathRequired', 'queryRequired'. all are booleans.
« More »

Classes, interfaces and traits

jdbProfilesCompiler

default plugin for jProfilesCompiler, and base plugin for other plugins.

« More »

Classes, interfaces and traits

jControllerCmdLine

a base class for controllers used in command line application.

A controller is used to implement one or many actions, one method for each action.
« More »

jControllerDaoCrud

a base class for crud controllers.

A controller is used to implement one or many actions, one method for each action.
« More »

jControllerDaoCrudDfk

a base class for crud controllers, for DAO which have a primary key based on two fields, a "static" field (a field that we know the value and which is a criteria to to select all viewed record), and a "dynamic" field (the value of the field is created by the user or autoincremented).

A controller is used to implement one or many actions, one method for each action.
« More »

Classes, interfaces and traits

htmlJformsBuilder

HTML form builder.

a builder form class is a class which help to generate a form for the output (html form for example)
« More »

htmllightJformsBuilder

HTML form builder.

a builder form class is a class which help to generate a form for the output (html form for example)
« More »

Classes, interfaces and traits

jICacheDriver

Interface for cache drivers.

« More »

jCache

Global caching data provided from whatever sources.

« More »

Classes, interfaces and traits

htmlFormBuilder

HTML form builder.

a builder form class is a class which help to generate a form for the output (html form for example)
« More »