Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/artesaos/seotools
SEO Tools for Laravel
https://github.com/artesaos/seotools
facade json-ld laravel lumen meta-tags opengraph opengraph-tags php seo seo-meta seometa seotools twitter webmaster webmasters
Last synced: 5 days ago
JSON representation
SEO Tools for Laravel
- Host: GitHub
- URL: https://github.com/artesaos/seotools
- Owner: artesaos
- License: mit
- Created: 2015-02-23T19:21:45.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2024-07-15T21:25:56.000Z (6 months ago)
- Last Synced: 2024-10-29T14:56:15.704Z (3 months ago)
- Topics: facade, json-ld, laravel, lumen, meta-tags, opengraph, opengraph-tags, php, seo, seo-meta, seometa, seotools, twitter, webmaster, webmasters
- Language: PHP
- Homepage:
- Size: 340 KB
- Stars: 3,110
- Watchers: 116
- Forks: 503
- Open Issues: 23
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
- awesome-brasil - SEOTools
- awesome-laravel-framework - SEOTools - Helpers for some common SEO techniques (Popular Packages)
- awesome - artesaos/seotools - SEO Tools for Laravel (PHP)
- laravel-awesome - SEOTools - Helpers for some common SEO techniques (Popular Packages)
- awesome-laravel - SEOTools - Helpers for some common SEO techniques (Popular Packages)
README
SEOTools - SEO Tools for Laravel and Lumen
SEOTools is a package for [Laravel 5.8+](https://laravel.com/) and [Lumen](https://lumen.laravel.com/) that provides helpers for some common SEO techniques.
> Current Build Status
[](https://travis-ci.org/artesaos/seotools)
[](https://codeclimate.com/github/artesaos/seotools)
> Statistics
[](https://packagist.org/packages/artesaos/seotools) [](https://packagist.org/packages/artesaos/seotools) [](https://packagist.org/packages/artesaos/seotools) [](https://packagist.org/packages/artesaos/seotools)
For license information check the [LICENSE](LICENSE.md)-file.
Features
--------
- Friendly simple interface
- Easy of set titles and meta tags
- Easy of set metas for [Twitter Cards](https://developer.twitter.com/en/docs/tweets/optimize-with-cards/overview/abouts-cards) and [Open Graph](https://ogp.me/)
- Easy of set for [JSON Linked Data](https://json-ld.org/)
Installation
------------
### 1 - Dependency
The first step is using composer to install the package and automatically update your `composer.json` file, you can do this by running:
```shell
composer require artesaos/seotools
```
> **Note**: If you are using Laravel 5.5, the steps 2 and 3, for providers and aliases, are unnecessaries. SEOTools supports Laravel new [Package Discovery](https://laravel.com/docs/5.5/packages#package-discovery).
### 2 - Provider
You need to update your application configuration in order to register the package so it can be loaded by Laravel, just update your `config/app.php` file adding the following code at the end of your `'providers'` section:
> `config/app.php`
```php
[
Artesaos\SEOTools\Providers\SEOToolsServiceProvider::class,
// ...
],
// ...
];
```
#### Lumen
Go to `/bootstrap/app.php` file and add this line:
```php
register(Artesaos\SEOTools\Providers\SEOToolsServiceProvider::class);
// ...
return $app;
```
### 3 - Facades
> Note: facades are not supported in Lumen.
You may get access to the SEO tool services using following facades:
- `Artesaos\SEOTools\Facades\SEOMeta`
- `Artesaos\SEOTools\Facades\OpenGraph`
- `Artesaos\SEOTools\Facades\TwitterCard`
- `Artesaos\SEOTools\Facades\JsonLd`
- `Artesaos\SEOTools\Facades\JsonLdMulti`
- `Artesaos\SEOTools\Facades\SEOTools`
You can setup a short-version aliases for these facades in your `config/app.php` file. For example:
```php
[
'SEOMeta' => Artesaos\SEOTools\Facades\SEOMeta::class,
'OpenGraph' => Artesaos\SEOTools\Facades\OpenGraph::class,
'Twitter' => Artesaos\SEOTools\Facades\TwitterCard::class,
'JsonLd' => Artesaos\SEOTools\Facades\JsonLd::class,
'JsonLdMulti' => Artesaos\SEOTools\Facades\JsonLdMulti::class,
// or
'SEO' => Artesaos\SEOTools\Facades\SEOTools::class,
// ...
],
// ...
];
```
### 4 Configuration
#### Publish config
In your terminal type
```shell
php artisan vendor:publish
```
or
```shell
php artisan vendor:publish --provider="Artesaos\SEOTools\Providers\SEOToolsServiceProvider"
```
> Lumen does not support this command, for it you should copy the file `src/resources/config/seotools.php` to `config/seotools.php` of your project
In `seotools.php` configuration file you can determine the properties of the default values and some behaviors.
#### seotools.php
- **meta**
- `defaults` - What values are displayed if not specified any value for the page display. If the value is `false`, nothing is displayed.
- `webmaster` - Are the settings of tags values for major webmaster tools. If you are `null` nothing is displayed.
- **opengraph**
- `defaults` - Are the properties that will always be displayed and when no other value is set instead. **You can add additional tags** that are not included in the original configuration file.
- **twitter**
- `defaults` - Are the properties that will always be displayed and when no other value is set instead. **You can add additional tags** that are not included in the original configuration file.
- **json-ld**
- `defaults` - Are the properties that will always be displayed and when no other value is set instead. **You can add additional tags** that are not included in the original configuration file.
Usage
-----
### Lumen Usage
> Note: facades are not supported in Lumen.
```php
generate();
```
### Meta tags Generator
With **SEOMeta** you can create meta tags to the `head`
### Opengraph tags Generator
With **OpenGraph** you can create OpenGraph tags to the `head`
### Twitter for Twitter Cards tags Generator
With **Twitter** you can create OpenGraph tags to the `head`
#### In your controller
```php
setUrl('http://current.url.com');
SEOTools::setCanonical('https://codecasts.com.br/lesson');
SEOTools::opengraph()->addProperty('type', 'articles');
SEOTools::twitter()->setSite('@LuizVinicius73');
SEOTools::jsonLd()->addImage('https://codecasts.com.br/img/logo.jpg');
$posts = Post::all();
return view('myindex', compact('posts'));
}
public function show($id)
{
$post = Post::find($id);
SEOMeta::setTitle($post->title);
SEOMeta::setDescription($post->resume);
SEOMeta::addMeta('article:published_time', $post->published_date->toW3CString(), 'property');
SEOMeta::addMeta('article:section', $post->category, 'property');
SEOMeta::addKeyword(['key1', 'key2', 'key3']);
OpenGraph::setDescription($post->resume);
OpenGraph::setTitle($post->title);
OpenGraph::setUrl('http://current.url.com');
OpenGraph::addProperty('type', 'article');
OpenGraph::addProperty('locale', 'pt-br');
OpenGraph::addProperty('locale:alternate', ['pt-pt', 'en-us']);
OpenGraph::addImage($post->cover->url);
OpenGraph::addImage($post->images->list('url'));
OpenGraph::addImage(['url' => 'http://image.url.com/cover.jpg', 'size' => 300]);
OpenGraph::addImage('http://image.url.com/cover.jpg', ['height' => 300, 'width' => 300]);
JsonLd::setTitle($post->title);
JsonLd::setDescription($post->resume);
JsonLd::setType('Article');
JsonLd::addImage($post->images->list('url'));
// OR with multi
JsonLdMulti::setTitle($post->title);
JsonLdMulti::setDescription($post->resume);
JsonLdMulti::setType('Article');
JsonLdMulti::addImage($post->images->list('url'));
if(! JsonLdMulti::isEmpty()) {
JsonLdMulti::newJsonLd();
JsonLdMulti::setType('WebPage');
JsonLdMulti::setTitle('Page Article - '.$post->title);
}
// Namespace URI: http://ogp.me/ns/article#
// article
OpenGraph::setTitle('Article')
->setDescription('Some Article')
->setType('article')
->setArticle([
'published_time' => 'datetime',
'modified_time' => 'datetime',
'expiration_time' => 'datetime',
'author' => 'profile / array',
'section' => 'string',
'tag' => 'string / array'
]);
// Namespace URI: http://ogp.me/ns/book#
// book
OpenGraph::setTitle('Book')
->setDescription('Some Book')
->setType('book')
->setBook([
'author' => 'profile / array',
'isbn' => 'string',
'release_date' => 'datetime',
'tag' => 'string / array'
]);
// Namespace URI: http://ogp.me/ns/profile#
// profile
OpenGraph::setTitle('Profile')
->setDescription('Some Person')
->setType('profile')
->setProfile([
'first_name' => 'string',
'last_name' => 'string',
'username' => 'string',
'gender' => 'enum(male, female)'
]);
// Namespace URI: http://ogp.me/ns/music#
// music.song
OpenGraph::setType('music.song')
->setMusicSong([
'duration' => 'integer',
'album' => 'array',
'album:disc' => 'integer',
'album:track' => 'integer',
'musician' => 'array'
]);
// music.album
OpenGraph::setType('music.album')
->setMusicAlbum([
'song' => 'music.song',
'song:disc' => 'integer',
'song:track' => 'integer',
'musician' => 'profile',
'release_date' => 'datetime'
]);
//music.playlist
OpenGraph::setType('music.playlist')
->setMusicPlaylist([
'song' => 'music.song',
'song:disc' => 'integer',
'song:track' => 'integer',
'creator' => 'profile'
]);
// music.radio_station
OpenGraph::setType('music.radio_station')
->setMusicRadioStation([
'creator' => 'profile'
]);
// Namespace URI: http://ogp.me/ns/video#
// video.movie
OpenGraph::setType('video.movie')
->setVideoMovie([
'actor' => 'profile / array',
'actor:role' => 'string',
'director' => 'profile /array',
'writer' => 'profile / array',
'duration' => 'integer',
'release_date' => 'datetime',
'tag' => 'string / array'
]);
// video.episode
OpenGraph::setType('video.episode')
->setVideoEpisode([
'actor' => 'profile / array',
'actor:role' => 'string',
'director' => 'profile /array',
'writer' => 'profile / array',
'duration' => 'integer',
'release_date' => 'datetime',
'tag' => 'string / array',
'series' => 'video.tv_show'
]);
// video.tv_show
OpenGraph::setType('video.tv_show')
->setVideoTVShow([
'actor' => 'profile / array',
'actor:role' => 'string',
'director' => 'profile /array',
'writer' => 'profile / array',
'duration' => 'integer',
'release_date' => 'datetime',
'tag' => 'string / array'
]);
// video.other
OpenGraph::setType('video.other')
->setVideoOther([
'actor' => 'profile / array',
'actor:role' => 'string',
'director' => 'profile /array',
'writer' => 'profile / array',
'duration' => 'integer',
'release_date' => 'datetime',
'tag' => 'string / array'
]);
// og:video
OpenGraph::addVideo('http://example.com/movie.swf', [
'secure_url' => 'https://example.com/movie.swf',
'type' => 'application/x-shockwave-flash',
'width' => 400,
'height' => 300
]);
// og:audio
OpenGraph::addAudio('http://example.com/sound.mp3', [
'secure_url' => 'https://secure.example.com/sound.mp3',
'type' => 'audio/mpeg'
]);
// og:place
OpenGraph::setTitle('Place')
->setDescription('Some Place')
->setType('place')
->setPlace([
'location:latitude' => 'float',
'location:longitude' => 'float',
]);
return view('myshow', compact('post'));
}
}
```
#### SEOTrait
```php
seo()->setTitle('Home');
$this->seo()->setDescription('This is my page description');
$this->seo()->opengraph()->setUrl('http://current.url.com');
$this->seo()->opengraph()->addProperty('type', 'articles');
$this->seo()->twitter()->setSite('@LuizVinicius73');
$this->seo()->jsonLd()->setType('Article');
$posts = Post::all();
return view('myindex', compact('posts'));
}
}
```
### In Your View
> **Pro Tip**: Pass the parameter `true` to get minified code and reduce filesize.
```html
{!! SEOMeta::generate() !!}
{!! OpenGraph::generate() !!}
{!! Twitter::generate() !!}
{!! JsonLd::generate() !!}
// OR with multi
{!! JsonLdMulti::generate() !!}
{!! SEO::generate() !!}
{!! SEO::generate(true) !!}
{!! app('seotools')->generate() !!}
```
```html
Title - Over 9000 Thousand!
{"@context":"https://schema.org","@type":"Article","name":"Title - Over 9000 Thousand!"}
{"@context":"https://schema.org","@type":"Article","name":"Title - Over 9000 Thousand!"}
{"@context":"https://schema.org","@type":"WebPage","name":"Title - Over 9000 Thousand!"}
```
#### Using Macro
Using the same code in multiple places can be tedious, which is why this package includes a Macroable trait. This trait allows additional functionality to be added to a class that was not defined in the class definition, using a simple trait.
For example, imagine that you need to add meta titles and descriptions for your pages. You can add your Macroable functions in the AppServiceProvider or create a dedicated file for this purpose, and define your function as shown in the code snippet:
```php
SEOTools::macro('webPage', function (string $title, string $description) {
SEOMeta::setTitle($title);
SEOMeta::setDescription($description);
SEOMeta::setCanonical('http://current.url.com');
OpenGraph::setDescription($description);
OpenGraph::setTitle($title);
OpenGraph::setUrl('http://current.url.com');
OpenGraph::addProperty('type', 'webpage');
});
```
In your controller, you can use the following code to utilize the function:
```php
SEOTools::webPage('Page title', 'Page description');
```
#### API (SEOMeta)
```php
setDescription($description)
->setKeywords($keywords)
->addKeyword($keyword)
->addMeta($meta, $value);
// Retrieving data
SEOMeta::getTitle();
SEOMeta::getTitleSession();
SEOMeta::getTitleSeparator();
SEOMeta::getKeywords();
SEOMeta::getDescription();
SEOMeta::getCanonical($url);
SEOMeta::getPrev($url);
SEOMeta::getNext($url);
SEOMeta::getRobots();
SEOMeta::reset();
SEOMeta::generate();
```
#### API (OpenGraph)
```php
addImage($url)
->addImages($url)
->setTitle($title)
->setDescription($description)
->setUrl($url)
->setSiteName($name);
// Generate html tags
OpenGraph::generate();
```
### API (TwitterCard)
```php
setType($type)
->setImage($url)
->setTitle($title)
->setDescription($description)
->setUrl($url)
->setSite($name);
// Generate html tags
TwitterCard::generate();
```
### API (JsonLd)
```php
setType($type)
->setImage($url)
->setTitle($title)
->setDescription($description)
->setUrl($url)
->setSite($name);
// Generate html tags
JsonLd::generate();
```
### API (JsonLdMulti)
```php
setType($type)
->setImage($url)
->setTitle($title)
->setDescription($description)
->setUrl($url)
->setSite($name);
// You can add an other group
if(! JsonLdMulti::isEmpty()) {
JsonLdMulti::newJsonLd()
->setType($type)
->setImage($url)
->setTitle($title)
->setDescription($description)
->setUrl($url)
->setSite($name);
}
// Generate html tags
JsonLdMulti::generate();
// You will have retrieve
```
#### API (SEO)
> Facilitates access to all the SEO Providers
```php
My name is
Elizabeth.
```
you will need to handle it yourself.
> Note: nowadays microdata markup is considered to be outdated. It is recommened to use [JSON Linked Data](https://json-ld.org/) instead,
which is supported by this extension.
### RSS
This package does not support RSS feed generation or related meta data composition. Please consider usage one of the following packages for it:
- [spatie/laravel-feed](https://packagist.org/packages/spatie/laravel-feed)