jchaney01/gravatari

一个简单且流畅的php Gravatar 包

dev-master 2013-06-15 16:27 UTC

This package is not auto-updated.

Last update: 2019-09-16 03:49:35 UTC


README

一个简单的php Gravatar 包

  • 提供流畅的Gravatar API接口
  • 无缝集成Laravel 4

这是直接克隆自 https://github.com/MalonMedia/gravatari 以解决此问题: https://github.com/MalonMedia/gravatari/issues/1

安装

通过Composer安装

推荐通过 Composer 安装 Gravatari。

  1. 在项目的 composer.json 文件中将 malonmedia/gravatari 添加为依赖项

     {
         "require": {
             "jchaney01/gravatari": "*"
         }
     }
    
  2. 下载并安装Composer

     curl -s http://getcomposer.org/installer | php
    
  3. 安装您的依赖项

     php composer.phar install
    
  4. 需要Composer的自动加载器

    Composer还准备了一个自动加载文件,能够自动加载它下载的任何库中的所有类。要使用它,只需将以下行添加到您的代码的引导过程中

     require 'vendor/autoload.php';
    

您可以在 getcomposer.org 上了解更多有关如何安装Composer、配置自动加载以及其他定义依赖项的最佳实践。

用法

图片(头像)

<?php

use Gravatari\Api\Image;

$gravatar = new Image;

// Generate url for 80x80 avatar using Mystery Man if avatar does not exist
$url = $gravatar->size(80)->default('mm')->url('foo@foo.com');

选项

size(80)                size in pixels                      1 - 2048
default('404')          image to use as default             404, mm, identicon, monsterid, wavatar, retro, blank, OR an url
forceDefault('no')      whether to force default image      yes, no
rating('g')             maximum allowed content rating      g, pg, r, x

URL生成


    url('email@email.com')          //retrieve the url for the supplied email's gravatar
    
    urlSecure('email@email.com')    //retrieve a secure url for the supplied email's gravatar

个人资料

<?php

use Gravatari\Api\Profile;

$profile = new Profile;

// Url Methods (retrieve url in specified format)
$profile->url('foo@foo.com');
$profile->urlJson('foo@foo.com');
$profile->urlJson('foo@foo.com', 'alert');      //Json method accepts optional javascript callback paremeter
$profile->urlXml('foo@foo.com');
$profile->urlPhp('foo@foo.com');
$profile->urlVcf('foo@foo.com');
$profile->urlQr('foo@foo.com');

// Request Methods (send request and return response for specified format)
$profile->requestJson('foo@foo.com');
$profile->requestJson('foo@foo.com', 'alert');  //Json method accepts optional javascript callback paremeter
$profile->requestXml('foo@foo.com');
$profile->requestPhp('foo@foo.com');

扩展

将通过扩展提供对一些常用框架的支持。以下是当前支持的扩展说明(未来还将提供更多)

Laravel 4

  1. 'Gravatari\Extension\Laravel\GravatariServiceProvider', 添加到 app/config/app.php 文件中的 providers 数组。
  2. 'Gravatari' => 'Gravatari\Extension\Laravel\Facades\Gravatari', 添加到 app/config/app.php 文件中的 aliases 数组。
  3. 要访问头像API,使用 Gravatari::image()->url('foo@foo.com') 或简单地 Gravatari::url('foo@foo.com')
  4. 要访问个人资料API,使用 Gravatari::profile()->urlJson('foo@foo.com')