M4d3L Blog's» Zend Framework

How to use Flickr with Zend Framework?

M4d3L — Wed, 16 Dec 2009 22:23:53 +0000

Zend Framework have a good API to play with Flickr Service. You will find it in the service API of Zend Framework.

First of all, we take the tag we want to search on the Flickr database.

1	$flirktag = "php, mysql"

After, we dont want to call each time the Flickr database so we will settup a cache of 10 minutes.

$frontendOptions = array(
    'lifetime' => 600,                   // cache lifetime of 10 minute
    'automatic_serialization' => false  // this is the default anyways
);
$backendOptions = array('cache_dir' => MYAPP_PATH_DATA);
$cache = Zend_Cache::factory('Output', 'File', $frontendOptions, $backendOptions);

We check first if it already have cache for the query we want. If no cache we execute the query like this :

if(!$flickrPlugin = $cache->load("flickr".md5($flirktag))) {
    $flickrPlugin = "";
    $flickr = new Zend_Service_Flickr('###YOUR#ID###');
    $options = array(
        'per_page' => 5, 
        'page'     => 1,
        'tag_mode' => 'all',
        'extras'   => 'license, date_upload, date_taken, owner_name, icon_server'
        );
    $tags = explode(", ", $flirktag);
    $flickr_results = $flickr->tagSearch($tags, $options);

After, if we have some result, we can show data like this :

    if (count($result) > 0){
        $flickrPlugin .= '';
        foreach ($flickr_results as $flickr_result) {
            if ($flickr_result->title == ""){
                $title = $result->flickr;
            }else{
                $substring = strtolower(substr($flickr_result->title, -4));
                if ($substring == ".jpg" or $substring == ".gif" or $substring == ".png"){
                    $title = $result->flickr;
                }else{
                    $title = $flickr_result->title;
                }
            }
            $flickrPlugin .= '.$flickr_result->Medium->uri.'" title="'.$flickr_result->title.'">.$flickr_result->Square->uri.'" />
';
        }
    $flickrPlugin .= '
';
}

Finally, we save the cache for future request than print the result.

38
39

    $cache->save($flickrPlugin, "flickr".md5($flirktag));
    print ($flickrPlugin);

This is a very simple exemple of what we can do with the Zend_Service_Flickr component.

Autocomplete field with Zend Framework and Dojo

M4d3L — Sat, 07 Nov 2009 00:20:32 +0000

In this exemple, we will se how to create an autocomplete field with Zend Framework and Dojo in the ZF MVC environment. We will use the QueryReadStore Dojo component to load new data when input value change.

Initialize Dojo in your layout

In the header of your layout, you must be able to load Dojo in page that need it loaded only to not overload other page that doesn’t have Javascript in it.

Exemple :

 echo $this->doctype('XHTML1_STRICT');?>


 echo $this->headTitle($request->getActionName())
	->headTitle($request->getControllerName());?>
$this->headLink()
	->appendStylesheet($this->theme_url.'/css/style.css')
	->headLink(array('rel' => 'favicon', 'href' =>'/images/favicon.ico'), 'PREPEND');?>
$this->headMeta()
        ->appendHttpEquiv('expires', 'Wed, 26 Feb 1997 08:21:57 GMT')
        ->appendHttpEquiv('pragma', 'no-cache')
        ->appendHttpEquiv('Content-Type', 'text/html;charset=UTF-8')                 
        ->appendHttpEquiv('Cache-Control', 'no-cache');?>                 
 if ($this->dojo()->isEnabled()){
   $this->dojo()->setLocalPath($this->BaseUrl().'/plugins/dojo/dojo.js')
         ->addStyleSheetModule('dijit.themes.tundra');
   echo $this->dojo();
}?>

This code will add all javascript library needed and css style in the head of your page.

Setup the form and choose the good element

In your main view, you create the form and add the good element for your autocomplete input.

Dojo provide 2 type of Element : FilteringSelect and ComboBox. For this exemple, I have choose the FilteringSelect element.

 $form = new Zend_Form;
$element = new Zend_Dojo_Form_Element_FilteringSelect('id');
$element->setAutoComplete(true)
			->setStoreId('tidStore')
			->setStoreType('dojox.data.QueryReadStore')
			->setStoreParams(array('url'=>$this->BaseUrl().'/admin/translate/autocomplete'))
			->setAttrib("searchAttr", "id")
			->setRequired(true);
$submit = $form->createElement('submit', 'submit');
$form->addElements(array($element, $submit));
print $form;
?>

Providing data for the autocomplete field

Now in the controller, we create a new action autocompleteAction to generate data in json format.
In this function, you must disable the view renderer and the layout.

public function autocompleteAction() {
        $this->_helper->viewRenderer->setNoRender();
        $this->_helper->layout->disableLayout();
        $id = $this->_getParam("id", "");
        $id = substr($id, 0, -1); //fix : remove * at the end of the ID.
 
        $MyTable= MyTable::getInstance();
        $select = $MyTable->select(true, array("id"))->limit(5)
        $select->where('id LIKE ?', "%".$id."%");
        $results = $MyTable->fetchAll($select);
        $data = new Zend_Dojo_Data('id', $results);
 
        // Send our output
        $this->_helper->autoCompleteDojo($data);
    }

This action will be called by the form element each time the value will change in the input and add propose 5 new possibility for the user to select.

(This exemple was tested on Zend Framework 1.9.5 and Dojo 1.3.2)

Phenix_Wiki, a parser componant for Zend Framework

M4d3L — Sun, 01 Nov 2009 18:03:01 +0000

Phenix_Wiki is a new component of the PhenixApp project. This component parse structured wiki text and render it into arbitrary formats such as XHTML.

How to use it with Factory method.

Factory methode returns a Phenix_Wiki Parser class for the specified parser

For Default parser :



1
2
$wiki = Phenix_Wiki::factory("Default");
echo $wiki->transform($text, 'xhtml');

For BBcode (with specified rules):



1
2
3
4
5
6
7
$rule = array('Prefilter', 'Delimiter', 'Code', 'Function', 'Html', 'Raw', 'Include', 'Embed', 'Anchor',
              'Heading', 'Toc', 'Horiz', 'Break', 'Blockquote', 'List', 'Deflist', 'Table', 'Image', 
              'Phplookup', 'Center', 'Newline', 'Paragraph', 'Url', 'Freelink', 'Interwiki', 'Wikilink', 
              'Colortext', 'Strong', 'Bold', 'Emphasis', 'Italic', 'Underline', 'Tt', 'Superscript', 
              'Subscript', 'Revise', 'Tighten');
$wiki = Phenix_Wiki::factory("Bbcode", $rule);
echo $wiki->transform($text, 'xhtml');

For Creole :



1
2
$wiki = Phenix_Wiki::factory("Creole");
echo $wiki->transform($text, 'xhtml');

How to use it with Singleton method

This avoids instantiating multiple Phenix_Wiki instances where a number of objects are required in one call, e.g. to save memory in a CMS environment where several parsers are required in a single page.



1
2
$wiki = Phenix_Wiki::singleton("Bbcode");
echo $wiki->transform($text, 'xhtml');

Where to find the component?

Web Repository : http://www.phenixapp-project.net/repositories/browse/phenixapp/trunk/PhenixApp/libs/Phenix/Wiki
To access via SVN : svn://phenixapp-project.net/phenixapp/trunk/PhenixApp/libs/Phenix/Wiki

Note that this first version is not recommanded for production.

Add language route to your Zend Framework project.

M4d3L — Mon, 29 Jun 2009 20:59:00 +0000

Today it’s easy to make business with other country and to join the most poeple as possible, our website must be translated in many language. This tutorial will show you how to integrate multi-language into your URL with Zend Framework controller route component and be able to use it with the Url helper in your layout.

This tutorial requiere Zend Framework 1.8.2 version or higher.

Summary :

Route configuration
Multilanguage Plugin
Url Helper howto
Conclusion

Route configuration

This tutorial will show you how to setup your route in .ini config. But you can do it with any other configuration type. The demonstration will also use the Module structure of Zend Framework.

Here we setup the default module route without any parameters because it will automatically use the Dispatcher to setup it. Note the abstract param. This part is not actually documented in the ZF Programmer’s reference guide but Abstract parameter make the route to be unusable outside a chain route.



1
2
3
resources.router.routes.defaultmodule.type = Zend_Controller_Router_Route_Module
resources.router.routes.defaultmodule.abstract = On    
resources.router.routes.defaultmodule.defaults.module = "system"

After we setup the language route with default language if you need it and the regex of what is expected for the language value.



4
5
6
7
resources.router.routes.language.type = Zend_Controller_Router_Route
resources.router.routes.language.route = ":language"
resources.router.routes.language.reqs.language = "^(fr|en)$"
resources.router.routes.language.defaults.language = "en"

Than we setup the default route to overwrite the one create by default by the Front Controller.



8
9
resources.router.routes.default.type = Zend_Controller_Router_Route_Chain
resources.router.routes.default.chain = "language, defaultmodule"

This configuration mean that if you call url like http://www.exemple.com/, language will be English, module will be default, controller will be index and action will be index.
If you call http://www.exemple.com/fr/articles , language will be french, and module will be articles.

Dont forgot to setup your locale and translate resources!

Multilanguage Plugin

In this part I will explain how to create your multilanguage plugin for controller. I assume here you know how to setup your Controller plugin into your Front Controller and pass directly to the Plugin class. It’s very basic and you will have to adapte to your own use.

Create a new class in your own library componant with routeShutdown method.



1
2
3
4
5
6
7
8
9
10
11
class My_Controller_Plugin_Multilanguage extends Zend_Controller_Plugin_Abstract{
    public function routeStartup (Zend_Controller_Request_Abstract $request)
    {
 
    }
 
    public function routeShutdown (Zend_Controller_Request_Abstract $request)
    {
 
    }
}

In the routeStartup method, we add a quick fix to be sure the language is alway in each RequestUri. If the language parameter is not there, we force it.



1
2
3
4
if (substr($request->getRequestUri(), 0, -1) == $request->getBaseUrl()){
    $request->setRequestUri($request->getRequestUri()."en"."/");
    $request->setParam("language", "en");
}

In the routeShutdown method you will catch the language and setup the local and translator object already created by the resource. After you setup the translator to the Zend_Controller_Router_Route. This will be something like this :



1
2
3
4
5
6
$language =  $request->getParam("language", Zend_Registry::getInstance()->Zend_Locale->getLanguage());
$locale = new Zend_Locale($language);
Zend_Registry::getInstance()->Zend_Locale->setLocale($locale);
$translate = Zend_Registry::getInstance()->Zend_Translate;
$translate->getAdapter()->setLocale(Zend_Registry::getInstance()->Zend_Locale);
Zend_Controller_Router_Route::setDefaultTranslator($translate);

Once it done. Url helper will be very easy to use.

Url Helper howto

Ok, here if you have lot of route setup, you will need the $currentRoute parameter in your url helper. If you play only with the default route, you don’t need the following part. Jump to the next step.



1
2
3
4
5
$front = Zend_Controller_Front::getInstance();
$router = Zend_Controller_Front::getInstance()->getRouter();
$currentRoute = $router->getCurrentRouteName();
$locale = $this->registry->Zend_Locale;
$currentRoute = ($currentRoute == "language")? "default": $currentRoute;

In the last part, I show you a basic Language Switch I did for my project. It check the current language and dont show the link of the current language.
See the Zend_View_Helper_Url parameter. If I dont put the language param in the array, it will show the current one. This link will switch between the same page but in different language.



1
2
3
4

	 if ($locale->getLanguage() != "fr"):?>$this->url(array("language" => "fr"), $currentRoute)?>">Francais endif?>
	 if ($locale->getLanguage() != "en"):?>$this->url(array("language" => "en"), $currentRoute)?>">English endif?>

An other example that will output http://www.exemple.com/fr/articles/



1
$this->url(array("language" => "fr", "module" =>"articles", "action"=>"list"), "default")?>">Module Articles

Conclusion

This example is take from my current PhenixApp project. All my source can be found in the repository. The code on my repository is not the same because I had more option like I take my default language from the database and I have some other route that I have to work with.

With the code in this tutorial, you get a working and easy multilanguage URL. You can integrate it very fast to your existing project because it use chain routing and dont broke any other route already exist.

If you like this tutorial or want to improve it, you can add comment.

Le projet PhenixApp

M4d3L — Sat, 27 Jun 2009 19:49:51 +0000

PhenixApp est une application construite avec Zend Framework qui propose une structure définit pour que tous les développeur puisse contruire des modules compatible utilisable avec le composant principale de PhenixApp sois, Zend_Application qui permet de bien structurer le démarrage (bootstrap) de l’application.

Chaque module peut écraser les configurations par défaut et donc contrôler le bootstrap. Ils peuvent avoir leurs propres ressource, configuration, composant, plug-in, contrôleur, etc. De base, il y a 2 modules principaux qui viennent avec PhenixApp. Le module System qui contrôle les composants de base, sois l’installation des modules, la configuration de ceux-ci, la gestion des widgets dans le thème appeler « Brickwall » et plusieurs autres élément. Ensuite, il y a le module members qui gère l’enregistrement des membres, les groupes et les permissions. PhenixApp est dépendant du module système, mais le module members peut être remplacé par d’autre module qui fait les choses autrement.

PhenixApp comprend 2 types de contrôleur d’action. Sois les contrôleur public et les contrôleur d’administration. Il sont sépararer dans 2 répertoires différents ce qui peut éviter des erreurs de routing du a la confusion de 2 différentes routes. Et permet aussi d’avoir des contrôleurs de même nom pour la partit public ou administrative ce qui facilite la création des vues.

Une des principales fonctions du projet qui est très intéressante est la gestion du multilanguage autant dans les textes que dans l’url et l’encodage. Un système avancé vous permet de modifier directement en ligne vos traductions et traque les textes non traduits. Vous pouvez aussi ajouter des éléments à traduire directement dans vos templates et le système va les ajouter dans la database dès qu’ils seront affichés pour une première fois. Ensuite il vous restera qu’à faire la traduction dans les différentes langues.

Par contre, PhenixApp n’est pas encore prêt pour la production. De nombreuses interfaces d’administration restent à être terminées avant qu’une première version bêta voie le jour. Il n’y a pas encore de Base de données fournie avec le code. Nous cherche des développeurs qui aimeraient investir du temps dans le projet. Tout le code source est sur le repository tu site officiel.

Site du projet : PhenixApp-Project.net

Phenix_File_Parser_Csv

M4d3L — Fri, 26 Jun 2009 04:45:54 +0000

If you need a CSV parser in PHP, this class is for you.

You can download the class from the repository of PhenixApp project : Phenix_File_Parser_Csv

This class open the CSV file, parse the data into the object and after you just need to use the object like an array.



1
2
3
4
5
6
7
8
9
10
$csvParser = new Phenix_File_Parser_Csv(
    $filename,   //CSV file name
    1,    //Start at row 1
    array(0 => "id", 1 => "title", 2 => "detail", 3 => "lastupdate") //Column expected to read in the CSV file.
);
 
//use like an array
foreach($csvParser as $key=>$value) {
    $date = $value['lastupdate'];
}

Phenix_View_Helper_Text2image

Phenix_View_Helper_Text2image (English)

M4d3L — Fri, 26 Jun 2009 03:41:59 +0000

Did you already got the probleme to create a menu with image because the font was not a standard web font and you has to make again and again the menu because you clients ask you to do many change? This helper is the solution.

What is Phenix_View_Helper_Text2image?

This is a simple View Helper for Zend Framework that allow you to transform on the fly a string texte to an image with the good font, size, background and position. When the image are generated, they are stored in an image folder and they are never regenereted else if you change a params of an image. This is a big avantage for the designer that doesnt have to care about the font or disposition to use.

Configuration :



1
2
3
4
5
6
7
8
9
10
11
12
13
14
 $param = array(
/* For image menu with special font */
'imgdir' => "home/user/public_html/images",
'imgurl' => "/images",
'font' => "/home/user/App/Fonts/ITCKrist.TTF",
'fsize' => 11,
'flag' => "menu",
'width' => 170,
'height' => 26,
'tcolor' => "#4e6549",
'bgcolor' => "#FFFFFF",
'tposition_x' => 3,
'tposition_y' => 20
)?>

Create all menu image :



1
2
3
4
5

$this->url()?>"> echo $this->Text2image("Acceuil", $param)?>
$this->url()?>"> echo $this->Text2image("Produits", $param)?>
$this->url()?>"> echo $this->Text2image("Contactez-nous", $param)?>

Note that if image already exist, only the image tag will be generated.

Where I can download this helper?

You can download this helper on the repository of PhenixApp project. View_Helper repository

Phenix_View_Helper_Text2image

Zend_Form : How to remove decorator from hidden field.

M4d3L — Thu, 25 Jun 2009 16:25:25 +0000

This question come a lot in #ZFtalk channel on IRC.

The Default decorator apply the DtDdWrapper to all form element when they are created. But hidden field does’nt need decorator and the actual hidden element class does’nt care about that.

Actually, without decorator remove, hidden field will output like the following and this is bad.



1
2
<dt id="MyElement-label">&nbsp;dt>
<dd id="MyElement-element"><input type="hidden" name="MyElement" value="something" id="MyElement">dd>

So to remove the decorator, you can do this after create your hidden element:



1
2
3
4
5
$id = $form->createElement('hidden', 'id');
$id->removeDecorator('DtDdWrapper');
$id->removeDecorator('HtmlTag');
$id->removeDecorator('Label');
$form->addElement($id);

This is important because this will prevent to get unwanted result if you add css to your DT/Dd decorator. After remove these decorator, this will print only the input hidden field.



1
<input type="hidden" name="MyElement" value="something" id="MyElement">

With the PhenixApp project, I have decided to extends the default hidden element class to remove decorator of each hidden field indefinitely.
I think this way is better because this prevent some method to be executed for nothing and this is more quick to add hidden field in all my form after.

Here is my class :



1
2
3
4
5
6
7
class Phenix_Form_Element_Hidden extends Zend_Form_Element_Hidden
{
    public function init(){
    	$this->setDisableLoadDefaultDecorators(true);
    	$this->addDecorator("ViewHelper");
    }
}

Phenix_View_Helper_Text2image

M4d3L — Thu, 11 Jun 2009 18:39:01 +0000

Avez-vous déjà éprouvé le problème de créer un menu pour un site web sous forme d’image, car la police n’est pas standard au web et qu’ensuite vous ailler souvent a refaire le menu, car sois le site est traduit ou encore votre client vous demande des ajouts et modifications très souvent? Ce nouveau helper est donc la solution pour vous.

Qu’est-ce que Phenix_View_Helper_Text2image?

C’est simplement un View Helper pour Zend Framework qui vous permet de transformer « on the fly » un texte en image avec la police de caractère voulu, la grandeur et aussi la possibilité d’avoir un arrière-plan pour chaque image. Les images créées sont ensuite sauvegardées dans le répertoire de votre choix et ne seront pas recréées à chaque fois que la page est demandée sauf si n’importe laquelle des configurations est changée.

Configuration :



1
2
3
4
5
6
7
8
9
10
11
12
13
14
 $param = array(
/* For image menu with special font */
'imgdir' => "home/user/public_html/images",
'imgurl' => "/images",
'font' => "/home/user/App/Fonts/ITCKrist.TTF",
'fsize' => 11,
'flag' => "menu",
'width' => 170,
'height' => 26,
'tcolor' => "#4e6549",
'bgcolor' => "#FFFFFF",
'tposition_x' => 3,
'tposition_y' => 20
)?>

Creer toutes les images du menu :



1
2
3
4
5

$this->url()?>"> echo $this->Text2image("Acceuil", $param)?>
$this->url()?>"> echo $this->Text2image("Produits", $param)?>
$this->url()?>"> echo $this->Text2image("Contactez-nous", $param)?>

Où trouver ce Helper?

Vous pouvez trouver ce helper sur le repository de PhenixApp. Par ici.