EFaceplugsBase.php

<?php

/**
 * Wrappers for facebook plugins.
 * @see http://www.yiiframework.com/extension/faceplugs/
 *
 * @copyright © Digitick <www.digitick.net> 2011
 * @license GNU Lesser General Public License v3.0
 * @version 1.3
 * @author Ianaré Sévi
 * @author Gustavo Salomé
 */

/**
 * Base class for all facebook widgets.
 *
 * Initializes required properties for widgets and sets opengraph properties.
 *
 * @see http://developers.facebook.com/plugins
 * @see http://developers.facebook.com/docs/opengraph
 *
 */
abstract class EFaceplugsBase extends CWidget
{
	/**
	 * @var string Facebook application ID.
	 *
	 * This can be set in the 'fbAppId' parameter in the Yii config file.
	 */
	public $app_id;
	/**
	 * @var string Page URL, for Open Graph
	 */
	public $url;
	/**
	 * @var array Open Graph properties.
	 */
	public $og = array();
	/**
	 * @var boolean Check user's login status.
	 */
	public $status = true;
	/**
	 * @var boolean Enable cookies to allow the server to access the session.
	 */
	public $cookie = true;
	/**
	 * @var boolean Whether or not to parse XFBML tags with the JS library (will render Plugins with iframes if false).
	 */
	public $xfbml = true;
	/**
	 * @var boolean Whether or not to use html5 social plugins instead of xfbml.
	 */
	public $html5 = false;
	/**
	 * @var boolean Load the Facebook init script asynchronously.
	 *
	 * This speeds up page loads because loading the plugin does not block
	 * loading other elements of the page.
	 */
	public $async = true;
	/**
	 * @var string Override default locale for the widget.
	 *
	 * Normally locale is set automatically based on the Yii language settings,
	 * setting it here allows a specific locale to be used.
	 */
	public $locale;
	/**
	 * @var string Specify the debug mode. When active, it loads the debug
	 * version of the SDK (en_US only).
	 *
	 * Options :
	 * <ul>
	 * <li>'auto' - If YII_DEBUG is true, debug mode is active.
	 * <li>'on' - debug enabled.
	 * <li>'off' - debug disabled (default).
	 * </ul>
	 */
	public $debugMode = 'off';
	/**
	 * @var boolean Force usage of https. False by default.  
	 */
	public $https = false;
	/**
	 * @var array Valid Facebook locales.
	 */
	protected $locales = array(
		'az_AZ',
		'be_BY',
		'bg_BG',
		'bn_IN',
		'bs_BA',
		'ca_ES',
		'ck_US',
		'cs_CZ',
		'cy_GB',
		'da_DK',
		'de_DE',
		'eu_ES',
		'en_GB',
		'en_PI',
		'en_UD',
		'en_US',
		'es_LA',
		'es_CL',
		'es_CO',
		'es_ES',
		'es_MX',
		'es_VE',
		'fb_FI',
		'fi_FI',
		'fr_FR',
		'gl_ES',
		'hu_HU',
		'it_IT',
		'ja_JP',
		'ko_KR',
		'nb_NO',
		'nn_NO',
		'nl_NL',
		'pl_PL',
		'pt_BR',
		'pt_PT',
		'ro_RO',
		'ru_RU',
		'sk_SK',
		'sl_SI',
		'sv_SE',
		'th_TH',
		'tr_TR',
		'ku_TR',
		'zh_CN',
		'zh_HK',
		'zh_TW',
		'fb_LT',
		'af_ZA',
		'sq_AL',
		'hy_AM',
		'hr_HR',
		'nl_BE',
		'eo_EO',
		'et_EE',
		'fo_FO',
		'fr_CA',
		'ka_GE',
		'el_GR',
		'gu_IN',
		'hi_IN',
		'is_IS',
		'id_ID',
		'ga_IE',
		'jv_ID',
		'kn_IN',
		'kk_KZ',
		'la_VA',
		'lv_LV',
		'li_NL',
		'lt_LT',
		'mk_MK',
		'mg_MG',
		'ms_MY',
		'mt_MT',
		'mr_IN',
		'mn_MN',
		'ne_NP',
		'pa_IN',
		'rm_CH',
		'sa_IN',
		'sr_RS',
		'so_SO',
		'sw_KE',
		'tl_PH',
		'ta_IN',
		'tt_RU',
		'te_IN',
		'ml_IN',
		'uk_UA',
		'uz_UZ',
		'vi_VN',
		'xh_ZA',
		'zu_ZA',
		'km_KH',
		'tg_TJ',
		'ar_AR',
		'he_IL',
		'ur_PK',
		'fa_IR',
		'sy_SY',
		'yi_DE',
		'gn_PY',
		'qu_PE',
		'ay_BO',
		'se_NO',
		'ps_AF',
		'tl_ST',
	);

	public function init()
	{
		if (property_exists($this, 'href') && $this->href === null)
			$this->href = $this->url;
		if (!$this->app_id && isset(Yii::app()->params->fbAppId))
			$this->app_id = Yii::app()->params->fbAppId;
		if ($this->url)
			self::registerOpenGraph('url', $this->url);
		if ($this->app_id)
			self::registerOpenGraph('app_id', $this->app_id);

		foreach ($this->og as $type => $value)
			self::registerOpenGraph($type, $value);
	}

	/**
	 * Get the protocol used.
	 * @return string 'http' or 'https'
	 */
	protected function getProtocol()
	{
		if($this->https==true || Yii::app()->getRequest()->getIsSecureConnection())
			return 'https';
		return 'http';
    }

