نسخهٔ ‏۳۱ ژانویهٔ ۲۰۱۲، ساعت ۰۵:۳۵ (نمایش مبدأ) Shmata (بحث | مشارکت‌ها) (←‏ایجاد یک package نصبی از ماژول) → تفاوت قدیمی‌تر		نسخهٔ کنونی تا ‏۸ فوریهٔ ۲۰۱۲، ساعت ۰۹:۳۰ (نمایش مبدأ) Hamidy (بحث | مشارکت‌ها)
سطر ۱:		سطر ۱:
−	[[رده:کدنویسی و گسترش جوملا ]]	+	=ماژول Hello World=
−	= ماژول Hello World =	+	یک [[ماژول]] [[جوملا]] 1.5 در حالت عادی معمولا شامل 2 فایل می‌باشد . یک فایل شامل تنظیمات [[XML]] ویک فایل کنترل کننده [[PHP]]. فایل تنظیمات [[XML]] شامل اطلاعات عمومی [[ماژول]] می‌باشد اگر [[ماژول]] دارای پارامترهایی باشد که یک عملکرد یا یک مدل نمایش خاص را برای [[ماژول]] ارائه کند در قسمت پارامترهای [[ماژول]] نمایش داده می‌شود (که در قسمت مدیریت [[ماژول]]‌ها در مدیریت [[جوملا]] نمایش داده می‌شوند) .
−	یک [[ماژول]] جوملا1.5 در حالت عادی معمولا شامل 2 فایل می باشد . یک فایل شامل تنظیمات [[XML]] ویک فایل کنترل کننده [[PHP]] . فایل تنظیمات [[XML]] شامل اطلاعات عمومی ماژول می باشد اگر ماژول دارای پارامترهایی باشد که یک عملکرد یا یک مدل نمایش خاص را برای ماژول ارائه کند در قسمت پارامترهای ماژول نمایش داده می شود (که در قسمت مدیریت ماژول ها در مدیریت جوملا نمایش داده میشوند) .	+
−	<br />	+	فایل [[PHP]] وظیفه کنترل منطق برنامه و کارایی [[ماژول]] [[جوملا]] را برعهده دارد.
−	فایل PHP وظیفه کنترل منطق برنامه و کارایی ماژول جوملا را برعهده دارد .	+
−	<br />	+	به عنوان مثال برای ایجاد یک [[ماژول]] ساده Hello World باید موارد زیر را انجام دهیم:
−	به عنوان مثال برای ایجاد یک ماژول ساده Hello World باید موارد زیر را انجام دهیم :	+
−	<br />	+	ابتدا باید یک پوشه در داخل پوشه [[ماژول]]‌ها (modules در فولدر ریشه [[جوملا]]) ایجاد کنیم. نام این پوشه را mod_hello_world می‌گذاریم این نحوه نام گذاری و این نام حائز اهمیت است.
−	ابتدا باید یک پوشه در داخل پوشه ماژول ها (modules در فولدر ریشه جوملا ) ایجاد کنیم . نام این پوشه را mod_hello_world می گذاریم این نحوه نام گذاری و این نام حائز اهمیت است . <br />	+
−	پس از ایجاد پوشه مورد نظر اقدام به ایجاد فایل XML نماییم , این فایل را در پوشه <br />	+	پس از ایجاد پوشه مورد نظر اقدام به ایجاد فایل [[XML]] نماییم، این فایل را در پوشه <div dir=ltr>/modules/mod_hello_world/mod_hello_world.xml</div> ایجاد می‌کنیم. دقت کنید که نحوه نام گذاری این فایل [[XML]] هم حائز اهمیت است.
−	<div dir=ltr>/modules/mod_hello_world/mod_hello_world.xml</div>	+
−	<br />	+	'''نکته:''' این نکته بسیار مهم است که نام فایل [[XML]] و نام [[ماژول]] یکی باشند در غیر اینصورت نصب کننده [[جوملا]] قادر به نصب بسته [[ماژول]] نخواهد بود.
−	ایجاد می کنیم دقت فرمایید که نحوه نام گذاری این فایل XML هم حائز اهمیت است .<br />	+
−	نکته : این نکته بسیار مهم است که نام فایل XML و نام ماژول یکی باشند در غیر اینصورت نصب کننده [[جوملا]] قادر به نصب بسته ماژول نخواهد بود .<br />	+	قوانین نامگذاری پوشه‌ها برای ایجاد [[ماژول]]:
−	قوانین نامگذاری پوشه ها برای ایجاد ماژول : <br />	+
−	• تمامی پوشه ها باید با نام mod_ آغاز شوند<br />	+	*تمامی پوشه‌ها باید با نام mod_ آغاز شوند
−	• قسمت دوم نام تمام ماژول ها باید بانام فایل XML یکی باشد . <br />	+	*قسمت دوم نام تمام [[ماژول]]‌ها باید بانام فایل [[XML]] یکی باشد.
		+
	<source lang="xml" >		<source lang="xml" >
