Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/astrotomic/php-open-graph

This package provides a fluent PHP OOP builder for Open Graph protocol.
https://github.com/astrotomic/php-open-graph

hacktoberfest open-graph open-graph-protocol php-open-graph treeware twitter

Last synced: 6 days ago
JSON representation

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

Host: GitHub
URL: https://github.com/astrotomic/php-open-graph
Owner: Astrotomic
License: mit
Created: 2017-02-22T15:38:09.000Z (almost 8 years ago)
Default Branch: main
Last Pushed: 2024-10-22T20:28:51.000Z (2 months ago)
Last Synced: 2024-10-29T21:06:02.421Z (about 2 months ago)
Topics: hacktoberfest, open-graph, open-graph-protocol, php-open-graph, treeware, twitter
Language: PHP
Homepage: https://ogp.me/
Size: 204 KB
Stars: 59
Watchers: 4
Forks: 4
Open Issues: 1
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md

Awesome Lists containing this project

README

        # PHP Open-Graph

[![Latest Version](http://img.shields.io/packagist/v/astrotomic/php-open-graph.svg?label=Release&style=for-the-badge)](https://packagist.org/packages/astrotomic/php-open-graph)

[![MIT License](https://img.shields.io/github/license/Astrotomic/php-open-graph.svg?label=License&color=blue&style=for-the-badge)](https://github.com/Astrotomic/php-open-graph/blob/master/LICENSE)

[![Offset Earth](https://img.shields.io/badge/Treeware-%F0%9F%8C%B3-green?style=for-the-badge)](https://plant.treeware.earth/Astrotomic/php-open-graph)

[![Larabelles](https://img.shields.io/badge/Larabelles-%F0%9F%A6%84-lightpink?style=for-the-badge)](https://www.larabelles.com/)

[![pest](https://img.shields.io/github/workflow/status/Astrotomic/php-open-graph/pest?style=flat-square&logoColor=white&logo=github&label=Tests)](https://github.com/Astrotomic/php-open-graph/actions?query=workflow%3Apest)

[![pint](https://img.shields.io/github/workflow/status/Astrotomic/php-open-graph/pint?style=flat-square&logoColor=white&logo=github&label=CS)](https://github.com/Astrotomic/php-open-graph/actions?query=workflow%3Apint)

[![Total Downloads](https://img.shields.io/packagist/dt/astrotomic/php-open-graph.svg?label=Downloads&style=flat-square)](https://packagist.org/packages/astrotomic/php-open-graph)

This package provides a fluent PHP OOP builder for [Open Graph protocol](https://ogp.me) and [Twitter Cards](https://developer.twitter.com/en/docs/tweets/optimize-with-cards/overview/abouts-cards).

## Installation

You can install the package via composer:

```bash

composer require astrotomic/php-open-graph

```

## Usage

```php

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));

```

```html

```

### Types

#### Global

-   `\Astrotomic\OpenGraph\Types\Article`

-   `\Astrotomic\OpenGraph\Types\Book`

-   `\Astrotomic\OpenGraph\Types\Profile`

-   `\Astrotomic\OpenGraph\Types\Website`

#### Music

-   `\Astrotomic\OpenGraph\Types\Music\Album`

-   `\Astrotomic\OpenGraph\Types\Music\Playlist`

-   `\Astrotomic\OpenGraph\Types\Music\RadioStation`

-   `\Astrotomic\OpenGraph\Types\Music\Song`

#### Video

-   `\Astrotomic\OpenGraph\Types\Video\Episode`

-   `\Astrotomic\OpenGraph\Types\Video\Movie`

-   `\Astrotomic\OpenGraph\Types\Video\Other`

-   `\Astrotomic\OpenGraph\Types\Video\TvShow`

#### Twitter

-   `\Astrotomic\OpenGraph\Types\Twitter\App`

-   `\Astrotomic\OpenGraph\Types\Twitter\Player`

-   `\Astrotomic\OpenGraph\Types\Twitter\SummaryLargeImage`

-   `\Astrotomic\OpenGraph\Types\Twitter\Summary`

### Structured Properties

-   `\Astrotomic\OpenGraph\StructuredProperties\Audio`

-   `\Astrotomic\OpenGraph\StructuredProperties\Image`

-   `\Astrotomic\OpenGraph\StructuredProperties\Video`

## Testing

```bash

composer test

```

## Changelog

Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently.

## Contributing

Please see [CONTRIBUTING](https://github.com/Astrotomic/.github/blob/master/CONTRIBUTING.md) for details. You could also be interested in [CODE OF CONDUCT](https://github.com/Astrotomic/.github/blob/master/CODE_OF_CONDUCT.md).

### Security

If you discover any security related issues, please check [SECURITY](https://github.com/Astrotomic/.github/blob/master/SECURITY.md) for steps to report it.

## Credits

-   [Tom Witkowski](https://github.com/Gummibeer)

-   [Alex Vanderbist](https://github.com/AlexVanderbist)

-   [All Contributors](../../contributors)

## License

The MIT License (MIT). Please see [License File](LICENSE.md) 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](https://www.bbc.co.uk/news/science-environment-48870920). 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](https://plant.treeware.earth/Astrotomic/php-open-graph)

Read more about Treeware at [treeware.earth](https://treeware.earth)