Oddaję pod waszą ocenę prostą oraz w pełni rozszerzalną bibliotekę do wysyłania wiadomości w aplikacji opartej o Zend Framework. Celem biblioteki jest dostarczenie jednolitego mechanizmu pozwalającego na wysyłanie powiadomień do użytkowników. Do powiadomień można zaliczyć informacje o rejestracji w serwisie, newsletter, informacje o odpowiedzi w obserwowanym temacie, link aktywacyjny, itd. W chwili obecnej biblioteka wspiera jedynie wysyłanie wiadomości e-mail.

Przykład użycia:

[PHP] pobierz, plaintext 
$notification = new Batman_Notification_Sender_Mail($options['register']);
// lub
// $notification = Batman_Notification::factory('mail', $options['register']);
 
$notification->setTo('reciver_emial@some-domain.pl');
$notification->userName = 'John Doe';
$notification->serviceName = 'Uber service';
$notification->send();
[PHP] pobierz, plaintext 

Przykładowa konfiguracja

[INI] pobierz, plaintext 
notification.register.template.templateName = "confirm_registration.phtml"
notification.register.template.templatePath = APPLICATION_PATH "/layouts/notifications"
notification.register.mail.from = "no-reply@some-domain.pl"
notification.register.mail.subject = "Thank You for..."
[INI] pobierz, plaintext 

Download, dokumentacja oraz issue tracker znajdziecie w serwisie github.

Brak testów jednostkowych

Dla mnie brakuje bardziej jasnego oznaczenia, łatwego znalezienia typu powiadomienia jakie wysyłasz.
Aktualnie zdefiniowałeś po prostu ustawienia z Zend_Config i jedynym miejscem w którym wiem o powiadomieniu to klucz z tych ustawień. To za mało.

A co jeżeli np dałbyś Batman_Notification_Data ?
Oczywiście odpowiednio rozszerzone np
Batman_Notification_Data_Config -> czyta dane z configa
Batman_Notification_Data_RDBMS -> czyta dane z bazy relacyjnej
Batman_Notification_Data_Xml -> z xmla
itd, itd wedle uznania

Po co to? Żeby łatwiej z tego korzystać i na przyszłość nie pamiętać jakie to dane musimy ustawić w konfiguracji, xmlu itd.
Dodatkowo niezwykle przydatne gdybyś np chciał rejestrować listę powiadomień z informacją o statusie wysłania.

Batman_Notification_Sender_Abstract::addTemplateData - to nie jest na to miejsce, od tego user pobiera sobie View (getView) i sam te dane wstawia.
Podobnie z __set i __get, to nie jest na to miejsce bo ja jako programista spodziewałbym się że ustawiam jakieś dane konfiguracyjne notyfikatora a nie szablonowe.

Batman_Notification_Sender_Mail
Bardziej uniwersalne byłoby gdyby do klasy można było podać obiekt Zend_Mail ze względu na możliwość dodania dodatkowych opcji do e-maila. Aktualna implementacja jest ograniczająca.

Nie napisałeś za dużo o założeniach programistycznych biblioteki dlatego tak gdybam.

Reszta ok. Ocena 7/10 za względu na brak jasnej informacji o typie powiadomienia.

Wiedziałem, że to będzie pierwsza rzecz, do której będą uwagi Testy się pojawią.


Tutaj wydaje mi się, że źle to opisałem.


Zastanawiałem się nad czymś podobnym, ale byłoby to nic innego jak powielenie Zend_Config. W chwili obecnej można przekazać obiekt Zend_Config, tablicę lub skorzystać z setterów.


Nad tym też się długo zastanawiałem i doszedłem do wniosku, że lepiej żeby to klasa powiadomień była proxy dla szablonu. Nic jednak nie stoi na przeszkodzie, aby stworzyć własny obiekt widoku i przekazać do klasy powiadomień.


