Zalążek frameworka z MVC, Proszę, zweryfikujcie moje podejście Opcje

[Prph]

Witam wszystkich,

Ostatnio zacząłem czytać o obiektowym php5, MVC, frameworkach i postanowiłem zacząć pisać kod, który byłby dla mnie wygodny oraz co ważne - nadawał się do powtórnego wykorzystania.

Opiszę to co do tej pory zrobiłem. Proszę Was, znaczniej bardziej doświadczonych programistów, o uwagi na temat mojego podejścia.

Zaznacze, że swoją pracę oparłem do tej pory na artykule Frameworki z php.pl, framework CakePHP oraz o wypowiedzi forumowiczach w topikach MVC.

Charakterystyka ogólna:
Drzewo projektu

Kod

|- actions/ (tu wrzucam kontrolery w postaci class.NazwaKontrolera.php)
|- conf/
|- models/ (tu będą modele, do tej pory nic tam nie mam)
|- lib/
|  +-- core/ - tu są moje pliki wykorzystywane w całej aplikacji
|        +-- class.Dispatcher.php
|        +-- class.Controller.php
|- templates/ - szablony Smarty  
|
|- index.php

Oczywiście nie jest to finalny widok drzewa projektu. Ale nie to jest ważne.

Jak działa mój framework?
index.php uruchamia Dispatcher, który parsuje URL. Jeżeli następuje zgłoszenie index.php/Akcja1/Parametr1/Parametr2/, to dispatcher załącza kontroler Akcja1, a następnie kontroler tej akcji wywołuje na sobie (w zasadzie na potomku) metodę Parametr1 z parametrem Parametr2.

Przykład: strona.pl/index.php/Uzytkownik/Pokaz/1234. Dispatcher przekaże kontrolę do kontrolera Uzytkownik. Ten natomiast włączy metodę Pokaz(1234);

Generalnie wygląda to właśnie tak. Z tego co czytałem, to chyba całkiem logiczne rozwiązanie. Oczywiście mogę się mylić...

Pliki

[PHP] pobierz, plaintext 
Plik index.php
<?php
require_once('conf/conf.Core.php');
require_once('lib/core/Logger/class.Logger.php'); // to nas nie interesuje - zwyklu silnik logowania
require_once('lib/core/class.Dispatcher.php');
 
try
{
  Logger::register('file:///tmp/log.core.txt');
 
  $objDispatcher = new Dispatcher();
  $objDispatcher->handle();
}
catch (Exception $exception)
{
  echo $exception->getMessage();
}
 
?>
[PHP] pobierz, plaintext 

[PHP] pobierz, plaintext 
 Plik class.Dispatcher.php
 
<?php
 
require_once('lib/core/class.Controller.php');
require_once('Smarty.class.php');
 
class Dispatcher
{
 
  private $_strUrlParameters; // zawiera parametry url, np: dla strona.pl/index/a/b/c/d zawiera a/b/c/d/
  private $_arrUrlParameters; // tutaj parametry juz są w tablicy 
 
  public function __construct()
  {
	$strUrlParameters = $_SERVER['PATH_INFO'];
	$this->_strUrlParameters = substr($strUrlParameters, 1);
  }
 
  public function handle()
  {
	$this->_parsePath(); // zapusuje parametry url do tablicy
 
	$strControllerName = $this->_getControllerName(); // zwroci pierwszy elementy w tablicy parametrow (indeks w tablicy oczywiscie 0)
	//Następnie tworzy kontroler na podstawie nazwy akcji i go uruchamia
	$strControllerFile = 'actions/class.'.$this->_getControllerName().'Controller.php'; 
	if(file_exists($strControllerFile))
	{
	  require_once($strControllerFile);
	  $strControllerClasName = $this->_getControllerName().'Controller';
	  $objController = new $strControllerClasName($this->_getParametersForController());
	  $objController->run();
 
	  $objSmarty = new Smarty();
	  $objSmarty->tempalte_dir = 'templates';
	  $objSmarty->compile_dir = 'var';
 
	  $objSmarty->assign($objController->getModelData()); // kontroler powinien zwrocic dane dla Smarty.
	  $objSmarty->display($objController->getView());
	}
	else
	{
	  throw new Exception('Core, dispatcher: Action '.$strActionToRun.' does not exist');
	}
  }
 
  private function _parsePath() // rozbija parametry url na tablice
  {
	 $arrParameters = explode('/', $this->_strUrlParameters);
	 if($arrParameters[count($arrParameters) - 1] == '')
	   array_pop($arrParameters);
 
	 $this->_arrUrlParameters = $arrParameters;
  }
 