	public function run()
	{
		//run only once
		if (!isset(Yii::app()->params->fbRootSet)) {
			if ($this->debugMode === 'auto' && YII_DEBUG === true)
				$this->debugMode = 'on';

			if ($this->debugMode === 'on')
				$script = 'static.ak.fbcdn.net/connect/en_US/core.debug.js';
			else
				$script = 'connect.facebook.net/'.$this->getLocale().'/all.js';

			$script = $this->getProtocol() . '://' . $script;

			echo CHtml::opentag('div', array('id' => 'fb-root'));

			$init = $this->registerSDKScript('init', array(
				'appId' => $this->app_id,
				'status' => $this->status,
				'cookie' => $this->cookie,
				'xfbml' => $this->xfbml,
				)
			);
			if ($this->async)
				$init = "window.fbAsyncInit = function(){{$init}};
				(function(){
				var e=document.createElement('script');
				e.async=true;
				e.src='{$script}';
				document.getElementById('fb-root').appendChild(e);}());";
			else
				Yii::app()->clientScript->registerScriptFile($script, CClientScript::POS_END);
			
			echo CHtml::closeTag('div');

			Yii::app()->getClientScript()->registerScript('fb-script', $init, CClientScript::POS_END);
			Yii::app()->params->fbRootSet = true;
		}
	}

	/**
	 * Register an OpenGraph property.
	 * @param string $property
	 * @param string $data
	 * @return void
	 */
	public static function registerOpenGraph($property, $data)
	{
		$property = 'og:' . $property;
		Yii::app()->clientScript->registerMetaTag($data, null, null, array('property' => $property));
	}

	/**
	 * Determine the script locale to load.
	 * Looks at $locale variable declared in this file first
	 * Then looks at the Yii application language
	 * Defaults to en_US
	 * @return string locale code
	 */
	protected function getLocale()
	{
		if (isset($this->locale))
			$locale = strtolower($this->locale);
		else
			$locale = Yii::app()->language;

		// Adjustments, mainly because facebook doesn't have all countries
		// of the same language translated.
		$lang = substr($locale, 0, 2);
		$adjust = array(
			'de' => 'de_de',
			'nl' => 'nl_nl',
			'ru' => 'ru_ru',
			'ar' => 'ar_ar', // non standard
			'ku' => 'ku_tr',
		);
		// single check languages, array above ...
		if (isset($adjust[$lang]))
			$locale = $adjust[$lang];
		// english
		else if ($lang === 'en' && !in_array($locale, array('en_us','en_pi','en_ud'))) {
			// closer to US english
			if ($locale === 'en_ca')
				$locale = 'en_us';
			// closer to UK english
			else
				$locale = 'en_gb';
		}
		// french
		else if ($lang === 'fr' && $locale !== 'fr_ca')
			$locale = 'fr_fr';
		// spanish
		else if ($lang === 'es' && !in_array($locale, array('es_es','es_cl','es_co','es_mx','es_ve')))
			$locale = 'es_la'; // non standard
		// portuguese
		else if ($lang === 'pt' && $locale !== 'pt_br')
			$locale = 'pt_pt';

		$c = explode('_', $locale);
		if (!isset($c[1]))
			throw new CException('Locale for Facebook plugins must be in the following format : ll_CC');

		$locale = $c[0] . '_' . strtoupper($c[1]);
		if (!in_array($locale, $this->locales))
			throw new CException('Invalid Facebook locale');

		return $locale;
	}

	/**
	 * Grabs public properties of the class for passing to the plugin creator.
	 * @return array Associative array
	 */
	protected function getParams()
	{
		$ignore = array('skin', 'actionPrefix', 'app_id', 'url', 'status',
			'cookie', 'async', 'debugMode', 'xfbml', 'https', 'html5');
		$ref = new ReflectionObject($this);
		$props = $ref->getProperties(ReflectionProperty::IS_PUBLIC);

		$params = array();
		foreach ($props as $k => $v) {
			$name = $v->name;
			if ($this->$name !== null && !is_array($this->$name) && !in_array($name, $ignore)) {
				if (is_bool($this->$name))
					$value = ($this->$name === true) ? 'true' : 'false';
				else
					$value = $this->$name;

				$params[$name] = $value;
			}
		}
		return $params;
	}

	/**
	 * Creates a method of facebook sdk script.
	 * @param string $method
	 * @param array $args args to use in the method
	 * @return string the js created
	 */
	public function registerSDKScript($method, $args=array())
	{
		$args = CJavaScript::encode($args);
		return "FB.{$method}({$args});";
	}

	/**
	 * @param $name the name of the Facebook Social Plugin
	 * @return void
	 */
	protected function renderTag($name)
	{
		$params = $this->getParams();
		if ($this->html5)
			$this->makeHtml5Tag('fb-'.$name,$params);
        else
			$this->makeXfbmlTag('fb:'.$name,$params);
    }

	/**
	 * @param $class the name of the Facebook Social Plugin
	 * @param $params the parameters for the Facebook Social Plugin
	 * @return void
	 */
    protected function makeHtml5Tag($class, $params)
    {
		$newParams = array();
        foreach($params as $key=>$data)
			$newParams['data-'.$key] = $data;

        $newParams['class'] = $class;
        echo CHtml::openTag('div', $newParams), CHtml::closeTag('div');
    }

    /**
	 * @param $tagName the name of the Facebook Social Plugin
	 * @param $params the parameters for the Facebook Social Plugin
	 * @return void
	 */
    protected function makeXfbmlTag($tagName, $params)
    {
        echo CHtml::openTag($tagName, $params), CHtml::closeTag($tagName);
    }
}