Functions

bcrypt

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

package

jelix

Arguments

$salt

$password

$iteration_count

« More »

can_use_password_API

function to check if the password API can be used In some PHP version ( <5.3.7), crypt() with blowfish is vulnerable.

But this issue has been fixed on some older PHP version (php 5.3.3 for most of them) in some distro, like Debian squeeze.

package

Default

see http://www.php.net/security/crypt_blowfish.php
« 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.

package

jelix

todo

migrate the code to jAppManager or jApp

« 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.

package

jelix

see \jAppManager
todo

migrate the code to jAppManager or jApp

« More »

hash_equals

package

jelix

Arguments

$known_str

$user_str

« More »

isAppInstalled

package

jelix

todo

migrate the code to jAppManager or jApp

« More »

jelix_autoload

function used by php to try to load an unknown class

package

jelix

Arguments

$class

« More »

jelix_read_ini

package

jelix

Arguments

$fileName

$config

« More »

jelix_scan_action_sel

package

jelix

Arguments

$selStr

$selObj

$actionName

« More »

jelix_scan_class_sel

package

jelix

Arguments

$selStr

$selObj

« More »

jelix_scan_locale_sel

package

jelix

Arguments

$selStr

$selObj

« More »

jelix_scan_module_sel

package

jelix

Arguments

$selStr

$selObj

« More »

jtpl_block_common_ifuserconnected

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

{ifuserconnected} ..here generated content if the user is connected  {/ifuserconnected}
package

jelix

Arguments

$compiler

\jTplCompiler

the template compiler

$begin

boolean

true if it is the begin of block, else false

$params

array

no parameters. array should be empty

Response

string

the php code corresponding to the begin or end of the block

« More »

jtpl_block_common_ifusernotconnected

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

{ifusernotconnected} ..here generated content if the user is NOTconnected  {/ifusernotconnected}
package

jelix

Arguments

$compiler

\jTplCompiler

the template compiler

$begin

boolean

true if it is the begin of block, else false

$params

array

no parameters. array should be empty

Response

string

the php code corresponding to the begin or end of the block

« More »

jtpl_block_common_jscompress

jscompress : formate a js block code by removing spaces, tabs and returns.

Example: {jscompress}var foo = bar;{/jscompress}

package

jelix

Arguments

$compiler

$begin

$params

Response

string

« More »

jtpl_block_common_stripws

remove all extra whitespaces

package

jelix

Arguments

$compiler

$begin

$param

« 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 :

  • string $builderName (default is 'html')
  • array $options for the builder. Example, for the 'html' builder :
    • "errorDecorator"=>"name of your javascript object for error listener"
    • "method" => "post" or "get". default is "post"

package

jelix

see \jForms

Arguments

$compiler

\jTplCompiler

the template compiler

$begin

boolean

true if it is the begin of block, else false

$param

array

0=>form object 1=>selector of submit action 2=>array of parameters for submit action 3=>name of the builder : default is html 4=>array of options for the builder

Response

string

the php code corresponding to the begin or end of the block

« 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

package

jelix

see \jForms

Arguments

$compiler

\jTplCompiler

the template compiler

$begin

boolean

true if it is the begin of block, else false

$param

array

empty array or 0=>jFormsBase object or 0=>jFormsBase object, 1=>array of control names or 0=>array of control names

Response

string

the php code corresponding to the begin or end of the block

« More »

jtpl_block_html_formdata

a block to display only data of a form

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

package

jelix

see \jForms
since 1.0.1

Arguments

$compiler

\jTplCompiler

the template compiler

$begin

boolean

true if it is the begin of block, else false

$param

array

0=>form object 2=>name of the builder : default is html 3=>array of options for the builder

Response

string

the php code corresponding to the begin or end of the block

« 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

package

jelix

see \jForms

Arguments

$compiler

\jTplCompiler

the template compiler

$begin

boolean

true if it is the begin of block, else false

$param

array

empty array or 0=>jFormsBase object or 0=>jFormsBase object, 1=>array of submit names or 0=>array of submit names

Response

string

the php code corresponding to the begin or end of the block

« 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}

package

jelix

Arguments

$compiler

\jTplCompiler

the template compiler

$begin

boolean

true if it is the begin of block, else false

$params

array

0=>'name',etc. to match against current control name

Response

string

the php code corresponding to the begin or end of the block

« More »

jtpl_block_html_swf

swf plugin : Adds html code to display a swf

Example : {swf 'promobidon.swf', array('id'=>'promo', 'width'=>150, 'height'=>90), array('quality'=>'hight', 'wmode'=>'transparent'), array('longeur'=>150)} {image 'toupie.png'} {/swf}

Render :

<object id="promo" width="150" height="90" data="/data/fichiers/promobidon.swf?&longeur=150" type="application/x-shockwave-flash">

<param value="transparent" name="wmode"/>
<img src="/data/fichiers/toupie.png"/>

$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

package

jelix

Arguments

$compiler

\jTplCompiler

the template compiler

$begin

boolean

true if it is the begin of block, else false

$params

array

parameters for the url

Response

string

PHP generated code

« 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 :

$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

package

jelix

Arguments

$compiler

\jTplCompiler

the template compiler

$begin

boolean

true if it is the begin of block, else false

$params

array

parameters for the url

Response

string

PHP generated code

« More »

jtpl_block_ltx2pdf_lcmd

a special to insert latex content

usage : {lcmd } .. calls the \{} latex command

package

jelix

Arguments

$compiler

\jTplCompiler

the template compiler

$begin

boolean

true if it is the begin of block, else false

$param

array

1=>latex command

Response

string

the php code corresponding to the begin or end of the block

« More »

jtpl_block_ltx2pdf_lenv

