CakePHP 3 Facebook Plugin
A CakePHP 3.x Plugin to allow Facebook Login into an application., (*1)
, (*2)
Requirements
- CakePHP 3.x with Auth component correctly setup. Refer to http://book.cakephp.org/3.0/en/controllers/components/authentication.html for setup
- PHP 5.4.6+
- Facebook PHP SDK 4.0+
- Users Table with at least the following columns
-
facebook_id varchar(20) // can be set in config
-
first_name // can be set in config
-
last_name // can be set in config
-
username // can be set in config
-
password // can be set in config
-
email // can be set in config
For existing applications that already have a first_name, last_name, username and password already created with a different column name, you can dynamically set it in configuration options when loading the Component to your AppController.php file. See section 2 of Configuration below, (*3)
NOTE: Facebook PHP SDK is a requirement. Composer will automatically install Facebook for you if not already installed. If manual download is chosen, you must download the Facebook Source into vendor/facebook/php-sdk-v4 and make sure it can be loaded by the composer. Else you need to manually include FAcebook's autoload.php file in your application's bootstrap.php., (*4)
Included
- Facebook Graph Component
- Facebook Graph Helper
- $this->Facebook->loginLink()
- $this->Facebook->loginButton()
- $this->Facebook->likeButton()
- $this->Facebook->shareButton()
- $this->Facebook->sendButton()
- $this->Facebook->followButton()
- $this->Facebook->comments()
- $this->Facebook->embeddedPosts()
- $this->Facebook->embeddedVideo()
- $this->Facebook->page()
***** See below for more details on how to use each, (*5)
Installation
Composer (Best Choice)
- Add the following to your
composer.json located in the root of your application, in the require section . ie. /var/www/domain.com/composer.json
"require": {
"akkaweb/cakephp-facebook": "dev-master"
}
- Run the following at the root of your application
sudo php composer.phar update
Note: if composer.phar is not found, you need to install it. Follow CakePHP's documentation here -> http://book.cakephp.org/3.0/en/installation.html. Refer to Installing Cakephp section, (*6)
Git Clone (plugins/AkkaFacebook)
git clone git@github.com:akkaweb/AKKA-CakePHP-Facebook-Plugin.git, (*7)
Download
https://github.com/akkaweb/AKKA-CakePHP-Facebook-Plugin/archive/master.zip, (*8)
Note: When installing with either manual download or Git Clone and CakePHP complains it cannot find the plugin, you need to add the plugin to vendor/cakephp-plugins.php in the plugins array [] --> 'AkkaFacebook' => $baseDir . '/plugins/AkkaFacebook/'. If you are using composer, running php composer.phar dumpautoload could be sufficient. If it does not work add the following to the "autoload" section in the root application's composer.json file in the "psr-4": section: "AkkaFacebook\\": "./plugins/AkkaFacebook/src", (*9)
Configuration
- Load the plugin in your application's
bootstrap.php file:
Plugin::load('AkkaFacebook', ['bootstrap' => false, 'routes' => true]);
- Load the plugin's component in
AppController.php
Note: You need to obtain your facebook App Id and App Secret from http://developers.facebook.com. Once you are on that page and have an App created, you can retrieve your App Id and App Secret. Make sure you add your domain to App Domains in the Settings page., (*10)
user_columns is optional and should only be used if your Users database columns defer from the defaults as specified in the Requirement section, above., (*11)
public function initialize(){
parent::initialize();
$this->loadComponent('AkkaFacebook.Graph', [
'app_id' => 'your-fb-app-id',
'app_secret' => 'your-fb-app-secret',
'app_scope' => 'email', // https://developers.facebook.com/docs/facebook-login/permissions/v2.3
'enable_create' => true,
'redirect_url' => '', //ie. Router::url(['controller' => 'Users', 'action' => 'login'], TRUE),
'post_login_redirect' => '' //ie. Router::url(['controller' => 'Users', 'action' => 'account'], TRUE)
// 'user_columns' => ['first_name' => 'fname', 'last_name' => 'lname', 'username' => 'uname', 'password' => 'pass', 'extra_columns' => ['active' => 1]] //not required
]);
}
Usage
Note: FacebookHelper is automatically loaded by the Graph Component. If that is not desired, add 'enable_graph_helper' => false, to $this->loadComponent() above., (*12)
Helper Template File Setup
- Add
<?php echo $this->Facebook->initJsSDK(); ?> immediately after the opening <body> tag
Login Link (Customizable Facebook link <a href)
Reference - https://developers.facebook.com/docs/plugins/login-button, (*13)
Optional Settings Array
* id -> Link id
* class -> Link class
* title -> Link title
* style -> Any html style
* label -> Hyperlink text
`<?php echo $this->Facebook->loginLink($options = []); ?>`
Reference - https://developers.facebook.com/docs/plugins/login-button, (*14)
Default Options
* 'auto-logout-link' => false,
* 'max-rows' => 1,
* 'onlogin' => null,
* 'size' => 'small',
* 'show-faces' => false,
* 'default-audience' => 'friends'
`<?php echo $this->Facebook->loginButton($options = []); ?>`
Reference - https://developers.facebook.com/docs/plugins/like-button, (*15)
Default Options
* 'action' => 'like', // like, recommend
* 'share' => true,
* 'width' => 450,
* 'show-faces' => true,
* 'layout' => 'standard' // standard, box_count, button_count, button
`<?php echo $this->Facebook->likeButton($options = []); ?>`
Reference - https://developers.facebook.com/docs/plugins/share-button, (*16)
Default Options
* 'layout' => 'button_count' // button_count/box_count/button/icon_link/icon/link
`<?php echo $this->Facebook->shareButton($options = []); ?>`
Reference - https://developers.facebook.com/docs/plugins/send-button, (*17)
Default Options
* 'width' => 50,
* 'height' => 30,
* 'colorscheme' => dark
`<?php echo $this->Facebook->sendButton($options = []); ?>`
Reference - https://developers.facebook.com/docs/plugins/follow-button, (*18)
Default Options
* 'width' => 300,
* 'height' => 100,
* 'colorscheme' => 'light',
* 'layout' => 'standard',
* 'show-faces' => false,
* 'kid-directed-site' => false
`<?php echo $this->Facebook->followButton($options = []); ?>`
Reference - https://developers.facebook.com/docs/plugins/comments, (*19)
Default Options
* 'colorscheme' => light, // light/dark
* 'mobile' => 'Auto-detected',
* 'num-posts' => 10,
* 'order-by' => 'social', // social/reverse_time/time
* 'width' => 550
`<?php echo $this->Facebook->comments($options = []); ?>`
Embedded Posts (Facebook Embedded Posts)
Reference - https://developers.facebook.com/docs/plugins/embedded-posts, (*20)
Default Options
* 'width' => 500
`<?php echo $this->Facebook->embeddedPosts($options = []); ?>`
Embedded Video (Facebook Embedded Video)
Reference - https://developers.facebook.com/docs/plugins/embedded-video-player, (*21)
Default Options
* 'href' => ''
* 'width' => 500
`<?php echo $this->Facebook->embeddedVideo($options = []); ?>`
Page Plugin (Facebook Page Plugin)
Reference - https://developers.facebook.com/docs/plugins/page-plugin, (*22)
Default Options
* 'href' => 'https://www.facebook.com/facebook',
* 'height' => 300,
* 'hide-cover' => false,
* 'show-facepile' => true,
* 'show-posts' => false,
* 'width' => 500
`<?php echo $this->Facebook->page($options = []); ?>`
Coming Soon
Disclaimer
Although we have done many tests to ensure this plugin works as intended, we advise you to use it at your own risk. As with anything else, you should first test any addition to your application in a test environment. Please provide any fixes or enhancements via issue or pull request., (*23)
Wallogit.com
