Source of file IOGObjectExplicit.php
Size: 1,700 Bytes - Last Modified: 2021-12-23T10:55:43+00:00
/var/www/docs.ssmods.com/process/src/src/Interfaces/ObjectTypes/IOGObjectExplicit.php
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657 | <?php namespace TractorCow\OpenGraph\Interfaces\ObjectTypes; use SilverStripe\Assets\File; /** * 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 {@see IOGObject}, * but are not mandatory. * @author Damian Mooyman * @see IOGObject */ interface IOGObjectExplicit extends IOGObjectRequired { /** * Any attached audio files * @return File[]|File|string[]|string The file(s) or url(s) to file(s) */ public function getOGAudio(); /** * Any attached video files * @return File[]|File|string[]|string The file(s) or url(s) to file(s) */ public function getOGVideo(); /** * Description for this opengraph object * @return string The description */ public function getOGDescription(); /** * The word that appears before this object's title in a sentence. * An enum of (a, an, the, "", auto). If auto is chosen, the * consumer of your data should chose between "a" or "an". * Default is "" (blank). * @return string The determiner */ public function getOGDeterminer(); /** * The locale(s) the opengraph tags are marked up in. Of the format language_TERRITORY. Default is en_US. * @return string[]|string The list of all locales given, or the sole locale. If multiple values are given the first * is treated as the default. */ public function getOGLocales(); /** * The name of this site * @return string The site name */ public function getOGSiteName(); } |