Add README

Author: asika32764

LICENSE.md

@@ -2,4 +2,201 @@
 
 A library to auto convert URLs to links in text.
 
-## Installation via 
+## Installation via Composer
+
+Add this to composer.json require block.
+
+``` json
+{
+    "require": {
+        "asika/autolink": "1.*"
+    }
+}
+```
+
+## Getting Started
+
+This is a quick start to convert URL to link:
+
+``` php
+use Asika\Autolink\Linker;
+
+$text = Linker::convert($text);
+$text = Linker::convertEmail($text);
+```
+
+## Use Autolink Object
+
+Create the object:
+
+``` php
+use Asika\Autolink\Autolink;
+
+$autolink = new Autolink;
+```
+
+Create with options.
+
+``` php
+$options = array(
+    'strip_scheme' => false,
+    'text_limit' => false,
+    'auto_title' => false
+);
+
+$schemes = array('http', 'https', 'skype', 'itunes');
+
+$autolink = new Autolink($options, $schemes);
+```
+
+## Convert Text
+
+This is an example text:
+
+``` html
+This is Simple URL:
+http://www.google.com.tw
+
+This is SSL URL:
+https://www.google.com.tw
+
+This is URL with multi-level query:
+http://example.com/?foo[1]=a&foo[2]=b
+```
+
+We convert all URLs.
+
+``` php
+$text = $autolink->convert($text);
+```
+
+Output:
+
+``` php
+This is Simple URL:
+<a href="http://www.google.com.tw">http://www.google.com.tw</a>
+
+This is SSL URL:
+<a href="https://www.google.com.tw">https://www.google.com.tw</a>
+
+This is URL with multi-level query:
+<a href="http://example.com/?foo[1]=a&amp;foo[2]=b">http://example.com/?foo[1]=a&amp;foo[2]=b</a>
+```
+
+### Add Attributes
+
+``` php
+$text = $autolink->convert($text, array('class' => 'center'));
+```
+
+All link will add this attributes:
+
+``` php
+This is Simple URL:
+<a href="http://www.google.com.tw" class="center">http://www.google.com.tw</a>
+
+This is SSL URL:
+<a href="https://www.google.com.tw" class="center">https://www.google.com.tw</a>
+```
+
+## Options
+
+### `text_limit`
+
+We can set this option by constructor or setter:
+
+``` php
+$auitolink->textLimit(50);
+
+$text = $autolink->convert($text);
+```
+
+The link text will be:
+
+``` php
+http://campus.asukademy.com/learning/job/84-fin...
+```
+
+Use Your own limit handler:
+
+``` php
+$auitolink->textLimit(function($url)
+{
+    return substr($url, 0, 50) . '...';
+});
+```
+
+Or use Pretty shorter:
+
+``` php
+$auitolink->textLimit(function($url)
+{
+    return \Asika\Autolink\Linker::shorten($url, 15, 6);
+});
+```
+
+Output:
+
+``` text
+http://campus.asukademy.com/....../84-find-interns......
+```
+
+### `auto_title`
+
+Use AutoTitle to force add title on anchor element.
+ 
+``` php
+$autolink->autoTitle(true);
+
+$text = $autolink->convert($text);
+```
+
+Output:
+
+``` html
+<a href="http://www.google.com.tw" title="http://www.google.com.tw">http://www.google.com.tw</a>
+```
+
+### `strip_scheme`
+
+Strip Scheme on link text:
+
+``` php
+$auitolink->stripScheme(true);
+
+$text = $autolink->convert($text);
+```
+
+Output
+
+``` html
+<a href="http://www.google.com.tw" >www.google.com.tw</a>
+```
+
+## Scheme
+
+You can add new scheme to convert URL begin with it, foe example: `vnc://example.com`
+
+``` php
+$autolink->addScheme('skype')
+    ->addScheme('vnc');
+```
+
+Default schemes is `http, https, ftp, ftps`.
+
+## Link Builder
+
+If you don't want to use `<a>` element as your link, you can set a callback to build link HTML.
+
+``` php
+$autolink->setLinkBuilder(function($url, $attribs)
+{
+    $attribs['src'] = htmlspecialchars($url);
+
+    return (string) \Windwalker\Html\HtmlElement('img', null, $attribs);
+});
+```
+
+See: [Windwalker Html Package](https://github.com/ventoviro/windwalker-html)
+
+

README.md

@@ -2,6 +2,8 @@
     "name": "asika/autolink",
     "description": "Auto convert url to link anchor.",
     "type": "library",
+    "homepage": "https://github.com/asika32764/php-autolink",
+    "license": "GPL-3.0+",
     "require": {
         "windwalker/dom": "~2.0@stable"
     },
@@ -10,7 +12,7 @@
     },
     "autoload": {
         "psr-4": {
-            "Asika\\": "src/"
+            "Asika\\Autolink\\": "src/"
         }
     },
     "license": "LGPL-3.0+",

