Absolute Basics of How a Component Functions - Revision history

Cmb: Some markup changes.

2022-10-09T21:36:10Z

Some markup changes.

← Older revision		Revision as of 21:36, 9 October 2022
Line 36:		Line 36:
	</translate>		</translate>
	<translate><!--T:16-->		<translate><!--T:16-->
	In the Joomla framework, models are responsible for managing the data. The first function that has to be written for a model is a get function. It returns data to the caller. For this example, the caller will be the HelloWorldViewHelloWorld view. By default, the model named HelloWorldModelHelloWorld residing in site/models/helloworld.php is the main model associated to this view.</translate>		In the Joomla framework, models are responsible for managing the data. The first function that has to be written for a model is a ''get'' function. It returns data to the caller. For this example, the caller will be the ''HelloWorldViewHelloWorld'' view. By default, the model named ''HelloWorldModelHelloWorld'' residing in ''site/models/helloworld.php'' is the main model associated to this view.</translate>
	<translate><!--T:17-->		<translate><!--T:17-->
	So let's have a quick look at the naming conventions with an example, since the naming convention are the actual magic that make everything work:</translate>		So let's have a quick look at the naming conventions with an example, since the naming convention are the actual magic that make everything work:</translate>
Line 57:		Line 57:
	user access</translate>		user access</translate>
	\| <translate><!--T:25-->		\| <translate><!--T:25-->
	~~<tt>~~<yoursite>/joomla/index.php~~</tt>~~</translate>		''<yoursite>/joomla/index.php''</translate>
	\|-		\|-
	\| 2		\| 2
	\| <translate><!--T:26-->		\| <translate><!--T:26-->
	administrator access</translate>		administrator access</translate>
	\| <translate><!--T:27-->		\| <translate><!--T:27-->
	~~<tt>~~<yoursite>/joomla/administrator/index.php~~</tt>~~</translate>		''<yoursite>/joomla/administrator/index.php''</translate>
	\|}		\|}
	<translate><!--T:28-->		<translate><!--T:28-->
	Hello World! example:</translate> ~~<tt>~~localhost/joomla/index.php~~</tt>~~		Hello World! example:</translate> ''localhost/joomla/index.php''
	<translate><!--T:29-->		<translate><!--T:29-->
	You can use the URL of the component, or a [[#Menu\| Menu]] in order to navigate to the component. In this article we will discuss using the URL.</translate>		You can use the URL of the component, or a [[#Menu\| Menu]] in order to navigate to the component. In this article we will discuss using the URL.</translate>
Line 74:		Line 74:
	user access</translate>		user access</translate>
	\| <translate><!--T:31-->		\| <translate><!--T:31-->
	~~<tt>~~<yoursite>/joomla/index.php?option=com_<component_name>~~</tt>~~</translate>		''<yoursite>/joomla/index.php?option=com_<component_name>''</translate>
	\|-		\|-
	\| 2		\| 2
	\| <translate><!--T:32-->		\| <translate><!--T:32-->
	administrator access</translate>		administrator access</translate>
	\| <translate><!--T:33-->		\| <translate><!--T:33-->
	~~<tt>~~<yoursite>/joomla/administrator/index.php?option=com_<component_name>~~</tt>~~</translate>		''<yoursite>/joomla/administrator/index.php?option=com_<component_name>''</translate>
	\|}		\|}
	<translate><!--T:34-->		<translate><!--T:34-->
	Hello World! example:</translate> ~~<tt>~~localhost/joomla/index.php?option=com_helloworld~~</tt>~~		Hello World! example:</translate> ''localhost/joomla/index.php?option=com_helloworld''
	<translate>		<translate>
	==MVC Basic Directory Structure== <!--T:35-->		==MVC Basic Directory Structure== <!--T:35-->