a special to insert latex content

usage : {lenv 'latex_block_name'} ..here latex content {/lenv}

package

jelix

Arguments

$compiler

\jTplCompiler

the template compiler

$begin

boolean

true if it is the begin of block, else false

$param

array

1=>latex command

Response

string

the php code corresponding to the begin or end of the block

« More »

jtpl_cfunction_common_break

cfunction to allow to had a break instruction in a template

    {for $i = 1; $i < 10; $i++}
  • {$i}
  • {if $i == '4'}{break}{/if} {/for}
package

jelix

Arguments

$compiler

« More »

jtpl_cfunction_common_fetchzone

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

 {fetchzone 'myVar', 'myModule~myzone', array('foo'=>'bar)}
{if $myVar !== ''}
{$myVar}
{/if}
package

jelix

Arguments

$compiler

\jTplCompiler

the template compiler

$params

Response

string

the php code corresponding to the function content

« More »

jtpl_cfunction_common_include

function plugin : include a template into another template

{include 'myModule~foo'}
package

jelix

Arguments

$compiler

\jTplCompiler

the template compiler

$param

array

0=>$string the template selector (string)

Response

string

the php code corresponding to the function content

« More »

jtpl_cfunction_common_zone

cfunction plugin : include the content of a zone

 {zone 'myModule~myzone'}
{zone 'myModule~myzone',array('foo'=>'bar)}
package

jelix

Arguments

$compiler

\jTplCompiler

the template compiler

$params

Response

string

the php code corresponding to the function content

« More »

jtpl_cfunction_html_const

compiled function plugin : display a constant. Not available in untrusted templates

{const 'foo'}
package

jelix

Arguments

$compiler

\jTplCompiler

the template compiler

$param

array

0=>$string the constant name

Response

string

the php code corresponding to the function content

« 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 :

  • string $builderName (default is 'html')
  • array $options for the builder. Example, for the 'html' builder :
    • "errorDecorator"=>"name of your javascript object for error listener"
    • "method" => "post" or "get". default is "post"

package

jelix

Arguments

$compiler

\jTplCompiler

the template compiler

$params

Response

string

the php code corresponding to the begin or end of the block

« 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="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"/>

$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

package

jelix

Arguments

$tpl

\jTpl

template engine

$params

array

parameters for the url

Response

string

PHP generated code

« More »

jtpl_cfunction_text_const

compiled function plugin : display a constant. Not available in untrusted templates

{const 'foo'}
package

jelix

Arguments

$compiler

\jTplCompiler

the template compiler

$param

array

0=>$string the constant name

Response

string

the php code corresponding to the function content

« More »

jtpl_cfunction_xml_const

compiled function plugin : display a constant. Not available in untrusted templates

{const 'foo'}
package

jelix

Arguments

$compiler

\jTplCompiler

the template compiler

$param

array

0=>$string the constant name

Response

string

the php code corresponding to the function content

« More »

jtpl_function_common_counter

function plugin : Increment and print a counter on all calls.

{for $i=0;$i<10;$i++}{counter 'name', true}{/for}
package

jelix

Arguments

$tpl

\jTpl

The template

$name

string

The name of the counter

$print

boolean

Print the counter or not

« More »

jtpl_function_common_counter_init

function plugin : Init a counter.

{counter_init 'name', 'type', 'start', 'incr'}
package

jelix

Arguments

$tpl

\jTpl

The template

$name

string

The name of the counter

$type

string

The type of the counter ('0', '00', 'aa' or 'AA').

$start

string|integer

Where the counter start. String if type == 'aa'/'AA'

$incr

integer

How many time the counter is increased on each call

« More »

jtpl_function_common_counter_reset

function plugin : Reset a counter.

{counter_reset 'name'}
package

jelix

Arguments

$tpl

\jTpl

The template

$name

string

The name of the counter

« More »

jtpl_function_common_counter_reset_all

function plugin : Reset all the counters.

{counter_reset_all}
package

jelix

Arguments

$tpl

\jTpl

The template

« More »

jtpl_function_common_cycle_init

Type: function<br> Name: cycle_init<br> Date: Feb, 2008<br> Purpose: initialize cycling through given values<br> Input: - values = comma separated list of values to cycle - name = name of cycle (optional)

Examples:

{cycle_init '#eeeeee,#d0d0d0d'}
{cycle_init 'name','#eeeeee,#d0d0d0d'}
package

jelix

Throws
\jException

Arguments

$tpl

\jTpl

$name

string

the name of the cycle or the list of values

$values

string

the list of values

« More »

jtpl_function_common_cycle_reset

Type: function<br> Name: cycle_reset<br> Date: Feb, 2008<br> Purpose: reset the cycle of a given cycle name or the default<br> Input: - name = name of cycle (optional)

Examples:

{cycle_reset 'name'}
{cycle_reset}
package

jelix

Throws
\jException

Arguments

$tpl

\jTpl

$name

string

the name of the cycle

« More »

jtpl_function_common_dumptolog

Dump a value into log files

package

jelix

Arguments

$tpl

\jTpl

$value

mixed

« More »

jtpl_function_common_repeat_string

Repeat a string

{repeat_string 'mystring'}
{repeat_string 'mystring',4}
package

jelix

Arguments

$tpl

\jTpl

The template

$string

string

The string to repeat

$count

integer

How many times to repeat

« More »

jtpl_function_html_breadcrumb

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

package

jelix

Arguments

$tpl

\jTpl

template engine

$nb

array

the number of items displayed by the plugin

$separator

string

Symbol separating items

« 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

package

jelix

Throws
\jException

Arguments

$tpl

\jTpl

template engine

$ctrlname

string

the name of the control to display (required if it is outside a formcontrols)

$attributes

array

attribute to add on the generated code (html attributes for example)

« More »

jtpl_function_html_ctrl_label

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

package

jelix

Throws
\jException

Arguments

$tpl

\jTpl

template engine

$ctrlname

string

the name of the control to display (required if it is outside a formcontrols)

$format

string

« 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

package

jelix

Throws
\jException

Arguments

$tpl

\jTpl

template engine

$ctrlname

string

the name of the control to display (required if it is outside a formcontrols)

$sep

string

separator to display values of a multi-value control

« More »

jtpl_function_html_ctrl_value

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

package

jelix

Throws
\jException

Arguments

$tpl

\jTpl

template engine

$ctrlname

string

the name of the control to display (required if it is outside a formcontrols)

$sep

string

separator to display values of a multi-value control

« More »

jtpl_function_html_diff

function plugin : show a diff between two string

package

jelix

Arguments

$tpl

\jTpl

template engine

$str1

string

the first string

$str2

string

the second string

$options

array

contains : 'nodiffmsg' message when no diff found ; 'version1' ; 'version2' to be compared ; 'type' of display

« More »

jtpl_function_html_formdatafull

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

package

jelix

Arguments

$tpl

\jTpl

template engine

$form

\jFormsBase

the form to display

$builder

string

the builder type to use

$options

array

options for the builder

« More »

jtpl_function_html_formreset

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

package

jelix

Arguments

$tpl

\jTpl

template engine

« 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

package

jelix

Throws
\jException

Arguments

$tpl

\jTpl

template engine

$ctrlname

string

the name of the submit to display (required if it is outside a formsubmits)

$attributes

array

attributes for the generated html element

« More »

jtpl_function_html_formurl

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

package

jelix

Arguments

$tpl

\jTpl

template engine

$selector

string

selector action

$params

array

parameters for the url

« More »

jtpl_function_html_formurlparam

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

package

jelix

Arguments

$tpl

\jTpl

template engine

$selector

string

selector action

$params

array

parameters for the url

« More »

jtpl_function_html_gravatar

gravatar plugin : write the url corresponding to the image of the gravatar account identified by the given email address

package

jelix

Arguments

$tpl

\jTpl

template engine

$email

string

account

$params

array

parameters for : 1) the default avatar URL 2) the default size of the image 3) the username to be put in the "alt" attribute of the img

« 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:

{hook 'myevent'}

In a Jelix Event listener:

function onmyevent($event) { $event->add('

html content
'); }

Result:

html content

package

jelix

Arguments

$tpl

\jTpl

template engine

$event

string

the event name to call

$params

array

parameters to give to the listener

« 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

package

jelix

Arguments

$tpl

\jTpl

template engine

$src

string

the url of image relative to the www path

$params

array

parameters for the transformation and img element

« More »

jtpl_function_html_jfullurl

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

package

jelix

Arguments

$tpl

\jTpl

template engine

$selector

string

selector action

$params

array

parameters for the url

$domain

string

domain name, false if you want to use the config domain name or the server name

$escape

boolean

if true, then escape the string for html

« More »

jtpl_function_html_jlocale

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

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

package

jelix

Arguments

$tpl

\jTpl

template engine

$locale

string

the locale key

« More »

jtpl_function_html_jmessage

function plugin : Display messages from jMessage

package

jelix

Arguments

$tpl

$type

« 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

package

jelix

Arguments

$tpl

\jTpl

template engine

$ressourceType

string

the name of the ressource type

« More »

jtpl_function_html_jurl

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

package

jelix

Arguments

$tpl

\jTpl

template engine

$selector

string

selector action

$params

array

parameters for the url

$escape

boolean

if true, then escape the string for html

« 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 :

it may produce something like that (depending how the url is configured for the 'jxacl~admin_rightslist' action): index.php/acl/rightslist/%idgroup%/bar?acl=%acl%

Then you can replace placeholders

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);

package

jelix

Arguments

$tpl

\jTpl

template engine

$selector

string

selector action

$params

array

static parameters for the url

$placeholders

array

list of placeholders: key=name of an url parameter, value=a placeholder name you choose

« More »

jtpl_function_html_mailto

Examples: <pre> {mailto array("address"=>"me@domain.com")} {mailto array("address"=>"me@domain.com","encode"=>"javascript")} {mailto array("address"=>"me@domain.com","encode"=>"hex")} {mailto array("address"=>"me@domain.com","subject"=>"Hello to you!")} {mailto array("address"=>"me@domain.com","cc"=>"you@domain.com,they@domain.com")} {mailto array("address"=>"me@domain.com","extra"=>'class="mailto"')} </pre>

package

jelix

params

jTpl $tpl

array $params

Arguments

$tpl

$params

« More »

jtpl_function_html_resurl

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

package

jelix

Arguments

$tpl

\jTpl

template engine

$module

string

the module name

$file

array

the relative path of the wanted file to the www directory of the module

$intheme

$escape

boolean

if true, then escape the string for html

« 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
example : {urljsstring 'jxacl~admin_rightslist',array(),array('grpid'=>'idgroup','__rnd'=>'Math.random()')};
it will produce: "index.php?module=acl&action=admin_rightslist&grpid="+idgroup+"&__rnd="+ Math.random();

package

jelix

Arguments

$tpl

\jTpl

template engine

$selector

string

selector action

$params

array

parameters for the url

$jsparams

« More »

jtpl_function_ltx2pdf_jlocale

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

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

package

jelix

Arguments

$tpl

\jTpl

template engine

$locale

string

the locale key

« More »

jtpl_function_ltx2pdf_jurl

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

package

jelix

Arguments

$tpl

\jTpl

template engine

$selector

string

selector action

$params

array

parameters for the url

« More »

jtpl_function_text_formdatafull

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

package

jelix

Arguments

$tpl

\jTpl

template engine

$form

\jFormsBase

the form to display

« More »

jtpl_function_text_jfullurl

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

package

jelix

Arguments

$tpl

\jTpl

template engine

$selector

string

selector action

$params

array

parameters for the url

$domain

string

domain name, false if you want to use the config domain name or the server name

« More »

jtpl_function_text_jlocale

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

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

package

jelix

Arguments

$tpl

\jTpl

template engine

$locale

string

the locale key

« More »

jtpl_function_text_jurl

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

package

jelix

Arguments

$tpl

\jTpl

template engine

$selector

string

selector action

$params

array

parameters for the url

« More »

jtpl_function_xml_jfullurl

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

package

jelix

Arguments

$tpl

\jTpl

template engine

$selector

string

selector action

$params

array

parameters for the url

$domain

string

domain name, false if you want to use the config domain name or the server name

$escape

boolean

if true, then escape the string for html

« More »

jtpl_function_xml_jlocale

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

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

package

jelix

Arguments

$tpl

\jTpl

template engine

$locale

string

the locale key

« More »

jtpl_function_xml_jurl

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

package

jelix

Arguments

$tpl

\jTpl

template engine

$selector

string

selector action

$params

array

parameters for the url

$escape

boolean

if true, then escape the string for xml

« More »

jtpl_meta_html_html

meta plugin : modify an html response object

package

jelix

see \jResponseHtml
params

array $params additionnal parameters (a media attribute for stylesheet for example)

Arguments

$tpl

\jTpl

template engine

$method

string

indicates what you want to specify (possible values : js, css, jsie, jsie7, jsltie7, cssie, cssie7, cssltie7, csstheme, cssthemeie, cssthemeie7, cssthemeltie7, bodyattr, keywords, description, others)

$param

mixed

parameter (a css style sheet for "css" for example)

$params

« More »

jtpl_meta_html_htmlmodule

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

package

jelix

see \jResponseHtml
params

array $params additionnal parameters for the generated tag (a media attribute for stylesheet for example)

Arguments

$tpl

\jTpl

template engine

$method

string

indicates what you want to specify (possible values : js, css, jsie, cssie, cssie7, cssltie7, csstheme, cssthemeie, cssthemeie7, cssthemeltie7)

$module

string

the module where file is stored

$path

mixed

the relative path inside the {module}/www/ directory, or inside the {module}/www/themes/{currenttheme}/ directory

$params

« More »

jtpl_meta_xml_xml

meta plugin : modify an xml response object

package

jelix

see \jResponseXml

Arguments

$tpl

\jTpl

template engine

$method

string

indicates what you want to specify (possible values : xsl,css,csstheme)

$param

mixed

parameter (a css style sheet url for "css" for example)

« More »

jtpl_modifier_common_cat

Modifier plugin : catenate a value to a variable

 {$var|cat:"foo"}
 {$var|cat:$othervar}
package

jelix

Arguments

$string

string

the string to be modified

$cat

string

the string to concat to $string

Response

string

« More »

jtpl_modifier_common_count_array

modifier plugin : display count of an array

{$myarray|count_array}
package

jelix

Arguments

$aArray

array

Response

integer

« More »

jtpl_modifier_common_count_characters

Modifier plugin : count the number of characters in a text

{$mytext|count_characters}
{$mytext|count_characters:true}
package

jelix

Arguments

$string

string

$include_spaces

boolean

include whitespace in the character count

Response

integer

« More »

jtpl_modifier_common_count_paragraphs

modifier plugin : count the number of paragraphs in a text

{$mytext|count_paragraphs}
package

jelix

Arguments

$string

string

Response

integer

« More »

jtpl_modifier_common_count_records

modifier plugin : display count of a DbResultSet Object (how many records)

{$myarray|count_records}
package

jelix

Arguments

$DbResultSet

\jDbResultSet

Response

integer

« More »

jtpl_modifier_common_count_sentences

modifier plugin : count the number of sentences in a text

{$mytext|count_sentences}
package

jelix

Arguments

$string

string

Response

integer

« More »

jtpl_modifier_common_count_words

modifier plugin : count the number of words in a text

{$mytext|count_words}
package

jelix

Arguments

$string

string

Response

integer

« More »

jtpl_modifier_common_date_format

modifier plugin : format a date <pre> {$mydate|date_format:"%b %e, %Y"} </pre>

package

jelix

Arguments

$string

string

input date string

$format

string

strftime format for output

$default_date

string|integer

default date if $string is empty

Response

string

the formated date

« 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'}

package

jelix

see \jDateTime

Arguments

$date

string

the date

$format_out

string

the format identifier of the output date

$format_in

string

the format identifier of the given date

Response

string

the converted date

« More »

jtpl_modifier_common_implode

modifier plugin : apply the implode function on the given value

package

jelix

Arguments

$arr

$glue

Response

string

« More »

jtpl_modifier_common_indent

Modifier plugin: indent lines of text

{$mytext|indent}
{$mytext|indent:$number_of_spaces}
{$mytext|indent:$number_of_chars:$chars_to_repeat}
package

jelix

Arguments

$string

string

$chars

integer

the value of the indentation

$char

string

the char to repeat

Response

string

« 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) :

  • 'lang_date' (jDateTime::LANG_DFORMAT)
  • 'lang_datetime' => jDateTime::LANG_DTFORMAT)
  • 'lang_time' => jDateTime::LANG_TFORMAT)
  • 'db_date' => jDateTime::DB_DFORMAT)
  • 'db_datetime' => jDateTime::DB_DTFORMAT)
  • 'db_time' => jDateTime::DB_TFORMAT)
  • 'iso8601' => jDateTime::ISO8601_FORMAT)
  • 'timestamp' => jDateTime::TIMESTAMP_FORMAT)
  • 'rfc822'=> jDateTime::RFC822_FORMAT)
  • 'full_lang_date'=> jDateTime::FULL_LANG_DATE

