Diem Project Snippets http://diem-project.org/snippets Tue, 09 Mar 2010 06:41:12 +0100 Thibault Duplessis en <![CDATA[Change default submit caption]]> http://diem-project.org/community/snippets/change-default-submit-caption In most cases echo $form in template suited fine, but if you want replace only submit button which shows as "Validate [Validate]", you need rewrite whole _form.php template.
This is not a DRY way, because you may change form, then you need change template too.
To avoid this just modify your form, by adding such method:

public function render($attributes = array())  
  {  
    $attributes = dmString::toArray($attributes, true);  
 
    return  
    $this->open($attributes).  
    '<ul class="dm_form_elements">'.  
    $this->getFormFieldSchema()->render($attributes).  
      sprintf('<li class="dm_form_element"><hr size="1" noshade color="silver">%s</li>',  
        $this->renderSubmitTag($this->__('send comment'))  
      ).  
    '</ul>'.  
    $this->close();  
  }
]]> Change default submit caption (12) Tue, 09 Mar 2010 06:41:12 +0100 <![CDATA[Include JavaScript files in the <head> section]]> http://diem-project.org/community/snippets/include-javascript-files-in-the-head-section By default with Diem, all JavaScript files are compressed and combined into one file. This file is loaded just before </body>, as recommended by Yahoo Best Practices.

Some symfony plugins write JavaScript code directly into the HTML. They expect jQuery to be loaded before their JavaScript code executes.
So we need a way to include jQuery from <head> section in order to make these plugins work.

Add the assets you want to include in <head> to the js head_inclusion configuration:

config/dm/config.yml

all:  
  
  js:  
    compress:             true  
    cdn:  
      enabled:            false  
    head_inclusion:       [ lib.jquery ]
]]> Include JavaScript files in the section (11) Thu, 04 Feb 2010 13:42:17 +0100 <![CDATA[Improve performances: gzip assets]]> http://diem-project.org/community/snippets/improve-performances-gzip-assets This snippet will only work with apache2 servers.

Problem

Bandwidth has a cost, and performances matters.

By default, Diem minifies and combines all your javascript and stylesheet files. This reduces dramatically the number of requests required to display a page.

But we can go even farther.
You can enable gzip compression for javacript and stylesheet files. It reduces their weight by three to four times.

Enable gzip compression

Just change an option on Diem javascript and stylesheet compressors to make them produce gziped files.
config/dm/services.yml

parameters:  
  
  javascript_compressor.options:    
    gz_compression: true  
  
  stylesheet_compressor.options:    
    gz_compression: true

Forward assets requests

Now, we will tell apache to forward requests to a .css or .js to the gzipped file, if any.
web/.htaccess, uncomment the lines between
# SEND GZIPPED CONTENT TO COMPATIBLE BROWSERS
and
# END GZIPPED CONTENT

You should now have:

  # SEND GZIPPED CONTENT TO COMPATIBLE BROWSERS  
  RemoveType .gz  
  RemoveOutputFilter .css .js  
  AddEncoding x-gzip .gz  
  AddType "text/css;charset=utf-8" .css  
  AddType "text/javascript;charset=utf-8" .js  
  RewriteCond %{HTTP:Accept-Encoding} gzip  
  RewriteCond %{REQUEST_FILENAME}.gz -f  
  RewriteRule ^(.*)$ $1.gz [L,QSA]  
  # END GZIPPED CONTENT

Try it

Open a page of your website and inspect requests with firebug. The server now sends gzipped assets, and load time is reduced.

This tip will not work on all servers, depending on apache configuration.

]]> Improve performances: gzip assets (10) Tue, 19 Jan 2010 22:10:32 +0100 <![CDATA[Customize the breadcrumb]]> http://diem-project.org/community/snippets/customize-the-breadcrumb On the front application, breadcrumbs are generated automatically.

Sometimes we want to modify the displayed links.

The easy way: listen an event

Use the dm.bread_crumb.filter_links event to modify the breadcrumb links before the are rendered.
The event contains a page parameter which is the current page.
The event value is an array of the breadcrumb links to be displayed. We will modify the links array to modify the breadcrumb.

In this example, we assume we have a post module with post/list and post/show pages.
We will rename the post/list link, or remove it when the current page is a post/show page.

apps/front/config/frontConfiguration.class.php

class frontConfiguration extends dmFrontApplicationConfiguration
{  
 
  public function configure()  
  {  
    // connect to the breadcrumb event  
    $this->getEventDispatcher()->connect('dm.bread_crumb.filter_links', array($this, 'listenToBreadCrumbFilterLinksEvent'));  
  }  
 
