File: README.md

Recommend this page to a friend!
  Classes of Nahid Bin Azhar  >  PHP Link to HTML  >  README.md  >  Download  
File: README.md
Role: Documentation
Content type: text/markdown
Description: Documentation
Class: PHP Link to HTML
Convert URLs and email addresses into HTML links
Author: By
Last change:
Date: 1 year ago
Size: 3,540 bytes
 

Contents

Class file image Download

Linkify

This a Linkify Laravel 5 supported package. Its converts URLs and email addresses into clickable links. It works on both snippets of HTML (or plain text) and complete HTML pages.

There are many regex variations shared on the internet for performing this task, but few are robust. Linkify contains a large number of unit tests to counter this.

It does not cover every possible valid-yet-never-used URLs and email addresses in order to handle 'real world' usage (eg no 'gopher://'). This means, for example, that it copes better with punctuation errors.

Authors

  • Main Author : Chris Wilkinson <chris.wilkinson@admin.cam.ac.uk>
  • Laravel Support : Nahid Bin Azhar <nahid.dns@gmail.com>

It uses regex based on John Gruber's Improved Liberal, Accurate Regex Pattern for Matching URLs.

Installation

1. Add Linkify to your dependencies:

    // composer.json

    {
       // ...
       "require": {
           // ...
           "nahid/linkify": "1.1.*"
       }
    }

2. Use Composer to download and install Linkify:

    $ php composer.phar update Nahid/linkify

3. open config/app.php and in providers array add this line

```php
Nahid\Linkify\LinkifyServiceProvider::class,
```

and in aliases array add this line too

```php
'Linkify' => Nahid\Linkify\Facades\Linkify::class,
```

4. Open terminal and goto your project and run this command

```
composer dump-autoload
```

Usage

    $text = 'This is my text containing a link to www.example.com.';

    echo Linkify::process($text);

Will output:

    This is my text containing a link to <a href="http://www.example.com">www.example.com</a>.

Options

Options set on the constructor will be applied to all links. Alternatively you can place the options on a method call. The latter will override the former.

    $linkify = new \Nahid\Linkify\Linkify(array('attr' => array('class' => 'foo')));
    $text = 'This is my text containing a link to www.example.com.';

    echo $linkify->process($text);

Will output:

    This is my text containing a link to <a href="http://www.example.com" class="foo">www.example.com</a>.

Whereas:

    $linkify = new \Nahid\Linkify\Linkify(array('attr' => array('class' => 'foo')));
    $text = 'This is my text containing a link to www.example.com.';

    echo $linkify->process($text, array('attr' => array('class' => 'bar')));

Will output:

    This is my text containing a link to <a href="http://www.example.com" class="bar">www.example.com</a>.

Available options are:

attr

An associative array of HTML attributes to add to the link. For example:

    array('attr' => array('class' => 'foo', 'style' => 'font-weight: bold; color: red;')

callback

A closure to call with each url match. The closure will be called for each URL found with three parameters: the url, the caption and a boolean isEmail (if $isEmail is true, then $url is equals to $caption.

If the callback return a non-null value, this value replace the link in the resulting text. If null is returned, the usual <a href="URL">CAPTION</a> is used.

    $linkify = new \Nahid\Linkify\Linkify(array('callback' => function($url, $caption, $isEmail) {
        return '<b>' . $caption . '</b>';
    }));
    echo $linkify->process('This link will be converted to bold: www.example.com.'));

For more information send a message to info at phpclasses dot org.