class PurchaseOrder in Commerce Purchase Order 8

Provides the Purchase Order payment method type.

Plugin annotation

@CommercePaymentMethodType(
  id = "purchase_order",
  label = @Translation("Purchase Order"),
  create_label = @Translation("New Purchase Order"),

)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\commerce_payment\Plugin\Commerce\PaymentMethodType\PaymentMethodTypeBase implements PaymentMethodTypeInterface
      • class \Drupal\commerce_purchase_order\Plugin\Commerce\PaymentMethodType\PurchaseOrder

File

src/Plugin/Commerce/PaymentMethodType/PurchaseOrder.php, line 19

Namespace

Drupal\commerce_purchase_order\Plugin\Commerce\PaymentMethodType

class PurchaseOrder extends PaymentMethodTypeBase {

  /**
   * {@inheritdoc}
   */
  public function buildLabel(PaymentMethodInterface $payment_method) {
    $po_number = NULL;
    if ($payment_method
      ->hasField('po_number')) {
      $po_number = $payment_method->po_number->value;
    }
    $placeholders = [
      '@po_number' => $po_number,
    ];
    return $this
      ->t('Purchase Order# @po_number', $placeholders);
  }

  /**
   * {@inheritdoc}
   */
  public function buildFieldDefinitions() {
    $fields = parent::buildFieldDefinitions();
    $fields['po_number'] = BundleFieldDefinition::create('string')
      ->setLabel(t('Purchase Order Number'))
      ->setDescription(t('The number assigned to your purchase order.'))
      ->setRequired(TRUE);
    return $fields;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
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.
PaymentMethodTypeBase::getCreateLabel	public	function	Gets the payment method type create label. Overrides PaymentMethodTypeInterface::getCreateLabel
PaymentMethodTypeBase::getLabel	public	function	Gets the payment method type label. Overrides PaymentMethodTypeInterface::getLabel
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.
PluginBase::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object.	92
PurchaseOrder::buildFieldDefinitions	public	function	Builds the field definitions for entities of this bundle. Overrides PaymentMethodTypeBase::buildFieldDefinitions
PurchaseOrder::buildLabel	public	function	Builds a label for the given payment method. Overrides PaymentMethodTypeInterface::buildLabel
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.