examples : {$mydate|jdatetime} {$mydate|jdatetime:'db_time':'lang_time'}

package

jelix

see \jDateTime
Throws
\jException

Arguments

$date

string

the date

$format_in

string

the format identifier of the given date

$format_out

string

the format identifier of the output date

Response

string

the converted date

« More »

jtpl_modifier_common_number_format

NumberFormat plugin for jTpl that wraps PHP number_format function

package

jelix

Arguments

$number

float

the number to format

$decimals

integer

the number of decimals to return

$dec_point

string

the separator string for the decimals

$thousands_sep

string

the separator string for the thousands

Response

string

« More »

jtpl_modifier_common_regex_replace

modifier plugin : regular epxression search/replace

You should provide two arguments, like the first both of preg_replace {$mystring|regex_replace:'/(\w+) (\d+), (\d+)/i':'${1}1,$3'}

package

jelix

Arguments

$string

string

$search

string|array

$replace

string|array

Response

string

« More »

jtpl_modifier_common_replace

modifier plugin : simple search/replace

You should provide two arguments, like the first both of str_replace

{$mystring|replace:'foo':'bar'}
package

jelix

Arguments

$string

string

the string to modify

$search

string

the string to search

$replace

string

Response

string

« More »

jtpl_modifier_common_round

Modifier plugin : Rounds a float

 {$var|round:2}
