class SimpleFbConnectFbFactory in Simple FB Connect 8.3

Class SimpleFbConnectFbFactory.

Creates an instance of Facebook\Facebook service with app ID and secret from SimpleFbConnect module settings.

Hierarchy

• class \Drupal\simple_fb_connect\SimpleFbConnectFbFactory

2 files declare their use of SimpleFbConnectFbFactory

SimpleFbConnectController.php in src/Controller/SimpleFbConnectController.php

SimpleFbConnectFbFactoryTest.php in tests/src/Unit/SimpleFbConnectFbFactoryTest.php

1 string reference to 'SimpleFbConnectFbFactory'

simple_fb_connect.services.yml in ./simple_fb_connect.services.yml

simple_fb_connect.services.yml

1 service uses SimpleFbConnectFbFactory

simple_fb_connect.fb_factory in ./simple_fb_connect.services.yml

Drupal\simple_fb_connect\SimpleFbConnectFbFactory

File

src/SimpleFbConnectFbFactory.php, line 15

Namespace

Drupal\simple_fb_connect

class SimpleFbConnectFbFactory {
  protected $configFactory;
  protected $loggerFactory;
  protected $peristentDataHandler;

  /**
   * Constructor.
   *
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
   *   Used for accessing Drupal configuration.
   * @param \Drupal\Core\Logger\LoggerChannelFactoryInterface $logger_factory
   *   Used for logging errors.
   * @param \Drupal\simple_fb_connect\SimpleFbConnectPersistentDataHandler $persistent_data_handler
   *   Used for reading data from and writing data to session.
   */
  public function __construct(ConfigFactoryInterface $config_factory, LoggerChannelFactoryInterface $logger_factory, SimpleFbConnectPersistentDataHandler $persistent_data_handler) {
    $this->configFactory = $config_factory;
    $this->loggerFactory = $logger_factory;
    $this->persistentDataHandler = $persistent_data_handler;
  }

  /**
   * Returns an instance of Facebook\Facebook service.
   *
   * Reads Facebook App ID and App Secret from SimpleFbConnect module settings
   * and creates an instance of Facebook service with these as parameters.
   *
   * @return \Facebook\Facebook
   *   Facebook service instance.
   */
  public function getFbService() {

    // Check that App ID and secret have been defined in module settings.
    if ($this
      ->validateConfig()) {
      $sdk_config = [
        'app_id' => $this
          ->getAppId(),
        'app_secret' => $this
          ->getAppSecret(),
        'default_graph_version' => $this
          ->getApiVersion(),
        'persistent_data_handler' => $this->persistentDataHandler,
        'http_client_handler' => $this
          ->getHttpClient(),
      ];
      return new Facebook($sdk_config);
    }

    // Return FALSE if app ID or secret is missing.
    return FALSE;
  }

  /**
   * Returns an instance of SimpleFbConnectPersistentDataHandler service.
   *
   * @return Drupal\simple_fb_connect\SimpleFbConnectPersistentDataHandler
   *   SimpleFbConnectPersistentDataHandler service instance.
   */
  public function getPersistentDataHandler() {
    return $this->persistentDataHandler;
  }

  /**
   * Checks that module is configured.
   *
   * @return bool
   *   True if module is configured
   *   False otherwise
   */
  protected function validateConfig() {
    $app_id = $this
      ->getAppId();
    $app_secret = $this
      ->getAppSecret();
    if (!$app_id || !$app_secret) {
      $this->loggerFactory
        ->get('simple_fb_connect')
        ->error('Define App ID and App Secret on module settings.');
      return FALSE;
    }
    return TRUE;
  }

  /**
   * Returns app_id from module settings.
   *
   * @return string
   *   Application ID defined in module settings.
   */
  protected function getAppId() {
    $app_id = $this->configFactory
      ->get('simple_fb_connect.settings')
      ->get('app_id');
    return $app_id;
  }

  /**
   * Returns app_secret from module settings.
   *
   * @return string
   *   Application secret defined in module settings.
   */
  protected function getAppSecret() {
    $app_secret = $this->configFactory
      ->get('simple_fb_connect.settings')
      ->get('app_secret');
    return $app_secret;
  }

  /**
   * Returns api_version from module settings.
   *
   * @return string
   *   API version defined in module settings.
   */
  protected function getApiVersion() {
    $api_version = $this->configFactory
      ->get('simple_fb_connect.settings')
      ->get('api_version');
    return $api_version;
  }

  /**
   * Returns HTTP client to be used with Facebook SDK.
   *
   * Facebook SDK v5 uses the following autodetect logic for determining the
   * HTTP client:
   * 1. If cURL extension is loaded, use it.
   * 2. If cURL was not loaded but Guzzle is found, use it.
   * 3. Fallback to FacebookStreamHttpClient.
   *
   * Drupal 8 ships with Guzzle v6 but Facebook SDK v5 works only
   * with Guzzle v5. Therefore we need to change the autodetect logic
   * so that we're first using cURL and if that is not available, we
   * fallback directly to FacebookStreamHttpClient.
   *
   * @return string
   *   Client that should be used with Facebook SDK.
   */
  protected function getHttpClient() {
    if (extension_loaded('curl')) {
      return 'curl';
    }
    return 'stream';
  }

}

Members

Name	Modifiers	Type	Description	Overrides
SimpleFbConnectFbFactory::$configFactory	protected	property
SimpleFbConnectFbFactory::$loggerFactory	protected	property
SimpleFbConnectFbFactory::$peristentDataHandler	protected	property
SimpleFbConnectFbFactory::getApiVersion	protected	function	Returns api_version from module settings.
SimpleFbConnectFbFactory::getAppId	protected	function	Returns app_id from module settings.
SimpleFbConnectFbFactory::getAppSecret	protected	function	Returns app_secret from module settings.
SimpleFbConnectFbFactory::getFbService	public	function	Returns an instance of Facebook\Facebook service.
SimpleFbConnectFbFactory::getHttpClient	protected	function	Returns HTTP client to be used with Facebook SDK.
SimpleFbConnectFbFactory::getPersistentDataHandler	public	function	Returns an instance of SimpleFbConnectPersistentDataHandler service.
SimpleFbConnectFbFactory::validateConfig	protected	function	Checks that module is configured.
SimpleFbConnectFbFactory::__construct	public	function	Constructor.