Joomla! Documentation - User contributions [en]

Loading extra language files

2012-04-28T10:55:43Z

Deldadam: Corrected default value for $base_dir

==Overview==
Many times, you need to load extra language files in your code. An example is loading your component's language file into a module for that component. This example loads a single language file, and appends the results to the existing language strings. Following is the code that helps you do this

==PHP Code==
<source lang="PHP">
$lang =& JFactory::getLanguage();
$extension = 'com_helloworld';
$base_dir = JPATH_SITE;
$language_tag = 'en-GB';
$reload = true;
$lang->load($extension, $base_dir, $language_tag, $reload);
</source>

Following is an explanation of the variables

1. $extension - This is the extension whose language file will be loaded

2. $base_dir - Should be JPATH_SITE in case you have language files stored elsewhere. Defaults to JPATH_BASE. [optional]

3. $language_tag - This is the locale string. Language files for this locale will be loaded. Defaults to the one set in backend. [optional]

4. $reload - Flag that will force a language to be reloaded if set to true. [optional]

<noinclude>[[Category:Development]][[Category:Languages]]</noinclude>

Loading extra language files

2012-04-28T10:53:59Z

Deldadam: Completed according Joomla! Platform 11.4

==Overview==
Many times, you need to load extra language files in your code. An example is loading your component's language file into a module for that component. This example loads a single language file, and appends the results to the existing language strings. Following is the code that helps you do this

==PHP Code==
<source lang="PHP">
$lang =& JFactory::getLanguage();
$extension = 'com_helloworld';
$base_dir = JPATH_SITE;
$language_tag = 'en-GB';
$reload = true;
$lang->load($extension, $base_dir, $language_tag, $reload);
</source>

Following is an explanation of the variables

1. $extension - This is the extension whose language file will be loaded

2. $base_dir - Should be JPATH_SITE in case you have language files stored elsewhere. Defaults to JPATH_SITE [optional]

3. $language_tag - This is the locale string. Language files for this locale will be loaded. Defaults to the one set in backend. [optional]

4. $reload - Flag that will force a language to be reloaded if set to true. [optional]

<noinclude>[[Category:Development]][[Category:Languages]]</noinclude>

Checkbox form field type

2012-03-25T21:40:52Z

Deldadam: Example corrected as well

The '''checkbox''' form field type provides a single checkbox. If the parameter has a saved value this is selected when the page is first loaded. If not, the default value (if any) is selected.

* '''type''' (mandatory) must be checkbox
* '''name''' (mandatory) is the unique name of the parameter.
* '''label''' (mandatory) (translatable) is the descriptive title of the field.
* '''value''' (optional) is the default value of the checkbox. If exist the checkbox will be checked by default.
* '''description''' (optional) (translatable) is text that will be shown as a tooltip when the user moves the mouse over the label.
* '''class''' (optional) is a CSS class name for the HTML form field. If omitted this will default to 'inputbox'.

Example XML parameter definition:
<source lang="xml"><field name="mycheckbox" type="checkbox" label="Show title" description="" value="1" /></source>
<noinclude>
=== See also ===
* [[Standard form field types|List of standard form field types]]
[[Category:Standard form field types]]</noinclude>

Checkbox form field type

2012-03-25T21:40:11Z

Deldadam: There is no drop-down box screen element

The '''checkbox''' form field type provides a single checkbox. If the parameter has a saved value this is selected when the page is first loaded. If not, the default value (if any) is selected.

* '''type''' (mandatory) must be checkbox
* '''name''' (mandatory) is the unique name of the parameter.
* '''label''' (mandatory) (translatable) is the descriptive title of the field.
* '''value''' (optional) is the default value of the checkbox. If exist the checkbox will be checked by default.
* '''description''' (optional) (translatable) is text that will be shown as a tooltip when the user moves the mouse over the label.
* '''class''' (optional) is a CSS class name for the HTML form field. If omitted this will default to 'inputbox'.

Example XML parameter definition:
<source lang="xml"><field name="mycheckbox" type="checkbox" label="Show title" description="" default="0" /></source>
<noinclude>
=== See also ===
* [[Standard form field types|List of standard form field types]]
[[Category:Standard form field types]]</noinclude>