  private function _getControllerName() // zwraca nazwe akcji ktora nalezy wykonac - tutaj to pierwsza pozycja w tablicy zawierajacej parametry url
  {
	$strControllerName = $this->_arrUrlParameters[0];
 
	if(strlen($strControllerName))
	  return $strControllerName;
	else
	  throw new Exception('Core, dispatcher: There is not action to run');
  }
 
  private function _getParametersForController()
  {
	$intNumOfPathParameters = count($this->_arrUrlParameters);
	$arrPrametersForController = array();
 
	for($i = 1; $i < $intNumOfPathParameters; $i++)
	  $arrPrametersForController[] = $this->_arrUrlParameters[$i];
 
	return $arrPrametersForController;
  }
}
 
?>
[PHP] pobierz, plaintext 

[PHP] pobierz, plaintext 
Plik class.Controller.php
<?php
 
require_once('Collection/class.Collection.php');
 
class Controller
{
  private $_strControllerName = null; // nazwa kontrolera - wyorzystuje sie do wybrania widoku i modelu
  private $_arrControllerParameters = array(); // parametry dla kontrolera. jezeli url wygladal nastepujaco: strona.pl/index.php/Uzytkownik/Pokaz/12345 to zawiera tablice [Pokaz][1234]
 
  protected $_strPageName; // tytul strony (dla htmla)
 
  private $_objModelsCollection; // kolekcja modeli, dziala jak tablica asocjacyjna - malo wazne
  private $_strView; // widok - tutaj to nazwa szablonu smarty
 
  private $_arrViewVars = array();
 
  public function __construct($arrParameters = null)
  {
	if(!isset($this->_strControllerName)) // pobiera nazwe swojej klasy - wykorzystuje sie to do wyboru widoku oraz modelu
	{
	  $arrResults = array();
 
	  if(!preg_match('/(.*)Controller/i', get_class($this), $arrResults))
	  {
		die('Controller: Can not get my class name');
	  }
 
	  $this->_strControllerName = $arrResults[1];
	}
 
	if(count($arrParameters))
	  $this->_arrControllerParameters = $arrParameters;
 
	$this->_objModelsCollection = new Collection();
 
	$this->_objModelsCollection->addItem($this->_strControllerName.'Model');
	$this->_strView = $this->_toLowerCase($this->_strControllerName).'.tpl';
  }
 
  public function getModelData() // zwraca tablice dla Smarty->assign()
  {
	if(count($this->_arrViewVars))
	  return $this->_arrViewVars;
  }
 
  public function getView() // zwraca szablon dla smarty->display();
  {
	return $this->_strView;
  }
 
  public function run() // sedno kontrolera. Jezeli przekazano dodatkowy parametr w url, np: strona.pl/index.php/Uzytkownik/Pokaz to wywola sie funkcja Pokaz, jezeli nie wywola funckje domysla, ktora defi
niuje juz potomek tej klasy
  {
	if($this->_getMethodToRun())
	{
	  if(is_callable(array($this, $this->_getMethodToRun()), $this->_getParameterForMethod()))
		call_user_func_array(array($this, $this->_getMethodToRun()), $this->_getParameterForMethod());
	}
	else
	  $this->runDefaultMethod();
  }
 
  protected function _setPageTitle($strTitle)
  {
	$this->_strPageTitle = $strTitle;
	$this->_setVar('TITLE', $strTitle);
  }
 
  protected function _setVar($strVarName, $mixValue)
  {
	$this->_arrViewVars[$strVarName] = $mixValue;
  }
 
  private function _toLowerCase($strString)
  {
	return strtolower(substr($strString, 0, 1)).substr($strString, 1);
  }
 
  private function _getMethodToRun() // sprawdza parametr url, czy ma wykonac jakas metode - patrz wyzej
  {
	if(isset($this->_arrControllerParameters))
	{
	  if(method_exists($this, $this->_arrControllerParameters[0]))
		return($this->_arrControllerParameters[0]);
	}
	return false;
  }
 
  private function _getParameterForMethod() // zwraca tablice parametrow dla metody ktora nalezy wykonac. Jezeli url wygldal: 
strona.pl/index.php/uzytkownik/pokaz/12345 to wykona metode pokaz kontrolera uzytkownik przekazujac do pokaz() 12345.
  {
	if(isset($this->_arrControllerParameters))
	{
	  if(count($this->_arrControllerParameters) > 1)
	  {
		$intNumOfParameters = count($this->_arrControllerParameters);
		$arrPrametersForMethod = array();
 
		for($i = 1; $i < $intNumOfParameters; $i++)
		  $arrPrametersForMethod[] = $this->_arrControllerParameters[$i];
 
		return $arrPrametersForMethod;
	  }
	}
  }
}
 
?>
[PHP] pobierz, plaintext 