package

jelix

Arguments

$val

float

the value to round

$precision

integer

The number of decimal digits to round to.

Response

float

« More »

jtpl_modifier_common_spacify

modifier plugin : add spaces between characters in a string

{$mytext|spacify}
{$mytext|spacify:$characters_to_insert}
package

jelix

Arguments

$string

string

the string to spacify

$spacify_char

string

spaces to add

Response

string

« More »

jtpl_modifier_common_sprintf

modifier plugin : format strings via sprintf

{$mytext|sprintf:'my format %s'}
package

jelix

see \sprintf

Arguments

$string

string

$format

string

Response

string

« More »

jtpl_modifier_common_strip

modifier plugin : Replace all repeated spaces, newlines, tabs with a single space or supplied replacement string

{$var|strip}
{$var|strip:" "}
package

jelix

Arguments

$text

string

the text to strip

$replace

string

the string replacing the repeated spaces

Response

string

« More »

jtpl_modifier_common_truncate

modifier plugin : Truncate a string

Truncate a string to a certain length if necessary, optionally splitting in the middle of a word, and appending the $etc string.

{$mytext|truncate}
{$mytext|truncate:40}
{$mytext|truncate:45:'...'}
{$mytext|truncate:60:'...':true}
package

jelix

Arguments

$string

