11<?php
2+
23/**
3- * Interface used by all adapters
4+ * Interface used by all adapters.
45 */
56namespace Embed \Adapters ;
67
1011interface AdapterInterface extends DataInterface
1112{
1213 /**
13- * Checks whether the request is valid to this Adapter
14+ * Checks whether the request is valid to this Adapter.
1415 *
1516 * @param Request $request
1617 *
17- * @return boolean
18+ * @return bool
1819 */
1920 public static function check (Request $ request );
2021
@@ -27,13 +28,13 @@ public static function check(Request $request);
2728 public function __construct (Request $ request , array $ config = null );
2829
2930 /**
30- * Run the provider
31+ * Run the provider.
3132 */
3233 public function run ();
3334
3435 /**
3536 * Gets all icon provider urls found
36- * It returns also the width, height and mime-type
37+ * It returns also the width, height and mime-type.
3738 *
3839 * @return array
3940 */
@@ -42,45 +43,45 @@ public function getProviderIcons();
4243 /**
4344 * Gets the best icon provider
4445 * if $config['getBiggerIcon'] is true, returns the bigger image found
45- * else, returns the first found
46+ * else, returns the first found.
4647 *
4748 * @return string|null
4849 */
4950 public function getProviderIcon ();
5051
5152 /**
5253 * Gets all images found in the webpage
53- * It returns also the width, height and mime-type
54+ * It returns also the width, height and mime-type.
5455 *
5556 * @return array
5657 */
5758 public function getImages ();
5859
5960 /**
6061 * Gets the best image
61- * if $config['getBiggerImage'] is true, returns the biggest image
62+ * if $config['getBiggerImage'] is true, returns the biggest image.
6263 *
6364 * @return string|null
6465 */
6566 public function getImage ();
6667
6768 /**
68- * Gets the image width
69+ * Gets the image width.
6970 *
70- * @return integer |null
71+ * @return int |null
7172 */
7273 public function getImageWidth ();
7374
7475 /**
75- * Gets the image height
76+ * Gets the image height.
7677 *
77- * @return integer |null
78+ * @return int |null
7879 */
7980 public function getImageHeight ();
8081
8182 /**
8283 * Gets the aspect ratio of the embedded widget
83- * (useful to make it flexible)
84+ * (useful to make it flexible).
8485 *
8586 * @return float|null
8687 */
0 commit comments