Weirdog - Articles

Une balise pour les tranductions interpolées

2013-05-06T14:06:25Europe/Paris

C'est presque incroyable qu'après 5 ans d'utilisation de Patron ce soit seulement aujourd'hui qu'il me faut recourir à une fonction de traduction qui supporte l'interpolation. La notation #{t:chaine_à_traduire} avait suffit à tous mes projets jusqu'à présent. La nouvelle balise translate permet non seulement de traduire des chaines de caractères, mais aussi de faire de l'interpolation.

La balise est décrite comme suit :

<p:translate
     native = string>
     <!-- Content: p:with-param* -->
</p:translate>

L'attribut native sert à spécifier la chaine à traduire et les paramètres destinés à l'interpolation sont spécifiés avec la construction with-param.

Voici un exemple d'utilisation :

<p:translate native="Posted on :date by !name">
    <p:with-param name="date"><time datetime="#{@date}" pubdate="pubdate">#{@date.format_date()}</time></p:with-param>
    <p:with-param name="name" select="@user.name" />
</p:translate>

La chaine est traduite et interpolée par la méthode t() du paquet ICanBoogie/I18n.

Masquer l'illustration d'une actualité comportant une vidéo

2013-04-10T08:45:48Europe/Paris

Sur le site Transitions, les actualités sont accompagnées d'une vignette que l'on doit masquer lorsque l'actualité contient une vidéo. Pour cela on peut utiliser le nom de classe node-id présent sur la balise BODY pour sélectivement cacher les illustrations de ce type d'actualités :

body.node-id-164 .view--news--view .illustration {
    display: node;
}

C'est simple, mais cela devient vite pénible lorsque l'on ajoute souvent des actualités accompagnées de vidéo, notamment parce que le client n'est pas autonome et qu'il nous faut intervenir pour mettre à jour la feuille de style par FTP. Bref, c'est simple mais c'est nul. Heureusement, on peut arranger tout ça en quelques lignes.

Une solution automatique

Ce que l'on va faire, c'est ajouter la classe has-video sur l'élément de vue qui affiche l'actualité, lorsque celle-ci comporte une vidéo. Une règle unique nous permettra de masquer les illustrations de ces actualités :

.view--news--view.has-video .illustration {
    display: node;
}

Pour ajouter cette classe on va se servir de deux évènements. L'évènement Icybee\Modules\Views\View::render:before est déclenché lorsqu'une vue s’apprête a être rendue. Lors de cet évènement on vérifie que la vue correspond à celle que nous souhaitons modifier, à savoir « news/view ». Si la vue correspond, on attache une fonction de rappel sur l'évènement Icybee\Modules\News\News::alter_css_class_names. Nous n'aurons plus qu'à ajouter la classe has-video aux noms de classe de l'actualité si son corps contient une balise IFRAME. On oubliera pas de détacher l'évènement une fois terminé afin d'éviter qu'il soit appelé en dehors du rendu de la vue.

<?php

use Icybee\Modules\Views\View;
use Icybee\Modules\News\News;

$core->events->attach(function(View\BeforeRenderEvent $event, View $target) use($core)
{
    if ($event->id != 'news/view')
    {
        return;
    }

    $eh = $core->events->attach(function(\Icybee\AlterCSSClassNamesEvent $event, News $target) use(&$eh) {

        if (strpos($target->body, '<iframe ') !== false)
        {
            $event->names['has-video'] = true;
        }

        $eh->detach();

    });
});

Exporter des propriétés privées durant serialize()

2013-03-19T14:19:41Europe/Paris

Depuis que j'ai ajouté le support de ICanBoogie/DateTime au paquet ActiveRecord, je souhaitais que les propriétés de type datetime soient toujours des instances de ICanBoogie/DateTime. Parce que les dates venant de la base de données sont des chaines de caractères, je souhaitais que l'on puisse poser une chaine de caractère ou une instance de DateTime, mais qu'à la lecture on obtienne toujours une instance de ICanBoogie/DateTime, même pour les dates vides. Rien de bien compliqué puisque les instances d'ActiveRecord étendent Object et qu'il est donc très simple d'ajouter des getter et des setters.