string

the string to truncate

$length

integer

the number of char to keep

$etc

string

the string to append to the truncated string

$break_words

boolean

false if the last word shouldn't be cut

Response

string

« More »

jtpl_modifier_common_truncatehtml

modifier plugin : cut a html formated string and close all opened tags so that it doesn't inpact on the rest of the page You should use this modifier in a zone so that the return value is cached Plugin from sniplr (original sources can be found here: http://snipplr.com/view.php?codeview&id=3618 ) <pre>{$mytext|wordwrap} {$mytext|truncatehtml:150:"\n<a href=".

..">read full article"} {$mytext|truncatehtml:45}

package

jelix

Arguments

$string

string

the string to truncate

$nbChar

integer

number of chars to keep (warning html tags included )

$etcPattern

string

the string to append to the truncated string

Response

string

« More »

jtpl_modifier_common_wiki

modifier plugin : transform a wiki text to another format you can use other transformations by given the name of corresponding wikirenderer rules <pre> {$var|wiki} {$var|wiki:"classicwr_to_xhtml"} </pre>

package

jelix

see \jWiki
link

http://wikirenderer.berlios.de/

Arguments

$text

string

the wiki texte

$config

string

the name of the wikirenderer rule to use

Response

string

« More »

jtpl_modifier_common_wordwrap

modifier plugin : wrap a string of text at a given length. Same parameters as the php wordwrap function <pre>{$mytext|wordwrap} {$mytext|wordwrap:40} {$mytext|wordwrap:45:"\n"} {$mytext|wordwrap:60:"\n":true} </pre>

package

jelix

Arguments

$string

string

$length

integer

$break

string

$cut

boolean

Response

string

« More »

jtpl_modifier_html_nl2br

modifier plugin : convert \r\n, \r or \n to <<br/>> Example: {$text|nl2br}

package

jelix

Arguments

$string

string

the string to modify

Response

string

« More »

jtpl_modifier_html_vardump

Dump any value

package

jelix

Arguments

$value

Response

string

« More »

jtpl_modifier_html_vardump

Dump any value

package

jelix

Arguments

$value

Response

string

« More »

jtpl_modifier_ltx2pdf_latex

modifier plugin : simple search/replace for latex chars

package

jelix

Arguments

$string

string

the string to modify

Response

\the

modified string

« More »

password_get_info

Get information about the password hash. Returns an array of the information that was used to generate the password hash.

array( 'algo' => 1, 'algoName' => 'bcrypt', 'options' => array( 'cost' => 10, ), )

package

Default

Arguments

$hash

string

The password hash to extract info from

Response

array

The array of information about the hash.

« More »

password_hash

Hash the password using the specified algorithm

package

Default

returns