[PHP] pobierz, plaintext 
Plik class.HelloController.php - przykładowy kontroler dla akcji Hello
<?php
 
// To jest przykladowy kontroler. Jak widac mozna wywolac strone tak: strona.pl/index.php/Hello/Hi albo Hello/Bye. Mozna przekazac argument: Hello/Bye/Adrian przez co akcja porzegna Adriana.
 
class HelloController extends Controller
{
  public function hi()
  {
	$this->_setPageTitle('Witamy Cię');
	$this->_setVar('HEADER', 'Witaj, to działa!');
  }
 
  public function bye($strName)
  {
	$this->_setPageTitle('Pa pa pa');
	$this->_setVar('HEADER', 'Pa pa '.$strName.', do następnego razu!');
  }
 
  public function runDefaultMethod()
  {
	$this->hi();
  }
}
 
?>
[PHP] pobierz, plaintext 

Będę Wam ogromnie wdzięczny za uwagi. Pozdrawiam serdecznie,
Adrian.

Ten post edytował Prph 4.03.2006, 19:40:41

[Prph]

Przeczytajcie na końcu!. Jak rozwiąć Widok?

Witam,

ja rozwizalem to tak:

w index.php laduje FrontController. Pierwsza czynnoscia jaka on wykona bedzie wydobycie informacji, jaka akcje powinien odpalic. Tym zajmie sie obiekt klasy URL. za pomoca metod getActionName() i getParameters() zwraca odpowiednie dane.

Majac juz nazwe akcji, Front kontroler wczytuje konfiguracje dla akji. Uruchamiany jest takze mechanizm autoryzacji, jezeli w konfiguracji bylo podane ze akcja jej wymaga.

Po przejsciu testow, zwyczajnie ladowana jest klasa, tworzony obiekt i wykonywana na nim metoda run();

Co robi run()?
1. Wybiera dla siebie model.
2. Wybiera dla siebie widok.
3. Wykonuje jakies dzialania
4. zwraca albo true, kiedy akcja sie powiedzie, albo tablice parametrow dla kolejnej akcji, albo false jak cos sie popsuje.

Znowu wszystko wraca do kontrolera. Ten czyta konfig czy ma wykonac nastepna akcje i czy ma jej przekazac parametry. Dane zwrotne z poprzedniej akcji ma, wiec reszta juz jest banalna.

Framment kontrolera glownego:

[PHP] pobierz, plaintext 
<?php
	try
	{
	  do
	  {
		$this->_loadConfig($sActionName);
 
		if(Registry::doesEntryExist($sActionName, 'useAuth'))
		  if(Registry::getEntry($sActionName, 'useAuth'))
			$this->_checkAuth($sActionName);
 
		$oAction = $this->_prepareAction($sActionName, $aParametersForAction);
 
		$mResult = $oAction->run();
 
		if(Registry::doesEntryExist($sActionName, 'nextAction'))
		{
		  $sActionName = Registry::getEntry($sActionName, 'nextAction');
		  $bContinueChain = true;
 
		  if(Registry::doesEntryExist($sActionName, 'passParameters'))
			$aParametersForAction = $mResult;
		}
		else
		  $bContinueChain = false;
	  }
	  while($mResult && $bContinueChain);
	}
	catch(Exception $oException)
	{
	  throw $oException;
	}
 
?>
[PHP] pobierz, plaintext 

Metoda prywatna _prepareAction($name) po prostu sprawdza czy pliki akcji istnieja, dlaczaje, tworzy obiekt i go zwraca.

Przykladowa akcja:

[PHP] pobierz, plaintext 
<?php
 
class DefaultExampleAction extends Action
{
  public function run()
  {
	$this->_setModel('ExampleModel');
	$this->_setView('DefaultExampleHtmlView');
 
	$aParameters = $this->_getParameters();
 
	$aAnswer = $this->_getModel()->getExampleMethod();
 
	$aData = $aAnswer;
	$aData['PARAMETERS'] = $aParameters;
 
	$this->_getView()->display($aData);
	return true;
  }
}
 
?>
[PHP] pobierz, plaintext 

