astrotomic/php-open-graph

Easily generate Open Graph tags

0.5.0 2020-09-15 10:39 UTC

This package is auto-updated.

Last update: 2020-10-15 10:55:48 UTC


README

Latest Version MIT License Offset Earth Larabelles

GitHub Workflow Status StyleCI Total Downloads

This package provides a fluent PHP OOP builder for Open Graph protocol and Twitter Cards.

Installation

You can install the package via composer:

composer require astrotomic/php-open-graph

Usage

use Astrotomic\OpenGraph\OpenGraph;
use Astrotomic\OpenGraph\StructuredProperties\Image;

echo OpenGraph::website('Example')
    ->url('https://example.com')
    ->image('https://example.com/image1.jpg')
    ->image(Image::make('https://example.com/image2.jpg')->width(600));
<meta property="og:type" content="website" />
<meta property="og:title" content="Example" />
<meta property="og:url" content="https://example.com" />
<meta property="og:image" content="https://example.com/image1.jpg" />
<meta property="og:image:url" content="https://example.com/image2.jpg" />
<meta property="og:image:width" content="600" />

Types

Global

  • \Astrotomic\OpenGraph\Types\Website
  • \Astrotomic\OpenGraph\Types\Article
  • \Astrotomic\OpenGraph\Types\Profile
  • \Astrotomic\OpenGraph\Types\Book

Music

  • \Astrotomic\OpenGraph\Types\Music\Album
  • \Astrotomic\OpenGraph\Types\Music\Playlist
  • \Astrotomic\OpenGraph\Types\Music\Song
  • \Astrotomic\OpenGraph\Types\Music\RadioStation

Video

  • \Astrotomic\OpenGraph\Types\Video\Movie
  • \Astrotomic\OpenGraph\Types\Video\TvShow
  • \Astrotomic\OpenGraph\Types\Video\Episode
  • \Astrotomic\OpenGraph\Types\Video\Other

Twitter

  • \Astrotomic\OpenGraph\Types\Twitter\Summary
  • \Astrotomic\OpenGraph\Types\Twitter\SummaryLargeImage
  • \Astrotomic\OpenGraph\Types\Twitter\Player

Structured Properties

  • \Astrotomic\OpenGraph\StructuredProperties\Image
  • \Astrotomic\OpenGraph\StructuredProperties\Video
  • \Astrotomic\OpenGraph\StructuredProperties\Audio

Testing

composer test

Changelog

Please see CHANGELOG for more information what has changed recently.

Contributing

Please see CONTRIBUTING for details. You could also be interested in CODE OF CONDUCT.

Security

If you discover any security related issues, please check SECURITY for steps to report it.

Credits

License

The MIT License (MIT). Please see License File for more information.

Treeware

You're free to use this package, but if it makes it to your production environment I would highly appreciate you buying the world a tree.

It’s now common knowledge that one of the best tools to tackle the climate crisis and keep our temperatures from rising above 1.5C is to plant trees. If you contribute to my forest you’ll be creating employment for local families and restoring wildlife habitats.

You can buy trees at offset.earth/treeware

Read more about Treeware at treeware.earth