mpclarkson/icon-scraper

PHP Library to get the apple-touch-icons and favicon from a website.

0.2.0 2017-03-21 20:40 UTC

This package is auto-updated.

Last update: 2024-11-08 14:14:59 UTC


README

Build Status Scrutinizer Code Quality

Overview

This library returns an array of apple-touch-icon and the favicon for a given url, sorted by width.

Requirements

PHP 5.4+

Composer

Use Composer by adding the following lines in your composer.json:

"require": {
    "mpclarkson/icon-scraper": "dev-master"
},

Usage

    require_once('vendor/autoload.php');

    $scraper = new \Mpclarkson\IconScraper\Scraper();

    $icons = $scraper->get('http://hilenium.com');

    foreach($icons as $icon) {
        $icon->getType(); //Returns favicon or apple-touch-icon
        $icon->getHref(); //Returns a url
        $icon->getSize(); //Returns an array of integers, or empty for favicons
        $icon->getWidth(); //Integer or null
        $icon->getHeight(); //Integer or null
    }

    //$icons looks like this:

    Array
    (
        [0] => Mpclarkson\IconScraper\Icon Object
            (
                [type:Mpclarkson\IconScraper\Icon:private] => favicon
                [href:Mpclarkson\IconScraper\Icon:private] => http://d1nhhppd50p5r.cloudfront.net/favicon.ico?1433897130
                [size:Mpclarkson\IconScraper\Icon:private] => Array
                    (
                    )

            )

        [1] => Mpclarkson\IconScraper\Icon Object
            (
                [type:Mpclarkson\IconScraper\Icon:private] => apple-touch-icon
                [href:Mpclarkson\IconScraper\Icon:private] => http://d1nhhppd50p5r.cloudfront.net/css/96113be.css?1433897130
                [size:Mpclarkson\IconScraper\Icon:private] => Array
                    (
                    )
            )

        [2] => Mpclarkson\IconScraper\Icon Object
            (
                [type:Mpclarkson\IconScraper\Icon:private] => apple-touch-icon
                [href:Mpclarkson\IconScraper\Icon:private] => https://d1nhhppd50p5r.cloudfront.net/icon57.png?1433897130
                [size:Mpclarkson\IconScraper\Icon:private] => Array
                    (
                        [0] => 57
                        [1] => 57
                    )
            )

        [3] => Mpclarkson\IconScraper\Icon Object
            (
                [type:Mpclarkson\IconScraper\Icon:private] => apple-touch-icon
                [href:Mpclarkson\IconScraper\Icon:private] => http://d1nhhppd50p5r.cloudfront.net/icon72.png?1433897130
                [size:Mpclarkson\IconScraper\Icon:private] => Array
                    (
                        [0] => 72
                        [1] => 72
                    )
            )

        [4] => Mpclarkson\IconScraper\Icon Object
            (
                [type:Mpclarkson\IconScraper\Icon:private] => apple-touch-icon
                [href:Mpclarkson\IconScraper\Icon:private] => https://d1nhhppd50p5r.cloudfront.net/icon76.png?1433897130
                [size:Mpclarkson\IconScraper\Icon:private] => Array
                    (
                        [0] => 76
                        [1] => 76
                    )

            )

        [5] => Mpclarkson\IconScraper\Icon Object
            (
                [type:Mpclarkson\IconScraper\Icon:private] => apple-touch-icon
                [href:Mpclarkson\IconScraper\Icon:private] => https://d1nhhppd50p5r.cloudfront.net/icon114.png?1433897130
                [size:Mpclarkson\IconScraper\Icon:private] => Array
                    (
                        [0] => 114
                        [1] => 114
                    )

            )

        [6] => Mpclarkson\IconScraper\Icon Object
            (
                [type:Mpclarkson\IconScraper\Icon:private] => apple-touch-icon
                [href:Mpclarkson\IconScraper\Icon:private] => https://d1nhhppd50p5r.cloudfront.net/icon120.png?1433897130
                [size:Mpclarkson\IconScraper\Icon:private] => Array
                    (
                        [0] => 120
                        [1] => 120
                    )

            )

        [7] => Mpclarkson\IconScraper\Icon Object
            (
                [type:Mpclarkson\IconScraper\Icon:private] => apple-touch-icon
                [href:Mpclarkson\IconScraper\Icon:private] => https://d1nhhppd50p5r.cloudfront.net/icon144.png?1433897130
                [size:Mpclarkson\IconScraper\Icon:private] => Array
                    (
                        [0] => 144
                        [1] => 144
                    )

            )

        [8] => Mpclarkson\IconScraper\Icon Object
            (
                [type:Mpclarkson\IconScraper\Icon:private] => apple-touch-icon
                [href:Mpclarkson\IconScraper\Icon:private] => http://d1nhhppd50p5r.cloudfront.net/icon152.png?1433897130
                [size:Mpclarkson\IconScraper\Icon:private] => Array
                    (
                        [0] => 152
                        [1] => 152
                    )

            )
    )

Todos

  • More tests
  • Improve code style

Credits

This library is significant fork of this library by Arthur Hoaro. Key changes include:

  • Returns an array of icons, rather than just the favicon
  • Icons returned as Icon objects which include the following properties: type, href and size, and getters for width and height
  • No caching
  • PSR-4

Thanks goes to Hilenium.