Vae Soli! - Framework PHP - Documentation en ligne

Niouzes

< Janvier 2021 >
Lu	Ma	Me	Je	Ve	Sa	Di
				1	2	3
4	5	6	7	8	9	10
11	12	13	14	15	16	17
18	19	20	21	22	23	24
25	26	27	28	29	30	31

Citation

Attention

The documentation is incomplete. The Vae Soli! team works hard to make it as exhaustive as possible with tons of useful examples and easy to understand explanations.

On top of that, we have decided to use our own tool to generate the documentation you read. This also takes time to fine-tune. Our goal is have better documentation, easier to read, easier to use, completely integrated with our site.

Even though NOT finalized, you can now link back to our documentation pages as we have decided once and for all about the structure of our documents and where they all reside on our server.

Thank you very much
The Vae Soli! team.

2020-01-18 à 01:24:43

LSForm.class.php

Generated by The Vae Soli! Documentor: Guide v. 1.3.0018 on 09-06-2014 09:09:29 (DD-MM-YYYY HH:mm:SS). This documentation is built with Vae Soli! functions and classes!

File Properties

C:\websites\vaesoli.org\www\httpdocs/vaesoli/include/LSForm.class.phpC:\websites\vaesoli.org\www\httpdocs\vaesoli\include\LSForm.class.phpapplication/force-downloadC:\websites\vaesoli.org\www\httpdocs\vaesoli\include105553 bytes03/08/2013 23:27:5204/06/2014 05:39:5204/06/2014 05:39:52

Assertions count: 0

Assertions successful: 0

Assertion failures: 0

LSForm.class.php exceeds 51200 bytes. We suggest this file got broken down in smaller chunks!

LSForm.class.php contains 1694 lines of code, which exceeds the suggested limit of 1024 lines. We suggest this file got broken down in smaller chunks!

File type:classes

Purpose:Form object

Author:Pat Y. Boens

Company:Lato Sensu Management
Rue Bois des Mazuis, 47
5070 Vitrival
Belgium (BE)
http://www.latosensu.be
Vae Soli! : http://www.vaesoli.org

Creation date:09/10/2010 - 11:37

Modification date:04/06/2014 - 05:39

License:http://creativecommons.org/licenses/by-sa/2.0/be/
To obtain detailed information about the license terms, please head to the full license text available in the LSCopyright.php file

Change History:

[ + ]

Manifest Constants

LS_FORM_CLASS_PWH: Define "LS" forms (Pat Was Here)

VAESOLI_PATH: Define the path where Vae Soli! is installed

VAESOLI_PLUGINS: Define the path where plugins are located

Sources required

LSV.functions.php: Vae Soli! Foundation functions

LSLabel.class.php: <label> class

LSInput.class.php: <input> class

LSDataEnvironment.class.php: Data environment class

LSFieldset.class.php: Data environment class

Classes

`LSForm` extends `LSContainer`Generic services to create HTML forms

Notes

Note: Genome

A special note about the genome:

The genome of a form makes it possible to activate and annihilate constituents of the form (say input zones, labels, divisions, and the likes). If the constituents do not have the proper genes, they are annihilated (not expressed).

For as smart as it sounds, the implementation of the genome in a form is actually technically straightforward. Genes are coded as cells in an array. Genome is a string. If a gene (a value stored in the array) is found in the genome (the string), the component is rendered. Period! Quite simple as a matter of fact!

Despite this inner simplicity, the genome can achieve great results such as having a form being expressed for PHONES or for TABLETS. A simple variation of the genome (a string) dictates how the form must be rendered. The variation itself can either be introduced manually or programmatically which brings enormous additional value to the mechanism.

Properties

