Skip to content

dayllanmaza/Embed

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Embed

Build Status Scrutinizer Code Quality

PHP library to get info and embed any web page (using oembed, opengraph, twitter-cards, etc). It's compatible with any web service (youtube, vimeo, flickr, instagram, etc). Has adapters to some webpages like (archive.org, github, deviantart, etc).

Requirements:

  • PHP 5.3+
  • Curl library installed
  • A PSR-0 compatible autoloader class

Usage:

//Load library (if you don't have composer or any psr-0 compatible loader):
include('Embed/autoloader.php');

//Load any url:
$info = Embed\Embed::create('https://www.youtube.com/watch?v=PP1xn5wHtxE');

//Get content info

$info->title;
$info->description;
$info->url;
$info->type;

$info->images;
$info->image;
$info->imageWidth;
$info->imageHeight;

$info->code;
$info->width;
$info->height;
$info->aspectRatio;

$info->authorName;
$info->authorUrl;

$info->providerIcons;
$info->providerIcon;
$info->providerName;
$info->providerUrl;

Available options

  • minImageWidth (int): Minimal image width used to choose the main image
  • minImageHeight (int): Minimal image height used to choose the main image
  • getBiggerImage (bool): Returns the bigger image as the main image (instead the first found). This can make the request slower because it need to check the size of all images.
  • getBiggerIcon (bool): The same than getBiggerImage but used to choose the main icon
  • facebookAccessToken (string): Used to get info from facebook pages when these pages are not public and a access token is required
  • soundcloudClientId (string): Used to get info of links from soundcloud. By default, it uses "YOUR_CLIENT_ID" that its a valid client id :P
  • embedlyKey (string): If it's defined, get info from embedly service (only for know supported services and if the page doesn't have its own oembed service)
$options = array(
	'getBiggerImage' => true
);

$info = Embed\Embed::create('https://www.youtube.com/watch?v=PP1xn5wHtxE', $options);

Customize the request

Embed provides a RequestResolvers\Curl class to resolve all requests using the curl library. You can create your own request resolver class creating a class implementing the RequestResolverInterface.

//Configure the request resolver class:
Embed\Request::setDefaultResolver('MyCustomResolverClass');

You can configure also the following options of the request resolver:

  • user_agent: User agent used in all requests. By default is "Embed PHP Library"
  • max_redirections: The maximum amount of HTTP redirections to follow. By default is 20
  • connection_timeout: The number of seconds to wait while trying to connect. Use 0 to wait indefinitely. By default is 10
  • timeout: The maximum number of seconds to allow execute the request. By default is 10

To set a new configuration:

Embed\Request::setResolverConfig(array(
	'user_agent' => 'My spider',
	'connection_timeout' => 0
));

Or you can set your custom resolver class and the configuration at the same time:

Embed\Request::setDefaultResolver('MyCustomResolverClass', array(
	'user_agent' => 'My spider',
	'connection_timeout' => 0
));

Online demo

http://oscarotero.com/embed/test.php

Contributors

About

Get info from any web service or page

Resources

License

Stars

Watchers

Forks

Packages

No packages published