Skip to content
This repository has been archived by the owner on Mar 14, 2020. It is now read-only.

Commit

Permalink
Merge pull request #26 from mhor/patch-1
Browse files Browse the repository at this point in the history
Syntax highlighting on README.markdown
  • Loading branch information
henrikbjorn committed Nov 21, 2013
2 parents 16ec60a + 3960868 commit f681200
Showing 1 changed file with 48 additions and 28 deletions.
76 changes: 48 additions & 28 deletions README.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -8,65 +8,85 @@ Installation

1. Add this bundle to your projects composer.json

"require: {
"ornicar/gravatar-bundle" : "dev-master"
}
```json
"require": {
"ornicar/gravatar-bundle" : "dev-master"
}
```

2. Run composer update to install the bundle and regenerate the autoloader

composer.phar update

```bash
$ composer.phar update
```

3. Add this bundle to your application's kernel:

// application/ApplicationKernel.php
public function registerBundles()
{
return array(
// ...
new Ornicar\GravatarBundle\OrnicarGravatarBundle(),
// ...
);
}
```php
// application/ApplicationKernel.php
public function registerBundles()
{
return array(
// ...
new Ornicar\GravatarBundle\OrnicarGravatarBundle(),
// ...
);
}
```

4. Configure the `gravatar` service, templating helper and Twig extension in your config:

# application/config/config.yml
ornicar_gravatar: ~
```yaml
# application/config/config.yml
ornicar_gravatar: ~
```

5. If you always have some default for your gravatars such as size, rating or default it can be configured in your config

# application/config/config.yml
ornicar_gravatar:
rating: g
size: 80
default: mm
```yaml
# application/config/config.yml
ornicar_gravatar:
rating: g
size: 80
default: mm
```

Usage
-----

All you have to do is use the helper like this example:

<img src="<?php echo $view['gravatar']->getUrl('[email protected]') ?>" />
```html
<img src="<?php echo $view['gravatar']->getUrl('[email protected]') ?>" />
```

Or with parameters:

<img src="<?php echo $view['gravatar']->getUrl('[email protected]', '80', 'g', 'defaultimage.png', true) ?>" />
```html
<img src="<?php echo $view['gravatar']->getUrl('[email protected]', '80', 'g', 'defaultimage.png', true) ?>" />
```

The only required parameter is the email adress. The rest have default values.

If you use twig you can use the helper like this example:

{{ gravatar('[email protected]') }}
```
{{ gravatar('[email protected]') }}
```

Or if you want to check if a gravatar email exists:

{% if gravatar_exists('[email protected]') %}
The email is an gravatar email
{% endif %}
```
{% if gravatar_exists('[email protected]') %}
The email is an gravatar email
{% endif %}
```

Or with parameters:

{{ gravatar('[email protected]', size, rating, default, secure) }}
```
{{ gravatar('[email protected]', size, rating, default, secure) }}
```

For more information [look at the gravatar implementation pages][gravatar].

Expand Down

0 comments on commit f681200

Please sign in to comment.