[Framework] Rapide Framework, Framework MVC dla aplikacji PHP5 Opcje

[Prph]

Rapide Framework


(IMG:http://adrian.livenet.pl/Rapide100.png)

Rapide Framework powstał na bazie rozwiązań stosowanych w kilku frameworkach. Organizację i sterowanie w dużej mierze oparto na Zend Framework. Kierowałem się przede wszystkim prostotą. Mojavi (tym bardziej Symphony) jest moim zdaniem zbyt rozległe. Po całej aplikacji krążą obiekty kontekstów, kontrolera głównego... Nie, nie - to nie jest to, czego szukałem.

Całe sterowanie w Rapide powierzono małemu i elastycznemu Front Kontrolerowi. Jądro podzielono na jak najmniejsze części pozwalające w przyszłości na szybką ich wymianę.

Na pierwsze spojrzenie Rapide działa identycznie jak Zend Framework. Jednak po głębszym zapoznaniu się z frameworkiem, okazuje się, że Rapide jest znacznie wygodniejsze.

Przede wszystkim Rapide poprawnie implementuje widok z MVC. W każdej chwili możemy zamienić widoki, aby prezentowane dane ukazały się np. w formacie CSV.

Ponadto wiele czynności zostało zautomatyzowanych, dzięki czemu nie musimy wczytywac konfiguracji do akcji, czy też martwić się o kontrolę dostępu.

Cechy frameworka

• Implementacja MVC
  
• Obsługa pomocników i appletów w widoku dzięki czemu szybko zamieścimy w aplikacji stałe elementy (takie jak menu) w pełni funkcjonalne (funkcjonalność zbliżona do kontrolera).
  
• Kontrola dostępu na podstawie ACL i grupy użytkowników. Konfigurację przeprowadza się w pliku konfiguracyjnym kontrolera i polega ona na zdefiniowaniu grup, które mają dostęp lub nie.

Biblioteki dostarczane przez Rapide

• Rapide_Controller
  Klasa bazowa dla kontrolerów. Zawiera szereg aliasów skracających czas tworzenie kontrolera.
  
• Rapide_View
  Klasa widoku implementująca szablony php. Rapide dostarcza prostą
  oraz rozszerzoną klasę widoku, pozwalającą na dekorowanie treści o elementy stałe (np. stopka, menu).
  
• Rapide_User
  Klasa danych sesyjnych. Umożliwia autentyfikacje użytkownika oraz składowanie danych w sesji.
  Zastępuje standardową tablicę $_SESSION. Umożliwia stosowanie handlerów, dzięki czemu sesja może
  być przechowywana w bazie danych.
  
• Rapide_ACL
  Access Control List - system kontroli dostępu. Pozwala na definiowanie grup mająych dostęp (lub nie) do poszczególnych kontenerów (akcji).
  
• Rapide_Registry
  Rejestr pozwalający na przechowywanie obiektów i wspódzielenie ich w całej aplikacji.
  
• Rapide_Database_MySQL
  Sterownik bazy danych MySQL dostarczający prosty i szybki w użyciu interfejs zarządzający danymi w bazie.
  
• Rapide_Language
  Prosta klasa języka. Dane przechowywane są w tablicach php.
  
• Rapide_Validator
  Szereg klas z rodziny Rapide_Validator dostarczaja prostych i skutecznych mechanizmów
  walidacyjncyh dla danych.
  
• Rapide_Form
  Klasa umożliwiająca szybki dostęp do danych przesłanych za pomocą formularzy. Obecnie bardzo skromna.

Zdaję sobie sprawę, że Rapide wcale nie musi być nadzwyczajnym frameworkiem. Napisałem go dla siebie. Zamieszczam go w sieci, ponieważ może przydać się osobom, które uczą się budowania frameworków.

Kod do pobrania: http://vgm.pl/adrianpawlikpl/rapide/

Tworzenie kontrolera

Kontrolery w aplikacji powinny dziedziczyć po abstrakcyjnej klasie Rapide_Controller. W zasadzie framework wymaga, aby kontrolery
implementowały interfejs Rapide_Controller_Interface.

Katalog kontrolerów definiowany jest w pliku konfiguracyjnym Rapide/config.php. Kontroler musi byź zapisany pod nazwą Kontroler.class.php.


Kontroler jest kontenerem dla wszystkich akcji. Dla przykładu: kontroler Nowosci będzie zawierał akcje Dodaj, Pokaz, Usun, Edytuj itd. Klasa kontrolera musi nosić nazwę Controller_Kontroler, natomiast metody będące akcjami - AkcjaAction.


Przykładowy kontroler

[PHP] pobierz, plaintext 
<?php
class Controller_Example extends Rapide_Controller
{
  public function ExampleAction()
  {
	echo 'Example action from controller Example';
  }
}
?>
[PHP] pobierz, plaintext 

Teraz wystarczy w przeglądarce wpisać adres: http://TwojAdres.pl/www/?controller=Exampl...;action=Example.
Rezultatem pracy frameworka będzie wyżej podany komunikat.

Metody klasy Rapide_Controller
Kontroler bazowy w Rapide został tak zaprojektowany, aby uprościć i przyśpieszyć budowę aplikacji. Poniższa lista zawiera metody, których warto używać:

getParameter($sParameter)
Zwraca parametr GET przekazany w adresie do kontrolera. W przypadku braku parametru wzraca null.


hasParameter($sParameter)
Zwraca wartość logiczną informującą, czy istnieje parametr GET przekazany w adresie.


getConfig()
Zwraca obiekt konfiguracji dla danego kontrolera. Dane konfiguracyjne pobierane są
z tablic php zapisanych w katalogu konfiguracji kontrolerów.


getView($sView)
Zwraca obiekt danego widoku. Widok pobierany jest z katalogu widoków.


getModel($sModel)
Zwraca obiekt wybranego modelu. Model pobierany jest z katalogu widoków.


getUser()
Zwraca obiekt User, który pozwala na zapis danych sesyjnych.


getLanguage()
Zwraca obiekt języka. Dane językowe dla kontrolera ładowane są wcześniej w pluginie
Rapide_Plugin_Language.


forward($sController = null, $sAction = null, array $aParameters = array())
Pozwala na określenie następnej akcji do wykonania. Pozostawienie wartości pustych spowoduje
forwarodwanie na domyślny kontroler.


redirect($sController = null, $sAction = null, array $aParameters = array())
Pozwala wykonać przekierowanie na inną akcję. Pozostawienie wartości pustych spowoduje
przekierowanie na domyślny kontroler.


Każdy kontroler posiada domyślną akcję Index. Jest ona wywoływana, jeżeli akcja nie zostanie
określona.


Przykładowe kody

Kontroler User - akcja zmiany hasla dla zalogowanego uzytkownika

[PHP] pobierz, plaintext 
<?php
 
class Controller_User extends Rapide_Controller
{
  public function PasswordAction()
  {
	$oForm = new Rapide_Form;
 
	if(!$oForm->isSubmitted())
	  return $this->getView('UserPassword');
 
	$sPassword  = $oForm->get('password');
	$sPassword2 = $oForm->get('password2');
 
	if($sPassword != $sPassword2)
	{
	  $aErrors[] = $this->getLanguage('Controller', 'User', 'Password', 'Error', 'Match');
 
	  $oView = $this->getView('UserPassword');
	  $oView->errors = $aErrors;
 
	  return $oView;
	}
 
	$iUser = $this->getUser()->id;
 
	$oUser = $this->getModel('User');
	$oUser->load($iUser);
 
	$oUser->password($sPassword);
	$oUser->save();
 
	$this->redirect();
  }
}
 
?>
[PHP] pobierz, plaintext 

Widok i szablon widoku dla tej akcji

[PHP] pobierz, plaintext 
<?php
class View_UserPassword extends Rapide_View_Html_Extended
{
  public function __construct()
  {
	$this->setTemplate('UserPassword');
  }
}
?>
[PHP] pobierz, plaintext 

[HTML] pobierz, plaintext 
<?php $this->title = $this->lang('Controller', 'User', 'Password', 'Title'); ?>
 
<h1><?= $this->lang('Controller', 'User', 'Password', 'Header') ?></h1>
 
<?php require_once('formErrors.inc.php'); ?>
 
<form action="" method="post">
  <p>
    <?= $this->lang('Controller', 'User', 'Password', 'Password') ?>: <br/>
    <input type="password" name="password">
  </p>
 
  <p>
    <?= $this->lang('Controller', 'User', 'Password', 'Password2') ?>: <br/>
    <input type="password" name="password2">
  </p>
 
  <p>
    <input type="submit" name="submit" value="<?= $this->lang('Form', 'Submit') ?>">
  </p>
</form>
[HTML] pobierz, plaintext 

Jak już wspomniałem - framework napisałem dla siebie. Mam nadzieję, że komuś może się przydać, chociaż w celach edukacyjnych.

Pozdrawiam, Adrian J. Pawlik.

Ten post edytował Prph 5.11.2006, 19:56:50

[AxZx]

a masz moze przyklad aplikcji zbudowanej za pomoca Rapide?

i jeszcze takie pytanie
czy dodawanie jakis tekstow w szablonie musi byc takie dlugie?

[PHP] pobierz, plaintext 
<?= $this->lang('Controller', 'User', 'Password', 'Password') ?>: <br/>
[PHP] pobierz, plaintext 

nie mogloby byc tak ze jezeli ladujesz jakis widok to razem z nim ladujesz plik z tlumaczeniami, albo pobierasz odpowiednie tlumaczenia z bazy otrzymujac tablice ktorej mozesz juz normalnie uzywac w szablonie.

[PHP] pobierz, plaintext 
<?= $this->lang('Password') ?>: <br/>
[PHP] pobierz, plaintext 

moze da sie tak?

Ten post edytował AxZx 3.01.2007, 16:30:37

[Prph]

a masz moze przyklad aplikcji zbudowanej za pomoca Rapide?

O ile Rapide jest w zasadzie skonczone (framework gotowy, ale wszystko wychodzi dopiero w praniu), to dokumentacji i przykladow nadal brak. Do projektu dolaczyl sie Jakub Kozicki, ktory obiecal pomoc przy dokumentacji. Wiem, ze pisze teraz projekt na Rapide. Moze uda mi sie go przekonac do udostepnienia fragmentow kodu.

Ja sam pisalem jakis czas temu Newsletter. Nie zostal ukonczony, popniewaz byl jedynie proba frameworka. Problem teraz jest taki, ze nie jest kompatybilny z najnowsza wersja Rapide, w ktorej nieco zmienilismy API. Przede wszystkim usuniecie apletow na rzecz kontrolerow, ktore mozna osadzac w szablonie, jako pluginy widoku (np. kontroler Menu, akcja Administrator wyswietla w danym miejscu menu administratora).

i jeszcze takie pytanie
czy dodawanie jakis tekstow w szablonie musi byc takie dlugie?

[PHP] pobierz, plaintext 
<?= $this->lang('Controller', 'User', 'Password', 'Password') ?>: <br/>
[PHP] pobierz, plaintext 

Oczywiscie, ze nie musi... Taki efekt jest uzyskany przez mocny podzial plikow jezykowych. W zasadzie kazda akcja zawiera wlasny plik. Nie jest to jednak narzutem ze strony Rapide. Mozna bez problemu wszystkie tlumaczenia zamiescic w pliku nazwaJezyka.php w katalogu Language/. Mozna tez inaczej rozmiescic pliki jezykowe, np:

Language/
Polish/
Nowosci.php
Uzytkownicy.php

Teraz wystarczy:

[PHP] pobierz, plaintext 
<?= $this->lang('Nowosci', 'Autor') ?>
  <?= $this->lang('Uzytkownicy', 'JakisKlucz');
[PHP] pobierz, plaintext 

Zaleta Language z Rapide jest elastytcznosc. Nie musimy martwic sie o ladowanie jezykow. Jezeli odwolujemy sie do jakiegos klucza w jezyku, a on nie istnieje, Rapide sprobuje odnalesc pliki jezykowe dla tego klucza. Kolejne odwolania juz nie powoduja poszukiwania pliku, bo jest on zaladowany.

Wczesniej odpowiedni plugin frontkontrolera byl odpowiedzialny za ladowanie plikow jezykowych. W praktyce okazalo sie to malo wygodne.

Naklonie Kube Kozickiego, aby pomagal rozwiazywac problemy z Rapide. Sam zapoznal sie z Rapide, przeczytal dokladnie kod, zglosil kilka poprawek, kilka ulepszen. Jego porady moga byc naprawde cenne.

Pozdrawiam,
Adrian.