Name	Visibility	Type	Description
`$HasFile`	public	boolean	Indicates whether the form is supposed to handle files (can be set manually; otherwise, it is treated automatically by examining all controls)
`$NoECMA`	public	bool	Indicates whether we need to have the ECMA scripts be generated.`false` by default (= ECMA scripts generated)
`$NoValidate`	public	bool	Novalidate attribute of the form (HTML5)
`$PostRenderFnc`	public	string	Callback to play after rendering of the form
`$PreRenderFnc`	public	string	Callback to play before rendering of the form
`$WithPreviousValues`	public	bool	Indicates if previous control values must be saved in the form
`$WithTabIndex`	public	bool	Determines whether tabindex must be used or not. `true` by default
`$aECMA`	public	array	Internal array of scripts to be generated by Vae Soli! for entry checks and form validation
`$aObjects`	public	array	Array of objects that are contained within the form
`$iTabIndex`	public	int	`tabindex` in the form (use the `$iTabIndex` property of the current page (`LSPage`) to hold a precise count between forms)
`$oDataEnvironment`	public	LSDataEnvironment	A `LSDataEnvironment` object. Warning: not really used at this stage (04-09-13 07:46)
`$oPage`	public	LSPage	The page in which this form must be rendered. `null` by default
`$szAction`	public	string	Action fo the form (usually a URL or `self` to submit the form to the current script)
`$szAfterword`	public	string	Text that must follow the rendering of the form
`$szAutocomplete`	public	string	Enumerated type (on, off). The off state indicates that by default, form controls in the form will have their resulting autocompletion state set to off; the on state indicates that by default, form controls in the form will have their resulting autocompletion state set to automatic.
`$szForeword`	public	string	Text that must precede the rendering of the form
`$szMethod`	public	string	HTTP method to be invoked when the form is to be submitted
`$szMode`	public	string	Mode the form is entered. Can be `'edit'` (modification of an existing record) or `'add'` (add a new record). `'add'` by default
`$szTarget`	public	string	Enumerated type (_blank, _self, _parent, _top). Specifies where to display the response that is received after submitting the form
`$szType`	public	string	Container type. `'form'` by default
`$szVersion`	public	string	Form version. `'Web form 1.0'` by default. Set to `'Web form 2.0'` to benefit from HTML5 controls

Parent Properties (`LSContainer`)

Name	Type
`Databag`	boolean
`IsHTML5`	boolean
`IsMandatory`	boolean
`IsReadonly`	boolean
`IsVisible`	boolean
`WithDataBag`	boolean
`aGenes`	NULL
`aHTML5Match`	array
`iHeight`	NULL
`iIndentLevel`	integer
`iIndentSpaces`	integer
`iInstance`	integer
`iInstances`	integer
`iLeft`	NULL
`iLevel`	integer
`iMaxLength`	NULL
`iSize`	NULL
`iTop`	NULL
`iWidth`	NULL
`oContainer`	NULL
`szBrowser`	string
`szClass`	NULL
`szComment`	NULL
`szDataBag`	string
`szDesc`	NULL
`szErrorMsg`	string
`szGUID`	NULL
`szGenome`	NULL
`szID`	NULL
`szInnerLeader`	NULL
`szInnerTrailer`	NULL
`szLang`	string
`szLeader`	NULL
`szName`	NULL
`szOnBlur`	NULL
`szOnChange`	NULL
`szOnClick`	NULL
`szOnFocus`	NULL
`szOnKeyDown`	NULL
`szOnKeyPress`	NULL
`szOnKeyUp`	NULL
`szOnLoad`	NULL
`szOnMouseOver`	NULL
`szOnSelect`	NULL
`szOnSubmit`	NULL
`szOnUnLoad`	NULL
`szPixels`	string
`szPlatform`	string
`szStyle`	NULL
`szText`	NULL
`szTitle`	NULL
`szTooltip`	NULL
`szTrailer`	NULL
`szType`	NULL
`szValue`	NULL

Methods

__construct(): Class constructor. (0 - 0)
__get(): Magic method. Called when trying to access a property which seems to be not accessible (0 - 0)
AddObject(): Adds an object to the container (0 - 0)
BuildAutocomplete(): Builds the autocomplete attribute of a form (0 - 0)
BuildNoValidate(): Builds the 'novalidate' attribute of a form (0 - 0)
BuildTarget(): Builds the target attribute of a form (0 - 0)
GenerateECMA(): Generates the ECMAScript of the form (0 - 0)
Render(): Generates the HTML code of the form (0 - 0)
RenderECMA(): Generates all the ECMA scripts that are needed by the form. If the same validation code is needed by several LSInput controls, the code is rendered only once. (0 - 0)

`__construct()`: Class constructor.

[ back to method list ]

