trait TeamAppFormTrait in Apigee Edge 8
Helper trait that contains team app (create/edit) form specific tweaks.
Hierarchy
- trait \Drupal\apigee_edge_teams\Entity\Form\TeamAppFormTrait
1 file declares its use of TeamAppFormTrait
- TeamAppApiKeyAddForm.php in modules/
apigee_edge_teams/ src/ Form/ TeamAppApiKeyAddForm.php
File
- modules/
apigee_edge_teams/ src/ Entity/ Form/ TeamAppFormTrait.php, line 38
Namespace
Drupal\apigee_edge_teams\Entity\FormView source
trait TeamAppFormTrait {
/**
* {@inheritdoc}
*/
public static function appExists(string $name, array $element, FormStateInterface $form_state) : bool {
// Do not validate if app name is not set.
if ($name === '') {
return FALSE;
}
// We use the team app controller factory here instead of entity
// query to reduce the number API calls. (Entity query may load all
// developers to return whether the given team has an app with
// the provided name already.)
/** @var \Drupal\apigee_edge_teams\Entity\Controller\TeamAppControllerFactoryInterface $factory */
$factory = \Drupal::service('apigee_edge_teams.controller.team_app_controller_factory');
$app = TRUE;
try {
$app = $factory
->teamAppController($form_state
->getValue('owner'))
->load($name);
} catch (ApiException $exception) {
if ($exception instanceof ClientErrorException && $exception
->getEdgeErrorCode() === 'developer.service.AppDoesNotExist') {
$app = FALSE;
}
else {
// Fail safe, return TRUE in case of an API communication error or an
// unexpected response.
$context = [
'%app_name' => $name,
'%owner' => $form_state
->getValue('owner'),
];
$context += Error::decodeException($exception);
\Drupal::logger('apigee_edge_teams')
->error("Unable to properly validate an app name's uniqueness. App name: %app_name. Owner: %owner. @message %function (line %line of %file). <pre>@backtrace_string</pre>", $context);
}
}
return (bool) $app;
}
/**
* {@inheritdoc}
*/
protected function appEntityDefinition() : EntityTypeInterface {
return $this
->getEntityTypeManager()
->getDefinition('team_app');
}
/**
* {@inheritdoc}
*/
protected function appOwnerEntityDefinition() : EntityTypeInterface {
return $this
->getEntityTypeManager()
->getDefinition('team');
}
/**
* {@inheritdoc}
*/
protected function appCredentialLifeTime() : int {
$config_name = 'apigee_edge_teams.team_app_settings';
$config = method_exists($this, 'config') ? $this
->config($config_name) : \Drupal::config($config_name);
return $config
->get('credential_lifetime');
}
/**
* Allows to access to the injected entity type manager.
*
* @return \Drupal\Core\Entity\EntityTypeManagerInterface
* The entity type manager.
*/
private function getEntityTypeManager() : EntityTypeManagerInterface {
if (property_exists($this, 'entityTypeManager') && $this->entityTypeManager instanceof EntityTypeManagerInterface) {
return $this->entityTypeManager;
}
return \Drupal::entityTypeManager();
}
/**
* Allows to access to the injected team member API product access handler.
*
* @return \Drupal\apigee_edge_teams\TeamMemberApiProductAccessHandlerInterface
* The team member API product access handler.
*/
private function getTeamMemberApiProductAccessHandler() : TeamMemberApiProductAccessHandlerInterface {
if (property_exists($this, 'teamMemberApiProductAccessHandler') && $this->teamMemberApiProductAccessHandler instanceof TeamMemberApiProductAccessHandlerInterface) {
return $this->teamMemberApiProductAccessHandler;
}
return \Drupal::service('apigee_edge_teams.team_member_api_product_access_handler');
}
/**
* Allows to access to the injected team membership manager.
*
* @return \Drupal\apigee_edge_teams\TeamMembershipManagerInterface
* The team membership manager.
*/
private function getTeamMembershipMananger() : TeamMembershipManagerInterface {
if (property_exists($this, 'teamMembershipManager') && $this->teamMembershipManager instanceof TeamMembershipManagerInterface) {
return $this->teamMembershipManager;
}
return \Drupal::service('apigee_edge_teams.team_membership_manager');
}
/**
* Returns a config object.
*
* @param string $config
* Config object name.
*
* @return \Drupal\Core\Config\ImmutableConfig
* The config object.
*/
private function getConfigObject(string $config) : ImmutableConfig {
/** @var \Drupal\Core\Config\ConfigFactoryInterface $config_factory */
$config_factory = \Drupal::service('config.factory');
if (method_exists($this, 'configFactory') && $this
->configFactory() instanceof ConfigFactoryInterface) {
$config_factory = $this
->configFactory();
}
elseif (property_exists($this, 'configFactory') && $this->configFactory instanceof ConfigFactoryInterface) {
$config_factory = $this->configFactory;
}
return $config_factory
->get($config);
}
/**
* Renders a render element with a warning for non-members.
*
* @param array $form
* Form render array.
* @param \Drupal\Core\Form\FormStateInterface $form_state
* Form state object.
*
* @return array
* An associative array with a key 'non_member_api_product_access_warning'
* and its value is a status message element which may or may not contain
* a warning message.
*/
protected function nonMemberApiProductAccessWarningElement(array $form, FormStateInterface $form_state) : array {
$element = [
'#theme' => 'status_messages',
'#message_list' => [],
'#weight' => -100,
];
if (!in_array($this
->getTeamName($form, $form_state), $this
->getTeamMembershipMananger()
->getTeams(\Drupal::currentUser()
->getEmail()))) {
$element['#message_list']['warning'][] = t('You are not member of this @team. You may see @api_products here that a @team member can not see.', [
'@team' => mb_strtolower($this
->getEntityTypeManager()
->getDefinition('team')
->getSingularLabel()),
'@api_products' => $this
->getEntityTypeManager()
->getDefinition('api_product')
->getPluralLabel(),
]);
}
return [
'non_member_api_product_access_warning' => $element,
];
}
/**
* {@inheritdoc}
*/
protected function apiProductList(array $form, FormStateInterface $form_state) : array {
$team_name = $this
->getTeamName($form, $form_state);
/** @var \Drupal\apigee_edge_teams\Entity\TeamInterface|null $team */
$team = $this
->getEntityTypeManager()
->getStorage('team')
->load($team_name);
// Sanity check, team should always exists with team name in this context.
if ($team === NULL) {
return [];
}
// If the user is not member of the team, but it still has access to this
// form. (For example because it has "Manage team apps" site-wide
// permission.) It should see a warning and only those API products should
// be visible that visibility is matching with the configured
// non_member_team_apps_visible_api_products config key value.
// @see nonMemberApiProductAccessWarningElement()
if (!in_array($team_name, $this
->getTeamMembershipMananger()
->getTeams(\Drupal::currentUser()
->getEmail()))) {
$filter = function (ApiProductInterface $api_product) use ($team) {
$visibility = $api_product
->getAttributeValue('access') ?? 'public';
return in_array($visibility, $this
->getConfigObject('apigee_edge_teams.team_settings')
->get('non_member_team_apps_visible_api_products'));
};
}
else {
$filter = function (ApiProductInterface $api_product) use ($team) {
return $this
->getTeamMemberApiProductAccessHandler()
->access($api_product, 'assign', $team);
};
}
return array_filter($this
->getEntityTypeManager()
->getStorage('api_product')
->loadMultiple(), $filter);
}
/**
* Gets the name of the team from the form.
*
* @param array $form
* Form render array.
* @param \Drupal\Core\Form\FormStateInterface $form_state
* Form state object.
*
* @return string
* Name (id) of the team.
*/
protected function getTeamName(array &$form, FormStateInterface $form_state) : string {
$team_name = $form_state
->getValue('owner') ?? $form['owner']['#value'] ?? $form['owner']['#default_value'];
return $team_name;
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
TeamAppFormTrait:: |
protected | function | ||
TeamAppFormTrait:: |
protected | function | ||
TeamAppFormTrait:: |
protected | function | ||
TeamAppFormTrait:: |
public static | function | ||
TeamAppFormTrait:: |
protected | function | ||
TeamAppFormTrait:: |
private | function | Returns a config object. | |
TeamAppFormTrait:: |
private | function | Allows to access to the injected entity type manager. | |
TeamAppFormTrait:: |
private | function | Allows to access to the injected team member API product access handler. | |
TeamAppFormTrait:: |
private | function | Allows to access to the injected team membership manager. | |
TeamAppFormTrait:: |
protected | function | Gets the name of the team from the form. | |
TeamAppFormTrait:: |
protected | function | Renders a render element with a warning for non-members. |