You are here

Home » API reference » Apigee Edge 8 » DeveloperAppCreateForm.php

class DeveloperAppCreateForm in Apigee Edge 8

General form handler for the developer app create.

Hierarchy

Expanded class hierarchy of DeveloperAppCreateForm

File

src/Entity/Form/DeveloperAppCreateForm.php, line 37

Namespace

Drupal\apigee_edge\Entity\Form
View source 
class DeveloperAppCreateForm extends DeveloperAppCreateFormBase {

  /**
   * The developer controller service.
   *
   * @var \Drupal\apigee_edge\Entity\Controller\DeveloperControllerInterface
   */
  protected $developerController;

  /**
   * The renderer service.
   *
   * @var \Drupal\Core\Render\RendererInterface
   */
  protected $renderer;

  /**
   * Constructs DeveloperAppCreateForm.
   *
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   The entity type manager.
   * @param \Drupal\apigee_edge\Entity\Controller\ApiProductControllerInterface $api_product_controller
   *   The API product controller service.
   * @param \Drupal\apigee_edge\Entity\Controller\DeveloperControllerInterface $developer_controller
   *   The developer controller service.
   * @param \Drupal\apigee_edge\Entity\Controller\DeveloperAppCredentialControllerFactoryInterface $app_credential_controller_factory
   *   The developer app credential controller factory.
   * @param \Drupal\Core\Render\RendererInterface $renderer
   *   The renderer service.
   */
  public function __construct(EntityTypeManagerInterface $entity_type_manager, ApiProductControllerInterface $api_product_controller, DeveloperControllerInterface $developer_controller, DeveloperAppCredentialControllerFactoryInterface $app_credential_controller_factory, RendererInterface $renderer) {
    parent::__construct($entity_type_manager, $api_product_controller, $app_credential_controller_factory);
    $this->developerController = $developer_controller;
    $this->renderer = $renderer;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('entity_type.manager'), $container
      ->get('apigee_edge.controller.api_product'), $container
      ->get('apigee_edge.controller.developer'), $container
      ->get('apigee_edge.controller.developer_app_credential_factory'), $container
      ->get('renderer'));
  }

  /**
   * {@inheritdoc}
   */
  protected function alterFormBeforeApiProductElement(array &$form, FormStateInterface $form_state) : void {

    // Do not reload a developer ids and users when AJAX refreshes the form.
    $developer_options = $form_state
      ->get('developer_options');
    if ($developer_options === NULL) {

      // It is faster to collect existing developer emails like this
      // from Apigee Edge.
      $developer_emails = $this->developerController
        ->getEntityIds();
      $developer_options = array_reduce($this->entityTypeManager
        ->getStorage('user')
        ->loadByProperties([
        'mail' => $developer_emails,
      ]), function ($carry, UserInterface $item) {
        $carry[$item
          ->getEmail()] = $item
          ->label();
        return $carry;
      }, []);
      reset($developer_options);
      $form_state
        ->set('developer_options', $developer_options);
    }

    // Override the owner field to be a select list with all developers from
    // Apigee Edge.
    $form['owner'] = [
      '#title' => $this
        ->t('Owner'),
      '#type' => 'select',
      '#weight' => $form['owner']['#weight'],
      '#default_value' => $form_state
        ->get('owner') ?? key($developer_options),
      '#options' => $developer_options,
      '#required' => TRUE,
      '#ajax' => [
        'callback' => '::updateApiProductList',
      ],
    ];
  }

  /**
   * {@inheritdoc}
   */
  protected function alterFormWithApiProductElement(array &$form, FormStateInterface $form_state) : void {
    $form['api_products']['#prefix'] = '<div id="api-products-ajax-wrapper">';
    $form['api_products']['#suffix'] = '</div>';
  }

  /**
   * Ajax command that refreshes the API product list when owner changes.
   *
   * @param array $form
   *   Form render array.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The form state object.
   *
   * @return \Drupal\Core\Ajax\AjaxResponse
   *   The AJAX response.
   */
  public function updateApiProductList(array $form, FormStateInterface $form_state) : AjaxResponse {
    $response = new AjaxResponse();
    $response
      ->addCommand(new ReplaceCommand('#api-products-ajax-wrapper', $this->renderer
      ->render($form['api_products'])));
    return $response;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
AppCreateForm::$apiProductController protected property The API product controller service.
AppCreateForm::apiProductsFormElement final protected function Returns the API Products form element element.
AppCreateForm::form final public function Gets the actual form array to be built. Overrides AppForm::form
AppCreateForm::saveAppCredentials protected function Save app credentials on Apigee Edge. Overrides AppForm::saveAppCredentials
AppCreateForm::saveButtonLabel protected function Returns the label of the Save button on the form. Overrides AppForm::saveButtonLabel
AppCreateForm::validateApiProductSelection final public function Element validate callback for the API product list.
AppForm::actions protected function Returns an array of supported actions for the current entity form. Overrides EntityForm::actions 1
AppForm::buildEntity public function Builds an updated entity object based upon the submitted form values. Overrides EntityForm::buildEntity
AppForm::getEntityFromRouteMatch public function Determines which entity will be used by this form from a RouteMatch object. Overrides EntityForm::getEntityFromRouteMatch
AppForm::getRedirectUrl protected function Returns the URL where the user should be redirected after form submission. 4
AppForm::save public function Form submission handler for the 'save' action. Overrides EntityForm::save
AppForm::saveApp protected function Saves the app entity on Apigee Edge.
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
DeveloperAppCreateForm::$developerController protected property The developer controller service.
DeveloperAppCreateForm::$renderer protected property The renderer service.
DeveloperAppCreateForm::alterFormBeforeApiProductElement protected function Allows to alter the form before API products gets added. Overrides AppCreateForm::alterFormBeforeApiProductElement
DeveloperAppCreateForm::alterFormWithApiProductElement protected function Allows to alter the form after API products form element have been added. Overrides AppCreateForm::alterFormWithApiProductElement
DeveloperAppCreateForm::create public static function Instantiates a new instance of this class. Overrides DeveloperAppCreateFormBase::create
DeveloperAppCreateForm::updateApiProductList public function Ajax command that refreshes the API product list when owner changes.
DeveloperAppCreateForm::__construct public function Constructs DeveloperAppCreateForm. Overrides DeveloperAppCreateFormBase::__construct
DeveloperAppCreateFormBase::$appCredentialControllerFactory protected property The app credential controller factory.
DeveloperAppCreateFormBase::appCredentialController protected function Returns the app specific app credential controller. Overrides AppForm::appCredentialController
DeveloperAppFormTrait::apiProductList protected function 1
DeveloperAppFormTrait::appCredentialLifeTime protected function
DeveloperAppFormTrait::appEntityDefinition protected function
DeveloperAppFormTrait::appExists public static function
DeveloperAppFormTrait::appOwnerEntityDefinition protected function
DeveloperAppFormTrait::getEntityTypeManager private function Allows to access to the injected entity type manager.
EntityForm::$entityTypeManager protected property The entity type manager. 3
EntityForm::$moduleHandler protected property The module handler service.
EntityForm::$operation protected property The name of the current operation.
EntityForm::$privateEntityManager private property The entity manager.
EntityForm::actionsElement protected function Returns the action form element for the current entity form.
EntityForm::afterBuild public function Form element #after_build callback: Updates the entity with submitted data.
EntityForm::buildForm public function Form constructor. Overrides FormInterface::buildForm 10
EntityForm::getBaseFormId public function Returns a string identifying the base form. Overrides BaseFormIdInterface::getBaseFormId 5
EntityForm::getEntity public function Gets the form entity. Overrides EntityFormInterface::getEntity
EntityForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId 10
EntityForm::getOperation public function Gets the operation identifying the form. Overrides EntityFormInterface::getOperation
EntityForm::prepareEntity protected function Prepares the entity object before the form is built first. 3
EntityForm::prepareInvokeAll protected function Invokes the specified prepare hook variant.
EntityForm::processForm public function Process callback: assigns weights and hides extra fields.
EntityForm::setEntity public function Sets the form entity. Overrides EntityFormInterface::setEntity
EntityForm::setEntityManager public function Sets the entity manager for this form. Overrides EntityFormInterface::setEntityManager
EntityForm::setEntityTypeManager public function Sets the entity type manager for this form. Overrides EntityFormInterface::setEntityTypeManager
EntityForm::setModuleHandler public function Sets the module handler for this form. Overrides EntityFormInterface::setModuleHandler
EntityForm::setOperation public function Sets the operation for this form. Overrides EntityFormInterface::setOperation
EntityForm::submitForm public function This is the default entity object builder function. It is called before any other submit handler to build the new entity object to be used by the following submit handlers. At this point of the form workflow the entity is validated and the form state… Overrides FormInterface::submitForm 17
EntityForm::__get public function
EntityForm::__set public function
FieldableEdgeEntityForm::$entity protected property The fieldable entity being used by this form. Overrides EntityForm::$entity
FieldableEdgeEntityForm::copyFormValuesToEntity protected function Copies top-level form values to entity properties Overrides EntityForm::copyFormValuesToEntity
FieldableEdgeEntityForm::flagViolations protected function Flags violations for the current form.
FieldableEdgeEntityForm::getEditedFieldNames protected function Gets the names of all fields edited in the form.
FieldableEdgeEntityForm::getFormDisplay public function Gets the form display. Overrides FieldableEdgeEntityFormInterface::getFormDisplay
FieldableEdgeEntityForm::init protected function Initialize the form state and the entity before the first form build. Overrides EntityForm::init
FieldableEdgeEntityForm::setFormDisplay public function Sets the form display. Overrides FieldableEdgeEntityFormInterface::setFormDisplay
FieldableEdgeEntityForm::validateForm public function TODO Add missing return type-hint in 2.x. Overrides FormBase::validateForm
FormBase::$configFactory protected property The config factory. 1
FormBase::$requestStack protected property The request stack. 1
FormBase::$routeMatch protected property The route match.
FormBase::config protected function Retrieves a configuration object.
FormBase::configFactory protected function Gets the config factory for this form. 1
FormBase::container private function Returns the service container.
FormBase::currentUser protected function Gets the current user.
FormBase::getRequest protected function Gets the request object.
FormBase::getRouteMatch protected function Gets the route match.
FormBase::logger protected function Gets the logger for a specific channel.
FormBase::redirect protected function Returns a redirect response object for the specified route. Overrides UrlGeneratorTrait::redirect
FormBase::resetConfigFactory public function Resets the configuration factory.
FormBase::setConfigFactory public function Sets the config factory for this form.
FormBase::setRequestStack public function Sets the request stack object to use.
LinkGeneratorTrait::$linkGenerator protected property The link generator. 1
LinkGeneratorTrait::getLinkGenerator Deprecated protected function Returns the link generator.
LinkGeneratorTrait::l Deprecated protected function Renders a link to a route given a route name and its parameters.
LinkGeneratorTrait::setLinkGenerator Deprecated public function Sets the link generator service.
LoggerChannelTrait::$loggerFactory protected property The logger channel factory service.
LoggerChannelTrait::getLogger protected function Gets the logger for a specific channel.
LoggerChannelTrait::setLoggerFactory public function Injects the logger channel factory.
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
RedirectDestinationTrait::$redirectDestination protected property The redirect destination service. 1
RedirectDestinationTrait::getDestinationArray protected function Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url.
RedirectDestinationTrait::getRedirectDestination protected function Returns the redirect destination service.
RedirectDestinationTrait::setRedirectDestination public function Sets the redirect destination service.
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.
UrlGeneratorTrait::$urlGenerator protected property The url generator.
UrlGeneratorTrait::getUrlGenerator Deprecated protected function Returns the URL generator service.
UrlGeneratorTrait::setUrlGenerator Deprecated public function Sets the URL generator service.
UrlGeneratorTrait::url Deprecated protected function Generates a URL or path for a specific route based on the given parameters.