Skip to content

matthewtrask/phergie-irc-plugin-react-url

 
 

Repository files navigation

Url Plugin

Phergie plugin for Display URL information about links.

Build Status

Install

To install via Composer, use the command below, it will automatically detect the latest version and bind it with ~.

composer require phergie/phergie-irc-plugin-url 

See Phergie documentation for more information on installing and enabling plugins.

Configuration

return array(

    'plugins' => array(

        // dependencies
        new \Phergie\Plugin\Dns\Plugin, // Handles DNS lookups for the HTTP plugin
        new \Phergie\Plugin\Http\Plugin, // Handles the HTTP requests for this plugin

        // configuration
        new \Phergie\Plugin\Url\Plugin(array(
            // All configuration is optional
            
            'hostUrlEmitsOnly' => false // url.host.(all|<host>) emits only, no further URL handling / shortening
            
            // or

            'handler' => new \Phergie\Plugin\Url\DefaultUrlHandler(), // URL handler that creates a formatted message based on the URL

            // or

            'shortenTimeout' => 15 // If after this amount of seconds no url shortener has come up with a short URL the normal URL will be used. (Not in effect when there are no shorteners listening.)

        )),

    )
);

Events

This plugin emits the following generic, do what ever you want with it, events.

  • url.host.HOSTNAME For example url.host.twitter.com (www. is stripped from the hostname).
  • url.host.all For all hostnames.

This plugins also emits two events for url shortening. Only called when there are listeners registered. Each event emit is passed a UrlshorteningEvent, if a shortener resolved short url it calls the resolve method on the promise.

  • url.shorten.HOSTNAME For example url.shorten.twitter.com (www. is stripped from the hostname).
  • url.shorten.all For all hostnames.

Tests

To run the unit test suite:

curl -s https://getcomposer.org/installer | php
php composer.phar install
./vendor/bin/phpunit

License

Released under the MIT License. See LICENSE.

About

Phergie plugin for displaying information about URLs

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • PHP 99.2%
  • Makefile 0.8%