ProviderInterface.php — EmbedPress – PDF Embedder, 3D PDF FlipBook, Google Reviews, YouTube Videos, Upload & Embed PDF documents 4.6.3

embedpress / vendor / wpdevelopers / embera / src / Embera / Provider / ProviderInterface.php

embedpress / vendor / wpdevelopers / embera / src / Embera / Provider Last commit date

ProviderInterface.php

136 lines

1	<?php
2	/**
3	* ProviderInterface.php
4	*
5	* @package Adapters
6	* @author Michael Pratt <yo@michael-pratt.com>
7	* @link http://www.michael-pratt.com/
8	*
9	* For the full copyright and license information, please view the LICENSE
10	* file that was distributed with this source code.
11	*/
12
13	namespace Embera\Provider;
14
15	use Embera\Url;
16
17	/**
18	* ProviderAdapter has boilerplate methods that help remove code
19	* from the other providers. It has the basic boilerplate to instantiate
20	* and validate Providers.
21	*/
22	interface ProviderInterface
23	{
24	/**
25	* Validates that the url belongs to this service.
26	* Should be implemented on all children and should
27	* return a boolean
28	*
29	* @param Url $url
30	*
31	* @return bool\|int
32	*/
33	public function validateUrl(Url $url);
34
35	/**
36	* Construct
37	*
38	* @param string $url
39	* @param array $config
40	*
41	* @return void
42	*/
43	public function __construct($url, array $config = []);
44
45	/**
46	* Returns an array with all the parameters for the oembed request
47	*
48	* @return array
49	*/
50	public function getParams();
51
52	/**
53	* Returns the name of the current provider
54	*
55	* @return string
56	*/
57	public function getProviderName();
58
59	/**
60	* Returns the provider Endpoint
61	*
62	* @return string
63	*/
64	public function getEndpoint();
65
66	/**
67	* Returns the url (normalized and filtered)
68	*
69	* @param bool $asString Wether to return the url as a String or an Object
70	* @return mixed
71	*/
72	public function getUrl($asString = true);
73
74	/**
75	* Checks if the provider has support for HTTPS
76	*
77	* @return bool
78	*/
79	public function hasHttpsSupport();
80
81	/**
82	* Checks if the provider supports responsive embeds.
83	*
84	* @return bool
85	*/
86	public function hasResponsiveSupport();
87
88	/**
89	* Gives the ability to modify the response array
90	* from the oembed provider.
91	*
92	* It should be overwritten by the provider when needed
93	*
94	* @param array $response
95	* @return array
96	*/
97	public function modifyResponse(array $response = []);
98
99	/**
100	* This method fakes a Oembed response.
101	*
102	* It should be overwritten by the provider
103	* itself if the provider is capable to determine
104	* an html embed code based on the url or by other methods.
105	*
106	* @return array with data that the basic oembed response should have
107	*/
108	public function getFakeResponse();
109
110	/**
111	* Normalizes a url.
112	* This method should be overwritten by the
113	* Provider itself, if needed.
114	*
115	* @param Url $url
116	* @return Url $url
117	*/
118	public function normalizeUrl(Url $url);
119
120	/**
121	* Returns an array with hosts that belong to this provider.
122	*
123	* @return array
124	*/
125	public static function getHosts();
126
127	/** @return bool $shouldSendRequest It determins wether we should send api request to get the embed data or we will create embed data manually */
128	public function shouldSendRequest();
129
130	/**
131	* @return array It should return the statically generated oembed content
132	*/
133	public function getStaticResponse();
134
135	}
136