README

A consistent interface for generating URLs and links for php models.

• Installation
• Usage
  • Creating a Generator
  • Preparing Your Model
  • Generating Links
  • Link Attributes

Installation

Via Composer

$ composer require oddvalue/link-builder

Usage

Creating a Generator

First off you will need a generator class for your model. This generator class will be responsible for deciding what the href and label of the link for your model should be.

This is the minimum generator setup:

<?php

namespace App;

use Oddvalue\LinkBuilder\Link;

class ArticleLink extends Link
{
    /**
     * The attribute on the model from which the link href is derived
     *
     * @var string
     */
    protected $hrefAttribute = 'slug';

    /**
     * The attribute on the model to use as the link text
     *
     * @var string
     */
    protected $labelAttribute = 'title';
}

You don't have to extend \Oddvalue\LinkBuilder\Link, the only requirement is that the generator implements \Oddvalue\LinkBuilder\Contracts\LinkGenerator.

Preparing Your Model

Next, in your model, implement \Oddvalue\LinkBuilder\Contracts\Linkable. There is also a trait for ease of use but it is not essential to use it: \Oddvalue\LinkBuilder\Traits\LinkableTrait

For example:

<?php

namespace App;

use App\ArticleLink;
use Oddvalue\LinkBuilder\Contracts\Linkable;
use Oddvalue\LinkBuilder\Traits\LinkableTrait;

class LinkableModel implements Linkable
{
    use LinkableTrait;

    public $title;
    public $slug;

    /**
     * Get the fully qualified class name of the model's link generator
     *
     * @return string
     */
    protected function getLinkGeneratorClass()
    {
        return ArticleLink::class;
    }
}

Generating Links

Once you have set all your linkable models up with their respective link generators you will have a consistent interface for handling their URLs and links in your app.

e.g.

$model = new Article;

echo $model->getLinkGenerator()->toHtml();
# output: <a href="/bar">foo</a>

echo (string) $model->getLinkGenerator();
# output: <a href="/bar">foo</a>

echo $model->getLinkGenerator()->label();
# output: foo

echo $model->getLinkGenerator()->href();
# output: /bar

There is also a helper method for fetching the link generator of a model:

echo get_link($model)->toHtml();
# output: <a href="/bar">foo</a>

echo (string) get_link($model);
# output: <a href="/bar">foo</a>

echo get_link($model)->label();
# output: foo

echo get_link($model)->href();
# output: /bar

Link Attributes

In order to set classes and other attributes on the generated links you may either pass them in via the options array on the getLinkGenerator(array) method or you can call the setAttributes(array) method on the generator itself.

$options = [
    'attributes' => [
        'class' => ['button', 'is-disabled'],
        'role' => 'button',
        'disabled',
    ]
];

echo (string) $model->getLinkGenerator($options);
echo (string) get_link($model, $options);

# output:
# <a href="/bar" class="button is-disabled" role="button" disabled>foo</a>
# <a href="/bar" class="button is-disabled" role="button" disabled>foo</a>