class JoinIntoHouseholdAction in CRM Core 8.3

Merges 2 or more contacts into household contact.

Plugin annotation

@Action(
  id = "join_into_household_action",
  label = @Translation("Join into household"),
  type = "crm_core_contact"
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\Core\Action\ActionBase implements ActionInterface
      • class \Drupal\Core\Action\ConfigurableActionBase implements ConfigurableInterface, ConfigurablePluginInterface, DependentPluginInterface, PluginFormInterface
        • class \Drupal\crm_core_contact\Plugin\Action\JoinIntoHouseholdAction implements ContainerFactoryPluginInterface

File

modules/crm_core_contact/src/Plugin/Action/JoinIntoHouseholdAction.php, line 25

Namespace

Drupal\crm_core_contact\Plugin\Action

class JoinIntoHouseholdAction extends ConfigurableActionBase implements ContainerFactoryPluginInterface {

  /**
   * A default relation type for household relations.
   */
  const RELATION_TYPE_HOUSEHOLD = 'crm_member';

  /**
   * The current user service.
   *
   * @var \Drupal\Core\Session\AccountProxy
   */
  protected $currentUser;

  /**
   * The entity form bulder service.
   *
   * @var \Drupal\Core\Entity\EntityFormBuilder
   */
  protected $entityFormBuilder;

  /**
   * Constructs a EmailAction 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\Core\Session\AccountProxy $current_user
   *   The current user service.
   * @param \Drupal\Core\Entity\EntityFormBuilder $entity_form_builder
   *   The entity form builder service.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, AccountProxy $current_user, EntityFormBuilder $entity_form_builder) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->currentUser = $current_user;
    $this->entityFormBuilder = $entity_form_builder;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition, $container
      ->get('current_user'), $container
      ->get('entity.form_builder'));
  }

  /**
   * {@inheritdoc}
   */
  public function access($object, AccountInterface $account = NULL, $return_as_object = FALSE) {
    return $return_as_object ? AccessResult::allowed() : AccessResult::allowed()
      ->isAllowed();
  }

  /**
   * {@inheritdoc}
   */
  public function executeMultiple(array $objects) {
    if (!isset($this->configuration['household'])) {
      $this->configuration['household'] = Contact::create([
        'type' => 'household',
      ]);
    }

    // Saving household only now because user can click "Cancel" on confirmation
    // page (if they notice that they selected a wrong contact).
    $this->configuration['household']
      ->setOwnerId($this->currentUser
      ->id());
    $this->configuration['household']
      ->save();
    foreach ($objects as $member) {
      $endpoints = [
        0 => [
          'entity_type' => $member
            ->getEntityTypeId(),
          'entity_id' => $member
            ->id(),
        ],
        1 => [
          'entity_type' => 'crm_core_contact',
          'entity_id' => $this->configuration['household']
            ->id(),
        ],
      ];
      $relation = Relation::create([
        'relation_type' => self::RELATION_TYPE_HOUSEHOLD,
        'endpoints' => $endpoints,
      ]);
      $relation
        ->save();
    }
  }

  /**
   * {@inheritdoc}
   */
  public function execute($object = NULL) {
    $this
      ->executeMultiple([
      $object,
    ]);
  }

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
    $household = Contact::create([
      'type' => 'household',
      'name' => 'Fam. Smith',
    ]);
    return $this->entityFormBuilder
      ->getForm($household);
  }

  /**
   * {@inheritdoc}
   */
  public function submitConfigurationForm(array &$form, FormStateInterface $form_state) {
    $this->configuration['household'] = $form_state
      ->getFormObject()
      ->getEntity();
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ConfigurableActionBase::calculateDependencies	public	function	Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies	1
ConfigurableActionBase::defaultConfiguration	public	function	Gets default configuration for this plugin. Overrides ConfigurableInterface::defaultConfiguration	8
ConfigurableActionBase::getConfiguration	public	function	Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
ConfigurableActionBase::setConfiguration	public	function	Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration
ConfigurableActionBase::validateConfigurationForm	public	function	Form validation handler. Overrides PluginFormInterface::validateConfigurationForm	2
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
JoinIntoHouseholdAction::$currentUser	protected	property	The current user service.
JoinIntoHouseholdAction::$entityFormBuilder	protected	property	The entity form bulder service.
JoinIntoHouseholdAction::access	public	function	Checks object access. Overrides ActionInterface::access
JoinIntoHouseholdAction::buildConfigurationForm	public	function	Form constructor. Overrides PluginFormInterface::buildConfigurationForm
JoinIntoHouseholdAction::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
JoinIntoHouseholdAction::execute	public	function	Executes the plugin. Overrides ExecutableInterface::execute
JoinIntoHouseholdAction::executeMultiple	public	function	Executes the plugin for an array of objects. Overrides ActionBase::executeMultiple
JoinIntoHouseholdAction::RELATION_TYPE_HOUSEHOLD		constant	A default relation type for household relations.
JoinIntoHouseholdAction::submitConfigurationForm	public	function	Form submission handler. Overrides PluginFormInterface::submitConfigurationForm
JoinIntoHouseholdAction::__construct	public	function	Constructs a EmailAction object. Overrides ConfigurableActionBase::__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.