Overview

Namespaces

  • EmanueleMinotto
    • Gravatar
      • Twig

Classes

  • Client
  • Overview
  • Namespace
  • Class
  • Tree
  • Todo

Class Client

PHP library for gravatar.com.

Namespace: EmanueleMinotto\Gravatar
Author: Emanuele Minotto minottoemanuele@gmail.com
Link: http://www.gravatar.com/
Located at Client.php
Methods summary
public
# __construct( GuzzleHttp\ClientInterface $httpClient = null )

Class constructor, with an alternative Guzzle HTTP client (optional).

Class constructor, with an alternative Guzzle HTTP client (optional).

Parameters

$httpClient
Guzzle 4/5 client.
public EmanueleMinotto\Gravatar\Client
# setHttpClient( GuzzleHttp\ClientInterface $httpClient )

HTTP client setter.

HTTP client setter.

Parameters

$httpClient
Guzzle 4/5 client.

Returns

EmanueleMinotto\Gravatar\Client
public GuzzleHttp\ClientInterface
# getHttpClient( )

HTTP client getter.

HTTP client getter.

Returns

GuzzleHttp\ClientInterface
public string
# getProfileUrl( string $email, string $format = 'json', array $options = [] )

Get user profile on gravatar.com.

Get user profile on gravatar.com.

Parameters

$email
User email.
$format
Request format (default json).
$options
Request options.

Returns

string
public array
# getProfile( string $email )

Get user profile data.

Get user profile data.

Parameters

$email
User email.

Returns

array
public string
# getAvatarUrl( string $email, integer $size = 80, string $extension = 'jpg', integer $default = 404, string $rating = 'g' )

Get user avatar image URL.

Get user avatar image URL.

Parameters

$email
User email.
$size
Image size (default 80).
$extension
Image extension (default jpg).
$default
Error response (default 404).
$rating
Image rating (default G).

Returns

string
public string
# getAvatar( string $email, integer $size = 80, string $extension = 'jpg', integer $default = 404, string $rating = 'g' )

Get user avatar image (as base 64 URI).

Get user avatar image (as base 64 URI).

Parameters

$email
User email.
$size
Image size (default 80).
$extension
Image extension (default jpg).
$default
Error response (default 404).
$rating
Image rating (default G).

Returns

string
public boolean
# exists( string $email )

Used to check if a gravatar exists.

Used to check if a gravatar exists.

Parameters

$email
User email.

Returns

boolean
API documentation generated by ApiGen