class SocialAuthLoginBlock in Social Auth 3.x

Same name and namespace in other branches

8.2 src/Plugin/Block/SocialAuthLoginBlock.php \Drupal\social_auth\Plugin\Block\SocialAuthLoginBlock
8 src/Plugin/Block/SocialAuthLoginBlock.php \Drupal\social_auth\Plugin\Block\SocialAuthLoginBlock

Provides a Social Auth Block for Login.

Plugin annotation


@Block(
  id = "social_auth_login",
  admin_label = @Translation("Social Auth Login"),
)

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
  - class \Drupal\Core\Block\BlockBase implements BlockPluginInterface, ContextAwarePluginInterface, PluginWithFormsInterface, PreviewFallbackInterface uses BlockPluginTrait, ContextAwarePluginAssignmentTrait, ContextAwarePluginTrait
    class \Drupal\social_auth\Plugin\Block\SocialAuthLoginBlock implements ContainerFactoryPluginInterface

Expanded class hierarchy of SocialAuthLoginBlock

File

src/Plugin/Block/SocialAuthLoginBlock.php, line 19

Namespace

Drupal\social_auth\Plugin\Block

View source

class SocialAuthLoginBlock extends BlockBase implements ContainerFactoryPluginInterface {

  /**
   * The network manager.
   *
   * @var \Drupal\social_api\Plugin\NetworkManager
   */
  private $networkManager;

  /**
   * Immutable configuration for social_auth.settings.
   *
   * @var \Drupal\Core\Config\ImmutableConfig
   */
  private $socialAuthConfig;

  /**
   * SocialAuthLoginBlock constructor.
   *
   * @param array $configuration
   *   The plugin configuration.
   * @param string $plugin_id
   *   The plugin_id for the plugin instance.
   * @param mixed $plugin_definition
   *   The plugin implementation definition.
   * @param \Drupal\Core\Config\ImmutableConfig $social_auth_config
   *   The Immutable configuration for social_oauth.settings.
   * @param \Drupal\social_api\Plugin\NetworkManager $network_manager
   *   The Social API network manager.
   */
  public function __construct(array $configuration, string $plugin_id, $plugin_definition, ImmutableConfig $social_auth_config, NetworkManager $network_manager) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->networkManager = $network_manager;
    $this->socialAuthConfig = $social_auth_config;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition, $container
      ->get('config.factory')
      ->get('social_auth.settings'), $container
      ->get('plugin.network.manager'));
  }

  /**
   * {@inheritdoc}
   */
  public function build() {

    // Add social network name to data passed to template.
    // @todo Move `route` and `img_path` settings to the Network declaration.
    $networks = $this->networkManager
      ->getDefinitions();
    $social_networks = $this->socialAuthConfig
      ->get('auth');
    foreach ($social_networks as $id => &$social_network) {
      $social_network['name'] = NULL;
      if (isset($networks[$id]) && isset($networks[$id]['social_network'])) {
        $social_network['name'] = $networks[$id]['social_network'];
      }
    }
    return [
      '#theme' => 'login_with',
      '#social_networks' => $social_networks,
    ];
  }

}

Members

Name	Modifiers	Type	Description	Overrides
BlockBase::buildConfigurationForm	public	function	Form constructor. Overrides PluginFormInterface::buildConfigurationForm	2
BlockPluginInterface::BLOCK_LABEL_VISIBLE		constant	Indicates the block label (title) should be displayed to end users.
BlockPluginTrait::$transliteration	protected	property	The transliteration service.
BlockPluginTrait::access	public	function
BlockPluginTrait::baseConfigurationDefaults	protected	function	Returns generic default configuration for block plugins.
BlockPluginTrait::blockAccess	protected	function	Indicates whether the block should be shown.	16
BlockPluginTrait::blockForm	public	function		16
BlockPluginTrait::blockSubmit	public	function		13
BlockPluginTrait::blockValidate	public	function		3
BlockPluginTrait::buildConfigurationForm	public	function	Creates a generic configuration form for all block types. Individual block plugins can add elements to this form by overriding BlockBase::blockForm(). Most block plugins should not override this method unless they need to alter the generic form elements. Aliased as: traitBuildConfigurationForm
BlockPluginTrait::calculateDependencies	public	function
BlockPluginTrait::defaultConfiguration	public	function		19
BlockPluginTrait::getConfiguration	public	function		1
BlockPluginTrait::getMachineNameSuggestion	public	function		1
BlockPluginTrait::getPreviewFallbackString	public	function		3
BlockPluginTrait::label	public	function
BlockPluginTrait::setConfiguration	public	function
BlockPluginTrait::setConfigurationValue	public	function
BlockPluginTrait::setTransliteration	public	function	Sets the transliteration service.
BlockPluginTrait::submitConfigurationForm	public	function	Most block plugins should not override this method. To add submission handling for a specific block type, override BlockBase::blockSubmit().
BlockPluginTrait::transliteration	protected	function	Wraps the transliteration service.
BlockPluginTrait::validateConfigurationForm	public	function	Most block plugins should not override this method. To add validation for a specific block type, override BlockBase::blockValidate().	1
ContextAwarePluginAssignmentTrait::addContextAssignmentElement	protected	function	Builds a form element for assigning a context to a given slot.
ContextAwarePluginAssignmentTrait::contextHandler	protected	function	Wraps the context handler.
ContextAwarePluginTrait::$context	protected	property	The data objects representing the context of this plugin.
ContextAwarePluginTrait::$initializedContextConfig	protected	property	Tracks whether the context has been initialized from configuration.
ContextAwarePluginTrait::getCacheContexts	public	function		9
ContextAwarePluginTrait::getCacheMaxAge	public	function		7
ContextAwarePluginTrait::getCacheTags	public	function		4
ContextAwarePluginTrait::getContext	public	function
ContextAwarePluginTrait::getContextDefinition	public	function
ContextAwarePluginTrait::getContextDefinitions	public	function
ContextAwarePluginTrait::getContextMapping	public	function
ContextAwarePluginTrait::getContexts	public	function
ContextAwarePluginTrait::getContextValue	public	function
ContextAwarePluginTrait::getContextValues	public	function
ContextAwarePluginTrait::getPluginDefinition	abstract protected	function		1
ContextAwarePluginTrait::setContext	public	function		1
ContextAwarePluginTrait::setContextMapping	public	function
ContextAwarePluginTrait::setContextValue	public	function
ContextAwarePluginTrait::validateContexts	public	function
DependencySerializationTrait::$_entityStorages	protected	property
DependencySerializationTrait::$_serviceIds	protected	property
DependencySerializationTrait::__sleep	public	function		2
DependencySerializationTrait::__wakeup	public	function		2
MessengerTrait::$messenger	protected	property	The messenger.	27
MessengerTrait::messenger	public	function	Gets the messenger.	27
MessengerTrait::setMessenger	public	function	Sets the messenger.
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	1
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.	1
PluginBase::$pluginId	protected	property	The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR		constant	A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId	public	function	Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId	public	function	Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable	public	function	Determines if the plugin is configurable.
PluginWithFormsTrait::getFormClass	public	function	Implements \Drupal\Core\Plugin\PluginWithFormsInterface::getFormClass().
PluginWithFormsTrait::hasFormClass	public	function	Implements \Drupal\Core\Plugin\PluginWithFormsInterface::hasFormClass().
SocialAuthLoginBlock::$networkManager	private	property	The network manager.
SocialAuthLoginBlock::$socialAuthConfig	private	property	Immutable configuration for social_auth.settings.
SocialAuthLoginBlock::build	public	function	Builds and returns the renderable array for this block plugin. Overrides BlockPluginInterface::build
SocialAuthLoginBlock::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
SocialAuthLoginBlock::__construct	public	function	SocialAuthLoginBlock constructor. Overrides BlockPluginTrait::__construct
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	4
StringTranslationTrait::formatPlural	protected	function	Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals	protected	function	Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation	protected	function	Gets the string translation service.
StringTranslationTrait::setStringTranslation	public	function	Sets the string translation service to use.	2
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.

You are here

class SocialAuthLoginBlock in Social Auth 3.x

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation