1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 <?php
/*-----8<--------------------------------------------------------------------
*
* BEdita - a semantic content management framework
*
* Copyright 2015 ChannelWeb Srl, Chialab Srl
*
* This file is part of BEdita: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published
* by the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
* BEdita is distributed WITHOUT ANY WARRANTY; without even the implied
* warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
* See the GNU Lesser General Public License for more details.
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with BEdita (see LICENSE.LGPL).
* If not, see <http://gnu.org/licenses/lgpl-3.0.html>.
*
*------------------------------------------------------------------->8-----
*/
/**
* interface used by media provider helper as (youtube, vimeo, ...)
*/
interface MediaProviderInterface {
/**
* Return true if source is available for $object else return false
*
* @param array $object a representation of BEdita object
* @return boolean
*/
public function isSourceAvailable(array $object);
/**
* Return an array with url to the source and related mime type
* If source is not available it should return an empty array
*
* The array returned should be in the form
* ```
* array(
* 'url' => 'http://example.com/video.mpg',
* 'mime_type' => 'video/mpeg'
* )
* ```
*
* @param array $object a representation of BEdita object
* @return array
*/
public function source(array $object);
/**
* Return the html to embed using provider UI
*
* @param array $object a representation of BEdita object
* @param array $attributes HTML attributes
* @return string|boolean return false if it fails to get data
*/
public function embed(array $object, array $attributes);
/**
* Return the thumbnail supplied by provider as <img> tag
* If $URLonly is true return only the url to img
*
* @param array $object a representation of BEdita object
* @param array $htmlAttributes HTML attributes to set in <img> tag
* @param boolean $URLonly true to return only the image url
* @return string
*/
public function thumbnail(array $object, array $htmlAttributes, $URLonly);
}