سطر ۵۴:		سطر ۵۵:
	</files>		</files>
−	<!-- درصورتی که ماژول شما نیاز به پارامترهای اضافی داشت می توانید از این قسمت آن پارامترها را معرفی کنید -->	+	<!-- درصورتی که ماژول شما نیاز به پارامترهای اضافی داشت می‌توانید از این قسمت آن پارامترها را معرفی کنید -->
	<params />		<params />
	</install>		</install>
	</source>		</source>
−	<br />	+
−	این دستورات XML صرفا برای معرفی نویسنده ماژول و تاریخ ایجاد و ... نیست بلکه برای شناسایی به نصب کننده جوملا در واقع این فایل به نصب کننده جوملا می گوید کدام فایلها باید به داخل جوملا کپی شوند و ایجاد بخش پارامترهای ماژول که از قسمت مدیریت ماژولها (از داخل جوملا ) مورد دسترسی و مدیریت قرار میگیرد, وظیفه تمامی اینکارها به عهده این فایل XML است . <br />	+
−	توجه کنید به چه صورت برای تک تک فایلها یک reference ایجاد کردیم.<br />	+	این دستورات [[XML]] صرفا برای معرفی نویسنده [[ماژول]] و تاریخ ایجاد و ... نیست بلکه برای شناسایی به نصب کننده [[جوملا]] می‌گوید کدام فایل‌ها باید در [[جوملا]] کپی شوند و ایجاد بخش پارامترهای [[ماژول]] که از قسمت مدیریت [[ماژول]]‌ها (از مدیریت [[جوملا]]) مورد دسترسی و مدیریت قرار می‌گیرد، وظیفه تمامی اینکارها به عهده این فایل [[XML]] است.
−	نکته : در بخش معرفی فایلها ما به هیچ عنوان '''نباید''' برای فایل XML مان یک reference ایجاد کنیم . <br />	+
−	ایجاد فایل PHP در آدرس <br />	+	توجه کنید به چه صورت برای تک تک فایل‌ها یک reference ایجاد کردیم.
−	<div dir=ltr>/modules/mod_hello_world/mod_hello_world.php</div>	+
−	<br />	+	'''نکته:''' در بخش معرفی فایل‌ها ما به هیچ عنوان '''نباید''' برای فایل [[XML]] مان یک reference ایجاد کنیم.
		+
		+	ایجاد فایل [[PHP]] در آدرس <div dir=ltr>/modules/mod_hello_world/mod_hello_world.php</div>
		+
		+
	<source lang="php " >		<source lang="php " >
	<?php		<?php
سطر ۷۵:		سطر ۸۰:
	</p>		</p>
	</source>		</source>
−	وقتی این ماژول در جوملا اجرا چه اتفاقی می افتد ؟  پیغام Hello World در صفحه نمایش ظاهر میشود . این ساده ترین شکل ایجاد یک ماژول جوملا است .	+
−	<br />	+
−	در آخر نیز میتوانیم یک صفحه html ایجاد کنیم	+	وقتی این [[ماژول]] در [[جوملا]] اجرا می‌شود، چه اتفاقی می‌افتد؟
−	<br />	+
		+	پیغام Hello World در صفحه نمایش ظاهر می‌شود.
		+
		+	این ساده ترین شکل ایجاد یک [[ماژول]] [[جوملا]] است.
		+
		+	در آخر نیز می‌توانیم یک صفحه [[HTML]] ایجاد کنیم.
		+
	<div dir=ltr>		<div dir=ltr>
	/modules/mod_hello_world/index.html		/modules/mod_hello_world/index.html
	</div>		</div>
−	<br />	+
	<div dir=ltr>		<div dir=ltr>
	<html><body bgcolor="#FFFFFF"></body></html>		<html><body bgcolor="#FFFFFF"></body></html>
	</div>		</div>