composer.json

@@ -6,14 +6,14 @@
  * @license    GNU General Public License version 2 or later;
  */
 
-namespace Asika;
+namespace Asika\Autolink;
 
 use Windwalker\Dom\HtmlElement;
 
 /**
  * The Autolink class.
  * 
- * @since  {DEPLOY_VERSION}
+ * @since  1.0
  */
 class Autolink
 {
@@ -68,7 +68,7 @@ public function __construct($options = array(), $schemes = array())
 	 *
 	 * @return  string
 	 */
-	public function render($text, $attribs = array())
+	public function convert($text, $attribs = array())
 	{
 		$self = $this;
 
@@ -82,7 +82,7 @@ function($matches) use ($self, $attribs)
 
 				if (!$inElements)
 				{
-					return $self->convert($matches[0], $attribs);
+					return $self->link($matches[0], $attribs);
 				}
 
 				return $matches[0];
@@ -99,7 +99,7 @@ function($matches) use ($self, $attribs)
 	 *
 	 * @return  string
 	 */
-	public function renderEmail($text, $attribs = array())
+	public function convertEmail($text, $attribs = array())
 	{
 		$regex = "/(([a-zA-Z]*=\")*\S+@\S+\.\S+)/";
 
@@ -130,7 +130,7 @@ function($matches) use ($attribs)
 	 *
 	 * @return  string
 	 */
-	public function convert($url, $attribs = array())
+	public function link($url, $attribs = array())
 	{
 		$content = $url;
 

src/Autolink.php

@@ -6,12 +6,12 @@
  * @license    GNU General Public License version 2 or later;
  */
 
-namespace Asika;
+namespace Asika\Autolink;
 
 /**
  * The LinkHelper class.
  * 
- * @since  {DEPLOY_VERSION}
+ * @since  1.0
  */
 class LinkHelper
 {

src/LinkHelper.php

@@ -0,0 +1,78 @@
+<?php
+/**
+ * Part of php-autolink project. 
+ *
+ * @copyright  Copyright (C) 2015 {ORGANIZATION}. All rights reserved.
+ * @license    GNU General Public License version 2 or later;
+ */
+
+namespace Asika\Autolink;
+
+/**
+ * The Linker class.
+ *
+ * @method  static  string  convert()       convert($url, $sttribs = array())
+ * @method  static  string  convertEmail()  convertEmail($url, $sttribs = array())
+ * @method  static  string  link()          link($url, $sttribs = array())
+ *
+ * @since  1.0
+ */
+class Linker
+{
+	/**
+	 * Property instance.
+	 *
+	 * @var  Autolink
+	 */
+	protected static $instance;
+	
+	/**
+	 * getInstance
+	 *
+	 * @param array $options
+	 * @param array $schemes
+	 *
+	 * @return  Autolink
+	 */
+	public static function getInstance($options = array(), $schemes = array())
+	{
+		if (static::$instance instanceof Autolink)
+		{
+			return static::$instance;
+		}
+
+		return static::$instance = new Autolink($options, $schemes);
+	}
+
+	/**
+	 * Method to set property instance
+	 *
+	 * @param   Autolink $instance
+	 *
+	 * @return  void
+	 */
+	public static function setInstance($instance)
+	{
+		static::$instance = $instance;
+	}
+
+	/**
+	 * __callStatic
+	 *
+	 * @param string $name
+	 * @param array  $args
+	 *
+	 * @return  mixed
+	 */
+	public static function __callStatic($name, $args)
+	{
+		$instance = static::getInstance();
+
+		if (is_callable(array($instance, $name)))
+		{
+			return call_user_func_array(array($instance, $name), $args);
+		}
+
+		throw new \BadMethodCallException(sprintf('Method: %s::%s not exists.', 'Autolink', $name));
+	}
+}