Checkbox form field type

2012-03-25T21:11:09Z

Deldadam:

The '''checkbox''' form field type provides a single checkbox. If the parameter has a saved value this is selected when the page is first loaded. If not, the default value (if any) is selected.

* '''type''' (mandatory) must be checkbox
* '''name''' (mandatory) is the unique name of the parameter.
* '''label''' (mandatory) (translatable) is the descriptive title of the field.
* '''value''' (optional) is the default value of the checkbox. If exist the checkbox will be checked by default.
* '''description''' (optional) (translatable) is text that will be shown as a tooltip when the user moves the mouse over the drop-down box.
* '''class''' (optional) is a CSS class name for the HTML form field. If omitted this will default to 'inputbox'.

Example XML parameter definition:
<source lang="xml"><field name="mycheckbox" type="checkbox" label="Show title" description="" default="0" /></source>
<noinclude>
=== See also ===
* [[Standard form field types|List of standard form field types]]
[[Category:Standard form field types]]</noinclude>

J1.5:Textarea parameter type

2012-03-25T19:29:26Z

Deldadam: Default value of textarea parameter type is not translatable

[[Image:Params.textarea.jpg|right]]

{{Ambox|type=notice|text=[[Parameter|Parameters]] have been superseded by [[Form field|form fields]] in Joomla! 1.6. You may want to use the corresponding [[Textarea form field type]].}}

The '''textarea''' parameter type provides a text area for entry of multi-line text. If the parameter has a value saved, this value is displayed when the page is first loaded. If not, the default value (if any) is selected.

* '''type''' (mandatory) must be ''textarea''.
* '''name''' (mandatory) is the unique name of the parameter.
* '''label''' (mandatory) (translatable) is the descriptive title of the field.
* '''rows''' (mandatory) is the height of the visible text area in lines. If omitted the width is determined by the browser. The value of rows does not limit the number of lines that may be entered.
* '''cols''' (mandatory) is the width of the visible text area in characters. If omitted the width is determined by the browser. The value of cols does not limit the number of characters that may be entered.
* '''default''' (optional) (not translatable) is the default value.
* '''description''' (optional) (translatable) is text that will be shown as a tooltip when the user moves the mouse over the drop-down box.
* '''class''' (optional) is a CSS class name for the HTML form field. If omitted this will default to 'text_area'.

Example XML parameter definition:
<source lang="xml"><param name="mytextarea" type="textarea" default="default" label="Enter some text" description="" rows="10" cols="5" /></source>
<noinclude>
=== Tips ===
* If you need to line break just encode <code><br /></code> in the XML config file like this: <code>&lt;br /&gt;</code>
=== See also ===
* [[Text parameter type]]
* [[Standard parameter types|List of standard parameter types]]
[[Category:Standard parameter types]]</noinclude>

J1.5:Text parameter type

2012-03-25T19:29:01Z

Deldadam: Default value of text parameter type is not translatable

[[Image:Params.text.jpg|right]]

{{Ambox|type=notice|text=[[Parameter|Parameters]] have been superseded by [[Form field|form fields]] in Joomla! 1.6. You may want to use the corresponding [[Text form field type]].}}

The '''text''' parameter type provides a text box for data entry. If the parameter has a value saved, this value is displayed when the page is first loaded. If not, the default value (if any) is selected.

* '''type''' (mandatory) must be ''text''.
* '''name''' (mandatory) is the unique name of the parameter.
* '''label''' (mandatory) (translatable) is the descriptive title of the field.
* '''size''' (optional) is the width of the text box in characters. If omitted the width is determined by the browser. The value of size does not limit the number of characters that may be entered.
* '''default''' (optional) (not translatable) is the default value.
* '''description''' (optional) (translatable) is text that will be shown as a tooltip when the user moves the mouse over the drop-down box.
* '''class''' (optional) is a CSS class name for the HTML form field. If omitted this will default to 'text_area'.

Example XML parameter definition:
<source lang="xml"><param name="mytextvalue" type="text" default="Some text" label="Enter some text" description="" size="10" /></source>
<noinclude>
=== See also ===
* [[Textarea parameter type]]
* [[Standard parameter types|List of standard parameter types]]
[[Category:Standard parameter types]]</noinclude>