−	<br />	+
−	این صفحه به منظور جلوگیری از دسترسی مستقیم غیر مجاز به ماژول ایجاد میشود. یعنی اگر کاربری که در مدیریت لاگین نکرده باشد و در آدرس بار خود ادرس ماژول را تایپ کند با یک صفحه سفید مواجه خواهد شد. ایجاد این صفحه برای ایجاد ماژولها اجباری نیست ولی برای جلوگیر از حمله مستقیم و دسترسی غیر مجاز مفید است .	+	این صفحه به منظور جلوگیری از دسترسی مستقیم غیر مجاز به [[ماژول]] ایجاد می‌شود. یعنی اگر کاربری وارد مدیریت [[جوملا]] نشده باشد و در آدرس بار خود آدرس [[ماژول]] را تایپ کند با یک صفحه سفید مواجه خواهد شد. ایجاد این صفحه برای ایجاد [[ماژول]]‌ها اجباری نیست ولی برای جلوگیری از حمله مستقیم و دسترسی غیر مجاز مفید است.
−	<br />	+
−	برای ایجاد یک بسته نصبی از این ماژول کافیست کل پوشه mod_hello_world را با تمام محتویاتش یک بسته zip تهیه کنید نتیجه کار یک بسته mod_hello_world.zip خواهد شد و سپس میتوانید براحتی آنرا از طریق مدیریت افزونه ها در جوملا نصب کنید.<br />	+	برای ایجاد یک بسته نصبی از این [[ماژول]] کافیست کل پوشه mod_hello_world را با تمام محتویاتش در یک بسته zip تهیه کنید نتیجه کار یک بسته mod_hello_world.zip خواهد شد و سپس می‌توانید براحتی آنرا از طریق مدیریت افزونه‌ها در [[جوملا]] نصب کنید.
−	=حالت واقعی ماژول های جوملا =	+
−	ایجاد ماژول مرحله خیلی ساده و آسان بود در واقع فقط یک نمونه آزمایشی بود. در حقیقت ماژول های جوملا اهداف بزرگتری را دنبال میکنند قابلیتهای بیشتری برای ارائه دارند . بنابراین سعی میکنیم یک ماژول پیچیده تری نسبت به ماژول قبلی ایجاد کنیم.	+	=حالت واقعی ماژول‌های جوملا =
−	برای ایجاد ماژولهای پیچیده تر ما نیاز داریم که از قبل با الگوی MVC (Model View Controller) آشنا باشیم . نام این ماژول را Hello World 2 میگذاریم و در آن معماری لایه بندی 3 لایه MVC را رعایت میکنیم.<br />	+
−	= نیازمندیها =	+	ایجاد [[ماژول]] مرحله خیلی ساده و آسان بود در واقع فقط یک نمونه آزمایشی بود. در حقیقت [[ماژول]]‌های [[جوملا]] اهداف بزرگتری را دنبال می‌کنند قابلیت‌های بیشتری برای ارائه دارند. بنابراین سعی می‌کنیم یک [[ماژول]] پیچیده تری نسبت به [[ماژول]] قبلی ایجاد کنیم.
−	برای ایجاد این ماژول ما به فایلها و فولدرهای زیر نیاز داریم :<br />	+
		+	برای ایجاد [[ماژول]]‌های پیچیده تر ما نیاز داریم که از قبل با الگوی MVC) Model View Controller) آشنا باشیم . نام این [[ماژول]] را Hello World 2 می‌گذاریم و در آن معماری لایه بندی 3 لایه MVC را رعایت می‌کنیم.
		+
		+	=نیازمندی‌ها=
		+
		+	برای ایجاد این [[ماژول]]‌ ما به فایل‌ها و فولدرهای زیر نیاز داریم:
		+
	<div dir=ltr>		<div dir=ltr>
−	/modules/mod_hello_world2/index.html <br />	+
−	/modules/mod_hello_world2/mod_hello_world2.php <br />	+	/modules/mod_hello_world2/index.html
−	/modules/mod_hello_world2/mod_hello_world2.xml <br />	+
−	/modules/mod_hello_world2/helper.php <br />	+	/modules/mod_hello_world2/mod_hello_world2.php
−	/modules/mod_hello_world2/en-GB.mod_hello_world2.ini <br />	+
−	/modules/mod_hello_world2/tmpl/index.html <br />	+	/modules/mod_hello_world2/mod_hello_world2.xml
−	/modules/mod_hello_world2/tmpl/default.php <br />	+
		+	/modules/mod_hello_world2/helper.php
		+
		+	/modules/mod_hello_world2/en-GB.mod_hello_world2.ini
		+
		+	/modules/mod_hello_world2/tmpl/index.html
		+
		+	/modules/mod_hello_world2/tmpl/default.php
		+
	</div>		</div>
−	<br />	+
−	= تفاوتها =	+	=تفاوت‌ها=
−	توجه کنید به جز فولدرها در این روش سه فایل در مقایسه با ماژول قبلی به این افزونه اضافه شده. این فایلها عبارتند از	+
−	<br />	+	توجه کنید به جز فولدرها در این روش سه فایل در مقایسه با [[ماژول]] قبلی به این افزونه اضافه شده است.
		+
		+	این فایل‌ها عبارتند از:
		+
	<div dir=ltr>		<div dir=ltr>
	helper.php , tmpl/default.php , en-GB.mod_hello_world2.ini		helper.php , tmpl/default.php , en-GB.mod_hello_world2.ini
	</div>		</div>
−	<br />	+
−	ما 2 هدف را به منظور اضافه کردن این فایلها دنبال میکنیم	+	ما 2 هدف را به منظور اضافه کردن این فایل‌ها دنبال می‌کنیم .
−	<br />	+
−	هدف اول : جدا کردن منطق برنامه از نحوه نمایش خروجی	+	هدف اول: جدا کردن منطق برنامه از نحوه نمایش خروجی.
−	<br />	+
−	هدف دوم : باز نویسی (خطا گیری , توسعه و ...) آن براحتی انجام میپذیرد	+	هدف دوم: باز نویسی (خطا گیری , توسعه و ...) آن براحتی انجام می‌پذیرد.
−	<br />	+
	بنابراین در فایل		بنابراین در فایل
−	<br />	+
	<div dir=ltr>		<div dir=ltr>
	/modules/mod_hello_world2/mod_hello_world2.php		/modules/mod_hello_world2/mod_hello_world2.php
	</div>		</div>
−	خواهیم داشت :	+
−	<br />	+	خواهیم داشت:
		+
		+
	<source lang="php " >		<source lang="php " >
	<?php		<?php
سطر ۱۴۳:		سطر ۱۷۳:
	?>		?>
	</source>		</source>
−	این موضوع که تفاوت این قسمت را با ماژول قبلی متوجه شویم '''خیلی مهم''' است . درواقع وقتی که تصمیم گرفته ایم برروی منطق افزونه و قابلیتهای ان کارکنیم باید فایل helper را include کنیم و داده های آماده ای که میخواهند نمایش داده شوند و باید با یک قالب به خروجی ارسال شود .	+
−	<br />	+
		+	این موضوع که تفاوت این قسمت را با [[ماژول]] قبلی متوجه شویم '''خیلی مهم''' است . درواقع وقتی که تصمیم گرفته‌ایم برروی منطق افزونه و قابلیت‌های آن کارکنیم باید فایل helper را include کنیم و داده‌های آماده‌ای که می‌خواهند نمایش داده شوند و باید با یک قالب به خروجی ارسال شود.
		+
	<div dir=ltr>		<div dir=ltr>
	/modules/mod_hello_world2/mod_hello_world2.xml		/modules/mod_hello_world2/mod_hello_world2.xml
	</div>		</div>
−	<br />	+
	<source lang="xml" >		<source lang="xml" >
	<?xml version="1.0" encoding="utf-8"?>		<?xml version="1.0" encoding="utf-8"?>
سطر ۱۸۹:		سطر ۲۲۱:
	<languages>		<languages>
−	<!-- فایلهای مربوط زبانهایی که این ماژول پشتیبانی میکند -->	+	<!—فایل‌های مربوط زبان‌هایی که این ماژول پشتیبانی می‌کند -->
	<language tag="en-GB">en-GB.mod_hello_world2.ini</language>		<language tag="en-GB">en-GB.mod_hello_world2.ini</language>
	</languages>		</languages>
−	<!-- پارامترهای اختیاری که در مدیریت ماژول نمایش داده میشود -->	+	<!-- پارامترهای اختیاری که در مدیریت ماژول نمایش داده می‌شود -->
	<params>		<params>
	<!-- Class Suffix پارامتر مربوط به  -->		<!-- Class Suffix پارامتر مربوط به  -->
سطر ۲۰۵:		سطر ۲۳۷:
	</install>		</install>
	</source>		</source>
