t-kuni/php-url-meta-mapper

URL based Meta data mapper.

dev-master 2019-07-27 15:10 UTC

Requires

• php: ^7.0

Requires (Dev)

• phpunit/phpunit: ^8

MIT

README

This library is URL based Meta tag(eg SEO text, OGP, etc...) mapper.
Purpose of this is to collect various places Meta tag settings into one place.
This is useful in web page like to often occur modification of Meta tag.
You can define mapping simply between URL and Meta tag through the fluent interface.

Instration

(TODO)

Features

Routing

$mapper = (new Mapper())
    ->map(['/foo', '/bar'])->provide([
        'title' => 'foo bar page',
    ]);
    ->map(['/hoge', '/fuga'])->provide([
        'title' => 'hoge fuga page',
    ]);

$meta = $mapper->resolve('https://example.com/foo');

var_dump($meta);
// [
//   'title' => 'hoge fuga page'
// ]

Route parameters, Query Strings

$mapper = new Mapper();
$mapper->map('/foo/{id}')->provide(function($route, $query) {
    if ($route['id'] == 1) {
        return [
            'title' => "Routed One", 
        ];
    } else {
        return [
            'title' => "Routed Two", 
        ];
    }
});
$meta = $mapper->resolve('https://example.com/foo/2?hoge=fuga');

• Regular Expression Constraints (TBD)

Hooks

Global Hook

(TBD)

$mapper->global()->pre(function($route, $query, $binding) {
    
    return compact('route', 'query', 'binding');
});

Pre Hook

$m = (new Mapper())
    ->map('/foo/{id}')->pre(function ($route, $query, $binding) {
        $route['id'] = 100;
        return compact('route', 'query', 'binding');
    })->provide(function($route, $query) {
        return [
            'title' => 'id is ' . $route['id'],
        ];
    });

$actual = $m->resolve('https://example.com/foo/2');
// [
//   'title' => 'id is 100'
// ]

Post Hook

(TBD)

Templating

$mapper = (new Mapper())
    ->map('/foo/{id}')->pre(function ($route, $query, $binding) {
        $binding['fizz'] = 'bazz';
        return compact('route', 'query', 'binding');
    })->provide(function ($route, $query) {
        return [
            'title' => '{{fizz}}',
        ];
    });

$meta = $mapper->resolve('https://example.com/foo/2?hoge=fuga');

Aliases

Generate Admin Page

(TBD)

Reuse Template

(TBD)

$mapper = new Mapper();
$mapper->map('/foo')->provide(M::template([
    'title' => '{{fizz}}'
])->as('temp-name'));
$mapper->map('/bar')->provide(M::template('temp-name'));
$meta = $mapper->resolve('https://example.com/foo/2?hoge=fuga');

define templates

(TBD)

$templates = [
    'top-page' => [
        'title' => 'this is top page',
    ],
    'mypage' => [
        'title' => 'this is mypage',
    ]
]

Contributes

Build

composer install --dev