Line 89:		Line 89:
	<translate><!--T:36-->		<translate><!--T:36-->
	Components are stored in a directory within your Joomla! installation, specifically at:		Components are stored in a directory within your Joomla! installation, specifically at:
	*~~<tt>~~htdocs/<path_to_joomla>/components/com_<component_name>/~~</tt>~~ .</translate>		*''htdocs/<path_to_joomla>/components/com_<component_name>/'' .</translate>
	<translate><!--T:37-->		<translate><!--T:37-->
	The Hello World! component would be stored in ~~<tt>~~ htdocs/<path_to_joomla>/components/com_helloworld/~~</tt>~~.</translate>		The Hello World! component would be stored in ''htdocs/<path_to_joomla>/components/com_helloworld/''.</translate>
	<translate><!--T:38-->		<translate><!--T:38-->
	A basic component will contain the following files within its directoryː</translate>		A basic component will contain the following files within its directoryː</translate>
	<translate><!--T:39-->		<translate><!--T:39-->
	*An HTML file that is just a security file with a background colorː ~~<tt>~~index.html~~</tt>~~</translate>		*An HTML file that is just a security file with a background colorː ''index.html''</translate>
	<translate><!--T:40-->		<translate><!--T:40-->
	*A PHP file that represents the controller itselfː ~~<tt>~~controller.php~~</tt>~~</translate>		*A PHP file that represents the controller itselfː ''controller.php''</translate>
	<translate><!--T:41-->		<translate><!--T:41-->
	*A PHP file that loads the controller classː ~~<tt>~~<component_name>.php~~</tt>~~</translate>		*A PHP file that loads the controller classː ''<component_name>.php''</translate>
	<translate><!--T:42-->		<translate><!--T:42-->
	*A PHP file that represents the model itselfː ~~<tt>~~models/<component_name>.php~~</tt>~~</translate>		*A PHP file that represents the model itselfː ''models/<component_name>.php''</translate>
	<translate><!--T:43-->		<translate><!--T:43-->
	*Another HTML file for background controlː ~~<tt>~~models/index.html~~</tt>~~</translate>		*Another HTML file for background controlː ''models/index.html''</translate>
	<translate><!--T:44-->		<translate><!--T:44-->
	*A PHP file containing the default viewː ~~<tt>~~views/<component_name>/tmpl/default.php~~</tt>~~</translate>		*A PHP file containing the default viewː ''views/<component_name>/tmpl/default.php''</translate>
	<translate><!--T:45-->		<translate><!--T:45-->
	*An XML file for adding a menu item typeː ~~<tt>~~views/<component_name>/tmpl/default.xml~~</tt>~~</translate>		*An XML file for adding a menu item typeː ''views/<component_name>/tmpl/default.xml''</translate>
	<translate><!--T:46-->		<translate><!--T:46-->
	*Another HTML file for background controlː ~~<tt>~~views/<component_name>/tmpl/index.html~~</tt>~~</translate>		*Another HTML file for background controlː ''views/<component_name>/tmpl/index.html''</translate>
	<translate><!--T:47-->		<translate><!--T:47-->
	*Another HTML file for background controlː ~~<tt>~~views/<component_name>/index.html~~</tt>~~</translate>		*Another HTML file for background controlː ''views/<component_name>/index.html''</translate>
	<translate><!--T:48-->		<translate><!--T:48-->
	*A PHP file for displaying the viewː ~~<tt>~~views/<component_name>/view.html.php~~</tt>~~</translate>		*A PHP file for displaying the viewː ''views/<component_name>/view.html.php''</translate>
	<translate>		<translate>
	==JEXEC== <!--T:49-->		==JEXEC== <!--T:49-->

Ceford: Replaced source with syntax highlight

2022-08-28T16:15:36Z

Replaced source with syntax highlight

← Older revision		Revision as of 16:15, 28 August 2022
Line 119:		Line 119:
	<translate><!--T:50-->		<translate><!--T:50-->
	The following line is commonly found at the start of Joomla! PHP files:</translate>		The following line is commonly found at the start of Joomla! PHP files:</translate>
	<~~source~~ lang="php">		<syntaxhighlight lang="php" line>
	<?php		<?php
	defined('_JEXEC') or die('Restricted Access');		defined('_JEXEC') or die('Restricted Access');
	</~~source~~>		</syntaxhighlight>
	<translate><!--T:51-->		<translate><!--T:51-->
	This enables a secure entry point into the Joomla! platform. [[S:MyLanguage/JEXEC\| JEXEC]] contains a detailed explanation.</translate>		This enables a secure entry point into the Joomla! platform. [[S:MyLanguage/JEXEC\| JEXEC]] contains a detailed explanation.</translate>

Wilsonge: Revert back

2022-06-22T09:18:05Z

Revert back

← Older revision		Revision as of 09:18, 22 June 2022
Line 119:		Line 119:
	<translate><!--T:50-->		<translate><!--T:50-->
	The following line is commonly found at the start of Joomla! PHP files:</translate>		The following line is commonly found at the start of Joomla! PHP files:</translate>
	<~~syntaxhighlight~~ lang="php">		<source lang="php">
	<?php		<?php
	defined('_JEXEC') or die('Restricted Access');		defined('_JEXEC') or die('Restricted Access');
	</~~syntaxhighlight~~>		</source>
	<translate><!--T:51-->		<translate><!--T:51-->
	This enables a secure entry point into the Joomla! platform. [[S:MyLanguage/JEXEC\| JEXEC]] contains a detailed explanation.</translate>		This enables a secure entry point into the Joomla! platform. [[S:MyLanguage/JEXEC\| JEXEC]] contains a detailed explanation.</translate>

Wilsonge: Oops

2022-06-22T09:16:11Z

Oops