Par exemple, pour la propriété created_at, il suffit d'ajouter le getter volatile_get_created_at et le setter volatile_set_created_at et de rendre la propriété privée. De cette façon le getter et le setter sont toujours appelés puisque la propriété n'est accessible que depuis la classe qui la définie. Il ne restait plus qu'à ajouter created_at au tableau renvoyé par __sleep pour que la propriété soit exportée lors de la sérialisation de l'objet. Tout allait pour le mieux jusqu'à ce ce que je créé une sous-classes et que j'essaie d'en sérialiser une instance, et là patatras :

Notice: serialize(): « created_at » returned as member variable from __sleep() but does not exist …

Damned, c'est tout pourrit !

Export problématique des propriété privées

Il semble que les propriétés privées d'une super classe ne peuvent pas être exportées. Le rapport de bug 40412, qui date déjà de 2007, en fait mention. Lorsque l'on cherche ce message d'erreur sur Google, il y a pas mal de retours, notamment Symphony2 et Doctrine. On conseille en général d'utiliser la visibilité protégée… mais cela ne fait pas du tout mon affaire parce que j'ai besoin de la visibilité privée pour que le getter et le setter correspondants soient appelés.

J'étais triste et quasiment prêt à saisir quelques commandes git pour revenir en arrière quand j'ai pensé à la méthode from() de ma classe Object. En effet, il y a quelques temps j'avais écris cette méthode pour me permettre de créer des instances de classes à la manière du mode FETCH_CLASS de PDO . Vous pouvez consulter mon article à ce sujet. Après tout, j'arrivais bien à créer des propriétés protégées ou privées en fabriquant moi-même la chaine de sérialisation, ce qui me permettait de créer n'importe qu'elle instance avec comme source un tableau associatif :

<?php

class A extends ICanBoogie\Object
{
    private $a;
}

$a = A::from(array('a' => "testing"));

C'est en consultant le code de la fonction et en revoyant le message « but does not exist » que j'ai retrouvé l'espoir.

Un nouvel espoir

Parce que le nom d'une propriété protégée est préfixée par "\x00*\x00" et que celui d'une propriété privée est préfixée par "\x00{$class}\x00", où {$class} est la classe définissant la propriété privée, peut-être que si je préfixe le nom de la propriété cela pourrait marcher… J'avais trouvé la solution !

Pour exporter une propriété privée, il convient de préfixer son nom par "\x00{$class}\x00".

La fonctionnalité de mes rêves

La fonctionnalité dont j'avais si chèrement rêvé était maintenant devenue réalité. J'étais heureux.

<?php

namespace Icybee\Modules\Sites;

use ICanBoogie\DateTime;

class Site extends \ICanBoogie\ActiveRecord
{
    // …

    public function __sleep()
    {
        return parent::__sleep() + array
        (
            'created_at' => "\x00" . __CLASS__ . "\x00created_at"
        );
    }

    // …

    private $created_at;

    /**
     * Returns the created time.
     *
     * @return \ICanBoogie\DateTime
     */
    protected function volatile_get_created_at()
    {
        $time = $this->created_at;

        if ($time instanceof DateTime)
        {
            return $time;
        }

        return $this->created_at = $time === null ? DateTime::none() : new DateTime($time, 'utc');
    }

    /**
     * Sets the created time.
     *
     * @param \DateTime|string $value
     */
    protected function volatile_set_created_at($value)
    {
        $this->created_at = $value;
    }

    // …
}

Singuliers, pluriels, acronymes, underscore... l'inflexion en PHP

2013-03-15T16:38:24Europe/Paris

Je viens d'adapter le nouvel inflecteur trop sexy de Ruby on Rails à PHP. Il permet de transformer les mots du singulier au pluriel, de l'underscore au camel case, de transformer des mots en titres… en respectant les mots irréguliers et les acronymes. Les inflexions peuvent être étendues, surchargées et localisées. Des inflexions localisées sont actuellement disponibles pour l'Anglais, l'Espagnol, le Français et le Norvégien Bokmål. Il peut être installé avec Composer.

Jetez un œil au dépôt ICanBoogie/Inflector sur GitHub !

Quelques exemples

<?php

use ICanBoogie\Inflector;

$inflector = Inflector::get();

# pluralize

