Facebook Gallery Widget - grab photos from your Facebook albums. More...

Public Member Functions
	__construct ($db)
	fbGallery constructor. Get widget settings into this->settings array and call checkRequirements More...

	checkAccessToken ()
	Check if access token is correctly set. Returns true or abort with an error message. More...

	checkAlbumId ()
	Check if album id is correctly set. Returns true or abort with an error message. More...

	checkApiObjectData ()
	Check if api object is set and not empty. More...

	checkAppId ()
	Check if App ID is set, not empty and numeric. Returns true if app ID is ok or abort with an error message. More...

	checkRequirements ()
	Check if all requirements are fulfilled to perform api call. More...

	drawGallery ()
	The heart of this widget: this method draws the gallery. More...

	loadJSSDK ()
	Load Facebook JS Code. More...

	makeApiCall ()
	Prepare object data, set json link, make API call and return apiObject. More...

Public Attributes
	$apiObject

	$fbGalleryAccessToken = ''

	$fbGalleryAlbumId = ''

	$fbGalleryAppId = ''

	$fbGalleryEndDate = ''

	$fbGalleryFields = 'images,source,name,id'

	$fbGalleryFixedImageHeight = 'auto'

	$fbGalleryGraphRequest = '/albums/'

	$fbGalleryHeading = ''

	$fbGalleryImageInfo = 1

	$fbGalleryLayout = 6

	$fbGalleryLimit = 0

	$fbGallerySortation = 'desc'

	$fbGalleryStartDate = ''

	$fbGallerySubtext = ''

	$fbGalleryType = 'past'

	$fbGalleryYearRange = '10'

	$jsSDKLoaded = 'false'

	$settings

	$shuffle = 0

	$sinceDate = ''

	$untilDate = ''

Detailed Description

Facebook Gallery Widget - grab photos from your Facebook albums.

Use Facebook Graph API to get album photos from a Facebook Page. Requires an App ID and a valid access token.

With this widget, you are able to embed photos from your facebook page onto your website. It helps you to keep your website up to date. Have you ever been bored of adding the same content twice? If you change your facebook photo album the data on your website will be updated automatically.

You need an APP ID, as well as a valid access token for the facebook page you want to embed photos from. For reasons, you (respectively the app id / access token) needs administrative access rights to the facebook page you want to grab photos from. Create a new fb gallery widget in the backend, enter app id, access token and press save widget settings. The page reloads and your albums will get loaded into a select field.

Author: Daniel Retzl danie.nosp@m.lret.nosp@m.zl@gm.nosp@m.ail..nosp@m.com

Copyright: 2018 Daniel Retzl

Version: 1.0.0

Definition at line 23 of file fbGallery.php.

Constructor & Destructor Documentation

◆ __construct()

YAWK\WIDGETS\FACEBOOK\GALLERY\fbGallery::__construct ( $db )

fbGallery constructor. Get widget settings into this->settings array and call checkRequirements

Parameters

$db