string|false The hashed password, or false on error.

Arguments

$password

string

The password to hash

$algo

integer

The algorithm to use (Defined by PASSWORD_* constants)

$options

array

The options for the algorithm to use

« More »

password_needs_rehash

Determine if the password hash needs to be rehashed according to the options provided

If the answer is true, after validating the password using password_verify, rehash it.

package

Default

Arguments

$hash

string

The hash to test

$algo

integer

The algorithm used for new password hashes

$options

array

The options array passed to password_hash

Response

boolean

True if the password needs to be rehashed.

« More »

password_verify

Verify a password against a hash using a timing attack resistant approach

package

Default

Arguments

$password

string

The password to verify

$hash

string

The hash to verify against

Response

boolean

If the password matches the hash

« More »

sha1WithSalt

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

package

jelix

deprecated

Arguments

$salt

$password

« More »

Constants

JELIX_VERSION

Version number of Jelix

« More »

JELIX_NAMESPACE_BASE

base of namespace path used in xml files of jelix

« More »

JELIX_LIB_PATH

« More »

JELIX_LIB_CORE_PATH

« More »

JELIX_LIB_UTILS_PATH

« More »

LIB_PATH

« More »

BYTECODE_CACHE_EXISTS

« More »

SERVICES_JSON_STRICT_TYPE

« More »

SERVICES_JSON_LOOSE_TYPE

« More »

_PASSWORD_CRYPT_HASH_FORMAT

« More »

_PASSWORD_CRYPT_PROLOG

« More »

PASSWORD_BCRYPT

« More »

PASSWORD_DEFAULT

« More »

Classes, interfaces and traits

jIAuthDriver

interface for auth drivers

« More »

jIAuthDriver2

interface for auth drivers

« More »

jIAuthDriverClass

interface for classes used with the jAuthDriverClass

« More »

jICacheDriver

Interface for cache drivers

« More »

jICoordPlugin

interface that should implement all coordinator plugins

« More »

jIDebugbarPlugin

interface for plugins for the debugbar

« More »

jIFilteredDatatype

interface for datatypes which can filter value

« More »

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 »

jIHTMLResponsePlugin

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

« More »

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 »

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 »

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 »

jISelector

interface of selector classes

« 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 »

jIUrlEngine

interface for url engines

« More »

jIUrlSignificantHandler

interface for user url handler

« More »

AuthCoordPlugin

« More »

AutoLocaleCoordPlugin

plugin for language auto detection

« More »

basic_significantUrlEngine

basic significant url engine generated url are like module/controller/action and others parameters are in the query

.)

« More »

button_htmlFormWidget

HTML form builder

« More »

captcha_htmlFormWidget

HTML form builder

« More »

check_installZone

a zone to display a default start page with results of the installation check

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

« More »

checkbox_htmlFormWidget

HTML form builder

« More »

checkboxes_htmlFormWidget

HTML form builder

« More »

checkZoneInstallReporter

an HTML reporter for jInstallChecker

« More »

choice_htmlFormWidget

HTML form builder

« More »

classAuthDriver

Driver for a class which implement an authentification

« More »

color_htmlFormWidget

HTML form builder

« More »

date_htmlFormWidget

HTML form builder

« More »

datetime_htmlFormWidget

HTML form builder

« More »

dbaKVDriver

« More »

dbAuthDriver

authentification driver for authentification information stored in a database

« More »

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 »

dbKVDriver

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

« More »

debugbarConfigCompilerPlugin

« 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 »

errorCtrl

class base for controllers

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

« More »

errorCtrl

class base for controllers

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

« More »

errorCtrl

class base for controllers

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

« More »

errorsDebugbarPlugin

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

..

« More »

file2KVDriver

« More »

fileServer

« More »

firebugLogger

« More »

ghostInstallReporter

a reporter which reports.

.. nothing

« More »

group_htmlFormWidget

HTML form builder

« More »

helpCtrl

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 »

historyCoordPlugin

« More »

htmleditor_htmlFormWidget

HTML form builder

« More »

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 »

htmlFormWidget

« More »

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 »

input_htmlFormWidget

HTML form builder

« More »

jAppManager

utilities to manage a jelix application

« More »

jAtom10Info

« More »

jAtom10Item

« More »

jAtom10Reader

« More »

jAuth

This is the main class for authentification process

« More »

jAuthDriverBase

base class for some jAuth drivers

« 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 »

jAuthUserLDS

object which represent a user

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

« More »

jAutoloader

« More »

jBasicErrorHandler

Error handlers for the framework.

Replace the default PHP error handler

« More »

jBinaryData

« More »

jBundle

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

« More »

jCache

Global caching data provided from whatever sources

« 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 »

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 »

jCmdlineCoordinator

The command line version of jCoordinator

This allows us to handle exit code of commands properly

« More »

jCmdLineRequest

a request object for scripts used in a command line

.)

« More »

jCmdUtils

utilities functions for command line

« 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 »

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 »

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 »

jCrypt

Static methods help to encrypt and decrypt string. mCrypt is used if it is installed, else a basic algorithm is used.

« More »

jCssRequest

handle classical request but only to control and produce css content

.)

« More »

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 »

jDaoDbMapper

It allows to create tables corresponding to a dao file.

« 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 »

jDatatype

« More »

jDatatypeBoolean

Datatype Booléen

« 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 »

jDateTime

Utility to manipulate dates and convert date format

« More »

jDb

factory for database connector and other db utilities

« More »

jDbColumn

« More »

jDbConnection

« More »

jDbConstraint

« More »

jDbFieldProperties

Description of a field of a table

« 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 »

jDbPDOConnection

A connection object based on PDO

« More »

jDbPDOConnectionDebug