Syntax

__construct( $szID,$szAction,$szClass,$szMethod,$szVersion )

Parameters

Name	Type	Description
`$szID`	string	ID of the form. Optional.
`$szAction`	string	Action of the form. Optional.
`$szClass`	string	CSS Class of the form. Optional.
`$szMethod`	string	Post or Get. Optional
`$szVersion`	string	Version of the form. Optional. $oPage (LSPage) The page in which this form must be rendered. Optional.

Parameters Warning

__construct() uses 5 parameters whereas the suggested limit is 3.

Return

(void)

Unit Testing

WARNING: No Unit Testing found. Please provide assertions with assertion constructs ({*assert ... *}) or with GuideAssert() function calls in exec constructs ({*exec LSUnitTesting::assert(...); *}).

`__get()`: Magic method. Called when trying to access a property which seems to be not accessible

[ back to method list ]

Syntax

__get()

Parameters

None

Return

(mixed) property we look for (can also be an object). null is returned when $szName does not correspond to any known control of the current form

Unit Testing

Syntax

AddObject( $oObj )

Parameters

Name	Type	Description
`$oObj`	mixed	Can be a `LSInput`, `LSLabel`, `LSFieldset`, `LSTag` (supported `LSTag` types :'p','div', `'datalist'` or `'hr'`) or `LSCursor` object. In the case of a `LSCursor` object, it is actually added to the `$oDataEnvironment` member of the form (`LSDataEnvironment`)

Return

(void)

Unit Testing

PROTECTED `BuildAutocomplete()`: Builds the autocomplete attribute of a form

[ back to method list ]

Syntax

BuildAutocomplete()

Parameters

None

Return

(string) The autocomplete attribute of the form

Unit Testing

PROTECTED `BuildNoValidate()`: Builds the `'novalidate'` attribute of a form

[ back to method list ]

Syntax

BuildNoValidate()

Parameters

None

Return

(string) The novalidate attribute of the form

Unit Testing

PROTECTED `BuildTarget()`: Builds the target attribute of a form

[ back to method list ]

Syntax

BuildTarget()

Parameters

None

Return

(string) The target attribute of the form

Unit Testing

PROTECTED `GenerateECMA()`: Generates the ECMAScript of the form

[ back to method list ]

Syntax

GenerateECMA( $aFuncs,$szType )

Parameters

Name	Type	Description
`$aFuncs`	array	An array of function signatures. Updated upon return. By reference.
`$szType`	string	Type of ECMAScript to generate: ltrim, rtrim or trim.

Return

(string) The ECMA script or empty ('') if $szType is not supported.

Unit Testing

`Render()`: Generates the HTML code of the form

[ back to method list ]

Modified: 05/09/2013 Genome taken into account

Syntax

Render( $oContainer )

Parameters

Name	Type	Description
`$oContainer`	LSControl	The container of the current control. Optional. `null` by default

Return

(void) No return is provided

Unit Testing

`RenderECMA()`: Generates all the ECMA scripts that are needed by the form. If the same validation code is needed by several LSInput controls, the code is rendered only once.

[ back to method list ]

Syntax

RenderECMA()

Parameters

None

Return

(string) The ECMA script code that has been generated (javascript)

Unit Testing

Précédent Suivant

