TractorCow\OpenGraph\Interfaces\ObjectTypes\IOGObjectExplicit
Interface encompassing all optional and required fields for an opengraph object.
This interface is intended mostly be used as documentation for optional fields.
Any fields in this can be used in a class that implements only ,
but are not mandatory.
- Author: Damian Mooyman
Synopsis
interface IOGObjectExplicit
extends IOGObjectRequired
{
- // methods
- public array getOGAudio()
- public array getOGVideo()
- public string getOGDescription()
- public string getOGDeterminer()
- public array getOGLocales()
- public string getOGSiteName()
- // Inherited methods from IOGObjectRequired
- public string|null|false getOGTitle()
- public string|null|false getOGType()
- public array getOGImage()
- // Inherited methods from IOGObject
- public void AbsoluteLink()
Hierarchy
Methods
public
- getOGAudio() — Any attached audio files
- getOGDescription() — Description for this opengraph object
- getOGDeterminer() — The word that appears before this object's title in a sentence.
- getOGLocales() — The locale(s) the opengraph tags are marked up in. Of the format language_TERRITORY. Default is en_US.
- getOGSiteName() — The name of this site
- getOGVideo() — Any attached video files
Inherited from TractorCow\OpenGraph\Interfaces\ObjectTypes\IOGObjectRequired
public
- getOGImage() — Determines the image(s) to use for this object Image should be at least 200px by 200px, with 1500px by 1500px preferred, and less than 5MB in size.
- getOGTitle() — Determines the OpenGraph Title
- getOGType() — Determines the OpenGraph type as defined at {@link http://ogp.me/#types}
Inherited from TractorCow\OpenGraph\Interfaces\ObjectTypes\IOGObject
public
- AbsoluteLink() — URI to this object Named as below to prevent having to wrap the {@link SiteTree::AbsoluteLink} method explicitly