Definition at line 76 of file fbGallery.php.

         {
             // load this widget settings from db
             $widget = new \YAWK\widget();
             $this->settings = $widget->getWidgetSettingsArray($db);
             foreach ($this->settings as $property => $value)
             {
                 $this->$property = $value;
             }
             // check if required settings are set
             $this->checkRequirements();

References $db, $value, and YAWK\WIDGETS\FACEBOOK\GALLERY\fbGallery\checkRequirements().

Member Function Documentation

◆ checkAccessToken()

YAWK\WIDGETS\FACEBOOK\GALLERY\fbGallery::checkAccessToken ( )

Check if access token is correctly set. Returns true or abort with an error message.

Returns: bool

Definition at line 126 of file fbGallery.php.

         {   // check if access token is set and not empty
             if (isset($this->fbGalleryAccessToken) && (!empty($this->fbGalleryAccessToken)))
             {   // check if access token is a string
                 if (is_string($this->fbGalleryAccessToken))
                 {   // access token seems legit
                     return true;
                 }
                 else
                 {   // access token is not a string, abort with error message
                     die ("Access token is set, but not a string value! Please check your access token.");
                 }
             }
             else
             {   // access token is not set or empty, abort with error message
                 die ("Access token is not set. Please add your access token. You can obtain it from http://developers.facebook.com/apps");
             }

References die.

Referenced by YAWK\WIDGETS\FACEBOOK\GALLERY\fbGallery\checkRequirements().

◆ checkAlbumId()

YAWK\WIDGETS\FACEBOOK\GALLERY\fbGallery::checkAlbumId ( )

Check if album id is correctly set. Returns true or abort with an error message.

Returns: bool

Definition at line 149 of file fbGallery.php.

         {   // check if Album ID is set and not empty
             if (isset($this->fbGalleryAlbumId) && (!empty($this->fbGalleryAlbumId)))
             {   // check if album ID is a string
                 if (is_string($this->fbGalleryAlbumId))
                 {   // seems legit
                     return true;
                 }
                 else
                 {   // album id is not a string, abort with error msg
                     die ("Album ID is set, but not a string value! Please check your photo album ID.");
                 }
             }
             else
             {   // album id is not set or empty, abort with error msg
                 die ("Album ID is not set. Please add your photo album ID.");
             }

References die.

Referenced by YAWK\WIDGETS\FACEBOOK\GALLERY\fbGallery\checkRequirements().

◆ checkApiObjectData()

YAWK\WIDGETS\FACEBOOK\GALLERY\fbGallery::checkApiObjectData ( )

Check if api object is set and not empty.

Returns: bool returns true or false

Definition at line 283 of file fbGallery.php.

         {   // check if object data is set and not empty
             if (isset($this->apiObject['data']) && (!empty($this->apiObject['data'])))
             {   // seems legit
                 return true;
             }
             else
             {   // object not set or empty
                 return false;
             }

◆ checkAppId()

YAWK\WIDGETS\FACEBOOK\GALLERY\fbGallery::checkAppId ( )

Check if App ID is set, not empty and numeric. Returns true if app ID is ok or abort with an error message.

Returns: bool

Definition at line 103 of file fbGallery.php.

         {   // check if App ID is set and not empty
             if (isset($this->fbGalleryAppId) && (!empty($this->fbGalleryAppId)))
             {   // is app ID a number for sure?
                 if (is_numeric($this->fbGalleryAppId))
                 {   // app id seems legit
                     return true;
                 }
                 else
                 {   // app id not numeric, abort with error message
                     die ("app ID is set, but not a numeric value! Please check your app ID - it should contain numbers only.");
                 }
             }
             else
             {   // app id not set or empty, abort with error message
                 die ("app ID is not set. Please add your app ID. You can obtain it from http://developers.facebook.com");
             }

References die.

Referenced by YAWK\WIDGETS\FACEBOOK\GALLERY\fbGallery\checkRequirements(), and YAWK\WIDGETS\FACEBOOK\GALLERY\fbGallery\loadJSSDK().

◆ checkRequirements()

YAWK\WIDGETS\FACEBOOK\GALLERY\fbGallery::checkRequirements ( )

Check if all requirements are fulfilled to perform api call.

Definition at line 92 of file fbGallery.php.

         {
             $this->checkAppId();
             $this->checkAccessToken();
             $this->checkAlbumId();

References YAWK\WIDGETS\FACEBOOK\GALLERY\fbGallery\checkAccessToken(), YAWK\WIDGETS\FACEBOOK\GALLERY\fbGallery\checkAlbumId(), and YAWK\WIDGETS\FACEBOOK\GALLERY\fbGallery\checkAppId().

Referenced by YAWK\WIDGETS\FACEBOOK\GALLERY\fbGallery\__construct().

◆ drawGallery()

YAWK\WIDGETS\FACEBOOK\GALLERY\fbGallery::drawGallery ( )

The heart of this widget: this method draws the gallery.

Definition at line 298 of file fbGallery.php.

         {
             // load facebook JS
             $this->loadJSSDK();
             // make facebook api call
             $this->makeApiCall();
  
             /* ALBUM DETAILED VIEW */
             if (isset($this->apiObject['data']) && (!empty($this->apiObject))) {
  
                 // check if array needs to be sorted
                 if (is_string($this->fbGallerySortation) && ($this->fbGallerySortation == "desc"))
                 {
                     // sort array ascending / descending
                     $this->apiObject['data'] = array_reverse($this->apiObject['data']);
                 }
  
                 // check if images needs to be shuffled
                 elseif ($this->fbGallerySortation == "shuffle")
                 {   // shuffle images on page load
                     shuffle($this->apiObject['data']);
                 }
  
                 // check if limit is set
                 if ($this->fbGalleryLimit > 0 && ($this->fbGalleryLimit != 25))
                 {   // limit images to x entries
                     $this->apiObject['data'] = array_slice($this->apiObject['data'], 0, $this->fbGalleryLimit);
                 }
  
                 // check gallery layout
                 if (!isset($this->fbGalleryLayout) || (empty($this->fbGalleryLayout)))
                 {   // if no layout is set, use this as default value
                     $this->fbGalleryLayout = 6;
                 }
  
                 // check heading
                 if (isset($this->fbGalleryHeading) && (!empty($this->fbGalleryHeading)))
                 {
                     // if heading is set, build markup
                     $this->fbGalleryHeading = "$this->fbGalleryHeading";
                 }
                 else
                     {   // no heading was set, leave empty
                         $this->fbGalleryHeading = '';
                     }
  
                 // check subtext
                 if (isset($this->fbGallerySubtext) && (!empty($this->fbGallerySubtext)))
                 {
                     // if subtext is set, build markup
                     $this->fbGallerySubtext = "<small>$this->fbGallerySubtext</small>";
                 }
                 else
                 {   // no subtext was set, leave empty
                     $this->fbGallerySubtext = '';
                 }
  
                 // draw heading + subtext
                 echo "<div class=\"row padding\"><div class=\"col-md-12\"><h1>$this->fbGalleryHeading&nbsp;$this->fbGallerySubtext</h1></div></div>";
  
  
                 $i = 0; // loop indicator
                 // walk through data array to help animation (first items fadeIn on load)
                 echo "<div class=\"row padding\">";
                 foreach ($this->apiObject['data'] as $property => $value)
                 {
                     // if loop runs for the first time
                     if (isset($i) && ($i <= 3))
                     {   // first element get this css class
                         $animateMarkup = 'animated fadeIn';
                     }
                     else
                         {   // all other items - set animate class on them
                             $animateMarkup = "animate";
                         }
  
                     $i++; // raise loop indicator
  
                     // check if image info is set
                     if (isset($this->fbGalleryImageInfo) && (!empty($this->fbGalleryImageInfo)))
                     {
                         // if image info is on
                         $this->fbGalleryImageInfo = $value['name'];
                     }
                     else
                         {   // leave image info empty
                             $this->fbGalleryImageInfo = '';
                         }
  
                     // random align images
                     $randomInt = rand(1,4);
                     if ($randomInt == 1)
                     {
                         $imgClass = "img-lefty";
                     }
                     elseif ($randomInt == 2)
                     {
                         $imgClass = "img-lefty-less";
                     }
                     elseif ($randomInt == 3)
                     {
                         $imgClass = "img-righty";
                     }
                     elseif ($randomInt == 4)
                     {
                         $imgClass = "img-righty-less";
                     }
                     /*
                     elseif ($randomInt == 5)
                     {
                         $imgClass = "img-thumbnail";
                     }
                     else
                         {   // default value:
                             $imgClass = "img-thumbnail";
                         }
                     */
  
                     // set filename to biggest image source
                     $fn = $value['images'][0]['source'];
                     // set layout div box, containing every single image
                     echo "<div class=\"col-md-$this->fbGalleryLayout text-center $animateMarkup\">
                           <a href=\"$fn\" data-lightbox=\"example-set\" data-title=\"$value[name]\">
                           <img src=\"$fn\" alt=\"$value[name]\" style=\"width:auto; height:$this->fbGalleryFixedImageHeight;\" class=\"img-thumbnail img-fluid ".$imgClass." hvr-grow\">
                           </a><br><br><small>$this->fbGalleryImageInfo</small><br><br><hr></div>";
                 } // end foreach
                  echo "</div>";
             }
             else
                 {   // api object not set or empty - abort with error
                     die("Unable to load Images from Facebook API because the apiObject is not set or empty.");
                 }

References $i, $value, die, YAWK\WIDGETS\FACEBOOK\GALLERY\fbGallery\loadJSSDK(), and YAWK\WIDGETS\FACEBOOK\GALLERY\fbGallery\makeApiCall().

◆ loadJSSDK()

YAWK\WIDGETS\FACEBOOK\GALLERY\fbGallery::loadJSSDK ( )

Load Facebook JS Code.

Definition at line 171 of file fbGallery.php.

         {   // check if fb JS SDK was loaded before
             if ($this->jsSDKLoaded == 'false')
             {   // check if app ID is set
                 if ($this->checkAppId() == true)
                 {
                     /*
                     // include facebook SDK JS
                     echo "<script>
                 window.fbAsyncInit = function() {
                     FB.init({
                     appId      : '" . $this->fbGalleryAppId . "',
                     xfbml      : true,
                     version    : 'v3.3'
                     });
                 FB.AppITEMS.logPageView();
                 };
                 
                 (function(d, s, id){
                     var js, fjs = d.getElementsByTagName(s)[0];
                     if (d.getElementById(id)) {return;}
                     js = d.createElement(s); js.id = id;
                     js.src = \"https://connect.facebook.net/en_US/sdk.js\";
                     fjs.parentNode.insertBefore(js, fjs);
                 }(document, 'script', 'facebook-jssdk'));
                 </script>";
                     $this->jsSDKLoaded = 'true';
                     */
                 }
                 /*
                 else
                 {   // check app ID failed, abort with error msg (app id not set correctly)
                     die ("unable to include facebook js SDK - checkAppId failed. Please check your app ID in the widget settings!");
                 }
                 */
             }

References YAWK\WIDGETS\FACEBOOK\GALLERY\fbGallery\checkAppId().

Referenced by YAWK\WIDGETS\FACEBOOK\GALLERY\fbGallery\drawGallery().

◆ makeApiCall()

YAWK\WIDGETS\FACEBOOK\GALLERY\fbGallery::makeApiCall ( )

Prepare object data, set json link, make API call and return apiObject.

Returns: object

Definition at line 213 of file fbGallery.php.

         {
             // WHICH ITEMS TO DISPLAY?
             // evaluation of event type select field
             if ($this->fbGalleryType == "all")
             {
                 // ALL ITEMS (FUTURE + PAST)
                 $this->sinceDate = date('Y-01-01', strtotime('-' . $this->fbGalleryYearRange . ' years'));
                 $this->untilDate = date('Y-01-01', strtotime('+' . $this->fbGalleryYearRange . ' years'));
             }
             elseif ($this->fbGalleryType == "future")
             {
                 // UPCOMING ITEMS
                 $this->sinceDate = date('Y-m-d');
                 $this->untilDate = date('Y-12-31', strtotime('+' . $this->fbGalleryYearRange . ' years'));
             }
             elseif ($this->fbGalleryType == "past")
             {
                 // PAST ITEMS
                 $this->sinceDate = date('Y-01-01', strtotime('-' . $this->fbGalleryYearRange . ' years'));
                 $this->untilDate = date('Y-m-d');
             }
             else
             {   // IF NOT SET - use default:
                 // UPCOMING ITEMS
                 $this->sinceDate = date('Y-m-d');
                 $this->untilDate = date('Y-12-31', strtotime('+' . $this->fbGalleryYearRange . ' years'));
             }
  
             // IF START + END DATE IS SET
             if (isset($this->fbGalleryStartDate) && (!empty($this->fbGalleryStartDate))
                 && (isset($this->fbGalleryEndDate) && (!empty($this->fbGalleryEndDate))))
             {
                 $this->sinceDate = date($this->fbGalleryStartDate);
                 $this->untilDate = date($this->fbGalleryEndDate);
             }
  
             // unix timestamp years
             $since_unix_timestamp = strtotime($this->sinceDate);
             $until_unix_timestamp = strtotime($this->untilDate);
  
             // check if fields are set
             if (isset($this->fbGalleryFields) && (!empty($this->fbGalleryFields)))
             {   // set markup for api query string
                 $fieldsMarkup = "?fields={$this->fbGalleryFields}";
             }
             else
             {   // no fields wanted, leave markup empty
                 $fieldsMarkup = '';
             }
  
             // prepare API call - get photos
             $json_link = "https://graph.facebook.com/v3.3/{$this->fbGalleryAlbumId}/photos$fieldsMarkup&access_token={$this->fbGalleryAccessToken}";
  
             // get json string
             $curl = curl_init();
             curl_setopt($curl, CURLOPT_URL, $json_link);
             curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
             $this->apiObject = json_decode(curl_exec($curl), true, 512, JSON_BIGINT_AS_STRING);
             curl_close($curl);
  
             // $json = file_get_contents($json_link);
             // convert json to object
             return $this->apiObject;

References YAWK\WIDGETS\FACEBOOK\GALLERY\fbGallery\$apiObject, and date.

Referenced by YAWK\WIDGETS\FACEBOOK\GALLERY\fbGallery\drawGallery().

Member Data Documentation

◆ $apiObject

YAWK\WIDGETS\FACEBOOK\GALLERY\fbGallery::$apiObject

Parameters

object api result (as object)

Definition at line 66 of file fbGallery.php.

Referenced by YAWK\WIDGETS\FACEBOOK\GALLERY\fbGallery\makeApiCall().

◆ $fbGalleryAccessToken

YAWK\WIDGETS\FACEBOOK\GALLERY\fbGallery::$fbGalleryAccessToken = ''

Parameters

string your access token (secret word from developers.facebook.com)

Definition at line 30 of file fbGallery.php.

◆ $fbGalleryAlbumId

YAWK\WIDGETS\FACEBOOK\GALLERY\fbGallery::$fbGalleryAlbumId = ''

Parameters

string your page ID (http://facebook.com/{YOURPAGEID}

Definition at line 28 of file fbGallery.php.

◆ $fbGalleryAppId

YAWK\WIDGETS\FACEBOOK\GALLERY\fbGallery::$fbGalleryAppId = ''

Parameters

string your app ID (from developers.facebook.com)

Definition at line 26 of file fbGallery.php.

◆ $fbGalleryEndDate

YAWK\WIDGETS\FACEBOOK\GALLERY\fbGallery::$fbGalleryEndDate = ''

Parameters

string user defined end date

Definition at line 40 of file fbGallery.php.

◆ $fbGalleryFields

YAWK\WIDGETS\FACEBOOK\GALLERY\fbGallery::$fbGalleryFields = 'images,source,name,id'

Parameters

string fields that should be selected from facebook graph

Definition at line 34 of file fbGallery.php.

◆ $fbGalleryFixedImageHeight

YAWK\WIDGETS\FACEBOOK\GALLERY\fbGallery::$fbGalleryFixedImageHeight = 'auto'

Parameters

string fixed image height in pixels or auto (select field)

Definition at line 58 of file fbGallery.php.

◆ $fbGalleryGraphRequest

YAWK\WIDGETS\FACEBOOK\GALLERY\fbGallery::$fbGalleryGraphRequest = '/albums/'

Parameters

string your graph request (the Album ID)

Definition at line 32 of file fbGallery.php.

◆ $fbGalleryHeading

YAWK\WIDGETS\FACEBOOK\GALLERY\fbGallery::$fbGalleryHeading = ''

Parameters

string gallery heading

Definition at line 44 of file fbGallery.php.

◆ $fbGalleryImageInfo

YAWK\WIDGETS\FACEBOOK\GALLERY\fbGallery::$fbGalleryImageInfo = 1

Parameters

int	show info under the gallery? 0\|1

Definition at line 56 of file fbGallery.php.

◆ $fbGalleryLayout

YAWK\WIDGETS\FACEBOOK\GALLERY\fbGallery::$fbGalleryLayout = 6

Parameters

int layout

Definition at line 54 of file fbGallery.php.

◆ $fbGalleryLimit

YAWK\WIDGETS\FACEBOOK\GALLERY\fbGallery::$fbGalleryLimit = 0

Parameters

int	limit entries to (n)

Definition at line 50 of file fbGallery.php.

◆ $fbGallerySortation

YAWK\WIDGETS\FACEBOOK\GALLERY\fbGallery::$fbGallerySortation = 'desc'

Parameters

string sortation

Definition at line 52 of file fbGallery.php.

◆ $fbGalleryStartDate

YAWK\WIDGETS\FACEBOOK\GALLERY\fbGallery::$fbGalleryStartDate = ''

Parameters

string user defined start date

Definition at line 38 of file fbGallery.php.

◆ $fbGallerySubtext

YAWK\WIDGETS\FACEBOOK\GALLERY\fbGallery::$fbGallerySubtext = ''

Parameters

string gallery small subtext beside heading

Definition at line 46 of file fbGallery.php.

◆ $fbGalleryType

YAWK\WIDGETS\FACEBOOK\GALLERY\fbGallery::$fbGalleryType = 'past'

Parameters

string which items should be shown? future|past|all

Definition at line 42 of file fbGallery.php.

◆ $fbGalleryYearRange

YAWK\WIDGETS\FACEBOOK\GALLERY\fbGallery::$fbGalleryYearRange = '10'

Parameters

string show ITEMS of this time range

Definition at line 36 of file fbGallery.php.

◆ $jsSDKLoaded

YAWK\WIDGETS\FACEBOOK\GALLERY\fbGallery::$jsSDKLoaded = 'false'

Parameters

string true|false was the js SDK loaded?

Definition at line 64 of file fbGallery.php.

◆ $settings

YAWK\WIDGETS\FACEBOOK\GALLERY\fbGallery::$settings

Parameters

array temporary settings array

Definition at line 68 of file fbGallery.php.

◆ $shuffle

YAWK\WIDGETS\FACEBOOK\GALLERY\fbGallery::$shuffle = 0

Parameters

int	shuffle 0\|1 if true, images get shuffled on page load

Definition at line 60 of file fbGallery.php.

◆ $sinceDate

YAWK\WIDGETS\FACEBOOK\GALLERY\fbGallery::$sinceDate = ''

Parameters

string ITEMS since this date (used for calc)

Definition at line 48 of file fbGallery.php.

◆ $untilDate

YAWK\WIDGETS\FACEBOOK\GALLERY\fbGallery::$untilDate = ''

Parameters

string ITEMS until this date (used for calc)

Definition at line 62 of file fbGallery.php.

The documentation for this class was generated from the following file:

/var/www/htdocs/yawk.io/system/widgets/fb_gallery/classes/fbGallery.php

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ checkAccessToken()

◆ checkAlbumId()

◆ checkApiObjectData()

◆ checkAppId()

◆ checkRequirements()

◆ drawGallery()

◆ loadJSSDK()

◆ makeApiCall()

Member Data Documentation

◆ $apiObject

◆ $fbGalleryAccessToken

◆ $fbGalleryAlbumId

◆ $fbGalleryAppId

◆ $fbGalleryEndDate

◆ $fbGalleryFields

◆ $fbGalleryFixedImageHeight

◆ $fbGalleryGraphRequest

◆ $fbGalleryHeading

◆ $fbGalleryImageInfo

◆ $fbGalleryLayout

◆ $fbGalleryLimit

◆ $fbGallerySortation

◆ $fbGalleryStartDate

◆ $fbGallerySubtext

◆ $fbGalleryType

◆ $fbGalleryYearRange

◆ $jsSDKLoaded

◆ $settings

◆ $shuffle

◆ $sinceDate

◆ $untilDate