class Transactor in Transaction 8

Defines a Transactor annotation object.

Hierarchy

• class \Drupal\Component\Annotation\Plugin implements AnnotationInterface
  • class \Drupal\transaction\Annotation\Transactor

See also

\Drupal\transaction\TransactorPluginManager

Plugin API

1 file declares its use of Transactor

TransactorPluginManager.php in src/TransactorPluginManager.php

3 string references to 'Transactor'

transaction.schema.yml in config/schema/transaction.schema.yml

config/schema/transaction.schema.yml

TransactionTypeCreationForm::buildForm in src/Form/TransactionTypeCreationForm.php

Form constructor.

TransactionTypeListBuilder::buildHeader in src/TransactionTypeListBuilder.php

Builds the header row for the entity listing.

2 classes are annotated with Transactor

BalanceTransactor in src/Plugin/Transaction/BalanceTransactor.php

Transactor for accounting type transactions.

GenericTransactor in src/Plugin/Transaction/GenericTransactor.php

Provides a generic transactor.

File

src/Annotation/Transactor.php, line 15

Namespace

Drupal\transaction\Annotation

class Transactor extends Plugin {

  /**
   * The plugin ID.
   *
   * @var string
   */
  public $id;

  /**
   * The title of the plugin.
   *
   * @var \Drupal\Core\Annotation\Translation
   *
   * @ingroup plugin_translatable
   */
  public $title;

  /**
   * The description of the plugin.
   *
   * @var \Drupal\Core\Annotation\Translation
   *
   * @ingroup plugin_translatable
   */
  public $description;

  /**
   * A list of entity types this transactor supports.
   *
   * @var string[]|optional
   */
  public $supported_entity_types = [];

  /**
   * Fields in transaction entity.
   *
   * @var array|optional
   */
  public $transaction_fields = [];

  /**
   * Fields in the target entity.
   *
   * @var array|optional
   */
  public $target_fields = [];

  /**
   * The default settings for the transactor.
   *
   * @var array|optional
   */
  public $settings = [];

}

Members

Name	Modifiers	Type	Description	Overrides
Plugin::$definition	protected	property	The plugin definition read from the class annotation.	1
Plugin::get	public	function	Gets the value of an annotation. Overrides AnnotationInterface::get	5
Plugin::getClass	public	function	Gets the class of the annotated class. Overrides AnnotationInterface::getClass
Plugin::getId	public	function	Gets the unique ID for this annotated class. Overrides AnnotationInterface::getId
Plugin::getProvider	public	function	Gets the name of the provider of the annotated class. Overrides AnnotationInterface::getProvider
Plugin::parse	protected	function	Parses an annotation into its definition.
Plugin::setClass	public	function	Sets the class of the annotated class. Overrides AnnotationInterface::setClass
Plugin::setProvider	public	function	Sets the name of the provider of the annotated class. Overrides AnnotationInterface::setProvider
Plugin::__construct	public	function	Constructs a Plugin object.	2
Transactor::$description	public	property	The description of the plugin.
Transactor::$id	public	property	The plugin ID.
Transactor::$settings	public	property	The default settings for the transactor.
Transactor::$supported_entity_types	public	property	A list of entity types this transactor supports.
Transactor::$target_fields	public	property	Fields in the target entity.
Transactor::$title	public	property	The title of the plugin.
Transactor::$transaction_fields	public	property	Fields in transaction entity.