class FacebookCheckout in Facebook Pixel 8

Provides the completion message pane.

Hijack the pane form subsystem so that we can call our addEvent for initialize checkout on the first stage of checkout.

Plugin annotation


@CommerceCheckoutPane(
  id = "facebook_checkout",
  label = @Translation("Facebook Checkout"),
  default_step = "order_information",
)

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
  - class \Drupal\commerce_checkout\Plugin\Commerce\CheckoutPane\CheckoutPaneBase implements CheckoutPaneInterface, ContainerFactoryPluginInterface
    class \Drupal\facebook_pixel_commerce\Plugin\Commerce\CheckoutPane\FacebookCheckout

Expanded class hierarchy of FacebookCheckout

File

modules/facebook_pixel_commerce/src/Plugin/Commerce/CheckoutPane/FacebookCheckout.php, line 26

Namespace

Drupal\facebook_pixel_commerce\Plugin\Commerce\CheckoutPane

View source

class FacebookCheckout extends CheckoutPaneBase {

  /**
   * The facebook pixel event.
   *
   * @var \Drupal\facebook_pixel\FacebookEventInterface
   */
  protected $facebookEvent;

  /**
   * The facebook pixel comment.
   *
   * @var \Drupal\facebook_pixel_commerce\FacebookCommerceInterface
   */
  protected $facebookComment;

  /**
   * Constructs a new CheckoutPaneBase object.
   *
   * @param array $configuration
   *   A configuration array containing information about the plugin instance.
   * @param string $plugin_id
   *   The plugin_id for the plugin instance.
   * @param mixed $plugin_definition
   *   The plugin implementation definition.
   * @param \Drupal\commerce_checkout\Plugin\Commerce\CheckoutFlow\CheckoutFlowInterface $checkout_flow
   *   The parent checkout flow.
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   The entity type manager.
   * @param \Drupal\facebook_pixel\FacebookEventInterface $facebook_event
   *   The facebook pixel event.
   * @param \Drupal\facebook_pixel_commerce\FacebookCommerceInterface $facebook_comment
   *   The facebook pixel commerce.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, CheckoutFlowInterface $checkout_flow, EntityTypeManagerInterface $entity_type_manager, FacebookEventInterface $facebook_event, FacebookCommerceInterface $facebook_comment) {
    parent::__construct($configuration, $plugin_id, $plugin_definition, $checkout_flow, $entity_type_manager);
    $this->facebookEvent = $facebook_event;
    $this->facebookComment = $facebook_comment;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition, CheckoutFlowInterface $checkout_flow = NULL) {
    return new static($configuration, $plugin_id, $plugin_definition, $checkout_flow, $container
      ->get('entity_type.manager'), $container
      ->get('facebook_pixel.facebook_event'), $container
      ->get('facebook_pixel_commerce.facebook_commerce'));
  }

  /**
   * {@inheritdoc}
   */
  public function buildPaneForm(array $pane_form, FormStateInterface $form_state, array &$complete_form) {

    // Only fire the FB event on page load.
    if (!$form_state
      ->getTriggeringElement()) {
      $data = $this->facebookComment
        ->getOrderData($this->order);
      $this->facebookEvent
        ->addEvent('InitiateCheckout', $data);
    }
    return [];
  }

}

Members

Name	Modifiers	Type	Description	Overrides
CheckoutPaneBase::$checkoutFlow	protected	property	The parent checkout flow.
CheckoutPaneBase::$entityTypeManager	protected	property	The entity type manager.
CheckoutPaneBase::$order	protected	property	The current order.
CheckoutPaneBase::buildConfigurationForm	public	function	Form constructor. Overrides PluginFormInterface::buildConfigurationForm	6
CheckoutPaneBase::buildConfigurationSummary	public	function	Builds a summary of the pane configuration. Overrides CheckoutPaneInterface::buildConfigurationSummary	5
CheckoutPaneBase::buildPaneSummary	public	function	Builds a summary of the pane values. Overrides CheckoutPaneInterface::buildPaneSummary	3
CheckoutPaneBase::calculateDependencies	public	function	Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies
CheckoutPaneBase::defaultConfiguration	public	function	Gets default configuration for this plugin. Overrides ConfigurableInterface::defaultConfiguration	6
CheckoutPaneBase::getConfiguration	public	function	Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
CheckoutPaneBase::getDisplayLabel	public	function	Gets the pane display label. Overrides CheckoutPaneInterface::getDisplayLabel
CheckoutPaneBase::getId	public	function	Gets the pane ID. Overrides CheckoutPaneInterface::getId
CheckoutPaneBase::getLabel	public	function	Gets the pane label. Overrides CheckoutPaneInterface::getLabel
CheckoutPaneBase::getStepId	public	function	Gets the pane step ID. Overrides CheckoutPaneInterface::getStepId
CheckoutPaneBase::getWeight	public	function	Gets the pane weight. Overrides CheckoutPaneInterface::getWeight
CheckoutPaneBase::getWrapperElement	public	function	Gets the pane wrapper element. Overrides CheckoutPaneInterface::getWrapperElement
CheckoutPaneBase::isVisible	public	function	Determines whether the pane is visible. Overrides CheckoutPaneInterface::isVisible	4
CheckoutPaneBase::setConfiguration	public	function	Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration
CheckoutPaneBase::setOrder	public	function	Sets the current order. Overrides CheckoutPaneInterface::setOrder
CheckoutPaneBase::setStepId	public	function	Sets the pane step ID. Overrides CheckoutPaneInterface::setStepId
CheckoutPaneBase::setWeight	public	function	Sets the pane weight. Overrides CheckoutPaneInterface::setWeight
CheckoutPaneBase::submitConfigurationForm	public	function	Form submission handler. Overrides PluginFormInterface::submitConfigurationForm	6
CheckoutPaneBase::submitPaneForm	public	function	Handles the submission of an pane form. Overrides CheckoutPaneInterface::submitPaneForm	7
CheckoutPaneBase::validateConfigurationForm	public	function	Form validation handler. Overrides PluginFormInterface::validateConfigurationForm
CheckoutPaneBase::validatePaneForm	public	function	Validates the pane form. Overrides CheckoutPaneInterface::validatePaneForm	4
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
FacebookCheckout::$facebookComment	protected	property	The facebook pixel comment.
FacebookCheckout::$facebookEvent	protected	property	The facebook pixel event.
FacebookCheckout::buildPaneForm	public	function	Builds the pane form. Overrides CheckoutPaneInterface::buildPaneForm
FacebookCheckout::create	public static	function	Creates an instance of the plugin. Overrides CheckoutPaneBase::create
FacebookCheckout::__construct	public	function	Constructs a new CheckoutPaneBase object. Overrides CheckoutPaneBase::__construct
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.
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.

You are here

class FacebookCheckout in Facebook Pixel 8

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation