class CreditMessaging in Commerce PayPal 8

Same name in this branch

8 src/Plugin/Block/CreditMessaging.php \Drupal\commerce_paypal\Plugin\Block\CreditMessaging
8 src/Plugin/views/area/CreditMessaging.php \Drupal\commerce_paypal\Plugin\views\area\CreditMessaging

Provides a PayPal credit messaging block.

Plugin annotation


@Block(
  id = "commerce_paypal",
  admin_label = @Translation("PayPal Credit messaging"),
  category = @Translation("Commerce")
)

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Component\Plugin\ContextAwarePluginBase implements ContextAwarePluginInterface
  - class \Drupal\Core\Plugin\ContextAwarePluginBase implements CacheableDependencyInterface, ContextAwarePluginInterface uses DependencySerializationTrait, StringTranslationTrait, TypedDataTrait
    class \Drupal\Core\Block\BlockBase implements BlockPluginInterface, PluginWithFormsInterface, PreviewFallbackInterface uses BlockPluginTrait, ContextAwarePluginAssignmentTrait
    class \Drupal\commerce_paypal\Plugin\Block\CreditMessaging

Expanded class hierarchy of CreditMessaging

File

src/Plugin/Block/CreditMessaging.php, line 17

Namespace

Drupal\commerce_paypal\Plugin\Block

View source

class CreditMessaging extends BlockBase {

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    return [
      'placement' => 'home',
      'style' => 'flex',
      'color' => 'blue',
      'ratio' => '1x1',
      'logo_type' => 'primary',
      'logo_position' => 'left',
      'text_size' => '12',
      'text_color' => 'black',
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function blockForm($form, FormStateInterface $form_state) {
    $form['placement'] = [
      '#type' => 'radios',
      '#title' => $this
        ->t('Placement type'),
      '#default_value' => $this->configuration['placement'],
      '#options' => [
        'home' => $this
          ->t('Home'),
        'category' => $this
          ->t('Category'),
      ],
    ];
    $form['style'] = [
      '#type' => 'radios',
      '#title' => $this
        ->t('Style'),
      '#default_value' => $this->configuration['style'],
      '#options' => [
        'flex' => $this
          ->t('Banner'),
        'text' => $this
          ->t('Text'),
      ],
    ];
    $states = [
      'visible' => [
        ':input[name="settings[style]"]' => [
          'value' => 'flex',
        ],
      ],
    ];
    $form['color'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Color'),
      '#default_value' => $this->configuration['color'],
      '#options' => [
        'blue' => $this
          ->t('Blue'),
        'black' => $this
          ->t('Black'),
        'white' => $this
          ->t('White'),
        'white-no-border' => $this
          ->t('White with no border'),
        'gray' => $this
          ->t('Gray'),
        'monochrome' => $this
          ->t('Monochrome'),
        'grayscale' => $this
          ->t('Grayscale'),
      ],
      '#states' => $states,
    ];
    $form['ratio'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Ratio'),
      '#default_value' => $this->configuration['ratio'],
      '#options' => [
        '1x1' => $this
          ->t('Square (1x1)'),
        '1x4' => $this
          ->t('Tall (1x4)'),
        '8x1' => $this
          ->t('Wide (8x1)'),
        '20x1' => $this
          ->t('Wide and narrow (20x1)'),
      ],
      '#states' => $states,
    ];
    $states = [
      'visible' => [
        ':input[name="settings[style]"]' => [
          'value' => 'text',
        ],
      ],
    ];
    $form['logo_type'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Logo type'),
      '#description' => $this
        ->t('See examples of these options in the <a href="https://developer.paypal.com/docs/limited-release/sdk-credit-messaging/reference/reference-tables/#logo-type" target="_blank">PayPal documentation</a>.'),
      '#default_value' => $this->configuration['logo_type'],
      '#options' => [
        'primary' => $this
          ->t('Stacked PayPal Credit logo'),
        'alternative' => $this
          ->t('Single line PayPal Credit logo'),
        'inline' => $this
          ->t('Single line PayPal Credit logo without monogram'),
        'none' => $this
          ->t('No logo, only text'),
      ],
      '#states' => $states,
    ];
    $form['logo_position'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Logo position'),
      '#default_value' => $this->configuration['logo_position'],
      '#options' => [
        'left' => $this
          ->t('Left'),
        'right' => $this
          ->t('Right'),
        'top' => $this
          ->t('Top'),
      ],
      '#states' => $states,
    ];
    $form['text_size'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Text size'),
      '#default_value' => $this->configuration['text_size'],
      '#options' => [
        '10' => $this
          ->t('10'),
        '11' => $this
          ->t('11'),
        '12' => $this
          ->t('12'),
        '13' => $this
          ->t('13'),
        '14' => $this
          ->t('14'),
        '15' => $this
          ->t('15'),
        '16' => $this
          ->t('16'),
      ],
      '#states' => $states,
    ];
    $form['text_color'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Text color'),
      '#default_value' => $this->configuration['text_color'],
      '#options' => [
        'black' => $this
          ->t('Black'),
        'white' => $this
          ->t('White'),
        'monochrome' => $this
          ->t('Monochrome'),
        'grayscale' => $this
          ->t('Grayscale'),
      ],
      '#states' => $states,
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function blockSubmit($form, FormStateInterface $form_state) {
    $this->configuration['placement'] = $form_state
      ->getValue('placement');
    $this->configuration['style'] = $form_state
      ->getValue('style');
    $this->configuration['color'] = $form_state
      ->getValue('color');
    $this->configuration['ratio'] = $form_state
      ->getValue('ratio');
    $this->configuration['logo_type'] = $form_state
      ->getValue('logo_type');
    $this->configuration['logo_position'] = $form_state
      ->getValue('logo_position');
    $this->configuration['text_size'] = $form_state
      ->getValue('text_size');
    $this->configuration['text_color'] = $form_state
      ->getValue('text_color');
  }

  /**
   * {@inheritdoc}
   */
  public function build() {
    $element = [
      '#type' => 'html_tag',
      '#tag' => 'div',
      '#attributes' => [
        'data-pp-message' => '',
        'data-pp-placement' => $this->configuration['placement'],
        'data-pp-style-layout' => $this->configuration['style'],
      ],
      '#attached' => [
        'library' => [
          'commerce_paypal/credit_messaging',
        ],
      ],
    ];
    if ($this->configuration['style'] == 'flex') {
      $element['#attributes'] += [
        'data-pp-style-color' => $this->configuration['color'],
        'data-pp-style-ratio' => $this->configuration['ratio'],
      ];
    }
    else {
      $element['#attributes'] += [
        'data-pp-style-logo-type' => $this->configuration['logo_type'],
        'data-pp-style-logo-position' => $this->configuration['logo_position'],
        'data-pp-style-text-size' => $this->configuration['text_size'],
        'data-pp-style-text-color' => $this->configuration['text_color'],
      ];
    }
    return $element;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
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::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.	2
BlockPluginTrait::calculateDependencies	public	function
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
BlockPluginTrait::__construct	public	function		22
ContextAwarePluginAssignmentTrait::addContextAssignmentElement	protected	function	Builds a form element for assigning a context to a given slot.
ContextAwarePluginAssignmentTrait::contextHandler	protected	function	Wraps the context handler.
ContextAwarePluginBase::$context	protected	property	The data objects representing the context of this plugin.
ContextAwarePluginBase::$contexts Deprecated	private	property	Data objects representing the contexts passed in the plugin configuration.
ContextAwarePluginBase::createContextFromConfiguration	protected	function	Overrides ContextAwarePluginBase::createContextFromConfiguration
ContextAwarePluginBase::getCacheContexts	public	function	The cache contexts associated with this object. Overrides CacheableDependencyInterface::getCacheContexts	9
ContextAwarePluginBase::getCacheMaxAge	public	function	The maximum age for which this object may be cached. Overrides CacheableDependencyInterface::getCacheMaxAge	7
ContextAwarePluginBase::getCacheTags	public	function	The cache tags associated with this object. Overrides CacheableDependencyInterface::getCacheTags	4
ContextAwarePluginBase::getContext	public	function	This code is identical to the Component in order to pick up a different Context class. Overrides ContextAwarePluginBase::getContext
ContextAwarePluginBase::getContextDefinition	public	function	Overrides ContextAwarePluginBase::getContextDefinition
ContextAwarePluginBase::getContextDefinitions	public	function	Overrides ContextAwarePluginBase::getContextDefinitions
ContextAwarePluginBase::getContextMapping	public	function	Gets a mapping of the expected assignment names to their context names. Overrides ContextAwarePluginInterface::getContextMapping
ContextAwarePluginBase::getContexts	public	function	Gets the defined contexts. Overrides ContextAwarePluginInterface::getContexts
ContextAwarePluginBase::getContextValue	public	function	Gets the value for a defined context. Overrides ContextAwarePluginInterface::getContextValue
ContextAwarePluginBase::getContextValues	public	function	Gets the values for all defined contexts. Overrides ContextAwarePluginInterface::getContextValues
ContextAwarePluginBase::setContext	public	function	Set a context on this plugin. Overrides ContextAwarePluginBase::setContext
ContextAwarePluginBase::setContextMapping	public	function	Sets a mapping of the expected assignment names to their context names. Overrides ContextAwarePluginInterface::setContextMapping
ContextAwarePluginBase::setContextValue	public	function	Sets the value for a defined context. Overrides ContextAwarePluginBase::setContextValue
ContextAwarePluginBase::validateContexts	public	function	Validates the set values for the defined contexts. Overrides ContextAwarePluginInterface::validateContexts
ContextAwarePluginBase::__get	public	function	Implements magic __get() method.
CreditMessaging::blockForm	public	function	Overrides BlockPluginTrait::blockForm
CreditMessaging::blockSubmit	public	function	Overrides BlockPluginTrait::blockSubmit
CreditMessaging::build	public	function	Builds and returns the renderable array for this block plugin. Overrides BlockPluginInterface::build
CreditMessaging::defaultConfiguration	public	function	Overrides BlockPluginTrait::defaultConfiguration
DependencySerializationTrait::$_entityStorages	protected	property	An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep	public	function		1
DependencySerializationTrait::__wakeup	public	function		2
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
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::getPluginDefinition	public	function	Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition	3
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
PluginWithFormsTrait::hasFormClass	public	function
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	1
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.
TypedDataTrait::$typedDataManager	protected	property	The typed data manager used for creating the data types.
TypedDataTrait::getTypedDataManager	public	function	Gets the typed data manager.	2
TypedDataTrait::setTypedDataManager	public	function	Sets the typed data manager.	2

You are here

class CreditMessaging in Commerce PayPal 8

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation