Warning: file_get_contents(http://graph.facebook.com/http://youthcoders.net/index.php): failed to open stream: HTTP request failed! HTTP/1.0 403 Forbidden in /var/www/old-yc/plugins/content/addthis.php on line 38
Tworzenie pluginu dla modyfikacji treści dla Joomla - Manual Drukuj
Ocena użytkowników: / 2
SłabyŚwietny 
Wpisany przez Jan Jackowicz-Korczyński   
wtorek, 22 czerwca 2010 04:30

Poniżej zamieszczamy opis, krok po kroku jak utworzyć dodatek (plugin) modyfikujący treść artykułu w CMS Joomla 1.5. API Joomla udostępnia porgramistom metody pzrechwycenia treści atykułu oraz zdarzenia (events) związane z jego przetwarzaniem przez system. Pozwala na na utworzenie dowolnego rozszerzenie modyfikującego pozastandardowo treści dokumentó.

Wprowadzenie

Plugin tego typu ingeruje w treść utworzonego artykułu i modyfikuje ją zgodnie z zamysłem programisty.

Plugin składa się co najmniej z 2 plików: PHP (silnik rozszerzenia) oraz XML (instalator). Dodatkowo często występują rozszerzenia z wersjami językowymi. Przyjęto standard, że nazwa rozszerzenie jest równoczesnie nazwą plików i tak dla przykładu:

Rozszerzenie o nazwie: Ble Ble będzie zrealizowane za pomocą plików:

  • plg_ble_ble.php
  • plg_ble_ble.xml

oraz odpowiednio plików językowych:

  • en_GB_plg_ble_ble.ini
  • pl_PL_plg_ble_ble.ini

Opis struktury pliku XML

Plik xml jest plikiem odpowiadającym za poprawną instalację dodatku w CMS Joomla. Poniżej przykładowy opis tego pliku.

deklaracje wstępne:

Zawartość 3 pierwszych znaczników pliku to:

  • deklaracja, że jest to plik xml oaz ustalenie dla niego kodowania znaków w standardzie utf-8
  • Ustalenie typu pliku xml oraz odesłąnie do jego wzorca DTD
  • określenie języka pliku jako xml
  • Określenie parametrów instalatora tu:
    • przeznaczenie dla Joomla 1.5
    • określenie, że instalowany jest plugin
    • określenie rodzaju instalowanego pluginu - tutaj do przetwarzania treści


	<?xml version="1.0" encoding="utf-8"?> 

	<!DOCTYPE install  PUBLIC"-//Joomla! 1.5//DTD plugin 1.0//EN" "http://www.joomla.org/xml/dtd/1.5/plugin-install.dtd"> 

	<source lang="xml">

	<install version="1.5" type="plugin" group="content">

	

 

metadane pluginu:

Kolejny blok dancyh pliku zawiera metadane dotyczące dodatku. 
Zawartość poniższego przykładu wystarczająco określa ich zawartość.


<name>Nazwa pluginu</name>
<creationDate>Data utwozrenia</creationDate>
<author>Nazwa autora</author>
<authorEmail>e-mail autora pluginu</authorEmail>
<authorUrl>strona www autora</authorUrl>
<copyright>Copyright</copyright>
<license>określenie rodzaju licencji, przykładowo GNU/GPL</license>
<version>Określenie wersji pluginu</version>
<description>Krótki opis pluginu. Wyświetlany jest w systemie w czasie instalacji 
oraz w trakcie jego edycji w Menadrzerze dodatków zaplecza administracyjnego. 
</description>

instalacja plików:

W bloku <files> deklaruje się jakie pliki mają być zainstalowane.
 W poniższym przykładzie uwzględniono jedynie główny plik PHP pluginu.
Jeśli plugin korzysta z większej ilości plików, wszystkie muszą być wymienione w bloku <files> 
w odrębnym znaczniku <file>

W poniższym przykłądzie zastosowano przykładową nazwę pluginu ustaloną dla tego manuala. 
(plg_ble_ble) Musisz ją oczywiście zmienić na nazwę swojego pluginu.
Uwaga na nnazewnictwo plików! Dostosuj się do nazw plików stosowanych w Internecie 
(brak spacji, brak polskich liter, małe i duże litery są innymi literami). 
Pamiętaj o zgodności nazw plików z ich deklarowaniem w opisywanym w tym miejscu instalatorze 
- pliku xml. 
 

 

<files>
   <filename plugin="nameofplugin">plg_ble_ble.php</filename>
</files>

instalacja wersji językowych:

Pilki z wrrsjami jeżykowymi, zgodnie ze standardem przyjętym w Joomla znajdują się w plikach kod_języka_ty_i_nazwa_rozszerzenia.ini Dzięki tak przyjętemu rozszerzeniu system rozpoznaje używany język i dostosowuje do niego również komunikaty dodatku.

Wersje językowe, o ile istnieją takie pliki instalowane są w bloku <lanquages>. Poszczególne pliki umieszczone są w znaczniku <lanquage> Parametr tag określa folder w jakim instalator będzie instalował plik językowy.

 

<languages>
   <language tag="en-GB">en-GB.plg_content_nameofplugin.ini</language>
</languages>
ciąg dalszy nastąpi - artykuł jest w trakcie redagowania