$inflector->pluralize('post');                       // "posts"
$inflector->pluralize('child');                      // "children"
$inflector->pluralize('sheep');                      // "sheep"
$inflector->pluralize('words');                      // "words"
$inflector->pluralize('CamelChild');                 // "CamelChildren"

# singularize

$inflector->singularize('posts');                    // "post"
$inflector->singularize('children');                 // "child"
$inflector->singularize('sheep');                    // "sheep"
$inflector->singularize('word');                     // "word"
$inflector->singularize('CamelChildren');            // "CamelChild"

# camelize

$inflector->camelize('active_model');                // 'ActiveModel'
$inflector->camelize('active_model', true);          // 'activeModel'
$inflector->camelize('active_model/errors');         // 'ActiveModel\Errors'
$inflector->camelize('active_model/errors', true);   // 'activeModel\Errors'

# underscore

$inflector->underscore('ActiveModel');               // 'active_model'
$inflector->underscore('ActiveModel\Errors');        // 'active_model/errors'

# humanize

$inflector->humanize('employee_salary');             // "Employee salary"
$inflector->humanize('author_id');                   // "Author"

# titleize

$inflector->titleize('man from the boondocks');      // "Man From The Boondocks"
$inflector->titleize('x-men: the last stand');       // "X Men: The Last Stand"
$inflector->titleize('TheManWithoutAPast');          // "The Man Without A Past"
$inflector->titleize('raiders_of_the_lost_ark');     // "Raiders Of The Lost Ark"

# ordinal

$inflector->ordinal(1);                              // "st"
$inflector->ordinal(2);                              // "nd"
$inflector->ordinal(1002);                           // "nd"
$inflector->ordinal(1003);                           // "rd"
$inflector->ordinal(-11);                            // "th"
$inflector->ordinal(-1021);                          // "st"

# ordinalize

$inflector->ordinalize(1);                           // "1st"
$inflector->ordinalize(2);                           // "2nd"
$inflector->ordinalize(1002);                        // "1002nd"
$inflector->ordinalize(1003);                        // "1003rd"
$inflector->ordinalize(-11);                         // "-11th"
$inflector->ordinalize(-1021);                       // "-1021st"

Des helpeurs permettent d'utiliser très simplement les inflexions localisées :

<?php

namespace ICanBoogie;

echo pluralize('child');                             // "children"
echo pluralize('genou', 'fr');                       // "genoux"
echo singularize('lærere', 'nb');                    // "lærer"

À la rescousse des requêtes HEAD

2013-03-05T15:47:40Europe/Paris

Il m'embêtait ce robot « facebookexternalhit » à réclamer les entêtes des miniatures générées par le module Thumbnailer d'Icybee. La méthode GET permet d'obtenir une miniature, mais point de méthode HEAD. Comme je préfère les solutions qui profitent à tout le monde, et que je n'avais pas envie d'ajouter tout un tas de routes supplémentaires, j'ai modifié le dispatcher HTTP pour qu'il tente de secourir les requêtes HEAD non implémentées.

Depuis le commit e9a169b, le dispatcher HTTP tente de secourir les requêtes HEAD dont le traitement soulève une exception NotFound. En effet, ni vu ni connu, le dispatcher clone la requête et la traite à nouveau avec cette fois la méthode GET. Si le résultat est une réponse, alors il retourne une nouvelle réponse créée à partir des entêtes du résultat. Et voilà !

Donc, s'il existe un contrôleur capable de renvoyer une réponse pour une requête GET, alors on peut en extraire les entêtes pour répondre automatiquement à une requête HEAD. Bien sûr, rien n'empêche d'ajouter un contrôleur pour traiter les requêtes HEAD soit même.

<?php

namespace ICanBoogie\HTTP;

class Dispatcher implements IDispatcher
{
    // …

    public function __invoke(Request $request)
    {
        try
        {
            return $this->dispatch($request);
        }
        catch (\Exception $e)
        {
            if ($request->method === Request::METHOD_HEAD && $e instanceof NotFound)
            {
                $get_request = clone $request;
                $get_request->method = Request::METHOD_GET;

                $response = $this($get_request);

                if (!($response instanceof Response))
                {
                    return $response;
                }

                return new Response(null, $response->status, $response->headers);
            }

            return $this->rescue($e, $request);
        }
    }

    // …
}

Manipuler les dates comme un boss avec ICanBoogie/DateTime

2013-03-13T09:13:01Europe/Paris

Le paquet DateTime du framework ICanBoogie étend les capacités des classes DateTime et DateTimeZone de PHP. Les classes qui composent le paquet facilitent le travail avec les dates et les heures, les fuseaux horaires ainsi que les emplacements des fuseaux horaires.

De nombreuses propriétés magiques permettent d'obtenir le jour, le mois, l'année, le fuseau horaire de l'instance… mais aussi de les manipuler. Le formatage des dates et des heures est facilité par de nombreux raccourcis. Des propriétés magiques permettent également de vérifier simplement certaines conditions . Toutes les instances peuvent être utilisées comme des chaînes de caractères. Enfin, le paquet est continuellement testé par Travis CI et peut-être installé par Composer.

Quelques exemples

Disons que nous sommes le « 2013-02-03 21:03:45 » à Paris:

<?php

use ICanBoogie\DateTime;

date_default_timezone_set('EST'); // set local time zone to Eastern Standard Time

$time = new DateTime('now', 'Europe/Paris');

echo $time;                             // 2013-02-03T21:03:45+0100
echo $time->utc;                        // 2013-02-03T20:03:45Z
echo $time->local;                      // 2013-02-03T15:03:45-0500
echo $time->utc->local;                 // 2013-02-03T15:03:45-0500
echo $time->utc->is_utc;                // true
echo $time->utc->is_local;              // false
echo $time->local->is_utc;              // false
echo $time->local->is_local;            // true
echo $time->is_dst;                     // false

echo $time->as_rss;                     // Sun, 03 Feb 2013 21:03:45 +0100
echo $time->as_db;                      // 2013-02-03 21:03:45

echo $time->as_time;                    // 21:03:45
echo $time->utc->as_time;               // 20:03:45
echo $time->local->as_time;             // 15:03:45
echo $time->utc->local->as_time;        // 15:03:45

echo $time->quarter;                    // 1
echo $time->week;                       // 5
echo $time->day;                        // 3
echo $time->minute;                     // 3
echo $time->is_monday;                  // false
echo $time->is_saturday;                // true
echo $time->is_today;                   // true
echo $time->tomorrow;                   // 2013-02-04T00:00:00+0100
echo $time->tomorrow->is_future         // true
echo $time->yesterday;                  // 2013-02-02T00:00:00+0100
echo $time->yesterday->is_past          // true
echo $time->monday;                     // 2013-01-28T00:00:00+0100
echo $time->sunday;                     // 2013-02-03T00:00:00+0100

echo $time->timestamp;                  // 1359921825
echo $time;                             // 2013-02-03T21:03:45+0100
$time->timestamp += 3600 * 4;
echo $time;                             // 2013-02-04T01:03:45+0100

echo $time->zone;                       // Europe/Paris
echo $time->zone->offset;               // 3600
echo $time->zone->location;             // FR,48.86667,2.33333
echo $time->zone->location->latitude;   // 48.86667
$time->zone = 'Asia/Tokyo';
echo $time;                             // 2013-02-04T09:03:45+0900

$time->hour += 72;
echo "Rendez-vous in 72 hours: $time";  // Rendez-vous in 72 hours: 2013-02-07T05:03:45+0900

Dates vides

Afin de faciliter le travail avec MySQL, les dates vides comme 0000-00-00 00:00:00 sont supportées.

<?php

$time = new DateTime('0000-00-00', 'utc');
// or
$time = DateTime::none();
echo $time;                             // -0001-11-30T00:00:00Z
echo $time->is_empty;                   // true
echo $time->as_date;                    // 0000-00-00
echo $time->as_db;                      // 0000-00-00 00:00:00

Pour en savoir plus, notamment découvrir les classes qui constituent ce paquet, merci de consulter son README.

Implémenter belongs_to en quelques lignes grâce à Prototype

2013-02-27T14:59:19Europe/Paris

L'implémentation d'ActiveRecord dans ICanBoogie permet de faire beaucoup de choses, notamment en terme de construction de requêtes, malheureusement la partie association péchait un peu. Aujourd'hui, la situation s'arrange quelque peu avec l'implémentation de la relation appartient à (belongs to), et comme vous allez le voir cela a été très simple à mettre en œuvre grâce aux fonctionnalités de Prototype.