Textarea form field type

2012-03-25T19:22:48Z

Deldadam: Default value of Textarea field type is currently not translatable

[[Image:Params.textarea.jpg|right]]

{{Ambox|type=notice|text=In Joomla! 1.5, [[Form field|form fields]] were [[Parameter|parameters]]. For that version, you may want to use the corresponding [[Textarea parameter type]].}}

The '''textarea''' form field type provides a text area for entry of multi-line text. If the field has a value saved, this value is displayed when the page is first loaded. If not, the default value (if any) is selected.

* '''type''' (mandatory) must be ''textarea''.
* '''name''' (mandatory) is the unique name of the field.
* '''label''' (mandatory) (translatable) is the descriptive title of the field.
* '''rows''' (mandatory) is the height of the visible text area in lines. If omitted the width is determined by the browser. The value of rows does not limit the number of lines that may be entered.
* '''cols''' (mandatory) is the width of the visible text area in characters. If omitted the width is determined by the browser. The value of cols does not limit the number of characters that may be entered.
* '''default''' (optional) (not translatable) is the default value.
* '''description''' (optional) (translatable) is text that will be shown as a tooltip when the user moves the mouse over the drop-down box.
* '''class''' (optional) is a CSS class name for the HTML form field. If omitted this will default to 'text_area'.
* '''filter''' (optional) allow the system to save certain html tags or raw data.

Example XML field definition:
<source lang="xml"><field name="mytextarea" type="textarea" default="default" label="Enter some text" description="" rows="10" cols="5" /></source>
Use the raw filter to ensure that html code is preserved when the form is processed:
<source lang="xml"><field name="mytextarea" type="textarea" default="default" label="Enter some html" description="" rows="10" cols="5" filter="raw"/></source>
<noinclude>
=== Tips ===
* If you need to line break just encode <code><br /></code> in the XML config file like this: <code>&lt;br /&gt;</code>
* If you need a new line character in your default value, add <code>&#13;&#10;</code> to the default parameter

=== See also ===
* [[Text form field type]]
* [[Standard form field types|List of standard form field types]]
[[Category:Standard form field types]]</noinclude>

Text form field type

2012-03-25T19:21:57Z

Deldadam: Default value of text field param is currently _not_ translatable

[[Image:Params.text.jpg|right]]

{{Ambox|type=notice|text=In Joomla! 1.5, [[Form field|form fields]] were [[Parameter|parameters]]. For that version, you may want to use the corresponding [[Text parameter type]].}}

The '''text''' form field type provides a text box for data entry. If the field has a value saved, this value is displayed when the page is first loaded. If not, the default value (if any) is selected.

* '''type''' (mandatory) must be ''text''.
* '''name''' (mandatory) is the unique name of the field.
* '''label''' (mandatory) (translatable) is the descriptive title of the field.
* '''size''' (optional) is the width of the text box in characters. If omitted the width is determined by the browser. The value of size does not limit the number of characters that may be entered.
* '''maxlength''' (optional) limits the number of characters that may be entered.
* '''default''' (optional) (not translatable) is the default value.
* '''description''' (optional) (translatable) is text that will be shown as a tooltip when the user moves the mouse over the drop-down box.
* '''class''' (optional) is a CSS class name for the HTML form field. If omitted this will default to 'text_area'.
* '''readonly''' (optional)
* '''disabled''' (optional)
* '''filter''' (optional) allow the system to save certain html tags or raw data.

Example XML field definition:
<source lang="xml"><field name="mytextvalue" type="text" default="Some text" label="Enter some text" description="" size="10" /></source>

Use the integer filter to ensure that letters types get stripped when the form is processed.
<source lang="xml"><field name="myintvalue" type="text" default="8" label="Enter some text" description="Enter some description" filter="integer" /></source>

Use the raw filter to ensure that html code is preserved when the form is processed.
<source lang="xml"><field name="myhtmlvalue" type="text" default="" label="Enter some text" description="Enter some description" filter="raw" /></source>
<noinclude>
=== See also ===
* [[Textarea form field type]]
* [[Standard form field types|List of standard form field types]]
[[Category:Standard form field types]]</noinclude>