Using the JFactory class: Difference between revisions
From Joomla! Documentation
Creation of JFactory class usage Boilerplate WIP -- 2017-03-15 |
Mickmackusa (talk | contribs) m →JFactory::getUser(): rewording in the description, fixed deadlink |
||
| (5 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
{{version | {{Top portal heading|color=white-bkgd|icon=magic|icon-color=#5091cd|size=3x|text-color=#333|title=Tutorial<br /> | ||
Using the JFactory Class}} | |||
<noinclude>{{Joomla version|version=3.0|time=and after|comment=<series}}</noinclude> | |||
{{-}} | |||
== Introduction == | == Introduction == | ||
JFactory is the Joomla Platform class, giving you access to the most important (mostly singletons) parts in Joomla. It contains multiple other objects, like the application one or the Joomla! global configuration. | JFactory is the Joomla! Platform class, giving you access to the most important (mostly singletons) parts in Joomla. It contains multiple other objects, like the application one or the Joomla! global configuration. | ||
== JFactory::getApplication() == | == JFactory::getApplication() == | ||
| Line 8: | Line 11: | ||
Returns the JApplicationCMS, through it you can access for the example do redirects, access the configuration and the input variables, the Menu or enqueue messages which are shown to the user. | Returns the JApplicationCMS, through it you can access for the example do redirects, access the configuration and the input variables, the Menu or enqueue messages which are shown to the user. | ||
See [[Using the JApplication class]] for more details. | *See [[S:MyLanguage/Using the JFactory class/Using the JApplication class|Using the JApplication class]] for more details. | ||
== JFactory::getDocument() == | == JFactory::getDocument() == | ||
| Line 14: | Line 17: | ||
Provides access to the current JDocument, with it you can set Meta data, add styles and scripts and more related to the document. | Provides access to the current JDocument, with it you can set Meta data, add styles and scripts and more related to the document. | ||
See [ | *See [https://docs.joomla.org/J3.x:Adding_JavaScript_and_CSS_to_the_page Adding JavaScript and CSS to the page] | ||
== JFactory::getDbo() == | == JFactory::getDbo() == | ||
Returns a database object | Returns a database object. [https://api.joomla.org/cms-3/classes/JDatabaseDriver.html JDatabase methods] are executed by chaining to the database object. | ||
See also [ | Examples: | ||
<source lang="php"> | |||
$db = JFactory::getDbo(); | |||
$query = $db->getQuery(true); | |||
</source> | |||
<source lang="php">$query = JFactory::getDbo()->getQuery(true);</source> | |||
*See also [https://docs.joomla.org/Selecting_data_using_JDatabase Selecting data using JDatabase] | |||
== JFactory::getUser() == | == JFactory::getUser() == | ||
Returns the | Returns the user object for the currently logged in user (JUser). The object provides access to preloaded values specific to the logged in user as well as methods within the class. If no user is logged in, the user is deemed a "guest" and the id of the user is set to zero. | ||
See [ | *See [https://docs.joomla.org/Accessing_the_current_user_object Accessing the current user object] | ||
== JFactory::getDate() == | == JFactory::getDate() == | ||
Returns a [[How to use JDate]] instance, you can also add a time and a timezone offset to it. Without parameters it uses the current time. | Returns a [[S:MyLanguage/Using the JFactory class/How to use JDate|How to use JDate]] instance, you can also add a time and a timezone offset to it. Without parameters it uses the current time. | ||
== JFactory::getMailer() == | == JFactory::getMailer() == | ||
| Line 36: | Line 48: | ||
Provides access to the Joomla Mailer (wrapper around PHPMailer) for sending emails with Joomla. | Provides access to the Joomla Mailer (wrapper around PHPMailer) for sending emails with Joomla. | ||
See also [[Sending email from extensions]] | *See also [[Sending email from extensions]] | ||
== JFactory::getConfig() == | == JFactory::getConfig() == | ||
Returns a registry with the Joomla! configuration file (configuration.php), see | Returns a registry with the Joomla! configuration file (configuration.php), see JConfig for more details. To access single values you can use <tt>JFactory::getApplication()->get('configValue')</tt> | ||
See also | *See also Getting global configuration parameters | ||
== JFactory::getSession() == | == JFactory::getSession() == | ||
Returns the current visitors session. (Make sure Joomla is called as Webapplication) | Returns the current visitors session. (Make sure Joomla! is called as Webapplication) | ||
== External Links == | == External Links == | ||
[https://api.joomla.org/cms-3/classes/JFactory.html API Docs for JFactory] | *[https://api.joomla.org/cms-3/classes/JFactory.html API Docs for JFactory] | ||
<noinclude> | |||
[[Category:JFactory]] | [[Category:JFactory]] | ||
[[Category:Tutorials]][[Category:Framework]] | [[Category:Tutorials]][[Category:Framework]] | ||
[[Category:Module Development]] | [[Category:Module Development]] | ||
[[Category:Plugin Development]][[Category:Component Development]] | [[Category:Plugin Development]] | ||
[[Category:Component Development]] | |||
</noinclude> | |||
Latest revision as of 03:46, 19 October 2019
Tutorial
Using the JFactory Class
Using the JFactory Class
Joomla!
≥ 3.0
<series
Introduction
JFactory is the Joomla! Platform class, giving you access to the most important (mostly singletons) parts in Joomla. It contains multiple other objects, like the application one or the Joomla! global configuration.
JFactory::getApplication()
Returns the JApplicationCMS, through it you can access for the example do redirects, access the configuration and the input variables, the Menu or enqueue messages which are shown to the user.
- See Using the JApplication class for more details.
JFactory::getDocument()
Provides access to the current JDocument, with it you can set Meta data, add styles and scripts and more related to the document.
JFactory::getDbo()
Returns a database object. JDatabase methods are executed by chaining to the database object.
Examples:
$db = JFactory::getDbo();
$query = $db->getQuery(true);
$query = JFactory::getDbo()->getQuery(true);
- See also Selecting data using JDatabase
JFactory::getUser()
Returns the user object for the currently logged in user (JUser). The object provides access to preloaded values specific to the logged in user as well as methods within the class. If no user is logged in, the user is deemed a "guest" and the id of the user is set to zero.
JFactory::getDate()
Returns a How to use JDate instance, you can also add a time and a timezone offset to it. Without parameters it uses the current time.
JFactory::getMailer()
Provides access to the Joomla Mailer (wrapper around PHPMailer) for sending emails with Joomla.
- See also Sending email from extensions
JFactory::getConfig()
Returns a registry with the Joomla! configuration file (configuration.php), see JConfig for more details. To access single values you can use JFactory::getApplication()->get('configValue')
- See also Getting global configuration parameters
JFactory::getSession()
Returns the current visitors session. (Make sure Joomla! is called as Webapplication)