interface WebformGroupManagerInterface in Webform 6.x

Defines an interface for the webform group manager.

Hierarchy

• interface \Drupal\webform_group\WebformGroupManagerInterface

File

modules/webform_group/src/WebformGroupManagerInterface.php, line 12

Namespace

Drupal\webform_group

interface WebformGroupManagerInterface {

  /**
   * Determine if the group owner token is enabled.
   *
   * @return bool
   *   TRUE if the group owner token is enabled.
   */
  public function isGroupOwnerTokenEnable();

  /**
   * Determine if the group role token is enabled.
   *
   * @return bool
   *   TRUE if the group role token is enabled.
   */
  public function isGroupRoleTokenEnabled($group_role_id);

  /**
   * Get the current user's group roles.
   *
   * @return array|bool
   *   An array containing the current user's group roles.
   *   FALSE if no group content is found for the current request.
   */
  public function getCurrentUserGroupRoles();

  /**
   * Get the group content for the current request.
   *
   * @return \Drupal\group\Entity\GroupContentInterface|bool
   *   The group content for the current request.
   *   FALSE if no group content is found for the current request.
   */
  public function getCurrentGroupContent();

  /**
   * Get the group webform for the current request.
   *
   * @return \Drupal\webform\WebformInterface|null
   *   The group webform for the current request.
   */
  public function getCurrentGroupWebform();

  /**
   * Get group roles for a webform submission and a specified user account.
   *
   * @param \Drupal\webform\WebformSubmissionInterface $webform_submission
   *   A webform submission.
   * @param \Drupal\Core\Session\AccountInterface $account
   *   A user account.
   *
   * @return \Drupal\group\Entity\GroupContentInterface|bool
   *   The group role  for the webform submission.
   *   FALSE if no group roles is found for the webform submission.
   */
  public function getWebformSubmissionUserGroupRoles(WebformSubmissionInterface $webform_submission, AccountInterface $account);

  /**
   * Get group content for a webform submission.
   *
   * @param \Drupal\webform\WebformSubmissionInterface $webform_submission
   *   A webform submission.
   *
   * @return \Drupal\group\Entity\GroupContentInterface|bool
   *   The group content for the webform submission.
   *   FALSE if no group roles is found for the webform submission.
   */
  public function getWebformSubmissionGroupContent(WebformSubmissionInterface $webform_submission);

  /**
   * Get a webform's access rules with group roles.
   *
   * @param \Drupal\webform\WebformInterface $webform
   *   A webform.
   *
   * @return array
   *   An associative array containiong a webform's access rules
   *   with group roles.
   */
  public function getAccessRules(WebformInterface $webform);

}

Members

Name	Modifiers	Type	Description	Overrides
WebformGroupManagerInterface::getAccessRules	public	function	Get a webform's access rules with group roles.	1
WebformGroupManagerInterface::getCurrentGroupContent	public	function	Get the group content for the current request.	1
WebformGroupManagerInterface::getCurrentGroupWebform	public	function	Get the group webform for the current request.	1
WebformGroupManagerInterface::getCurrentUserGroupRoles	public	function	Get the current user's group roles.	1
WebformGroupManagerInterface::getWebformSubmissionGroupContent	public	function	Get group content for a webform submission.	1
WebformGroupManagerInterface::getWebformSubmissionUserGroupRoles	public	function	Get group roles for a webform submission and a specified user account.	1
WebformGroupManagerInterface::isGroupOwnerTokenEnable	public	function	Determine if the group owner token is enabled.	1
WebformGroupManagerInterface::isGroupRoleTokenEnabled	public	function	Determine if the group role token is enabled.	1