README

Une librairie pour faire de l'AB Testing et du comptage de résultats

68747470733a2f2f7472617669732d63692e636f6d2f6c656d6f6e64652f7068616c636f6e2d66726f6e742e7376673f746f6b656e3d324e6341784455624751675a4251347047347970266272616e63683d6d6173746572

Pré-requis

Pour fonctionner correctement vous devez exposer un service nommé cache dans l'injection de dépendance de phalcon.

Ce service doit, au minimum exposer 2 méthodes publiques: hIncrBy et hScan. Ces méthodes sont natives dans la classe \Redis (voir hIncrBy et hScan). En utilisant la classe \Phalcon\Cache\Backend\Redis vous pouvez les définir comme suit :

namespace App;

class Redis extends \Phalcon\Cache\Backend\Redis {

    /**
     * @param string $key
     * @param string $hashKey
     * @param int $value
     * @return int
     */
    public function hIncrBy($key, $hashKey, $value)
    {
        return $this->_redis->hIncrBy($key, $hashKey, $value);
    }
    
    /**
     * @param string $key
     * @param string $pattern
     * @param int $count
     * @return array
     */
    public function hScan($key, $pattern = null, $count = 0)
    {
        $iterator = null;
        $results = [];
        $this->_redis->setOption(\Redis::OPT_SCAN, \Redis::SCAN_RETRY);
    
        do {
            $arr_keys = $this->_getRedis()->hScan($key, $iterator, $pattern, $count);
    
            if (!$arr_keys) {
                break;
            }
    
            foreach ($arr_keys as $str_field => $str_value) {
                $results[$str_field] = $str_value;
            }
        } while ($arr_keys);
    
        return $results;
    }
}

Installation

Versions :

1.X : Phalcon 3
2.X : Phalcon 4
3.X : Phalcon 5

Ajouter la dépendance

Il faut rajouter le repository git dans votre configuration Composer
{
   "repositories": [
       {
           "type": "vcs",
           "url": "https://github.com/lemonde/phalcon-abtest.git"
       }
   ],
}

composer require lemonde/phalcon-abtest

Ajouter les configurations PHP

Ajouter le listener des évènements dispatch:

$eventManager->attach('dispatch', new \ABTesting\Plugin\AnnotationListener());

Ajouter l'extension volt:

$volt->getCompiler()->addExtension(new \ABTesting\Volt\ABTestingExtension());

Ajouter le contrôleur au routing:

# il faut forcément un paramètre nommé testName
# et un autre nommé winner
$router->add('/_my_ab_redirection/{testName:[a-zA-Z0-9\_]+}/{winner:[a-zA-Z0-9\_]+}', ['controller' => 'ab_test', 'action' => 'count', 'namespace' => 'ABTesting\Controller'])->setName('ab_test_redirect');

(Optionnel) Ajouter le reporting au routing:

$router->add('/_my_ab_dashboard', ['controller' => 'ab_test', 'action' => 'report', 'namespace' => 'ABTesting\Controller'])->setName('ab_test_report');

Ajouter la configuration des tests A/B (via un service nommé config utilisant \Phalcon\Config)

$config = new Phalcon\Config([
    
    // ...
    
    'ab_test' => [
        'home_text_content' => [
            'default' => 'home_test_A',
            'variants' => [
                'home_test_A' => 'something',
                'home_test_B' => 'some other thing',
            ],
            'chooser' => [\ABTesting\Chooser\PercentChooser::class]
        ],
        'home_link_url' => [
            'default' => 'https://www.google.com',
            'variants' => [
                'home_test_A' => 'https://www.google.fr',
                'home_test_B' => 'https://www.google.be',
            ],
            'chooser' => [\ABTesting\Chooser\PercentChooser::class]
        ],
        'home_partial' => [
            'default' => 'path/to/default',
            'variants' => [
                'home_test_A' => 'path/to/A',
                'home_test_B' => 'path/to/B',
            ],
            'chooser' => [\ABTesting\Chooser\PercentChooser::class]
        ],
    ],

]);

Plus d'info ici

Déclarer les actions soumises aux tests A/B avec l'annotation @AbTesting('home_text_content')

Utiliser les fonctions volt pour afficher les élements souhaités, par exemple :

pour tester un wording :

<a {{ ab_test_href('home_text_content', 'https://www.google.com') }}>
    {{ ab_test_result('home_text_content') }}
</a>

pour tester un lien défini comme test :

<a {{ ab_test_href('home_link_url', ab_test_result('home_link_url')) }}>
    Lien
</a>

pour tester 2 formats :

{# home.volt #}

{{ partial('path/to/specific/partial/dir/' ~ ab_test_result('home_partial')) }}

{# path/to/specific/partial/dir/path/to/A.volt #}

<!-- your content -->
<a {{ ab_test_href('home_partial', 'https://example.org/link/for/A') }}>
    Lien
</a>

{# path/to/specific/partial/dir/path/to/B.volt #}

<!-- your content -->
<a {{ ab_test_href('home_partial', 'https://example.org/link/for/B') }}>
    Lien
</a>

{# path/to/specific/partial/dir/path/to/default.volt #}

<!-- your content -->
<a href="https://example.org">
    Lien
</a>

Configuration des tests A/B

Pour configurer vos tests A/B, tout se fait dans une conf en tableau sous la forme :

'nom_du_test' => [ # Définition du test
    'variants' => [ # Définition des résultats possibles
        'varianteA' => 'une valeur',
        'varianteB' => 'une autre valeur',
        'varianteC' => 1337,
    ],
    'default' => 'valeur par défaut', # Valeur par défaut du résultat (s'il n'y a pas eu de bataille par exemple)
    'chooser' => ['\La\Classe\Du\Chooser', 'les', 'arguments', 'du', 'constructeur']
]

Les variantes peuvent être de n'importe quel type compatible avec var_export.
Le chooser doit être une classe qui implémente ABTesting\Chooser\ChooserInterface
Vous pouvez écouter sur les évenements de l' ABTesting\Engine :
- abtest:beforeBattle: avant le calcul d'un test
- abtest:afterBattle: après le calcul d'un test
- abtest:beforePrint: avant l'affichage du résultat via volt
- abtest:beforeClick: avant la redirection via le lien du test

lemonde / phalcon-abtest

Maintainers

Details

README

Pré-requis

Installation

Configuration des tests A/B