[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

[Quickest]

Nadal nie rozumiem, tych praw dostępu, może dlatego, że pierwszy raz mam z tym do czynienia...
Jak wygląda taka konfiguracja pliku kontrolera?(IMG:http://forum.php.pl/style_emoticons/default/questionmark.gif) Przykład?

Przypuśmy plik konfiguracyjny kontrollera z przykładu:

np. /application/Config/Controller/example.php

[PHP] pobierz, plaintext 
<?php
$aConfig = array(array('example' => array('Security' => array('Groups' =>
array('Deny' => array('banned_user', 'moderators'), 'Allow' => array('admins'))))));
?>
[PHP] pobierz, plaintext 

Tak wygląda przykładowy plik konfiguracyjny?(IMG:http://forum.php.pl/style_emoticons/default/questionmark.gif) yyy...? (IMG:http://forum.php.pl/style_emoticons/default/worriedsmiley.gif)

hmm... może za dużo nad tym siedzę i mam już mętlik w głowie i wszystko mi się miesza. Mianowicie nie rozumiem jednej rzeczy. ... na podstawie jakich danych user jest identyfikowany czy może mieć dostęp do danej metody?

Jak rozumieć metody: isAuthenticated() oraz setAuthenticated() w klasie Rapide_User(IMG:http://forum.php.pl/style_emoticons/default/questionmark.gif) ?
Czy one nie powinny być wywoływane w trakcie sprawdzania danych user'a o zalogowaniu?(IMG:http://forum.php.pl/style_emoticons/default/questionmark.gif)
Albo może inne pytanie... jeżeli autoryzacja się nie powiedzie to przekierowujemy usera na akcję z formularzem logowania? (IMG:http://forum.php.pl/style_emoticons/default/worriedsmiley.gif)

Ehh... wszystko już mi się to miesza jak widać (IMG:http://forum.php.pl/style_emoticons/default/blink.gif) , może ktoś mi rzuci światło na to, jak to dokładnie wygląda np. z akcją logowania usera na stronę w powyższym frameworku (IMG:http://forum.php.pl/style_emoticons/default/sad.gif)

Ten post edytował Quickest 7.09.2006, 18:21:55

[Prph]

Wszystko przez to ze nie udostepnilem dokumentacji. Nie umiem pisac dokumentacji :/

Konfiguracja kontroli dostępu

Konfiguracja jest zapisywana w pliku konfiguracyjnym kontrolera. Domyslnie jest to application/Config/Controller/Nazwa.php

Przykladowy plik wygląda następująco:

[PHP] pobierz, plaintext 
<?php
 
$aConfig['Actions']['Password'] = array
(
  'Security' => array
  (
	'Groups' = array
	(
	  'Allow' => array('admin', 'moderator'),
	  'Deny' => array('nieproszony_gosc')
	)
  )
);
 
?>
[PHP] pobierz, plaintext 

W tym przypadku dostęp będą mieli użytkownicy którzy posiadają grupy admin i moderator, ale nie posiadają grupy nieproszony_gosc. Czyli np. jezeli mamy uzytkownika Adrian z grupą moderator, to on uzyska dostęp. Jeżeli mamy użytkownika Joasia z grupami admin i nieproszony_gosc, to Joasia nie dostanie dostępu.

Autentyfikacja uzytkownika odbywa sie w klasie Rapide_User. Za pomoca metody isAuthenticated() klasa informuje, czy użytkownik sie zalogował (o tym za chwile). Ponadto metoda getGroups zwraca tablice z grupami, jakie ma użytkownik.

Można zdefiniować, aby dana akcja wymagała jedynie zalogowania użytkownika. Czyli nie musi ustawiać jakie grupy mają dostęp. Wystarczy wówczas zapisać taką konfigurację:

[PHP] pobierz, plaintext 
<?php
$aConfig['Actions']['Password'] = array
(
  'Security' => true
);
?>
[PHP] pobierz, plaintext 

Wartosc Security moze byc dowolna. Wazne zeby sekcja Security byla utworzona.

Oczywiście, wszystko nabiera sensu w chwili, kiedy użytkownik się zaloguje. Niżej przedstawiam akcję logowania:

[PHP] pobierz, plaintext 
<?php
 
class Controller_Auth extends Rapide_Controller
{
  public function LoginAction()
  {
	$oForm = new Rapide_Form;
 
	/*
	  Check the form. If it has not been submitted,
	  display the form.
	*/
 
	if(!$oForm->isSubmitted())
	{
	  return $this->getView('AuthLogin');
	}
 
	$sLogin	= $oForm->get('login');
	$sPassword = $oForm->get('password');
 
	/*
	   Check the data and display the form on failure.
	*/
 
	if(empty($sLogin) || empty($sPassword))
	{
	  $aErrors[] = $this->getLanguage()->get('Controller', 'Auth', 'Login', 'Error', 'Empty');
 
	  $oView = $this->getView('AuthLogin');
	  $oView->errors = $aErrors;
 
	  return $oView;
	}
 
	/*
	   Check the login using DAO.
	*/
 
	$oUserDAO = $this->getModel('UserDAO');
 
	$iUser = $oUserDAO->getIdByLogin($sLogin, $sPassword);
 
	if(!$iUser)
	{
	  $aErrors[] = $this->getLanguage()->get('Controller', 'Auth', 'Login', 'Error', 'Data');
 
	  $oView = $this->getView('AuthLogin');
	  $oView->errors = $aErrors;
 
	  return $oView;
	}
 
	/*
	   Everything is correct. Set the user and forward
	   to default action.
	*/
 
	$oUserModel = $this->getModel('User');
	$oUserModel->load($iUser);
 
	$aGroups = $oUserModel->groups();
 
	$oUser = $this->getUser();
	$oUser->setAuthenticated();
	$oUser->setGroups($aGroups);
 
	// Set additional data
 
	$oUser->id = $iUser;
	$oUser->firstName = $oUserModel->firstName();
	$oUser->lastName  = $oUserModel->lastName();
 
	$this->forward();
  }
 
  public function logoutAction()
  {
	$this->getUser()->destroy();
	$this->forward();
  }
}
 
?>
[PHP] pobierz, plaintext 

Ostatnie linie akcji Login przedstawiaja sposob autentykacji użytkownika oraz ustawienie dodatkowych informaacji (np imie i nazwisko).