Tutaj miałem ogromny dylemat jak to rozwiązać i wybrałem najprostszy ze sposobów. Niemniej masz rację. Powinna być możliwość przekazania gotowego już obiektu Zend_Mail (lub dowolnego innego implementującego metodę send).


Racja. Za chwilę dodam opis.

Nie jest to powielenie. Jest to idealny sposób aby np osoby NIE korzystające z Zend_Config mogły podać własne źródło notyfikatorów (właście chociażby z bazy). Aktualnie programista musi robić obiekty atrapy tworzące Zend_Config.

Idealnie by było gdyby istniał tak obiekt danych notyfikatora zawierający w sobie tworzenie Sendera. Przykład

[PHP] pobierz, plaintext 
class Notyfikator_Rejestracja extends Batman_Notification_Data_Xml {
	public function __construct() {
		parent::__construct('sciezka/do/pliku/xml/z/danymi/notyfikatora.xml');
	}
}
 
$note = new Notyfikator_Rejestracja();
$note->setTo('ziom@wp.pl');
$node->send();
[PHP] pobierz, plaintext 

Obiekt notyfikacji sam zadbałby sobie o utworzenie odpowiedniego Sendera, tytułu itd itd itd
Oczywiście wszystko wedle... założeń, upodobań


Tak, ale dotykasz innego poziomu abstrakcji. Rodzi to następujące problemy
1) Przy zmianie implementacji Zend_View musisz zmienić taką implementacją wszędzie indziej = rodzisz dodatkowe niepotrzebne zależności
2) Programista używający Zend_View raz może skorzystać z metod notyfikatora, ale przy innych musi i tak operować bezpośrednio na Zend_View co jest pewną niejasnością i niekonsekwencją.
Siedząc w AS zauważyłem, że po prostu nie warto robić takich prostych ułatwień bo tylko zaciemniają kod i w niczym nie pomagają.

Jedna spora wada.. Brak Method Chaining :/

Masz rację. W ten sposób będzie to o wiele bardziej elastyczne.


Tutaj niestety nie ma złotego środka. Tak, czy siak uzależniam się od systemu szablonów, którego zadaniem jest zebranie danych i przekucie ich na jednolitą treść wysyłaną do użytkownika. Wydaje mi się, że najlepiej będzie jak usunę możliwość dodawania/pobierania obiektu widoku, a dostęp do niego ograniczę do metod notyfikatora.


Fakt. O tym w zupełności zapomniałem.

Fajny pomysł na bibliotekę - czekam na dalsze nowości. Z przyczepień to oczywiście brak testów oraz na sztywno zakodowana zależność od Zend_View, która praktycznie uniemożliwia podpięcie jakiegoś innego systemu szablonów.

Testy się pojawią jak tylko biblioteka nabierze bardziej solidnego kształtu. Odnośnie systemu szablonów to codziennie mam inny pomysł na rozwiązanie tego problemu i jak na razie nie zdecydowałem się na jedno rozwiązanie.


edit

Rozważyłem wszystkie uwagi i przepisałem bibliotekę na bardziej modułową. W chwili obecnej do obiektu "powiadamiacza" należy przekazać obiekt "wysyłacza" oraz obiekt szablonu danych.W celach demonstracyjnych przygotowałem po jednej klasie każdego typu. Mimo iż są to przykładowe klasy, nic stoi na przeszkodzie, aby z nich korzystać.

Skorzystanie z powiadamiacza mocno się zmieniło i wygląda następująco

[PHP] pobierz, plaintext 
$sender = new Batman_Notification_Sender_ZendMail();
$sender->addTo('our_client@some-domain.pl')
       ->setSubject('Super-duper newsletter');
 
$dataTemplate = new Batman_Notification_DataTemplate_ZendView();
$dataTemplate->setTemplatePath(APPLICATION_PATH . '/layouts/mail_templates')
             ->setTemplateName('mail_template.phtml');
$dataTemplate->userName = 'John Doe';
 
$notification = new Batman_Notification($sender, $dataTemplate);
$notification->send();
[PHP] pobierz, plaintext