−	<br />	+
−	توجه داشته باشید که ما میتوانیم به این الگو تعداد زبان و پارامترهای بیشتری را اضافه کنیم.	+
−	<br />	+	توجه داشته باشید که ما می‌توانیم به این الگو تعداد زبان و پارامترهای بیشتری را اضافه کنیم.
−	=اتصال به Database در [[جوملا]]=	+
		+	=اتصال به Database در جوملا=
		+
		+
	<div dir=ltr>		<div dir=ltr>
	/modules/mod_hello_world2/helper.php		/modules/mod_hello_world2/helper.php
	</div>		</div>
−	<br />	+
		+
	<source lang="php " >		<source lang="php " >
	<?php		<?php
سطر ۲۳۹:		سطر ۲۷۵:
	?>		?>
	</source>		</source>
−	<br />	+
−	در این فایل helper ما سعی کردیم با بانک اطلاعاتی ارتباط برقرار کنیم و یک کوئری نیز اجرا کنیم این یک نمونه آموزشی و الگوی ارتباط با دیتابیس در جوملا 1.5 است.	+
−	<br />	+	در این فایل helper ما سعی کردیم با بانک اطلاعاتی ارتباط برقرار کنیم و یک کوئری نیز اجرا کنیم این یک نمونه آموزشی و الگوی ارتباط با دیتابیس در [[جوملا]] 1.5 است.
		+
	<div dir=ltr>		<div dir=ltr>
	/modules/mod_hello_world2/tmpl/default.php		/modules/mod_hello_world2/tmpl/default.php
	</div>		</div>
−	<br />	+
		+
	<source lang="php " >		<source lang="php " >
	<?php defined('_JEXEC') or die('Restricted access'); // no direct access ?>		<?php defined('_JEXEC') or die('Restricted access'); // no direct access ?>
سطر ۲۵۷:		سطر ۲۹۵:
	</ul>		</ul>
	</source>		</source>
−	<br />	+
−	در این فایل ما یک html نامرتب (فعلا بدون استایل) ایجاد کردیم در این فایل حلقه ای وجود دارد که باعث میشود تمام items هاییکه از helper بازگردانده میشود را به نمایش درآورد.<br />	+
		+	در این فایل ما یک [[HTML]] نامرتب (فعلا بدون استایل) ایجاد کردیم در این فایل حلقه‌ای وجود دارد که باعث می‌شود تمام itemsهاییکه از helper بازگردانده می‌شود را به نمایش درآورد.
		+
	<div dir=ltr>		<div dir=ltr>
	/modules/mod_hello_world2/en-GB.mod_hello_world2.ini		/modules/mod_hello_world2/en-GB.mod_hello_world2.ini
	</div>		</div>
−	<br />	+
	<div dir=ltr>		<div dir=ltr>
−	LABEL USER COUNT=User Count <br />	+	LABEL USER COUNT=User Count
−	DESC USER COUNT=The number of users to display <br />	+	DESC USER COUNT=The number of users to display
−	RANDOM USERS=Random Users for Hello World2 <br />	+	RANDOM USERS=Random Users for Hello World2
−	USER LABEL=%s is a randomly selected user <br />	+	USER LABEL=%s is a randomly selected user
	</div>		</div>
−	در این قسمت مافایل های ترجمه انگلیسی ماژول نوشته ایم . در واقع دستورات  '''JText::_''' یا  '''JText::sprintf'''این امکان را فراهم میسازد تا بدون تغییر در HTML براحتی بتوانیم یک ترجمه برای ماژول اضافه کنیم .	+
−	<br />	+	در این قسمت ما فایل‌های ترجمه انگلیسی [[ماژول]] را نوشته‌ایم. در واقع دستورات  '''JText::_''' یا  '''JText::sprintf'''این امکان را فراهم می‌سازد تا بدون تغییر در [[HTML]] براحتی بتوانیم یک ترجمه برای [[ماژول]] اضافه کنیم.
		+
	=ایجاد یک package نصبی از ماژول=		=ایجاد یک package نصبی از ماژول=
		+
	اینک ما باید یک بسته zip از پوشه mod_hello_world2 تهیه کنیم به نام  mod_hello_world2.zip .		اینک ما باید یک بسته zip از پوشه mod_hello_world2 تهیه کنیم به نام  mod_hello_world2.zip .