  public function listenToBreadCrumbFilterLinksEvent(sfEvent $e, array $links)  
  {  
    // check if the breadcrumb contains a link to the post/list page  
    if(isset($links['post/list']))  
    {  
      // if the current page is a post/show page  
      if($e['page']->isModuleAction('post', 'show'))  
      {  
        // remove the post/list link  
        unset($links['post/list']);  
      }  
      else  
      {  
        // Rename the link  
        $links['post/list']->text('Articles');  
      }  
    }  
 
    // return the links to the breadcrumb  
    return $links;  
  }

The powerful way: override the class

You can also override the breadcrumb view class. First, declare the new view class for breadcrumb widgets:

apps/front/config/dm/widget_types.yml

dmWidgetNavigation:  
  
  breadCrumb:  
    view_class:         myBreadCrumbView

Then create your class, which inherits dmWidgetNavigationBreadCrumbView.
apps/front/lib/myBreadCrumbView

class myBreadCrumbView extends dmWidgetNavigationBreadCrumbView
{  
  // override the getLinks method  
  protected function getLinks($includeCurrent = true)  
  {  
    // get links from dmWidgetNavigationBreadCrumbView  
    $links = parent::getLinks($includeCurrent);  
 
    // always remove the home link (for example)  
    unset($links['main/root']);  
 
    return $links;  
  }  
}

This way you can override all the breadcrumb view methods.

With the apps/front/config/dm/widget_types.yml config file, you can replace every form or view class for all widgets, and even create yours.

]]> Customize the breadcrumb (9) Thu, 14 Jan 2010 15:45:48 +0100 <![CDATA[Exclude files from JS minification]]> http://diem-project.org/community/snippets/exclude-files-from-js-minification Diem minify javascript files automatically, and merge them into one file, which is compressed with gzip.
This is a good thing.

But some javascript libraries don't support compression, like jquery.lightbox-0.5.js.

In this case you may disable all javascript minification in config/dm/config.yml

all:  
  js:  
    compress: false

But it's a bad solution: none of your javascript files is minified anymore.

The better solution is to disable minification only for jquery.lightbox-0.5.js.

This can be done by configuring the javascript_compressor service.

config/dm/services.yml

parameters:  
  javascript_compressor.options:  
    black_list:               [ jquery.lightbox-0.5.js ]

Then clear the cache, and all the javascript files are minified, excepted this one.

]]> Exclude files from JS minification (8) Fri, 08 Jan 2010 08:34:34 +0100 <![CDATA[Diem and Nginx]]> http://diem-project.org/community/snippets/diem-and-nginx Diem can't be easily used in combination with NGINX. Nginx replaces the + with %2B in the url. Which is vital for the Diem routing.

But there is a very easy fix:
in config/ProjectConfiguration.class.php put

$_SERVER['PATH_INFO'] =urldecode($_SERVER['PATH_INFO']);

in the setup() method.

]]> Diem and Nginx (7) Tue, 29 Dec 2009 12:01:31 +0100 <![CDATA[Create a manageable menu]]> http://diem-project.org/community/snippets/create-a-manageable-menu In this snippet we will create a manageable menu.

Deprecated snippet
Diem now provides a much better way to create and manage menus without any technical knowledge. Learn more about the new menu widget.

The links must be manageable from the admin application.
They must be activable/deactivable, and sortable. They can be internal or external links.

schema.yml

Link:  
  actAs:              [ Timestampable, Sortable ]  
  columns:  
    name:             { type: string(255), notnull: true }  
    title:            { type: string(255), notnull: false }  
    url:              { type: string(255), notnull: true, extra: link }  
    is_active:        { type: boolean, notnull: true, default: true }

modules.yml

Content:  

  Global:  

    link:  
      components:  
        list:

Update the project

php symfony doctrine:generate-migrations-diff  

php symfony doctrine:migrate  

php symfony dm:setup

In the Content menu of the admin upper toolbar, a links section is now available.

We can drag & drop a page from the PAGES left panel into the "url" form field.
This way, if the page url change later, the link will be automatically updated.

We can write full urls like http://symfony-project.org

We can also use the "Loremize" box to automate test data creation.

Create the front interface

Click the "Add" button on the lower tool bar, and drag & drop a Link/List widget on the page.
Then edit the template /apps/front/modules/link/templates/_list.php and replace "echo $link" with:

echo _link($link->url)->title($link->title)->text($link->name);

Now we have a menu widget as specified above.

]]> Create a manageable menu (6) Wed, 16 Dec 2009 15:29:27 +0100