A connection object based on PDO, for debugging

« More »

jDbPDOResultSet

a resultset based on PDOStatement

« More »

jDbPrimaryKey

used to declare a primary key

« More »

jDbReference

used to declare a foreign key

« More »

jDbResultSet

represent a statement

« More »

jDbSchema

« More »

jDbStatement

« More »

jDbTable

« More »

jDbTools

Provides utilities methods for a database

« More »

jDbUniqueKey

represents a unique key

« More »

jDbWidget

« More »

jDuration

Utility to manipulate durations between two instants

« More »

jEvent

Class which represents an event in the event system

« More »

jEventCompiler

« More »

jEventListener

base class for event listeners

« More »

jException

Jelix Exception

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

« More »

jExceptionForms

exception for jforms

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

« 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 »

jFile

A class helper to read or create files

« More »

jFileLogger

logger storing message into a file

« More »

jFilter

utility class to check values

« 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 »

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 »

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 »

jFormsControlUpload

base class for all jforms control

« More »

jFormsControlUpload2

base class for all jforms control

« More »

jFormsControlWikiEditor

base class for all jforms control

« More »

jformsCtrl

class base for controllers

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

« 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 »

jHttp

To send http request

« More »

jImageModifier

Utility class to manipulate image

« 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 »

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 »

jInstallCheck

check an installation of a jelix application

« More »

jInstaller

main class for the installation

It load all entry points configurations. Each configurations has its own activated modules. jInstaller then construct 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 »

jInstallerApplication

Application configuration reader and manager

« More »

jInstallerBase

base class for installers

« More »

jInstallerComponentBase

a class to install a component (module or plugin)

« More »

jInstallerComponentModule

a class to install a module.

« More »

jInstallerComponentPlugin

EXPERIMENTAL a class to install a module.

« More »

jInstallerEntryPoint

container for entry points properties

« More »

jInstallerException

Installer Exception

It handles installer messages.

« More »

jInstallerMessageProvider

message provider for jInstallCheck and jInstaller

« More »

jInstallerModule

a class to install a module.

« More »

jInstallerModuleInfos

Properties of a module, and values about its installation status

« More »

jInstallerPlugin

a class to install a plugin.

« More »

jJson

object which encode or decode a php variable to or from JSON

« More »

jJsonRpc

object which encode and decode a jsonrpc request and response

« More »

jJsonRpcRequest

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

.)

« More »

jKVDb

main class to access to key-value storage databases

« More »

jKVDriver

« More »

jLocale

static class to get a localized string

« More »

jLog

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

« 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 »

jMailer

jMailer based on PHPMailer - PHP email transport class

« More »

jMailLogger

logger sending message by email

« 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 »

jqueryConfigCompilerPlugin

« More »

jRedis

extends the class Redis from the phpredis extension

« 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 »

jResponseAtom10

Atom 1.0 response

Known limitations : only text in the title, and only name in categories

« More »

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 »

jResponseHtml4

Response class for HTML 4 or XHTML 1.x

« 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 »

jResponseRss20

Rss2.0 response

« More »

jResponseSitemap

Sitemap 0.9 response

« More »

jResponseText

plain Text response

« More »

jResponseXml

XML response generator

« More »

jResponseXMLFeed

Responses for Syndication should inherits from jResponseXMLFeed

« More »

jResponseXmlRpc

xmlrpc response

« More »

jResponseZip

generate a zip content and send it to the browser

« More »

jRSS20Info

« More »

jRSS20Item

« More »

jRSS20Reader

« 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 »

jSelectorCfg

Selector for files stored in the 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 »

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 »

jSelectorUrlCfgSig

a specific selector for the xml files which contains the configuration of the engine

« More »

jSelectorUrlHandler

a specific selector for user url handler

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 »

jSelectorVar

Selector for files stored in the var directory

« More »

jSelectorZone

Zone selector

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

« More »

jServer

Static class providing some utilities to retrieve informations about the server

« More »

jSession

session management class of the jelix core

« More »

jSignificantUrlsCompiler

Compiler for significant url engine

« More »

jSitemapIndex

Content of a sitemap file

« More »

jSitemapUrl

Content of a URL

« 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 »

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 »

jTpl

template engine

« More »

jTplCompiler

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

« More »

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 »

jVersionComparator

class to compare version numbers. it supports the following keywords: "pre", "-dev", "b", "beta", "a", "alpha".

It supports also the "*" wilcard. This wilcard must be the last part of the version number

« More »

jWiki

transform a wiki text into a document (html or else)

« More »

jXMLFeedInfo

« More »

jXMLFeedItem

« More »

jXMLFeedReader

« More »

jXmlRpc

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

« More »

jXmlRpcRequest

handle XML-rpc call. The response has to be a 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 »

ldapAuthDriver

LDAP authentification driver for authentification information stored in LDAP server

« More »

ldsAuthDriver

authentification driver, which communicate with a LDS server LDS = Linbox Directory Server

« More »

legacysyslogLogger

logger storing message into syslog using old api

« More »

listbox_htmlFormWidget

HTML form builder

« More »

localesConfigCompilerPlugin

« More »

memcache22CacheDriver

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

This plugin should be used with a version of the memcache extension, lower than 3.0.1

« 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 »

memcacheKVDriver

« More »

menulist_htmlFormWidget

HTML form builder

« More »

minifyHTMLResponsePlugin

plugin for jResponseHTML, which minify css and js files

« More »

mssqlDaoBuilder

driver for jDaoCompiler

It is called by jDaoCompiler

« More »

mssqlDbConnection

« More »

mssqlDbResultSet

Layer encapsulation resultset mssql.

« More »

mssqlDbSchema

« More »

mssqlDbTable