Klasa ta dziedziczy po Action. Wszystkie akcje we frameworku musza z niej dzidziczyc.. No chyba ze ktos woli swoje pisac (IMG:http://forum.php.pl/style_emoticons/default/winksmiley.jpg)

[PHP] pobierz, plaintext 
<?php
$this->getParameters();
?>
[PHP] pobierz, plaintext 

Jezeli podano url postaci strona.pl/JakasAkcja/Opcja1/Opcja1/ to klasa nadrzedna Action zwroci w tej chwili tablice array(Opcja1, Opcja2). Parametry przekazywane sa do konstruktora Action we Front kontrolerze.

[PHP] pobierz, plaintext 
<?php
 
	$this->_setModel('ExampleModel');
	$this->_setView('DefaultExampleHtmlView');
 
?>
[PHP] pobierz, plaintext 

Co robia te metody nadrzednej klasy Action? Tworza obiekty Modelu i widoku, dostepne pozniej za pomoca:

[PHP] pobierz, plaintext 
<?php
$this->_getModel();
$this->_getView();
 
?>
[PHP] pobierz, plaintext 

Klasa widoku

[PHP] pobierz, plaintext 
<?php
 
class DefaultExampleHtmlView extends HtmlView
{
  public function __construct()
  {
	$this->_setTemplate('DefaultExample');
	parent::__construct();
  }
}
?>
[PHP] pobierz, plaintext 

Klasa dziedziczy z HtmlView, ktora u mnie w zasadzie jest jakby aliasem do SmartyView.


Klasa SmartyView|

[PHP] pobierz, plaintext 
<?php
 
class SmartyView
{
  private $_oSmarty;
  protected $sTemplateName;
 
  public function __construct()
  {
	$this->_oSmarty = new Smarty();
	$this->_oSmarty->tempalte_dir = PATH_TEMPLATES;
	$this->_oSmarty->compile_dir = PATH_VAR;
  }
 
  public function display($aData)
  {
	$this->_oSmarty->assign($aData);
	$this->_oSmarty->display($this->sTemplateName);
  }
 
  protected function _setTemplate($sTemplateName)
  {
	$this->sTemplateName = $sTemplateName.'.tpl';
  }
}
 
?>
[PHP] pobierz, plaintext 

No to tak wyglada to z grubsza. Przepraszam, za brak komentarzy, ale zaraz musze isc na basen :/

Ktos powie, ze to nie tak, ze inaczej, po co tak... MVC mowi - masz miec model i widok, ktore nie sa w jednym miejscu. A kontroler ma pomoc im nawiazac miedzy nimi wspolprace.

Wydaje mi sie, ze moje rozwiazanie jest calkiem wygodne. Oczywiscie sporo brakuje tutaj do funkcjonalnosci. Obecnie mecze mechanizm autoryzacji, obslugi sesji itp.

Pozdrawiam, Adrian.

Jak rozwiązać widok?

Teraz, kiedy napisałem już większość bazowego kodu, stanął przede mną problem rozsądnego rozwiązania klasy widoku.

Chciałbym aby moj Framework był przystosowany do różnego rodzau widoków. Oczywiste jest, że najczęściej wykorzystam widok HTML, ale może się także pojawić widok samego pliku - tzn. akcja w wyniku swojego działania zwróci plik, chociażby obraz który zostanie wysłany wraz zodpowienim nagłówkiem do odbiorcy (prawdopodobnie przeglądarki).

W związku z tym zasada jest taka:

FrontController->Akcja->wykonaj czynnosci->uruchom widok.

Do przeglądarki nie tarfi nic, jeżeli akcja niczego takiego nie zwróci. Jest to normalne rozwiązanie, a do tego dosyć skuteczne, bo wiadome jest, że aby do przeglądarki wysłać naglówki to nic innego wcześniej nie może być wysłanego.

Problem pojawia się przy widoku HTML. Wiadomo przecież, że zwrócenie tabelek z newsami, czy fotek z galerii nie wystarczy - trzeba to ubrać w nagłówek, stopkę, tytuł strony itp.
Bez senu jest, aby szablon newsow zawierał to wszystko w sobie.

Rozwiązanie nasuwa się dosyć szybko - niech każdy widok HTML dziedziczy po jakimś widoku, który ubierze zwrócone dane z akcji w nagłowej, stopkę itp. I to by działało całkiem sprawie.

Jest jedno ale. Mój framework będzie dawał możliwość łańcuchów akcji. A działało to będzie tak:

Front Kontrole->Akcja->wykonaj
jeżeli w konfigu podano, ze ma wykonac nasteona akcje to ja wykonuje itd.

Jezeli tylko otatnia akcja jest widokiem HTML, a poprzednie to tylko działanie na modelu to jest ok:

Akcja ZapiszNewsa
zapisuje newsa w bazie. Nic sie nie wyswietla - nie korzysta z zadnego widoku.
Nastepna akcja to PokazNewsy

PokazNewsy
Wyswietla newsy z bazy danych

W rezultacie na ekranie pojawia sie wynik PokazNewsy - i tylko ten wynik.

Ale możliwe jest aby wykonac kilka akcji z widokiem. W takim przypadki nie ma mowy, aby obie akcje wyswietlały całą stronę...

Jak można to rozwiązac?

Pozdrawiam, Adrian.

Ten post edytował Prph 25.03.2006, 13:54:50