D:\websites\vaesoli.org\www\httpdocs\vaesoli\include\LSGeorama.class.php:3672:
object(LogicException)[100]
  protected 'message' => string 'Class LSContentsCookieUsage could not be loaded' (length=47)
  private 'string' (Exception) => string '' (length=0)
  protected 'code' => int 0
  protected 'file' => string 'D:\websites\vaesoli.org\www\httpdocs\vaesoli\include\LSGeorama.class.php' (length=72)
  protected 'line' => int 3601
  private 'trace' (Exception) => 
    array (size=16)
      0 => 
        array (size=4)
          'file' => string 'D:\websites\vaesoli.org\www\httpdocs\vaesoli\include\LSGeorama.class.php' (length=72)
          'line' => int 3601
          'function' => string 'spl_autoload' (length=12)
          'args' => 
            array (size=1)
              ...
      1 => 
        array (size=6)
          'file' => string 'D:\websites\vaesoli.org\www\httpdocs\vaesoli\include\LSGeorama.class.php' (length=72)
          'line' => int 3276
          'function' => string 'EmergeIsland' (length=12)
          'class' => string 'LSGeorama' (length=9)
          'type' => string '->' (length=2)
          'args' => 
            array (size=6)
              ...
      2 => 
        array (size=6)
          'file' => string 'D:\websites\vaesoli.org\www\httpdocs\vaesoli\include\LSGeorama.class.php' (length=72)
          'line' => int 2770
          'function' => string 'EmergeIslands' (length=13)
          'class' => string 'LSGeorama' (length=9)
          'type' => string '->' (length=2)
          'args' => 
            array (size=5)
              ...
      3 => 
        array (size=6)
          'file' => string 'D:\websites\vaesoli.org\www\httpdocs\vaesoli\include\LSGeorama.class.php' (length=72)
          'line' => int 3008
          'function' => string 'EmergeArchipelagosFromParent' (length=28)
          'class' => string 'LSGeorama' (length=9)
          'type' => string '->' (length=2)
          'args' => 
            array (size=3)
              ...
      4 => 
        array (size=6)
          'file' => string 'D:\websites\vaesoli.org\www\httpdocs\vaesoli\include\LSPage.class.php' (length=69)
          'line' => int 5928
          'function' => string 'EmergeArchipelagos' (length=18)
          'class' => string 'LSGeorama' (length=9)
          'type' => string '->' (length=2)
          'args' => 
            array (size=2)
              ...
      5 => 
        array (size=6)
          'file' => string 'D:\websites\vaesoli.org\www\httpdocs\vaesoli\include\LSPage.class.php' (length=69)
          'line' => int 5940
          'function' => string 'Land' (length=4)
          'class' => string 'LSPage' (length=6)
          'type' => string '->' (length=2)
          'args' => 
            array (size=1)
              ...
      6 => 
        array (size=6)
          'file' => string 'D:\websites\vaesoli.org\www\httpdocs\template\vaesoli.html' (length=58)
          'line' => int 135
          'function' => string 'EmergeArchipelagos' (length=18)
          'class' => string 'LSPage' (length=6)
          'type' => string '->' (length=2)
          'args' => 
            array (size=1)
              ...
      7 => 
        array (size=4)
          'file' => string 'D:\websites\vaesoli.org\www\httpdocs\vaesoli\include\LSPage.class.php' (length=69)
          'line' => int 6110
          'args' => 
            array (size=1)
              ...
          'function' => string 'include' (length=7)
      8 => 
        array (size=6)
          'file' => string 'D:\websites\vaesoli.org\www\httpdocs\vaesoli\include\LSPage.class.php' (length=69)
          'line' => int 6053
          'function' => string 'XInclude' (length=8)
          'class' => string 'LSPage' (length=6)
          'type' => string '->' (length=2)
          'args' => 
            array (size=1)
              ...
      9 => 
        array (size=6)
          'file' => string 'D:\websites\vaesoli.org\www\httpdocs\vaesoli\include\LSPage.class.php' (length=69)
          'line' => int 5828
          'function' => string 'IncludeTemplate' (length=15)
          'class' => string 'LSPage' (length=6)
          'type' => string '->' (length=2)
          'args' => 
            array (size=1)
              ...
      10 => 
        array (size=6)
          'file' => string 'D:\websites\vaesoli.org\www\httpdocs\vaesoli\include\LSPage.class.php' (length=69)
          'line' => int 5580
          'function' => string 'UseTemplate' (length=11)
          'class' => string 'LSPage' (length=6)
          'type' => string '->' (length=2)
          'args' => 
            array (size=1)
              ...
      11 => 
        array (size=6)
          'file' => string 'D:\websites\vaesoli.org\www\httpdocs\vaesoli\include\LSPage.class.php' (length=69)
          'line' => int 3282
          'function' => string 'RenderXML' (length=9)
          'class' => string 'LSPage' (length=6)
          'type' => string '->' (length=2)
          'args' => 
            array (size=1)
              ...
      12 => 
        array (size=6)
          'file' => string 'D:\websites\vaesoli.org\www\httpdocs\vaesoli\include\LSPage.class.php' (length=69)
          'line' => int 2082
          'function' => string 'StartPage' (length=9)
          'class' => string 'LSPage' (length=6)
          'type' => string '->' (length=2)
          'args' => 
            array (size=1)
              ...
      13 => 
        array (size=6)
          'file' => string 'D:\websites\vaesoli.org\www\httpdocs\vaesoli\include\LSApplication.class.php' (length=76)
          'line' => int 814
          'function' => string 'Render' (length=6)
          'class' => string 'LSPage' (length=6)
          'type' => string '->' (length=2)
          'args' => 
            array (size=0)
              ...
      14 => 
        array (size=6)
          'file' => string 'D:\websites\vaesoli.org\www\httpdocs\master.php' (length=47)
          'line' => int 8
          'function' => string 'Run' (length=3)
          'class' => string 'LSApplication' (length=13)
          'type' => string '->' (length=2)
          'args' => 
            array (size=0)
              ...
      15 => 
        array (size=4)
          'file' => string 'D:\websites\vaesoli.org\www\httpdocs\documentation\documentation-vaesoli-code-source.php' (length=88)
          'line' => int 1
          'args' => 
            array (size=1)
              ...
          'function' => string 'include' (length=7)
  private 'previous' (Exception) => null
  public 'xdebug_message' => string '<tr><th align='left' bgcolor='#f57900' colspan="5"><span style='background-color: #cc0000; color: #fce94f; font-size: x-large;'>( ! )</span> LogicException: Class LSContentsCookieUsage could not be loaded in D:\websites\vaesoli.org\www\httpdocs\vaesoli\include\LSGeorama.class.php on line <i>3601</i></th></tr>
