https://github.com/artdarek/gravatarer

Gravatar for Laravel 4
https://github.com/artdarek/gravatarer

Last synced: 1 day ago
JSON representation

Gravatar for Laravel 4

• Host: GitHub
• URL: https://github.com/artdarek/gravatarer
• Owner: artdarek
• Created: 2013-06-28T09:34:23.000Z (about 11 years ago)
• Default Branch: master
• Last Pushed: 2017-09-28T07:14:04.000Z (almost 7 years ago)
• Last Synced: 2024-09-18T16:50:58.283Z (7 days ago)
• Language: PHP
• Size: 17.6 KB
• Stars: 6
• Watchers: 1
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• awesome-laravel4 - Gravatarer

README

        
# Gravatarer - Laravel 4 Service Provider

Gravatarer is a simple [Gravatar.com](http://gravatar.com/) service provider for Laravel 4.

A [Gravatar](http://gravatar.com/) is a Globally Recognized Avatar. You upload it and create

your profile just once, and then when you participate in any Gravatar-enabled site, your

Gravatar image will automatically follow you there. Gravatar is a free service for site

owners, developers, and users.

---

- [Installation](#installation)

- [Registering the Package](#registering-the-package)

- [Usage](#usage)

- [Generating gravatar url by user() method](#generating-gravatar-url-by-user-method)

- [Generating gravatar url by make() method](#generating-gravatar-url-by-make-method)

- [Generating HTM avatar code](#generating-htm-avatar-code)

## Installation

Use [composer](http://getcomposer.org) to install this package:

```

$ composer require artdarek/gravatarer

```

### Registering the Package

Add the Gravatarer Service Provider to your config in ``app/config/app.php``:

```php

'providers' => array(

	'Artdarek\Gravatarer\GravatarerServiceProvider'

),

```

### Usage

#### Generating gravatar url by user() method

Generating avatar with default settings is very simple and all you have to do is to call

``user()`` method with user email as a paramterer:

```php

url();

?>

```

If you want to customize avatar a little bit you can set some more parameters using additional methods

like ``size()``, ``rating()``, ``defaultImage()``.

```php

size('220');

	// Maximum rating (inclusive) [ g | pg | r | x ]

	// defaults to 'g'

	$gravatar->rating('g');

	// Default imageset to use [ 404 | mm | identicon | monsterid | wavatar ]

	// You can also specify url to your own default avatar image

	// defaults to 'mm'

	$gravatar->defaultImage('mm');

    // set gravatarer to build urls with https [true = use https, false = ise http]

    // defaults to 'false'

    $gravatar->secured( true );

	// get gravatar url as a string

	$url = $gravatar->url();

?>

```

U can also chain all methods:

```php

size('220')->rating('g')->defaultImage('mm')->url();

?>

```

#### Generating gravatar url by make() method

Basic way to generate gravatar url is just to call ``make()`` method with

user email address as a parameter (all other parameters will be loaded from defaults).

```php

url();

?>

```

U can aslo chain methods:

```php

url();

?>

```

If you want specify size of avatar or some other additional parameters you can do this

by passing array with parameters to ``make()`` method:

```php

 $email, 'size' => 220] )->url();

	// create a gravatar object with some other additional parameters

 	$url = Gravatarer::make( [

 		'email' => $email,

 		'size' => 220,

 		'defaultImage' => 'mm',

 		'rating' => 'g',

 	    'secured' => true

 	])->url();

?>

```

#### Generating HTM avatar code

With Gravatarer you can get url string of user avatar by calling ``url()`` method

but also you can generate full html  code by calling ``html()`` method instead of ``url()``.

```php

size('120');

	 // get gravatar  html code

	$html = $gravatar->html();

?>

```

If you want to have more controll over

the returned html code you can pass some additional html attributes to html() method, for examle:

```php

html( ['class' => 'avatar', 'id' => 'user123' ] );

?>

```