apigee_edge_teams.api.php in Apigee Edge 8

Copyright 2018 Google Inc.

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License version 2 as published by the Free Software Foundation.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.

File

modules/apigee_edge_teams/apigee_edge_teams.api.php

<?php

/**
 * @file
 * Copyright 2018 Google Inc.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * version 2 as published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
 * MA 02110-1301, USA.
 */

/**
 * Hooks for apigee_edge_teams module.
 */

/**
 * @addtogroup hooks
 * @{
 */

/**
 * Alters the title of team listing page and its default menu link item.
 *
 * @param \Drupal\Core\StringTranslation\TranslatableMarkup $title
 *   The menu link/page title.
 */
function hook_apigee_edge_teams_team_listing_page_title_alter(\Drupal\Core\StringTranslation\TranslatableMarkup &$title) {
}

/**
 * Control API product entity operation access of a team (and its members).
 *
 * @param \Drupal\apigee_edge\Entity\ApiProductInterface $api_product
 *   The API Product entity for which to check access.
 * @param string $operation
 *   The entity operation. Usually one of 'view', 'update', 'create',
 *   'delete' or 'assign".
 * @param \Drupal\apigee_edge_teams\Entity\TeamInterface $team
 *   The team for which to check access.
 * @param \Drupal\Core\Session\AccountInterface $account
 *   The team member for which to check access.
 *
 * @return \Drupal\Core\Access\AccessResultInterface
 *   The access result.
 *
 * @see \Drupal\apigee_edge_teams\TeamMemberApiProductAccessHandler
 */
function hook_apigee_edge_teams_team_api_product_access(\Drupal\apigee_edge\Entity\ApiProductInterface $api_product, string $operation, \Drupal\apigee_edge_teams\Entity\TeamInterface $team, \Drupal\Core\Session\AccountInterface $account) {

  // Grant access if API product's name is prefixed with the team's name.
  return \Drupal\Core\Access\AccessResult::allowedIf(mb_strpos($api_product
    ->id(), $team
    ->id()) === 0);
}

/**
 * Alters a team member's team permissions within a team.
 *
 * WARNING: This alter hook gets called even if the developer is not (yet) a
 * member of a team (company) in Apigee Edge. This allows to grant team-level
 * permissions to a developer (Drupal user) to a team without adding it to a
 * team (company) as member in Apigee Edge. (Ex.: for team management
 * purposes, etc.)
 *
 * @param array $permissions
 *   Array of team permissions.
 * @param \Drupal\apigee_edge_teams\Entity\TeamInterface $team
 *   The team entity.
 * @param \Drupal\Core\Session\AccountInterface $account
 *   The Drupal user of the developer.
 */
function hook_apigee_edge_teams_developer_permissions_by_team_alter(array &$permissions, \Drupal\apigee_edge_teams\Entity\TeamInterface $team, \Drupal\Core\Session\AccountInterface $account) {

  // @see apigee_edge_teams_test_apigee_edge_teams_developer_permissions_by_team_alter()
}

/**
 * @} End of "addtogroup hooks".
 */

Functions

Name	Description
hook_apigee_edge_teams_developer_permissions_by_team_alter	Alters a team member's team permissions within a team.
hook_apigee_edge_teams_team_api_product_access	Control API product entity operation access of a team (and its members).
hook_apigee_edge_teams_team_listing_page_title_alter	Alters the title of team listing page and its default menu link item.