Définir une relation d'appartenance

L'attribut BELONGS_TO permet de définir une relation d'appartenance. Considérons un modèle « guests » définit comme suit :

<?php

use ICanBoogie\ActiveRecord\Model;

$guests_attributes = array
(
    Model::BELONGS_TO => 'events',
    Model::SCHEMA => array
    (
        'fields' => array
        (
            'event_id' => array('foreign', 'primary' => true),
            'email' => array('varchar', 'primary' => true),
            // …
        )
    )
);

Ici, l'attribut BELONGS_TO définit que les enregistrements du modèle « guests » appartiennent à des enregistrements du modèle « events ». Il s'agit d'une relation simple, établie à partir du champ event_id, qui est aussi la clé primaire du modèle « events » :

<?php

use ICanBoogie\ActiveRecord\Model;

$events_attributes = array
(
    Model::SCHEMA => array
    (
        'fields' => array
        (
            'event_id' => 'serial',
            // …
        )
    )
);

Ajout automatique du getter correspondant

Lorsque l'attribut est défini, un getter est automatiquement ajouté au prototype des enregistrements du modèle. Par exemple, pour le modèle « events » le getter get_event sera ajouté, ce qui permettra d'obtenir l'objet évènement auquel appartient un invité par la propriété magique event.

<?php

$guest = $core->models['guest']->one;

var_dump($guest->event);

Voici le code qui a était ajouté à la classe Model :

<?php

namespace ICanBoogie\ActiveRecord;

use ICanBoogie\ActiveRecord;

class Model extends Table implements \ArrayAccess
{
    // …

    public function belongs_to($belongs_to)
    {
        $activerecord_class = $this->activerecord_class;
        $getter_name = 'get_' . \ICanBoogie\singularize($belongs_to);

        if ($activerecord_class == 'ICanBoogie\ActiveRecord')
        {
            throw new ActiveRecordException('The Active Record class cannot be <code>ICanBoogie\ActiveRecord</code> for a <em>belongs to</em> relationship.');
        }

        $prototype = \ICanBoogie\Prototype::get($activerecord_class);

        $prototype[$getter_name] = function(ActiveRecord $ar) use($belongs_to)
        {
            $model = get_model($belongs_to);
            $primary = $model->primary;
            $key = $ar->$primary;

            return $key ? $model[$key] : null;
        };
    }

    // …
}

Avec cette dizaine de lignes, les active record n'auront plus à définir de getter pour leurs relations d'appartenance. Pratique.

transitionspro.fr tourne sous Icybee

2013-02-01T09:56:37Europe/Paris

Le site dédié aux professionnels de l'optique de Transitions tourne maintenant sous Icybee !

On y retrouve des informations sur la marque et sur sa technologie de verres à teinte variable, mais la plus grande partie du site n'est accessible que pour les membres du club.

Une réalisation spéciale puisqu'il s'agit du premier site réalisé avec Icybee chez Monkees.

www.transitionspro.fr

Icybee plait à mes nouveaux collègues

2012-12-19T14:39:58Europe/Paris

Cela fait trois mois que j'ai quitté Hima360 pour rejoindre Monkees, pour la première fois nous utilisons mon CMS Icybee afin de répondre au mieux et au plus vite aux exigences d'un gros projet, et voici le mot que je viens de recevoir d'une de mes collègues :

Dis, je voulais te dire, plus je l'utilise, plus je trouve ton CMS top, hyper fluide, facile à utiliser, clair...
Dommage qu'on ait pas d'autres projets en vue avec BO mais pour les prochains, fini Drupal! Vive Icybee!

Ça fait plaisir :) Vivement les prochains projets !

cuisinevirtuelle.fr, mon premier projet chez Monkees

2012-12-06T14:52:17Europe/Paris

Mon premier projet chez Monkees est enfin en ligne ! Il s'agit d'une cuisine virtuelle qui permet d'évaluer son repas en fonction de son type de diabète. C'est aussi mon premier projet avec Silex, alors c'est doublement chouette. Le site utilise également mes logiciels Brickrouge (pour générer les éléments HTML et faire vivre les widgets) et ICanBoogie\ActiveRecord (pour l'ORM).

Venez donc découvrir la cuisine virtuelle des laboratoires Roche !