 |
Joomla CMS
2.5.24 (avec JPlatform 11.4 inclus)
Documentation des API du CMS Joomla en version 2.5 et du framework Joomla Platform intégré
|
|
Joomla CMS
2.5.24 (avec JPlatform 11.4 inclus)
Documentation des API du CMS Joomla en version 2.5 et du framework Joomla Platform intégré
|
Access
Class that handles all access authorisation routines.
Access
JAccessRule class.
Access
Deprecated class placeholder. You should use JAccessRule instead.
Access
JAccessRules class.
Access
Deprecated class placeholder. You should use JAccessRules instead.
Access
Application
Base class for a Joomla! application.
Acts as a Factory class for application specific objects and provides many supporting API functions. Derived clases should supply the route(), dispatch() and render() functions.
Application
Joomla Platform Base Application Class
Application
JCategories Class.
Application
Helper class to load Categorytree
Application
Backward Compatability Stub for JApplicationDaemon
Application
Base class for a Joomla! command line application.
Application
Deprecated class placeholder. You should use JApplicationCli instead.
Application
Base class for a Joomla Controller
Controller (Controllers are where you put all the actual code.) Provides basic functionality, such as rendering views (aka displaying templates).
Application
Base class for a Joomla Administrator Controller
Controller (controllers are where you put all the actual code) Provides basic functionality, such as rendering views (aka displaying templates).
Application
Controller tailored to suit most form-based admin operations.
Application
Component helper class
Application
Base class for a Joomla Model
Acts as a Factory class for application specific objects and provides many supporting API functions.
Application
Prototype admin model.
Application
Prototype form model.
Application
Prototype item model.
Application
Model class for handling lists of items.
Application
Base class for a Joomla View
Class holding methods for displaying presentation data.
Application
Class to turn JCli applications into daemons. It requires CLI and PCNTL support built into PHP.
Application
Application helper functions
Application
Joomla! Input CLI Class
Application
Joomla! Input Cookie Class
Application
Joomla! Input Files Class
Application
Joomla! Input Base Class
This is an abstracted input class used to manage retrieving data from the application environment.
Application
integer getInt() getInt($name, $default) Get a signed integer. integer getUint() getUint($name, $default) Get an unsigned integer. float getFloat() getFloat($name, $default) Get a floating-point number. boolean getBool() getBool($name, $default) Get a boolean. string getWord() getWord($name, $default) string getAlnum() getAlnum($name, $default) string getCmd() getCmd($name, $default) string getBase64() getBase64($name, $default) string getString() getString($name, $default) string getHtml() getHtml($name, $default) string getPath() getPath($name, $default) string getUsername() getUsername($name, $default)
JMenu class
Application
Module helper class
Application
Class to maintain a pathway.
The user's navigated path within the application.
Application
Class to create and parse routes
Application
Class to model a Web Client.
Application
Base class for a Joomla! Web application.
Application
Deprecated class placeholder. You should use JApplicationWeb instead.
Application
Base
Adapter Class Retains common adapter pattern functions Class harvested from joomla.installer.installer
Base
Adapter Instance Class
Base
Tree Node Class.
Base
This class allows for simple but smart objects with get and set methods and an internal error handler.
Base
Abstract observable class to implement the observer design pattern
Base
Abstract observer class to implement the observer design pattern
Base
Tree Class.
Base
Cache
Joomla! Cache base object
Cache
Joomla! Cache callback type object
Cache
Joomla Cache output type object
Cache
Joomla! Cache page type object
Cache
Joomla! Cache view type object
Cache
Public cache handler
Cache
APC cache storage handler
Cache
Cache lite storage handler
Cache
eAccelerator cache storage handler
Cache 11.1 File cache storage handler Cache 11.1 Cache storage helper functions. Cache 11.1 Memcache cache storage handler Cache http://php.net/manual/en/book.memcache.php 11.1 Memcached cache storage handler Cache http://php.net/manual/en/book.memcached.php 12.1 WINCACHE cache storage handler Cache http://php.net/manual/en/book.wincache.php 11.1 XCache cache storage handler Cache http://xcache.lighttpd.net/ 11.1 Abstract cache storage handler Cache 11.1 Client Copyright (C) 2005 - 2014 Open Source Matters, Inc. All rights reserved. GNU General Public License version 2 or later; see LICENSE Error Codes:30 : Unable to connect to host31 : Not connected32 : Unable to send command to server33 : Bad username34 : Bad password35 : Bad response36 : Passive mode failed37 : Data transfer error38 : Local filesystem error FTP client class Client 11.1 Client helper class Client 11.1 LDAP client class Client 11.1 Crypt Copyright (C) 2005 - 2014 Open Source Matters, Inc. All rights reserved. GNU General Public License version 2 or later; see LICENSE JCrypt cipher for Simple encryption, decryption and key generation. Crypt 12.1 JCrypt cipher interface. Crypt 12.1 JCrypt is a Joomla Platform class for handling basic encryption/decryption of data. Crypt 12.1 Crypt 12.1 Database Copyright (C) 2005 - 2014 Open Source Matters, Inc. All rights reserved. GNU General Public License version 2 or later; see LICENSE MySQL database driver Database http://dev.mysql.com/doc/ 11.1 MySQL export driver. Database 11.1 MySQLi database driver Database http://php.net/manual/en/book.mysqli.php 11.1 MySQL import driver. Database 11.1 Query Building Class. Database 11.1 SQL Server database driver Database http://msdn.microsoft.com/en-us/library/ee336279.aspx 11.1 SQL Server database driver Database http://msdn.microsoft.com/en-us/library/cc296152(SQL.90).aspx 11.1 Database interface class. Database 11.2 Database connector class. Database 11.1 Exception class definition for the Database subpackage. Database 11.1 deprecated 80. Query Element Class. Database 11.1 Table class supporting modified pre-order tree traversal behavior. Database http://docs.joomla.org/JTableAsset 11.1 Category table Table 11.1 Content table Table 11.1 Extension table Replaces plugins table Table 11.1 Languages table. Database 11.1 Menu table Table 11.1 Menu Types table Table 11.1 Module table Table 11.1 Session table Table 11.1 Update table Stores updates temporarily Table 11.1 Users table Table 11.1 Usergroup table class. Database 11.1 Viewlevels table class. Database 11.1 Abstract Table class Parent class to all tables. Table http://docs.joomla.org/JTable 11.1 Joomla.Platform/jtable.cls Table class supporting modified pre-order tree traversal behavior. Database http://docs.joomla.org/JTableNested 11.1 Document Copyright (C) 2005 - 2014 Open Source Matters, Inc. All rights reserved. GNU General Public License version 2 or later; see LICENSE Document class, provides an easy interface to parse and display a document Document 11.1 DocumentError class, provides an easy interface to parse and display an error page Document 11.1 DocumentFeed class, provides an easy interface to parse and display any feed document Document 11.1 JFeedItem is an internal class that stores feed item information Document 11.1 JFeedEnclosure is an internal class that stores feed enclosure information Document 11.1 JFeedImage is an internal class that stores feed image information Document 11.1 JDocumentRenderer_Atom is a feed that implements the atom specification Please note that just by using this class you won't automatically produce valid atom files. For example, you have to specify either an editor for the feed or an author for every single feed item. Document http://www.atomenabled.org/developers/syndication/atom-format-spec.php 11.1 JDocumentRenderer_RSS is a feed that implements RSS 2.0 Specification Document http://www.rssboard.org/rss-specification 11.1 DocumentHTML class, provides an easy interface to parse and display a HTML document Document 11.1 Component renderer Document 11.1 JDocument head renderer Document 11.1 JDocument system message renderer Document 11.1 JDocument Module renderer Document 11.1 JDocument Modules renderer Document 11.1 JDocumentJSON class, provides an easy interface to parse and display JSON output Document http://www.json.org/ 11.1 Document Copyright (C) 2005 - 2014 Open Source Matters, Inc. All rights reserved. GNU General Public License version 2 or later; see LICENSE.txt OpenSearch class, provides an easy interface to display an OpenSearch document Document http://www.opensearch.org/ 11.1 JOpenSearchUrl is an internal class that stores the search URLs for the OpenSearch description Document 11.1 JOpenSearchImage is an internal class that stores Images for the OpenSearch Description Document 11.1 DocumentRAW class, provides an easy interface to parse and display raw output Document 11.1 Abstract class for a renderer Document 11.1 DocumentXML class, provides an easy interface to parse and display XML output Document 11.1 Environment Copyright (C) 2005 - 2014 Open Source Matters, Inc. All rights reserved. GNU General Public License version 2 or later; see LICENSE Browser class, provides capability information about the current web client. Browser identification is performed by examining the HTTP_USER_AGENT environment variable provided by the web server. This class has many influences from the lib/Browser.php code in version 3 of Horde by Chuck Hagenbuch and Jon Parise. Environment 11.1 deprecated 84. JRequest Class This class serves to provide the Joomla Platform with a common interface to access request variables. This includes $_POST, $_GET, and naturally $_REQUEST. Variables can be passed through an input filter to avoid injection or returned raw. Environment 11.1 deprecated 95. JResponse Class. This class serves to provide the Joomla Platform with a common interface to access response variables. This includes header and body. Environment 11.1 JURI Class This class serves two purposes. First it parses a URI and provides a common interface for the Joomla Platform to access and manipulate a URI. Second it obtains the URI of the current executing script from the server regardless of server. Environment 11.1 Error Copyright (C) 2005 - 2014 Open Source Matters, Inc. All rights reserved. GNU General Public License version 2 or later; see LICENSE Error Handling Class This class is inspired in design and concept by patErrorManager http://www.php-tools.net patErrorManager contributors include:gERD Schaufelberger gerd@php-tools.netSebastian Mordziol argh@php-tools.netStephan Schmidt scst@php-tools.net Error 11.1 deprecated 113. Joomla! Exception object. Error 11.1 deprecated 139. Utility class to assist in the process of benchmarking the execution of sections of code to understand where time is being spent. Error 11.1 Event Copyright (C) 2005 - 2014 Open Source Matters, Inc. All rights reserved. GNU General Public License version 2 or later; see LICENSE Class to handle dispatching of events. This is the Observable part of the Observer design pattern for the event architecture. Event http://docs.joomla.org/Tutorial:Plugins Plugin tutorials JPlugin 11.1 JEvent Class Event 11.1 Joomla Platform Factory class 11.1 FileSystem Copyright (C) 2005 - 2014 Open Source Matters, Inc. All rights reserved. GNU General Public License version 2 or later; see LICENSE Bzip2 format adapter for the JArchive class FileSystem 11.1 Gzip format adapter for the JArchive class This class is inspired from and draws heavily in code and concept from the Compress package of The Horde Project http://www.horde.org Michael Slusarz slusarz@horde.org Michael Cochrane mike@graftonhall.co.nz FileSystem 11.1 Tar format adapter for the JArchive class This class is inspired from and draws heavily in code and concept from the Compress package of The Horde Project http://www.horde.org Michael Slusarz slusarz@horde.org Michael Cochrane mike@graftonhall.co.nz FileSystem 11.1 ZIP format adapter for the JArchive class The ZIP compression code is partially based on code from: Eric Mueller eric@themepark.com http://www.zend.com/codex.php?id=535&single=1 Deins125 webmaster@atlant.ru http://www.zend.com/codex.php?id=470&single=1 The ZIP compression date code is partially based on code from Peter Listiak mlady@users.sourceforge.net This class is inspired from and draws heavily in code and concept from the Compress package of The Horde Project http://www.horde.org Chuck Hagenbuch chuck@horde.org Michael Slusarz slusarz@horde.org Michael Cochrane mike@graftonhall.co.nz FileSystem 11.1 An Archive handling class FileSystem 11.1 A File handling class FileSystem 11.1 A Folder handling class FileSystem 11.1 File system helper Holds support functions for the filesystem, particularly the stream FileSystem 11.1 A Path handling class FileSystem 11.1 Joomla! Stream Interface The Joomla! stream interface is designed to handle files as streams where as the legacy JFile static class treated files in a rather atomic manner. FileSystem This class adheres to the stream wrapper operations: http://php.net/manual/en/function.stream-get-wrappers.php http://php.net/manual/en/intro.stream.php PHP Stream Manual http://php.net/manual/en/wrappers.php Stream Wrappers http://php.net/manual/en/filters.php Stream Filters http://php.net/manual/en/transports.php Socket Transports (used by some options, particularly HTTP proxy) 11.1 String Stream Wrapper This class allows you to use a PHP string in the same way that you would normally use a regular stream wrapper FileSystem 11.1 String Controller FileSystem 11.1 Filter Copyright (C) 2005 - 2014 Open Source Matters, Inc. All rights reserved. GNU General Public License version 2 or later; see LICENSE JFilterInput is a class for filtering input from any data source Forked from the php input filter library by: Daniel Morris dan@rootcube.com Original Contributors: Gianpaolo Racca, Ghislain Picard, Marco Wandschneider, Chris Tobin and Andrew Eddie. Filter 11.1 JFilterOutput Filter 11.1 Form Copyright (C) 2005 - 2014 Open Source Matters, Inc. All rights reserved. GNU General Public License version 2 or later; see LICENSE Abstract Form Field class for the Joomla Platform. Form 11.1 Form Field class for the Joomla Platform. Provides a list of access levels. Access levels control what users in specific groups can see. Form JAccess 11.1 Form Field class for the Joomla Platform. Provides a list of available cache handlers Form JCache 11.1 Form Field class for the Joomla Platform. Provides a pop up date picker linked to a button. Optionally may be filtered to use user's or server's time zone. Form 11.1 Form Field class for the Joomla Platform. Supports an HTML select list of categories Form 11.1 Form Field class for the Joomla Platform. Single check box field. This is a boolean field with null for false and the specified option for true Form http://www.w3.org/TR/html-markup/input.checkbox.html#input.checkbox JFormFieldCheckboxes 11.1 Form Field class for the Joomla Platform. Displays options as a list of check boxes. Multiselect may be forced to be true. Form JFormFieldCheckbox 11.1 Color Form Field class for the Joomla Platform. This implementation is designed to be compatible with HTML5's
Form 11.3 Form Field class for the Joomla Platform. Implements a combo box field. Form 11.1 Form Field to display a list of the layouts for a component view from the extension or template overrides. Form 11.1 Form Field class for the Joomla Platform. Provides a list of content languages Form JFormFieldLanguage for a select list of application languages. 11.1 Form Field class for the Joomla Platform. Provides a list of available database connections, optionally limiting to a given list. Form JDatabase 11.3 Form Field class for the Joomla Platform. An editarea field for content creation Form JFormfieldEditors JEditor 11.1 Form Field class for the Joomla Platform. Provides a list of installed editors. Form JFormFieldEditor 11.1 deprecated 157. Form Field class for the Joomla Platform. Provides and input field for e-mail addresses Form http://www.w3.org/TR/html-markup/input.email.html#input.email JFormRuleEmail 11.1 Form Field class for the Joomla Platform. Provides an input field for files Form http://www.w3.org/TR/html-markup/input.file.html#input.file 11.1 Supports an HTML select list of files Form 11.1 Supports an HTML select list of folder Form 11.1 Form Field class for the Joomla Platform. Provides a grouped list select field. Form 11.1 Form Field class for the Joomla Platform. Provides a hidden field Form http://www.w3.org/TR/html-markup/input.hidden.html#input.hidden 11.1 Supports an HTML select list of image Form 11.1 Form Field class for the Joomla Platform. Provides a select list of integers with specified first, last and step values. Form 11.1 Form Field class for the Joomla Platform. Supports a list of installed application languages Form JFormFieldContentLanguage for a select list of content languages. 11.1 Form Field class for the Joomla Platform. Supports a generic list of options. Form 11.1 Form Field class for the Joomla Platform. Provides a modal media selector including upload mechanism Form 11.1 Supports an HTML grouped select list of menu item grouped by menu Form 11.1 Form Field to display a list of the layouts for module display from the module or template overrides. Form 11.1 Form Field class for the Joomla Platform. Text field for passwords Form http://www.w3.org/TR/html-markup/input.password.html#input.password Two password fields may be validated as matching using JFormRuleEquals 11.1 Form Field class for the Joomla Framework. Form 11.4 Form Field class for the Joomla Platform. Provides radio button inputs Form http://www.w3.org/TR/html-markup/command.radio.html#command.radio 11.1 Form Field class for the Joomla Platform. Field for assigning permissions to groups for a given asset Form JAccess 11.1 Form Field class for the Joomla Platform. Provides a select list of session handler options. Form 11.1 Form Field class for the Joomla Platform. Provides spacer markup to be used in form layouts. Form 11.1 Supports an custom SQL select list Form 11.1 Form Field class for the Joomla Platform. Supports a text field telephone numbers. Form http://www.w3.org/TR/html-markup/input.tel.html JFormRuleTel for telephone number validation JHtmlTel for rendering of telephone numbers 11.1 Form Field class for the Joomla Platform. Supports a one line text field. Form http://www.w3.org/TR/html-markup/input.text.html#input.text 11.1 Form Field class for the Joomla Platform. Supports a multi line area for entry of plain text Form http://www.w3.org/TR/html-markup/textarea.html#textarea 11.1 Form Field class for the Joomla Platform. Form 11.1 Form Field class for the Joomla Platform. Supports a URL text field Form http://www.w3.org/TR/html-markup/input.url.html#input.url JFormRuleUrl for validation of full urls 11.1 Form Field class for the Joomla Platform. Supports a nested check box field listing user groups. Multiselect is available by default. Form 11.1 Form Class for the Joomla Platform. This class implements a robust API for constructing, populating, filtering, and validating forms. It uses XML definitions to construct form fields and a variety of field and rule classes to render and validate the form. Form http://www.w3.org/TR/html4/interact/forms.html http://www.w3.org/TR/html5/forms.html 11.1 JForm's helper class. Provides a storage for filesystem's paths where JForm's entities reside and methods for creating those entities. Also stores objects with entities' prototypes for further reusing. Form 11.1 Form Rule class for the Joomla Platform. Form 11.1 Form Rule class for the Joomla Platform. Form 11.2 Form Copyright (C) 2005 - 2014 Open Source Matters, Inc. All rights reserved. GNU General Public License version 2 or later; see LICENSE.txt Form Rule class for the Joomla Platform. Requires the value entered be one of the options in a field of type="list" Form 11.1 Form Rule class for the Joomla Platform Form 11.1 GitHub Copyright (C) 2005 - 2014 Open Source Matters, Inc. All rights reserved. GNU General Public License version 2 or later; see LICENSE GitHub API References class for the Joomla Platform. GitHub 11.3 GitHub API Gists class for the Joomla Platform. GitHub 11.3 Joomla Platform class for interacting with a GitHub server instance. GitHub 11.3 HTTP client class for connecting to a GitHub instance. GitHub 11.3 GitHub API Issues class for the Joomla Platform. GitHub 11.3 GitHub API object class for the Joomla Platform. GitHub 11.3 GitHub API Pull Requests class for the Joomla Platform. GitHub 11.3 HTML Copyright (C) 2005 - 2014 Open Source Matters, Inc. All rights reserved. GNU General Public License version 2 or later; see LICENSE JEditor class to handle WYSIWYG editors HTML 11.1 JGrid class to dynamically generate HTML tables HTML Copyright (C) 2005 - 2014 Open Source Matters, Inc. All rights reserved. GNU General Public License version 2 or later; see LICENSE JGrid class to dynamically generate HTML tables HTML 11.3 Extended Utility class for all HTML drawing classes. HTML 11.1 Extended Utility class for batch processing widgets. HTML 11.1 Utility class for javascript behaviors HTML 11.1 Utility class for categories HTML 11.1 Utility class to fire onContentPrepare for non-article based content. HTML 11.1 Utility class working with content language select lists HTML 11.1 Extended Utility class for handling date display. HTML 11.3 Utility class for cloaking email addresses HTML 11.1 Utility class for form elements HTML 11.1 Utility class for creating HTML Grids HTML 11.1 Utility class working with images. HTML 11.1 Utility class for creating different select lists HTML 11.1 Utility class working with menu select lists HTML 11.1 HTML helper class for rendering numbers. HTML 11.1 Utility class for creating HTML select lists HTML 11.1 Utility class for Sliders elements HTML 11.1 HTML helper class for rendering manipulated strings. HTML 11.1 Utility class for Tabs elements. HTML 11.2 HTML helper class for rendering telephone numbers. HTML 11.1 Utility class working with users HTML 11.4 Utility class for all HTML drawing classes HTML 11.1 Pagination Class. Provides a common interface for content pagination for the Joomla! Platform. HTML 11.1 Pagination object representing a particular item in the pagination lists. HTML 11.1 JPane abstract class HTML 11.1 deprecated 168. JPanelTabs class to to draw parameter panes. HTML 11.1 deprecated 169. JPanelSliders class to to draw parameter panes. HTML 11.1 deprecated 170. Renders a calendar element Parameter 11.1 deprecated 188. Renders a category element Parameter 11.1 deprecated 191. Parameter to display a list of the layouts for a component view from the extension or default template overrides. Parameter JFormFieldComponentLayout When replacing take note that JFormFieldComponentLayout does not end in s. 11.1 deprecated 193. Renders a select list of Asset Groups Parameter 11.1 deprecated 195. Be careful in replacing to note that JFormFieldConentLanguage does not end in s. Renders a editors element Parameter 11.1 deprecated 197. Renders a filelist element Parameter 11.1 deprecated 199. Renders a filelist element Parameter 11.1 deprecated 201. Renders a helpsites element Parameter 11.1 deprecated 203. When updating note that JformFieldHelpsite does not end in s. Renders a hidden element Parameter 11.1 deprecated 205. Renders a imagelist element Parameter 11.1 deprecated 208. Renders a languages element Parameter 11.1 deprecated 210. In updating please noe that JFormFieldLanguage does not end in s. Renders a list element Parameter 11.1 deprecated 212. Renders a menu element Parameter 11.1 deprecated 215. Renders a menu item element Parameter 11.1 deprecated 217. Parameter to display a list of the layouts for a module from the module or default template overrides. Parameter Note that JFormFieldModuleLayout does not end in s. 11.1 deprecated 219. Renders a password element Parameter 11.1 deprecated 221. Renders a radio element Parameter 11.1 deprecated 223. Renders a spacer element Parameter 11.1 deprecated 225. Renders a SQL element Parameter 11.1 deprecated 228. Renders a list of template styles. Parameter 11.1 deprecated 230. Renders a text element Parameter 11.1 deprecated 233. Renders a textarea element Parameter 11.1 deprecated 235. Renders a timezones element Parameter 11.1 deprecated 237. In updating note that JFormFieldTimeZone does not end in s. Renders a editors element Parameter 11.1 deprecated 239. Parameter base class The JElement is the base class for all JElement types Parameter 11.1 deprecated 241. Parameter handler Parameter 11.1 deprecated 246. Renders a standard button with a confirm dialog HTML 11.1 Renders a custom button HTML 11.1 Renders a help popup window button HTML 11.1 Renders a link button HTML 11.1 Renders a popup window button HTML 11.1 Renders a button separator HTML 11.1 Renders a standard button HTML 11.1 Button base class The JButton is the base class for all JButton types HTML 11.1 ToolBar handler HTML 11.1 HTTP Copyright (C) 2005 - 2014 Open Source Matters, Inc. All rights reserved. GNU General Public License version 2 or later; see LICENSE HTTP factory class. HTTP 12.1 HTTP client class. HTTP 11.3 HTTP response data object class. HTTP 11.3 HTTP transport class for using cURL. HTTP 11.3 HTTP transport class for using sockets directly. HTTP 11.3 HTTP transport class for using PHP streams. HTTP 11.3 HTTP transport class interface. HTTP 11.3 Image Copyright (C) 2005 - 2014 Open Source Matters, Inc. All rights reserved. GNU General Public License version 2 or later; see LICENSE Class to manipulate an image. Image 11.3 Image Filter class adjust the brightness of an image. Image 11.3 Image Filter class adjust the contrast of an image. Image 11.3 Image Filter class to add an edge detect effect to an image. Image 11.3 Image Filter class to emboss an image. Image 11.3 Image Filter class to transform an image to grayscale. Image 11.3 Image Filter class to negate the colors of an image. Image 11.3 Image Filter class to make an image appear "sketchy". Image 11.3 Image Filter class adjust the smoothness of an image. Image 11.3 Installer Copyright (C) 2005 - 2014 Open Source Matters, Inc. All rights reserved. GNU General Public License version 2 or later; see LICENSE Component installer Installer 11.1 File installer Installer 11.1 Language installer Installer 11.1 Library installer Installer 11.1 Module installer Installer 11.1 Package installer Installer 11.1 Plugin installer Installer 11.1 Template installer Installer 11.1 Extension object Installer 11.1 Installer helper class Installer 11.1 Joomla base installer class Installer 11.1 Joomla! Library Manifest File Installer 11.1 Joomla! Package Manifest File Installer 11.1 Language Copyright (C) 2005 - 2014 Open Source Matters, Inc. All rights reserved. GNU General Public License version 2 or later; see LICENSE Help system class Language 11.1 Language helper class Language 11.1 Languages/translation handler class Language 11.1 Language 11.1 Class to transliterate strings Language 11.1 Log Copyright (C) 2005 - 2014 Open Source Matters, Inc. All rights reserved. GNU General Public License version 2 or later; see LICENSE Joomla! Log Entry class This class is designed to hold log entries for either writing to an engine, or for supported engines, retrieving lists and building in memory (PHP based) search operations. Log 11.1 Joomla! Log Class This class hooks into the global log configuration settings to allow for user configured logging events to be sent to where the user wishes them to be sent. On high load sites SysLog is probably the best (pure PHP function), then the text file based loggers (CSV, W3C or plain FormattedText) and finally MySQL offers the most features (e.g. rapid searching) but will incur a performance hit due to INSERT being issued. Log 11.1 Exception class definition for the Log subpackage. Log 11.1 deprecated 269. Joomla! Logger Base Class This class is used to be the basis of logger classes to allow for defined functions to exist regardless of the child class. Log 11.1 Joomla! MySQL Database Log class This class is designed to output logs to a specific MySQL database table. Fields in this table are based on the SysLog style of log output. This is designed to allow quick and easy searching. Log 11.1 Joomla Echo logger class. Log 11.1 Joomla! Formatted Text File Log class This class is designed to use as a base for building formatted text files for output. By default it emulates the SysLog style format output. This is a disk based output format. Log 11.1 Joomla MessageQueue logger class. This class is designed to output logs to a specific MySQL database table. Fields in this table are based on the Syslog style of log output. This is designed to allow quick and easy searching. Log 11.1 Joomla! SysLog Log class This class is designed to call the PHP SysLog function call which is then sent to the system wide log system. For Linux/Unix based systems this is the syslog subsystem, for the Windows based implementations this can be found in the Event Log. For Windows, permissions may prevent PHP from properly outputting messages. Log 11.1 Joomla! W3C Logging class This class is designed to build log files based on the W3C specification at: http://www.w3.org/TR/WD-logfile.html Log 11.1 Mail Copyright (C) 2005 - 2014 Open Source Matters, Inc. All rights reserved. GNU General Public License version 2 or later; see LICENSE Email helper class, provides static methods to perform various tasks relevant to the Joomla email routines. TODO: Test these methods as the regex work is first run and not tested thoroughly Mail 11.1 Email Class. Provides a common interface to send email from the Joomla! Platform Mail 11.1 Route handling class 11.1 Text handling class. Language 11.1 Plugin Copyright (C) 2005 - 2014 Open Source Matters, Inc. All rights reserved. GNU General Public License version 2 or later; see LICENSE Plugin helper class Plugin 11.1 JPlugin Class Plugin 11.1 Registry Copyright (C) 2005 - 2014 Open Source Matters, Inc. All rights reserved. GNU General Public License version 2 or later; see LICENSE INI format handler for JRegistry. Registry 11.1 JSON format handler for JRegistry. Registry 11.1 PHP class format handler for JRegistry Registry 11.1 XML format handler for JRegistry. Registry 11.1 Abstract Format for JRegistry Registry 11.1 JRegistry class Registry 11.1 Session Copyright (C) 2005 - 2014 Open Source Matters, Inc. All rights reserved. GNU General Public License version 2 or later; see LICENSE Class for managing HTTP sessions Provides access to session-state values as well as session-level settings and lifetime management methods. Based on the standard PHP session handling mechanism it provides more advanced features such as expire timeouts. Session 11.1 APC session storage handler for PHP Session http://www.php.net/manual/en/function.session-set-save-handler.php 11.1 Database session storage handler for PHP Session http://www.php.net/manual/en/function.session-set-save-handler.php 11.1 eAccelerator session storage handler for PHP Session http://www.php.net/manual/en/function.session-set-save-handler.php 11.1 Memcache session storage handler for PHP – Inspired in both design and implementation by the Horde memcache handler – Session http://www.php.net/manual/en/function.session-set-save-handler.php 11.1 Memcached session storage handler for PHP – Inspired in both design and implementation by the Horde memcached handler – Session http://www.php.net/manual/en/function.session-set-save-handler.php 11.1 File session handler for PHP Session http://www.php.net/manual/en/function.session-set-save-handler.php 11.1 WINCACHE session storage handler for PHP Session http://www.php.net/manual/en/function.session-set-save-handler.php 11.1 XCache session storage handler Cache 11.1 Custom session storage handler for PHP Session http://www.php.net/manual/en/function.session-set-save-handler.php todo 18. 11.1 String Copyright (C) 2005 - 2014 Open Source Matters, Inc. All rights reserved. GNU General Public License version 2 or later; see LICENSE Joomla Platform String Normalize Class String 11.3 deprecated 278. Joomla Platform String Normalise Class String 11.3 String handling class for utf-8 data Wraps the phputf8 library All functions assume the validity of utf-8 strings. String 11.1 Updater Copyright (C) 2005 - 2014 Open Source Matters, Inc. All rights reserved. GNU General Public License version 2 or later; see LICENSE Collection Update Adapter Class Updater 11.1 Extension class for updater Updater 11.1 Update class. Updater 11.1 UpdateAdapter class. Updater 11.1 Updater Class Updater 11.1 User Copyright (C) 2005 - 2014 Open Source Matters, Inc. All rights reserved. GNU General Public License version 2 or later; see LICENSE Authentication class, provides an interface for the Joomla authentication system User 11.1 Authentication response class, provides an object for storing user and error details User 11.1 Authorisation helper class, provides static methods to perform various tasks relevant to the Joomla user and authorisation classes This class has influences and some method logic from the Horde Auth package User 11.1 User class. Handles all application interaction with a user User 11.1 Utilities Copyright (C) 2005 - 2014 Open Source Matters, Inc. All rights reserved. GNU General Public License version 2 or later; see LICENSE JArrayHelper is an array utility class for doing all sorts of odds and ends with arrays. Utilities 11.1 Generic Buffer stream handler This class provides a generic buffer stream. It can be used to store/retrieve/manipulate string buffers with the standard PHP filesystem I/O methods. Utilities 11.1 JDate is a class that stores a date and provides logic to manipulate and render that date in a variety of formats. Utilities 11.1 JSimpleCrypt is a very simple encryption algorithm for encrypting/decrypting strings Utilities 11.1 deprecated 292. SimpleXML implementation. The XML Parser extension (expat) is required to use JSimpleXML. The class provides a pure PHP4 implementation of the PHP5 interface SimpleXML. As with PHP5's SimpleXML it is what it says: simple. Nevertheless, it is an easy way to deal with XML data, especially for read only access. Because it's not possible to use the PHP5 ArrayIterator interface with PHP4 there are some differences between this implementation and that of PHP5: The access to the root node has to be explicit in JSimpleXML, not implicit as with PHP5. Write $xml->document->node instead of $xml->node You cannot access CDATA using array syntax. Use the method data() instead You cannot access attributes directly with array syntax. Use attributes() to read them. Comments are ignored. Last and least, this is not as fast as PHP5 SimpleXML–it is pure PHP4. Example: :simple.xml: <?xml version="1.0" encoding="utf-8" standalone="yes"?> <node> <child gender="m">Tom Foo</child> <child gender="f">Tamara Bar</child> <node> </document>
// read and write a document $xml = new JSimpleXML; $xml->loadFile('simple.xml'); print $xml->document->toString();
// access a given node's CDATA print $xml->root->node->child[0]->data(); // Tom Foo
// access attributes $attr = $xml->root->node->child[1]->attributes(); print $attr['gender']; // f
// access children foreach($xml->root->node->children() as $child) { print $child->data(); }
Note: JSimpleXML cannot be used to access sophisticated XML doctypes using datatype ANY (e.g. XHTML). With a DOM implementation you can handle this.
Utilities
SimpleXML Element
This object stores all of the direct children of itself in the $children array. They are also stored by type as arrays. So, if, for example, this tag had 2 <font> tags as children, there would be a class member called $font created as an array. $font[0] would be the first font tag, and $font[1] would be the second.
To loop through all of the direct children of this object, the $children member should be used.
To loop through all of the direct children of a specific tag for this object, it is probably easier to use the arrays of the specific tag names, as explained above.
Utilities
JUtility is a utility functions class
Utilities
Wrapper class for php SimpleXMLElement.
Utilities
Static class to handle loading of libraries.
Version information class for the Joomla Platform.
