linusrendahl/social-fontawesome

PHP Class to generate social links with FontAwesome icons.

social-fontawesome

, _(*1)

, _(*2)

, _(*3)

PHP Class to generate social links with FontAwesome icons., _(*4)

Note

This module does not add FontAwesome to your project. This will have to be added by yourself., _(*5)

Installation

Either download or use composer:, _(*6)

"require": {
        "linusrendahl/social-fontawesome": "1.*"
}

Basic usage

Usage:, _(*7)

//create the object
$icons = new LinusRendahl\SocialFontAwesome;

//add some icons with the add method
$icons
    ->add('http://www.facebook.com')
    ->add('http://twitter.com')
    ->add('http://instagram.com');

//get the html
$html = $icons->getHtml();

Returns:, _(*8)

<a href="http://www.facebook.com"title="Facebook">
    <i class="fa fa-facebook"></i>
</a>
<a href="http://twitter.com"title="Twitter">
    <i class="fa fa-twitter"></i>
</a>
<a href="http://instagram.com"title="Instagram">
    <i class="fa fa-instagram"></i>
</a>

Icons & Social Networks supported by default

• Facebook
• Twitter
• Instagram
• GitHub
• LinkedIn
• Youtube
• Tumblr
• Vimeo

Methods

add

Add your URL to your social network with the add method. Use only if the social network is in the defaults listed above., _(*9)

->add('http://facebook.com/user')

Returns:, _(*10)

<a href="http://facebook.com/user" title="Facebook">
    <i class="fa fa-facebook"></i>
</a>

addCustom

If your link is not in the supported defaults, use this method to create your own., _(*11)

//addCustom($url, $class, $title=null)
->addCustom('http://some-other-network.com/user', 'fa fa-some-icon', 'My title!')

Returns:, _(*12)

<a href="http://some-other-network.com/user" title="My title!">
    <i class="fa fa-some-icon"></i>
</a>

title

Change the title for the default icons using this method., _(*13)

->add('http://facebook.com/user')->title('Welcome to my Facebook page!')

Returns:, _(*14)

<a href="http://facebook.com/user" title="Welcome to my Facebook page!">
    <i class="fa fa-facebook"></i>
</a>

wrapper

Add a HTML element to wrap around your icons., _(*15)

->add('http://facebook.com/user')->wrapper('<div class="wrapper">', '</div>')

Returns:, _(*16)

<div class="wrapper">
    <a href="http://facebook.com/user" title="Facebook">
        <i class="fa fa-facebook"></i>
    </a>
</div>

setClass

Add a custom class to the i element., _(*17)

->add('http://facebook.com/user')->setClass('foobar')

Returns:, _(*18)

<a href="http://facebook.com/user" title="Facebook">
    <i class="fa fa-facebook foobar"></i>
</a>

setClass

Add a custom class to the i element., _(*19)

->add('http://facebook.com/user')->setClass('foobar')

Returns:, _(*20)

<a href="http://facebook.com/user" title="Facebook">
    <i class="fa fa-facebook foobar"></i>
</a>

getHtml

Method to return the formatted HTML., _(*21)

->getHtml()

getArray

Method to return the raw array of icons to easily format with your own markup, _(*22)

->getArray()

Complete Example

Usage:, _(*23)

//create the object
$icons = new LinusRendahl\SocialFontAwesome;

//add some icons with the add method
$icons
    ->add('http://www.facebook.com')
    ->add('http://twitter.com')->title('My Twitter Page!')
    ->add('http://instagram.com')->title('Cool pictures!')->setClass('foobar')
    ->wrapper('

', '

');

//get the html
$html = $icons->getHtml();

echo $html;

Returns:, _(*24)

<div class="wrapper">
    <a href="http://www.facebook.com" title="Facebook">
        <i class="fa fa-facebook"></i>
    </a>
    <a href="http://twitter.com" title="My Twitter Page!">
        <i class="fa fa-twitter"></i>
    </a>
    <a href="http://instagram.com" title="Cool pictures!">
        <i class="fa fa-facebook foobar"></i>
    </a>
</div>

History

v1.0.2

• Added as a composer package at Packagist.

v1.0

• First release.