−	<br />	+
−	'''نکته : این فایل zip همان بسته نصبی ما خواهد بود .'''	+	'''نکته: این فایل zip همان بسته نصبی ما خواهد بود .'''
−	<br />	+
−	در این مرحله میتوانیم از مدیریت جوملا اقدام به نصب این ماژول کنیم . بعد از نصب این ماژول فایل '''en-GB.mod_hello_world2.ini''' در '''language/en-GB/en-GB.mod_hello_world2.ini'''  قرار میگرد باقی فایلها در modules/mod_hello_world2 قرار میگرند این عمل توسط installer جوملا انجام میشود.	+	در این مرحله می‌توانیم از مدیریت [[جوملا]] اقدام به نصب این [[ماژول]] کنیم. بعد از نصب این [[ماژول]] فایل '''en-GB.mod_hello_world2.ini''' در '''language/en-GB/en-GB.mod_hello_world2.ini'''  قرار می‌گیرد و بقیه فایل‌ها در modules/mod_hello_world2 قرار می‌گیرند. این عمل توسط installer [[جوملا]] انجام می‌شود.
−	<br />	+
−	<br />	+
		+	----
		+
	منبع : <nowiki> http://docs.joomla.org/Creating_a_simple_module</nowiki>		منبع : <nowiki> http://docs.joomla.org/Creating_a_simple_module</nowiki>
−	<br />	+
	جمع آوری و ترجمه: [http://forum.joomlafarsi.com/members/26237-shmata شهاب مطاع پور]		جمع آوری و ترجمه: [http://forum.joomlafarsi.com/members/26237-shmata شهاب مطاع پور]
−	<br />	+
	{{معرفی پشتیبانی}}		{{معرفی پشتیبانی}}
	{{کپی رایت}}		{{کپی رایت}}
−	[[رده:مقالات جوملا]] [[رده:زبان برنامه نویسی تحت وب]]	+	[[رده:مقالات جوملا]] [[رده:زبان برنامه نویسی تحت وب]] [[رده:کدنویسی و گسترش جوملا]]

---

نسخهٔ کنونی تا ‏۸ فوریهٔ ۲۰۱۲، ساعت ۰۹:۳۰

ماژول Hello World

یک ماژول جوملا 1.5 در حالت عادی معمولا شامل 2 فایل می‌باشد . یک فایل شامل تنظیمات XML ویک فایل کنترل کننده PHP. فایل تنظیمات XML شامل اطلاعات عمومی ماژول می‌باشد اگر ماژول دارای پارامترهایی باشد که یک عملکرد یا یک مدل نمایش خاص را برای ماژول ارائه کند در قسمت پارامترهای ماژول نمایش داده می‌شود (که در قسمت مدیریت ماژول‌ها در مدیریت جوملا نمایش داده می‌شوند) .

فایل PHP وظیفه کنترل منطق برنامه و کارایی ماژول جوملا را برعهده دارد.

به عنوان مثال برای ایجاد یک ماژول ساده Hello World باید موارد زیر را انجام دهیم:

ابتدا باید یک پوشه در داخل پوشه ماژول‌ها (modules در فولدر ریشه جوملا) ایجاد کنیم. نام این پوشه را mod_hello_world می‌گذاریم این نحوه نام گذاری و این نام حائز اهمیت است.

پس از ایجاد پوشه مورد نظر اقدام به ایجاد فایل XML نماییم، این فایل را در پوشه ایجاد می‌کنیم. دقت کنید که نحوه نام گذاری این فایل XML هم حائز اهمیت است.

نکته: این نکته بسیار مهم است که نام فایل XML و نام ماژول یکی باشند در غیر اینصورت نصب کننده جوملا قادر به نصب بسته ماژول نخواهد بود.

قوانین نامگذاری پوشه‌ها برای ایجاد ماژول:

• تمامی پوشه‌ها باید با نام mod_ آغاز شوند
• قسمت دوم نام تمام ماژول‌ها باید بانام فایل XML یکی باشد.

<source lang="xml" > <?xml version="1.0" encoding="utf-8"?> <install type="module" version="1.5.0"> <name>Hello World - Hello</name>

<author>Shahab Matapour</author>

<creationDate>2011-06-23</creationDate>

<copyright>All rights reserved by Sh Matapour 2011.</copyright>

<license>GPL 2.0</license>

<authorEmail>[email protected]</authorEmail>

<authorUrl>www.studio-design.co</authorUrl>

<version>1.0.0</version>

<description>Provides a basic "Hello World" notice</description>

<files> <filename module="mod_hello_world">mod_hello_world.php</filename> <filename>index.html</filename> </files>

<params /> </install>

</source>

این دستورات XML صرفا برای معرفی نویسنده ماژول و تاریخ ایجاد و ... نیست بلکه برای شناسایی به نصب کننده جوملا می‌گوید کدام فایل‌ها باید در جوملا کپی شوند و ایجاد بخش پارامترهای ماژول که از قسمت مدیریت ماژول‌ها (از مدیریت جوملا) مورد دسترسی و مدیریت قرار می‌گیرد، وظیفه تمامی اینکارها به عهده این فایل XML است.

توجه کنید به چه صورت برای تک تک فایل‌ها یک reference ایجاد کردیم.

نکته: در بخش معرفی فایل‌ها ما به هیچ عنوان نباید برای فایل XML مان یک reference ایجاد کنیم.

ایجاد فایل PHP در آدرس

<source lang="php " > <?php //این خط برای تضمین امنیت در جوملا است. defined('_JEXEC') or die('Direct Access to this location is not allowed.'); ?>

Hello World

</source>

وقتی این ماژول در جوملا اجرا می‌شود، چه اتفاقی می‌افتد؟

پیغام Hello World در صفحه نمایش ظاهر می‌شود.

این ساده ترین شکل ایجاد یک ماژول جوملا است.

در آخر نیز می‌توانیم یک صفحه HTML ایجاد کنیم.

این صفحه به منظور جلوگیری از دسترسی مستقیم غیر مجاز به ماژول ایجاد می‌شود. یعنی اگر کاربری وارد مدیریت جوملا نشده باشد و در آدرس بار خود آدرس ماژول را تایپ کند با یک صفحه سفید مواجه خواهد شد. ایجاد این صفحه برای ایجاد ماژول‌ها اجباری نیست ولی برای جلوگیری از حمله مستقیم و دسترسی غیر مجاز مفید است.

برای ایجاد یک بسته نصبی از این ماژول کافیست کل پوشه mod_hello_world را با تمام محتویاتش در یک بسته zip تهیه کنید نتیجه کار یک بسته mod_hello_world.zip خواهد شد و سپس می‌توانید براحتی آنرا از طریق مدیریت افزونه‌ها در جوملا نصب کنید.

حالت واقعی ماژول‌های جوملا

ایجاد ماژول مرحله خیلی ساده و آسان بود در واقع فقط یک نمونه آزمایشی بود. در حقیقت ماژول‌های جوملا اهداف بزرگتری را دنبال می‌کنند قابلیت‌های بیشتری برای ارائه دارند. بنابراین سعی می‌کنیم یک ماژول پیچیده تری نسبت به ماژول قبلی ایجاد کنیم.

برای ایجاد ماژول‌های پیچیده تر ما نیاز داریم که از قبل با الگوی MVC) Model View Controller) آشنا باشیم . نام این ماژول را Hello World 2 می‌گذاریم و در آن معماری لایه بندی 3 لایه MVC را رعایت می‌کنیم.

