class ProfileFormEmbedded in Entity Legal 3.0.x

Method class for displaying a checkbox on the user register form.

Plugin annotation

@EntityLegal(
  id = "form_inline",
  label = @Translation("Checkbox on signup form with embedded document"),
  type = "new_users",
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\entity_legal\EntityLegalPluginBase implements EntityLegalPluginInterface
    • class \Drupal\entity_legal\Plugin\EntityLegal\ProfileForm
      • class \Drupal\entity_legal\Plugin\EntityLegal\ProfileFormEmbedded

File

src/Plugin/EntityLegal/ProfileFormEmbedded.php, line 14

Namespace

Drupal\entity_legal\Plugin\EntityLegal

class ProfileFormEmbedded extends ProfileForm {

  /**
   * {@inheritdoc}
   */
  public function execute(array &$context = []) {
    parent::execute($context);
    if (!empty($this->documents)) {

      /** @var \Drupal\Core\Render\RendererInterface $renderer */
      $renderer = \Drupal::service('renderer');
      $view_builder = \Drupal::entityTypeManager()
        ->getViewBuilder(ENTITY_LEGAL_DOCUMENT_VERSION_ENTITY_NAME);

      /** @var \Drupal\entity_legal\EntityLegalDocumentInterface $document */
      foreach ($this->documents as $document) {
        $document_markup = $view_builder
          ->view($document
          ->getPublishedVersion());
        $context['form']["legal_{$document->id()}"]['#prefix'] = $renderer
          ->renderPlain($document_markup);
      }
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
EntityLegalPluginBase::$documents	protected	property	The legal documents that implement this plugin.
EntityLegalPluginBase::getDocumentsForMethod	public	function	Get all Entity Legal Documents for this plugin.
EntityLegalPluginBase::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object. Overrides PluginBase::__construct	1
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	2
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.
ProfileForm::submitForm	public static	function	Submit handler for user register form.
ProfileFormEmbedded::execute	public	function	Execute callback for Entity Legal method plugin. Overrides ProfileForm::execute