<tr><th align='left' bgcolor='#e9b96e' colspan='5'>Call Stack</th></tr>
<tr><th align='center' bgcolor='#eeeeec'>#</th><th align='left' bgcolor='#eeeeec'>Time</th><th align='left' bgcolor='#eeeeec'>Mem'... (length=6627)

Documentation framework web (PHP) Vae Soli!

Niouzes

Citation

Attention

Table Of Contents

LSForm.class.php

File Properties

Compliance

Early Warning

File Header

Manifest Constants

Sources required

Classes

LSForm extends LSContainerGeneric services to create HTML forms

Notes

Note: Genome

Properties

Parent Properties (LSContainer)

Methods

__construct(): Class constructor.

Syntax

Parameters

Parameters Warning

Return

Unit Testing

__get(): Magic method. Called when trying to access a property which seems to be not accessible

Syntax

Parameters

Return

Unit Testing

See Also

AddObject(): Adds an object to the container

Syntax

Parameters

Return

Unit Testing

PROTECTED BuildAutocomplete(): Builds the autocomplete attribute of a form

Syntax

Parameters

Return

Unit Testing

PROTECTED BuildNoValidate(): Builds the 'novalidate' attribute of a form

Syntax

Parameters

Return

Unit Testing

PROTECTED BuildTarget(): Builds the target attribute of a form

Syntax

Parameters

Return

Unit Testing

PROTECTED GenerateECMA(): Generates the ECMAScript of the form

Syntax

Parameters

Return

Unit Testing

Render(): Generates the HTML code of the form

Syntax

Parameters

Return

Unit Testing

RenderECMA(): Generates all the ECMA scripts that are needed by the form. If the same validation code is needed by several LSInput controls, the code is rendered only once.

Syntax

Parameters

Return

Unit Testing

`LSForm` extends `LSContainer`Generic services to create HTML forms

Parent Properties (`LSContainer`)

`__construct()`: Class constructor.

`__get()`: Magic method. Called when trying to access a property which seems to be not accessible

`AddObject()`: Adds an object to the container

PROTECTED `BuildAutocomplete()`: Builds the autocomplete attribute of a form

PROTECTED `BuildNoValidate()`: Builds the `'novalidate'` attribute of a form

PROTECTED `BuildTarget()`: Builds the target attribute of a form

PROTECTED `GenerateECMA()`: Generates the ECMAScript of the form

`Render()`: Generates the HTML code of the form

`RenderECMA()`: Generates all the ECMA scripts that are needed by the form. If the same validation code is needed by several LSInput controls, the code is rendered only once.