نیازمندی‌ها

برای ایجاد این ماژول‌ ما به فایل‌ها و فولدرهای زیر نیاز داریم:

تفاوت‌ها

توجه کنید به جز فولدرها در این روش سه فایل در مقایسه با ماژول قبلی به این افزونه اضافه شده است.

این فایل‌ها عبارتند از:

ما 2 هدف را به منظور اضافه کردن این فایل‌ها دنبال می‌کنیم .

هدف اول: جدا کردن منطق برنامه از نحوه نمایش خروجی.

هدف دوم: باز نویسی (خطا گیری , توسعه و ...) آن براحتی انجام می‌پذیرد.

بنابراین در فایل

خواهیم داشت:

<source lang="php " > <?php //برای جلوگیری از دسترسی مستقیم و غیر مجاز defined('_JEXEC') or die('Direct Access to this location is not allowed.');

// include the helper file require_once(dirname(__FILE__).DS.'helper.php');

// گرفتن پارامتر از تنظیمات ماژول $userCount = $params->get('usercount');

// گرفتن آیتم از هلپر برای نمایش $items = ModHelloWorld2Helper::getItems($userCount);

// include the template for display require(JModuleHelper::getLayoutPath('mod_hello_world2')); ?> </source>

این موضوع که تفاوت این قسمت را با ماژول قبلی متوجه شویم خیلی مهم است . درواقع وقتی که تصمیم گرفته‌ایم برروی منطق افزونه و قابلیت‌های آن کارکنیم باید فایل helper را include کنیم و داده‌های آماده‌ای که می‌خواهند نمایش داده شوند و باید با یک قالب به خروجی ارسال شود.

