140 lines
2.5 KiB
PHP
140 lines
2.5 KiB
PHP
<?php
|
|
|
|
namespace Embed;
|
|
|
|
/**
|
|
* Interface used by all adapters and providers.
|
|
*/
|
|
interface DataInterface
|
|
{
|
|
/**
|
|
* Gets the title.
|
|
*
|
|
* @return string|null
|
|
*/
|
|
public function getTitle();
|
|
|
|
/**
|
|
* Gets the description.
|
|
*
|
|
* @return string|null
|
|
*/
|
|
public function getDescription();
|
|
|
|
/**
|
|
* Gets the type of the url
|
|
* The types are the same than the oEmbed types:
|
|
* video, photo, link, rich.
|
|
*
|
|
* @return string|null
|
|
*/
|
|
public function getType();
|
|
|
|
/**
|
|
* Gets the tags of the url.
|
|
*
|
|
* @return array
|
|
*/
|
|
public function getTags();
|
|
|
|
/**
|
|
* Gets the feeds urls.
|
|
*
|
|
* @return array
|
|
*/
|
|
public function getFeeds();
|
|
|
|
/**
|
|
* Gets the embed code.
|
|
*
|
|
* @return string|null
|
|
*/
|
|
public function getCode();
|
|
|
|
/**
|
|
* Gets the canonical url.
|
|
*
|
|
* @return string|null
|
|
*/
|
|
public function getUrl();
|
|
|
|
/**
|
|
* Gets the author name.
|
|
*
|
|
* @return string|null
|
|
*/
|
|
public function getAuthorName();
|
|
|
|
/**
|
|
* Gets the author url.
|
|
*
|
|
* @return string|null
|
|
*/
|
|
public function getAuthorUrl();
|
|
|
|
/**
|
|
* Gets the urls of all icons of the provider
|
|
* Note: it doesn't check whether the image exists or not.
|
|
*
|
|
* @return array
|
|
*/
|
|
public function getProviderIconsUrls();
|
|
|
|
/**
|
|
* Gets the provider name.
|
|
*
|
|
* @return string|null
|
|
*/
|
|
public function getProviderName();
|
|
|
|
/**
|
|
* Gets the provider url (usually the home url of the link).
|
|
*
|
|
* @return string|null
|
|
*/
|
|
public function getProviderUrl();
|
|
|
|
/**
|
|
* Gets the urls of all images found in the webpage
|
|
* Note: it doesn't check whether the image exists or not.
|
|
*
|
|
* @return array
|
|
*/
|
|
public function getImagesUrls();
|
|
|
|
/**
|
|
* Gets the width of the embedded widget.
|
|
*
|
|
* @return int|null
|
|
*/
|
|
public function getWidth();
|
|
|
|
/**
|
|
* Gets the height of the embedded widget.
|
|
*
|
|
* @return int|null
|
|
*/
|
|
public function getHeight();
|
|
|
|
/**
|
|
* Gets the published time, if the webpage is an article.
|
|
*
|
|
* @return string|null
|
|
*/
|
|
public function getPublishedTime();
|
|
|
|
/**
|
|
* Gets the license info.
|
|
*
|
|
* @return string|null
|
|
*/
|
|
public function getLicense();
|
|
|
|
/**
|
|
* Returns all linked data found.
|
|
*
|
|
* @return array
|
|
*/
|
|
public function getLinkedData();
|
|
}
|