Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/creativeorange/gravatar
A Laravel Gravatar package for retrieving gravatar image URLs or checking the existance of an image.
https://github.com/creativeorange/gravatar
Last synced: 3 days ago
JSON representation
A Laravel Gravatar package for retrieving gravatar image URLs or checking the existance of an image.
- Host: GitHub
- URL: https://github.com/creativeorange/gravatar
- Owner: creativeorange
- License: mit
- Created: 2015-03-19T12:54:18.000Z (almost 10 years ago)
- Default Branch: 1.0
- Last Pushed: 2024-02-28T09:24:25.000Z (11 months ago)
- Last Synced: 2025-01-03T03:06:50.836Z (10 days ago)
- Language: PHP
- Homepage:
- Size: 43 KB
- Stars: 534
- Watchers: 12
- Forks: 58
- Open Issues: 5
-
Metadata Files:
- Readme: readme.md
- License: LICENSE
Awesome Lists containing this project
- laravel_awesome_user_mgmt_recaptcha - Gravatar API
README
# Gravatar for Laravel 5 - 10
[](https://packagist.org/packages/creativeorange/gravatar)
[](https://packagist.org/packages/creativeorange/gravatar)
[](https://packagist.org/packages/creativeorange/gravatar)
## Installation
First, pull in the package through Composer via the command line:
```js
composer require creativeorange/gravatar ~1.0
```
or add the following to your composer.json file and run `composer update`.
```js
"require": {
"creativeorange/gravatar": "~1.0"
}
```
Then include the service provider within (Laravel 5.3 or below) `app/config/app.php`.
```php
'providers' => [
'Creativeorange\Gravatar\GravatarServiceProvider'
];
```
If using Laravel 5.4, include service provider withing `config/app.php`
```php
'providers' => [
Creativeorange\Gravatar\GravatarServiceProvider::class
];
```
If you want to use the facade, add this to de bottom of `app/config/app.php`
And, for convenience, add a facade alias to this same file at the bottom:
```php
'aliases' => [
'Gravatar' => 'Creativeorange\Gravatar\Facades\Gravatar',
];
```
If you are using Laravel 5.4 or greater, add as follows, add to `config/app.php`
```php
'aliases' => [
'Gravatar' => Creativeorange\Gravatar\Facades\Gravatar::class,
];
```
Finally, publish the config by running the `php artisan vendor:publish` command
## Usage
Within your controllers or views, you can use
```php
Gravatar::get('[email protected]');
```
this will return the URL to the gravatar image of the specified email address.
In case of a non-existing gravatar, it will return return a URL to a placeholder image.
You can set the type of the placeholder in the configuration option `fallback`.
For more information, visit [gravatar.com](http://en.gravatar.com/site/implement/images/#default-image)
Alternatively, you can check for the existence of a gravatar image by using
```php
Gravatar::exists('[email protected]');
```
This will return a boolean (`true` or `false`).
Or you can pass a url to a custom image using the fallback method:
```php
Gravatar::fallback('http://urlto.example.com/avatar.jpg')->get('[email protected]');
```
## Configuration
You can create different configuration groups to use within your application and pass the group name as a second parameter to the `get`-method:
There is a default group in `config/gravatar.php` which will be used when you do not specify a second parameter.
If you would like to add more groups, feel free to edit the `config/gravatar.php` file. For example:
```php
return array(
'default' => array(
'size' => 80,
'fallback' => 'mm',
'secure' => false,
'maximumRating' => 'g',
'forceDefault' => false,
'forceExtension' => 'jpg',
),
'small-secure' => array (
'size' => 30,
'secure' => true,
),
'medium' => array (
'size' => 150,
)
);
```
then you can use the following syntax:
```php
Gravatar::get('[email protected]', 'small-secure'); // will use the small-secure group
Gravatar::get('[email protected]', 'medium'); // will use the medium group
Gravatar::get('[email protected]', 'default'); // will use the default group
Gravatar::get('[email protected]'); // will use the default group
```
Alternatively, you could also pass an array directly as the second parameter as inline options. So, instead of passing a configuration key, you pass an array, which will be merged with the default group:
```php
Gravatar::get('[email protected]', ['size'=>200]);
```