<source lang="xml" > <?xml version="1.0" encoding="utf-8"?> <install type="module" version="1.5.0"> <name>Hello World 2 - Hello</name>

<author>Shahab Matapour</author>

<creationDate>2010-06-23</creationDate>

<copyright>All rights reserved by Shahab Matapour 2011.</copyright>

<license>GPL 2.0</license>

<authorEmail>[email protected]</authorEmail>

<authorUrl>www.studio-design.co</authorUrl>

<version>1.0.0</version>

<description>Provides a random listing of registered users</description>

<files> <filename module="mod_hello_world2">mod_hello_world2.php</filename> <filename>index.html</filename> <filename>helper.php</filename> <filename>tmpl/default.php</filename> <filename>tmpl/index.html</filename> </files>

   <languages>
       <!—فایل‌های مربوط زبان‌هایی که این ماژول پشتیبانی می‌کند -->
       <language tag="en-GB">en-GB.mod_hello_world2.ini</language>
   </languages>

<params> <param name="moduleclass_sfx" type="text" default="" label="Module Class Suffix" description="PARAMMODULECLASSSUFFIX" />

<param name="@spacer" type="spacer" default="" label="" description="" />

       <param name="usercount" type="text" default="5" label="LABEL USER COUNT" description="DESC USER COUNT" />
   </params>

</install> </source>

توجه داشته باشید که ما می‌توانیم به این الگو تعداد زبان و پارامترهای بیشتری را اضافه کنیم.

اتصال به Database در جوملا

<source lang="php " > <?php defined('_JEXEC') or die('Direct Access to this location is not allowed.');

class ModHelloWorld2Helper {

   /**
    * بازگرداندن لیست آیتمها
   */
   public function getItems($userCount)
   {
       // ایجاد یک کانکشن به بانک اطلاعاتی در جوملا
       $db = &JFactory::getDBO();

       // نحوه نگارش کوئری در جوملا 
       $query = 'SELECT a.name FROM `#__users` AS a ORDER BY rand() LIMIT ' . $userCount  . ;
	// اجرای کوئری در جوملا 
       $db->setQuery($query);
       $items = ($items = $db->loadObjectList())?$items:array();

       return $items;
   } 

} ?> </source>

در این فایل helper ما سعی کردیم با بانک اطلاعاتی ارتباط برقرار کنیم و یک کوئری نیز اجرا کنیم این یک نمونه آموزشی و الگوی ارتباط با دیتابیس در جوملا 1.5 است.

<source lang="php " > <?php defined('_JEXEC') or die('Restricted access'); // no direct access ?> <?php echo JText::_('RANDOM USERS'); ?>

<?php foreach ($items as $item) { ?>
• <?php echo JText::sprintf('USER LABEL', $item->name); ?>

   <?php } ?>

</source>

در این فایل ما یک HTML نامرتب (فعلا بدون استایل) ایجاد کردیم در این فایل حلقه‌ای وجود دارد که باعث می‌شود تمام itemsهاییکه از helper بازگردانده می‌شود را به نمایش درآورد.

در این قسمت ما فایل‌های ترجمه انگلیسی ماژول را نوشته‌ایم. در واقع دستورات JText::_ یا JText::sprintfاین امکان را فراهم می‌سازد تا بدون تغییر در HTML براحتی بتوانیم یک ترجمه برای ماژول اضافه کنیم.

ایجاد یک package نصبی از ماژول

اینک ما باید یک بسته zip از پوشه mod_hello_world2 تهیه کنیم به نام mod_hello_world2.zip .

نکته: این فایل zip همان بسته نصبی ما خواهد بود .

در این مرحله می‌توانیم از مدیریت جوملا اقدام به نصب این ماژول کنیم. بعد از نصب این ماژول فایل en-GB.mod_hello_world2.ini در language/en-GB/en-GB.mod_hello_world2.ini قرار می‌گیرد و بقیه فایل‌ها در modules/mod_hello_world2 قرار می‌گیرند. این عمل توسط installer جوملا انجام می‌شود.

---

منبع : http://docs.joomla.org/Creating_a_simple_module

جمع آوری و ترجمه: شهاب مطاع پور

هر گونه سوال و یا مشکلی در این رابطه دارید، می‌توانید در انجمن تخصصی تیم جوملا فارسی جستجو کرده و در صورت عدم دریافت نتیجه مورد نظر، سوال جدیدی را مطرح کنید.