artdarek/gravatarer

为 Laravel 4 提供的 Gravatar。

1.0.1 2014-08-13 07:12 UTC

This package is not auto-updated.

Last update: 2024-09-14 13:45:45 UTC


README

Gravatarer 是一个简单的 Laravel 4 的 Gravatar.com 服务提供者。一个 Gravatar 是一个全球认可的头像。您只需上传一次并创建个人资料,然后当您在任何启用 Gravatar 的网站上参与时,您的 Gravatar 图片将自动跟随您。Gravatar 是为网站所有者、开发者和用户提供的免费服务。

安装

使用 composer 安装此包

$ composer require artdarek/gravatarer

注册包

将 Gravatarer 服务提供者添加到您的 app/config/app.php 配置中

'providers' => array(
	'Artdarek\Gravatarer\GravatarerServiceProvider'
),

用法

通过 user() 方法生成 gravatar url

使用默认设置生成头像非常简单,您只需使用用户电子邮件作为参数调用 user() 方法即可

<?php
	// user email
	$email = "example@user.email";

	// create a gravatar object for specified email
 	$gravatar = Gravatarer::user( $email );

	 // get gravatar url as a string
	$url = $gravatar->url();

?>

如果您想稍微自定义头像,可以使用如 size()rating()defaultImage() 等附加方法设置更多参数。

<?php
	// user email
	$email = "example@user.email";

	// create a gravatar object for specified email with additional settings
 	$gravatar = Gravatarer::user( $email );

 	// Size in pixels, defaults to 80px [ 1 - 2048 ]
	$gravatar->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();

?>

您也可以链式调用所有方法

<?php
 	$url = Gravatarer::user( $email )->size('220')->rating('g')->defaultImage('mm')->url();
?>

通过 make() 方法生成 gravatar url

生成 gravatar url 的基本方法只是调用 make() 方法,将用户电子邮件地址作为参数(所有其他参数将使用默认值加载)。

<?php
	// user email
	$email = "example@user.email";

	// create a gravatar object for specified email
 	$gravatar = Gravatarer::make( $email );

	 // get gravatar url as a string
	$url = $gravatar->url();

?>

您也可以链式调用方法

<?php
	// to get url string
	$url = Gravatarer::make( $email )->url();
?>

如果您想指定头像的大小或其他附加参数,可以通过将参数数组传递给 make() 方法来实现。

<?php
	// user email
	$email = "example@user.email";

	// create a gravatar object in specified size
 	$url = Gravatarer::make( ['email' => $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();
?>

生成 HTM 头像代码

使用 Gravatarer,您可以通过调用 url() 方法获取用户头像的 URL 字符串,也可以通过调用 html() 方法而不是 url() 生成完整的 HTML 代码。

<?php
	// user email
	$email = "example@user.email";

	// create some gravatarer object
 	$gravatar = Gravatarer::user( $email )->size('120');

	 // get gravatar <img> html code
	$html = $gravatar->html();
?>

如果您想对返回的 HTML 代码有更多控制,可以将一些额外的 HTML 属性传递给 html() 方法,例如

<?php
	$html = Gravatarer::user( $email )->html( ['class' => 'avatar', 'id' => 'user123' ] );
?>