alexeevdv/yii2-gravatar-widget

Gravatar widget for Yii2

1.0.0 2019-03-15 23:18 UTC

This package is auto-updated.

Last update: 2021-09-16 12:03:54 UTC


README

Build Status codecov PHP 5.6 PHP 7.0 PHP 7.1 PHP 7.2 PHP 7.2

Yii2 wrapper for Gravatar service.

Installation

The preferred way to install this extension is through composer.

Either run

$ php composer.phar require alexeevdv/yii2-gravatar-widget

or add

"alexeevdv/yii2-gravatar-widget": "^1.0"

to the require section of your composer.json file.

Usage

echo \alexeevdv\yii\gravatar\Widget([
    "email" => "mail@example.com", // required
]);

Params

/**
 * User email address
 */
string $email;

/**
 * Use HTTPS connection?
 */
bool $secure = true;

/**
 * Append .jpg extension?
 */
bool $extension = true;

/**
 * Avatar width and height. Must be beetween 1 and 2048
 */
integer $size;

/**
 * Default image if avatar is not available. Must be valid image URI or one of the following strings:
 * "404", "mm", "identicon", "monsterid", "wavatar", "retro", "blank"
 */
string $defaultImage;

/**
 * Force default image even if the avatar is available?
 */
bool $forceDefault = false;

/**
 * Allowed avatar rating. Must be one of the following strings:
 * "g", "pg", "r", "x"
 */
string $rating;

/**
 * Additional HTML attributes to img tag
 */
array $options = [];

For more information see Gravatar manual.