← Older revision		Revision as of 09:16, 22 June 2022
Line 119:		Line 119:
	<translate><!--T:50-->		<translate><!--T:50-->
	The following line is commonly found at the start of Joomla! PHP files:</translate>		The following line is commonly found at the start of Joomla! PHP files:</translate>
	< syntaxhighlight lang="php">		<syntaxhighlight lang="php">
	<?php		<?php
	defined('_JEXEC') or die('Restricted Access');		defined('_JEXEC') or die('Restricted Access');

Wilsonge: Try fixing

2022-06-22T09:15:32Z

Try fixing

← Older revision		Revision as of 09:15, 22 June 2022
Line 119:		Line 119:
	<translate><!--T:50-->		<translate><!--T:50-->
	The following line is commonly found at the start of Joomla! PHP files:</translate>		The following line is commonly found at the start of Joomla! PHP files:</translate>
	<~~source~~ lang="php">		< syntaxhighlight lang="php">
	<?php		<?php
	defined('_JEXEC') or die('Restricted Access');		defined('_JEXEC') or die('Restricted Access');
	</~~source~~>		</syntaxhighlight>
	<translate><!--T:51-->		<translate><!--T:51-->
	This enables a secure entry point into the Joomla! platform. [[S:MyLanguage/JEXEC\| JEXEC]] contains a detailed explanation.</translate>		This enables a secure entry point into the Joomla! platform. [[S:MyLanguage/JEXEC\| JEXEC]] contains a detailed explanation.</translate>

Max123kl: translation tag moved

2022-05-04T17:36:40Z

translation tag moved

← Older revision		Revision as of 17:36, 4 May 2022
Line 135:		Line 135:
	* [[S:MyLanguage/J2.5:Developing_a_MVC_Component\| Joomla! 2.5]]</translate>		* [[S:MyLanguage/J2.5:Developing_a_MVC_Component\| Joomla! 2.5]]</translate>
	<translate><!--T:56-->		<translate><!--T:56-->
	* [[S:MyLanguage/J3.x:Developing_an_MVC_Component/Introduction\| Joomla! 3.x]]~~</translate>~~		* [[S:MyLanguage/J3.x:Developing_an_MVC_Component/Introduction\| Joomla! 3.x]]
	* [[S:MyLanguage/J4.x:Developing_an_MVC_Component\| Joomla! 4.x]]		* [[S:MyLanguage/J4.x:Developing_an_MVC_Component\| Joomla! 4.x]]</translate>

	<noinclude>		<noinclude>

Cmb: Changes to comply with Joomla's Words to Watch (W2W).

2022-02-19T20:47:09Z

Changes to comply with Joomla's Words to Watch (W2W).

Show changes

M-b-o: translation strings fixed

2020-04-05T18:59:10Z

translation strings fixed

← Older revision		Revision as of 18:59, 5 April 2020
Line 166:		Line 166:

	<noinclude>		<noinclude>
	~~<translate>~~		[[Category:Tutorials{{#translation:}}]]
	~~<!--T:57-->~~		[[Category:Explanations{{#translation:}}]]
	[[Category:Tutorials]]		[[Category:Component Development{{#translation:}}]]
	[[Category:Explanations]]		[[Category:Beginner Development{{#translation:}}]]
	[[Category:Component Development]]		[[Category:Development Recommended Reading{{#translation:}}]]
	[[Category:Beginner Development]]
	[[Category:Development Recommended Reading]]
	~~</translate>~~
	</noinclude>		</noinclude>

Wilsonge: Joomla 4.x link

2020-04-05T00:55:34Z

Joomla 4.x link

← Older revision		Revision as of 00:55, 5 April 2020
Line 163:		Line 163:
	<translate><!--T:56-->		<translate><!--T:56-->
	* [[S:MyLanguage/J3.x:Developing_an_MVC_Component/Introduction\| Joomla! 3.x]]</translate>		* [[S:MyLanguage/J3.x:Developing_an_MVC_Component/Introduction\| Joomla! 3.x]]</translate>
			* [[S:MyLanguage/J4.x:Developing_an_MVC_Component\| Joomla! 4.x]]

	<noinclude>		<noinclude>

Bg17aw: Spelling error: corrected to "So let's" instead of "Do let's"

2016-03-30T17:50:15Z

Spelling error: corrected to "So let's" instead of "Do let's"

← Older revision		Revision as of 17:50, 30 March 2016
Line 52:		Line 52:

	<translate><!--T:19-->		<translate><!--T:19-->
	Do let's just assume we want to use an imaginary view ''fluffy'', you would have to have:</translate>		So let's just assume we want to use an imaginary view ''fluffy'', you would have to have:</translate>

	<translate><!--T:20-->		<translate><!--T:20-->
Line 61:		Line 61:

	<translate>		<translate>

	==Accessing a Joomlaǃ Component== <!--T:22-->		==Accessing a Joomlaǃ Component== <!--T:22-->
	</translate>		</translate>