Action Helpers ב-Zend Framework

במאמר הקודם דיברנו על Base Controllers בזנד פריימוורק. ציינתי שמדובר בדרך כלל במשהו שלא מאד כדאי לעשות כיוון של-Base Controllers יש נטייה להתנפח ולהכיל כל מני דברים שלא אמורים להיות שם מלכתחילה ולהעיק על המערכת.

דבר שיותר טוב להוסיף כאשר יש לנו מתודות שצריכות להיות במקומות אחרים הם Action Helpers. מדובר ב-classים מסוגים שונים שנמצאים 'לפי דרישה' ואנו משתמשים בהם רק כשצריך. אפשר ליצור כמה וכמה Helpers כאלו לפי תפקידים שונים ולפשט את הדרוש פישוט.

הרבה מאד מתכנתים מתייחסים בחשד מה ל-Action Helpers ואני יכול להבין אותם. מתודות ההוספה של ה-Helpers הן קשות להבנה. לפיכך אני אלמד במאמר זה את הדרך היותר קלה לטפל בהן ולמעוניינים לעשות את זה בדרך הקונבנציונלית יותר אני אפנה למקורות ששם הם יוכלו לשבור את הראש.

יצירת ה-Helper

אני אצור Helper בשם myhelper שמה שהוא יעשה זה לטפל בכל נושא ה-Tokens שבמאמר הקודם הכנסתי ל-Base Controllers. מה שה-myHelper החביב צריך לעשות זה לבצע יצירה של ה-Token (באמצעות generateToken) ובדיקה שלו (באמצעות tokenCheck). אנו יוצרים קובץ בתיקית mytwit/library/myhelper (אם אתם עובדים על חלונות פשוט תהפכו את הסלאשים) ושמו בישראל יהיה: myhelper.php.

לקובץ זה נעשה inclide ב-BootStrap או ב-index.php. או ישר בהגדרות של ה-Apache מבחינתי.

הקובץ החביב נראה כך:

<?php class Zend_Controller_Action_Helper_Myhelper extends Zend_Controller_Action_Helper_Abstract { 
	
	public function generateToken($seed='The^SeeD&Of#Love!%') {
		$token = md5($seed.mktime());
		$globalSession = new Zend_Session_Namespace('global_data');
		$globalSession->token = $token;
		return $token;
	}
	
	public function tokenCheck($tokenToCheck='')	{
		$globalSession = new Zend_Session_Namespace('global_data');
		$returnValue = (!empty($tokenToCheck) and $tokenToCheck==$globalSession->token);
		return $returnValue;
	}

}

על המתודות אין לי יותר מדי מה לדבר, אחת יוצרת Token והשניה בודקת אותו. דנו עליהן מספיק במאמר הקודם. אני רוצה שתשימו לב לשם של ה-Class ומאיפה הוא יורש. שניהם הם די Self Explanatory אבל מאד מאד חשובים.

אחרי זה, כל מה שנותר לי לעשות זה לקרוא ל-Helper ולמתודות השונות שלו – בדיוק כמו ב-Base Controller. הדגשתי את הקריאות:

<?php

class IndexController extends BaseController
{
    public function init()
    {
        /* Initialize action controller here */
    }

    public function indexAction()
    {
		$this->view->token = $this->_helper->Myhelper->generateToken();
    }

    public function extractAction()
    {
	$this->token = Zend_Filter::get($this->getRequest()->getPost('token'), 'StripTags');
	
	$tsearch = Zend_Filter::get($this->getRequest()->getPost('tsearch'), 'StripTags');
	
	if (!$this->_helper->Myhelper->tokenCheck($this->token)) {
			$this->_redirect('/index/index');
			return false;
		} 
	$this->_helper->Myhelper->generateToken();

	$twitterSearch  = new Zend_Service_Twitter_Search('json');
	$searchResults  = $twitterSearch->search("$tsearch", array('lang' => 'en'));
	$result = $searchResults['results'];

	$this->view->tsearch = $tsearch;
	$this->view->result = $result;
    }
}

אין כאן סיבוך גדול במיוחד, כל עוד מקפידים על הכללים. ניתן כמובן להוסיף עוד ועוד מתודות לכל Action Helper. יש ב-Action Helpers כמה Hookים נחמדים במיוחד.

Direct

השימוש במתודות direct מאפשר לנו גישה ישירה לפונקציונליות הבסיסית של ה-Action Helper. כך למשל, אם אני אוסיף מתודת direct באופן הבא:

<?php class Zend_Controller_Action_Helper_Myhelper extends Zend_Controller_Action_Helper_Abstract { 

	public function direct() {
		return $this->generateToken();
	}
	
	public function generateToken($seed='The^SeeD&Of#Love!%') {
		$token = md5($seed.mktime());
		$globalSession = new Zend_Session_Namespace('global_data');
		$globalSession->token = $token;
		return $token;
	}
	
	public function tokenCheck($tokenToCheck='')	{
		$globalSession = new Zend_Session_Namespace('global_data');
		$returnValue = (!empty($tokenToCheck) and $tokenToCheck==$globalSession->token);
		return $returnValue;
	}
}

ואז, אם אני רוצה לקרוא ל-direct, כל מה שאני צריך לעשות זה לבצע את הקריאה באופן הבא:

$this->view->token = $this->_helper->Myhelper();

חביב ושימושי לפרקים.

ישנם כמה hookים חביבים ב-Action Helpers – שלושה מתוכם הם init, postDespatch ו-preDispatch שמופעלים בשלבים שונים בזמן הקריאה ל-Helper. מתודת preDispatch מופעלת ברגע שה-helper מאותחל. מתודת init כאשר הוא נקרא ומתודת postDispatch לאחר שהפעולה הסתיימה. ככה הם נראים:

< ?php class Zend_Controller_Action_Helper_Myhelper extends Zend_Controller_Action_Helper_Abstract { 
    public function init() {
    	
    }
    public function preDispatch() {
		
    }

	public function direct() {
		$view = $this->getActionController()->view;
		return $this->generateToken();
	}

	public function generateToken($seed='The^SeeD&Of#Love!%') {
		$token = md5($seed.mktime());
		$globalSession = new Zend_Session_Namespace('global_data');
		$globalSession->token = $token;
		return $token;
	}
	
	public function tokenCheck($tokenToCheck='')	{
		$globalSession = new Zend_Session_Namespace('global_data');
		$returnValue = (!empty($tokenToCheck) and $tokenToCheck==$globalSession->token);
		return $returnValue;
	}
	
    public function postDispatch() {
		//Code that runs after initiation
    }
}

במאמר הבא נדבר על מודלים שאפשר לייצר באמצעות זנד פריימוורק.