« More »

mssqlDbTools

Provides utilities methods for a database

« More »

mysqlDaoBuilder

driver for jDaoCompiler

It is called by jDaoCompiler

« More »

mysqlDbConnection

« More »

mysqlDbResultSet

Couche d'encapsulation des resultset mysql.

« More »

mysqlDbSchema

« More »

mysqlDbTable

« More »

mysqlDbTools

Provides utilities methods for a mysql database

« More »

mysqliDaoBuilder

driver for jDaoCompiler

It is called by jDaoCompiler

« More »

mysqliDbConnection

« More »

mysqliDbResultSet

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

« More »

mysqliDbSchema

« More »

mysqliDbStatement

« More »

mysqliDbStmtResultSet

Object to fetch result, wrapping a statement object of mysqli, for installation where mysqlnd is not used

« More »

mysqliDbTable

« More »

mysqliDbTools

Provides utilities methods for a mysql database

« More »

nsautoloaderConfigCompilerPlugin

« More »

ociDaoBuilder

driver for jDaoCompiler

It is called by jDaoCompiler

« More »

ociDbConnection

« More »

ociDbResultSet

represent a statement

« More »

ociDbSchema

« More »

ociDbTable

« More »

ociDbTools

Provides utilities methods for a database

« More »

output_htmlFormWidget

HTML form builder

« More »

pgsqlDaoBuilder

driver for jDaoCompiler

It is called by jDaoCompiler

« More »

pgsqlDbConnection

« More »

pgsqlDbResultSet

represent a statement

« More »

pgsqlDbSchema

« More »

pgsqlDbTable

« More »

pgsqlDbTools

Provides utilities methods for a database

« 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 element or in the configuration

<captcha validator="recaptcha"/>
[forms]
captcha=recpatcha
« More »

redis_extCacheDriver

« More »

redis_extKVDriver

« More »

redis_phpCacheDriver

« More »

redis_phpKVDriver

« More »

redisworkerCtrl

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 »

reset_htmlFormWidget

HTML form builder

« More »

responsesConfigCompilerPlugin

« More »

secret_htmlFormWidget

HTML form builder

« More »

secretconfirm_htmlFormWidget

HTML form builder

« More »

sessionConfigCompilerPlugin

« More »

sessiondataDebugbarPlugin

plugin to show content of a session

« More »

significantUrlEngine

an url engine to parse,analyse and create significant url it needs an urls.xml file in the config directory (see documentation)

« More »

significantUrlInfoParsing

« More »

simpleUrlEngine

simple url engine generated url are "dirty" jelix url, with full of parameter in the query (module, action etc.

.)

« More »

SoapClientDebug

« More »

soapfileLogger

logger storing soap message into several xml files

« More »

soaplogDebugbarPlugin

plugin to show soap message

« More »

sqlite3DaoBuilder

driver for jDaoCompiler

It is called by jDaoCompiler

« More »

sqlite3DbConnection

« More »

sqlite3DbResultSet

Couche d'encapsulation des resultset sqlite.

« More »

sqlite3DbSchema

« More »

sqlite3DbTable

« More »

sqlite3DbTools

tools to manage a sqlite database

« More »

sqliteDaoBuilder

driver for jDaoCompiler

It is called by jDaoCompiler

« More »

sqliteDbConnection

« More »

sqliteDbResultSet

Couche d'encapsulation des resultset sqlite.

« More »

sqliteDbSchema

« More »

sqliteDbTable

« More »

sqliteDbTools

tools to manage a sqlite database

« 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 »

sqlsrvDbSchema

« More »

sqlsrvDbTable

« More »

sqlsrvDbTools

Provides utilities methods for a database

« More »

submit_htmlFormWidget

HTML form builder

« More »

textarea_htmlFormWidget

HTML form builder

« More »

textInstallReporter

simple text reporter

« More »

traceexecCoordPlugin

« 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 »

upload_htmlFormWidget

HTML form builder

« More »

wikieditor_htmlFormWidget

HTML form builder

« More »

wwwCtrl

class base for controllers

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

« More »

zendframeworkCoordPlugin

Jelix plugin to use the Zend Framework library

In order not to load Zend at each action, you need to explicitely activate it !

Use the $pluginParams property of the controller Example : public $pluginParams = array('index' => array('zd.active' => true));

« More »

Classes, interfaces and traits

ParentWidgetInterface

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

« More »

WidgetInterface

Interface for HTML widgets plugins

« More »

RootWidget

« More »

WidgetBase

« More »

Classes, interfaces and traits

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 »

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 »

Classes, interfaces and traits

CaptchaValidatorInterface

Interface for validators for the captcha widget

« More »

ReCaptchaValidator

« More »

SimpleCaptchaValidator

« More »

Classes, interfaces and traits

ApacheCGI

Simulate an Apache with CGI module or fastcgi module + PHP-FPM

« More »

ApacheMod

simulate a server configured with apache + mod_php

« More »

FakeServerConf

base class for servers

« More »

Classes, interfaces and traits

ConfigCompilerPluginInterface

interface for plugins of jConfigCompiler

« More »

Classes, interfaces and traits

VersionRangeOperatorInterface

« More »

Parser

« More »

Version

Embed version informations.

« More »

VersionComparator

class to compare version numbers. it supports the following keywords: "pre", "-dev", "b", "beta", "a", "alpha".

It supports also the "*" wilcard. This wilcard must be the last part of the version number.

« More »

versionRangeBinaryOperator

Represents a binary operator (AND or OR) in a version range expression.

« More »

versionRangeTrueOperator

« More »

versionRangeUnaryOperator

Represents an unary operator (>,<,=,!=,<=,>=,~) in a version range expression.

« More »