The master branch is not stable, please use tagged release branches. The previous stable branch with support for the
old API is now under the opengraph-v1.0 branch.
Also included are some helper functions that:
- Include the Facebook JS SDK on your pages
- Allow setting Open Graph meta tags
- Easy rendering of Facebook Social Plugins.
Facebook PHP SDK:
- https://developers.facebook.com/docs/reference/php
- https://developers.facebook.com/docs/php/gettingstarted
- https://github.com/facebook/facebook-php-sdk-v4
Facebook JS SDK:
Facebook Social Plugins:
Open Graph Protocol:
Upgrading from PHP SDK 4 to PHP SDK 5
It is recommended that you install this via composer. This extension is hosted on packagist.org: https://packagist.org/packages/splashlab/yii-facebook-opengraph
"require": {
"splashlab/yii-facebook-opengraph": "dev-master"
}
Instead of 'dev-master' you can choose a release tag like '1.0.2-beta'.
Run composer update to get the extension. This will pull down the official Facebook SDK as a dependency.
Configure Yii application component SFacebook in your yii config file:
'components'=>[
'facebook'=>[
'class' => '\YiiFacebook\SFacebook',
'appId'=>'YOUR_FACEBOOK_APP_ID', // needed for JS SDK, Social Plugins and PHP SDK
'secret'=>'YOUR_FACEBOOK_APP_SECRET', // needed for the PHP SDK
//'version'=>'v2.5', // Facebook API version to default to i.e. default_graph_version
//'enable_beta_mode' => null, // optional Facebook\Facebook setting
//'http_client_handler' => null, // optional Facebook\Facebook setting
//'persistent_data_handler' => null, // optional Facebook\Facebook setting
//'url_detection_handler' => null, // optional Facebook\Facebook setting
//'pseudo_random_string_generator' => null, // optional Facebook\Facebook setting
//'locale'=>'en_US', // override JS SDK locale setting (defaults to en_US)
//'jsSdk'=>true, // include JavaScript SDK on all pages
//'async'=>true, // load JavaScript SDK asynchronously
//'jsCallback'=>false, // declare if you are going to be inserting any JS callbacks to the async JS SDK loader
//'callbackScripts'=>'', // default JS SDK init callback JavaScript
//'status'=>false, // JS SDK - check login status
//'cookie'=>false, // JS SDK - enable cookies to allow the server to access the session
//'xfbml'=>false, // JS SDK - parse XFBML / html5 Social Plugins
//'frictionlessRequests'=>false, // JS SDK - enable frictionless requests for request dialogs
//'hideFlashCallback'=>null, // JS SDK - A function that is called whenever it is necessary to hide Adobe Flash objects on a page.
//'html5'=>true, // use html5 Social Plugins instead of older XFBML
//'defaultScope'=>[], // default Facebook Login permissions to request with Login button
//'redirectUrl'=>null, // default Facebook post-Login redirect URL
//'userFbidAttribute'=>null, // if using FBAuthRequest, declare Facebook ID attribute on user model here
//'accountLinkUrl'=>null, // if using FBAuthRequest, declare link to user account page here
//'ogTags'=>[ // set default OG tags
//'og:title'=>'MY_WEBSITE_NAME',
//'og:description'=>'MY_WEBSITE_DESCRIPTION',
//'og:image'=>'URL_TO_WEBSITE_LOGO',
//],
//'authenticationErrorCallback' => function(\Facebook\Exceptions\FacebookAuthenticationException $e) {
// special logic for expired API accessTokens
// prompt to re-authenticate?
// log error?
// throw $e?
// return true?
//},
//'authorizationErrorCallback' => function(\Facebook\Exceptions\FacebookAuthorizationException $e) {
// special logic for missing API permissions
// prompt to authorize additional permissions?
// log error?
// throw $e?
// return true?
//},
//'sdkErrorCallback' => function(\Facebook\Exceptions\FacebookSDKException $e) {
// special logic for generic Facebook SDK errors
// log error?
// throw $e?
// return true?
//}
],
],
Then, to enable the JS SDK and Open Graph meta tag functionality in your base Controller,
add this function to override the afterRender() callback:
protected function afterRender($view, &$output) {
parent::afterRender($view,$output);
//Yii::app()->facebook->addJsCallback($js); // use this if you are registering any additional $js code you want to run on init()
Yii::app()->facebook->initJs($output); // this initializes the Facebook JS SDK on all pages
Yii::app()->facebook->renderOGMetaTags(); // this renders the OG tags
return true;
}
Included is an autoload.php file to assist in installing this extension without Composer. YMMV.
- https://www.sammyk.me/using-the-facebook-sdk-v4-without-composer
- https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-4-autoloader-examples.md
Some Open Graph meta tags are set by default.
Set custom OG tags on a page (in view or action):
<?php Yii::app()->facebook->ogTags['og:title'] = "My Page Title"; ?>
Render Facebook Social Plugins using helper Yii widgets:
<?php $this->widget('\YiiFacebook\Plugins\LikeButton', [
//'href' => 'YOUR_URL', // if omitted Facebook will use the current page URL
'show_faces'=>true,
'share' => true
]); ?>
You can, of course, just use the XFBML code for social plugins as well (if loading the JS SDK with XFBML = true):
<div class="fb-like" data-share="true" data-show-faces="true"></div>
At any point you can add additional JavaScript code to run after the Facebook JS SDK initializes:
<?php Yii::app()->facebook->addJsCallback($js); ?>
To use the PHP SDK anywhere in your application, just call it like so (there pass-through the Facebook class):
<?php $accessToken = Yii::app()->facebook->getAccessToken() ?>
<?php $accessToken = Yii::app()->facebook->getLongLivedAccessToken() ?>
<?php $loginUrl = Yii::app()->facebook->getLoginUrl($redirect_url_after_login) ?>
<?php $reRequestUrl = Yii::app()->facebook->getReRequestUrl() ?>
<?php $reAuthenticationUrl = Yii::app()->facebook->getReAuthenticationUrl() ?>
<?php $signedRequest = Yii::app()->facebook->getSignedRequest() ?>
<?php $logoutUrl = Yii::app()->facebook->getLogoutUrl('http://example.com/after-logout') ?>
Calling API methods directly on the Yii::app()->facebook component will automatically check for and add the proper
accessToken for the logged in user. Call them like so:
<?php $graphPageObject = Yii::app()->facebook->get('/me')->getUserNode() ?>
<?php $graphPageObject = Yii::app()->facebook->get('/SOME_PAGE_ID')->getPageNode() ?>
<?php $response = Yii::app()->facebook->post('/me/feed', [
'message' => 'User provided message'
'link' => 'www.example.com',
])->getGraphNode() ?>
<?php Yii::app()->facebook->$fb->delete('/{node-id}') ?>
If you call the SDK methods directly on the Yii::app()->facebook component then some default error handling
logic will run. You can override this logic by specifying 3 different global Facebook error handlers:
authenticationErrorCallback=>function(\Facebook\Exceptions\FacebookAuthenticationException $e)authorizationErrorCallback=>function(\Facebook\Exceptions\FacebookAuthorizationException $e)sdkErrorCallback=>function(\Facebook\Exceptions\FacebookSDKException $e)
If you want to make API calls without the default accessToken or without the global error handlers, call it
via the fb property like this (Yii::app()->facebook->fb):
<?php
try {
$response = Yii::app()->facebook->fb->post('/me/feed', [
'link' => 'www.example.com',
'message' => 'User provided message'
])->getGraphNode()
echo "Posted with id: " . $response->getField('id');
} catch (\Facebook\Exceptions\FacebookSDKException $e) {
// your own error handlers
echo "Exception occurred, code: " . $e->getCode();
echo " with message: " . $e->getMessage();
}
?>
<?php Yii::app()->facebook->destroySession() ?>
There are a couple of additional convenience methods added the component:
<?php $fb_user_id = Yii::app()->facebook->getUserId() ?>
<?php $graphUserObject = Yii::app()->facebook->getMe() // gets the Graph info of the current user ?>
<?php $graphUserObject = Yii::app()->facebook->getGraphUser($user_id) // gets the Graph object of the current user ?>
<?php $imageUrl = Yii::app()->facebook->getProfilePicture('large') // gets the Facebook picture URL of the current user ?>
<?php $imageUrl = Yii::app()->facebook->getProfilePicture(['height'=>300,'width'=>300]) // $size can also be specific ?>
<?php $imageUrl = Yii::app()->facebook->getProfilePictureById($openGraphId, $size) // gets the Facebook picture URL of a given OG entity ?>
Also included are two helper classes: FBAuthRequest and FBUserIdentity
FBAuthRequest can be used to prompt a user to log in with Facebook if no active Facebook Session is detected. The message
is displayed as a notice Flash message. You can optionally pass in Facebook permissions to prompt for.
\YiiFacebook\FBAuthRequest::fbLoginPrompt();
\YiiFacebook\FBAuthRequest::fbLoginPrompt(['manage_pages']);
FBUserIdentity is a base CBaseUserIdentity class that can be extended when adding Facebook authentication to your application.
- New version 1.x breaks everything from previous version and requires PHP 5.4
- 2.x version breaks most things, now using the PHP SDK v5 and Graph API v2.5
- 1.0.2-beta Updated to PHP SDK 4.0 and Open Graph API 2.2
- 2.0.0-beta Updated to PHP SDK 5.1 and Open Graph API 2.5
I plan on continuing to update and bugfix this extension as needed.
Please log bugs to the GitHub tracker.
Extension is posted on Yii website also: http://www.yiiframework.com/extension/facebook-opengraph/
The original version with support for Facebook SDK 3.x and Open Graph API 1.x was forked from ianare's faceplugs Yii extension: http://www.yiiframework.com/extension/faceplugs https://github.com/digitick/yii-faceplugs
Updated Feb 19th 2016 by Evan Johnson http://splashlabsocial.com