interface UserDeveloperConverterInterface in Apigee Edge 8

User-developer converter service definition.

Hierarchy

• interface \Drupal\apigee_edge\UserDeveloperConverterInterface

2 files declare their use of UserDeveloperConverterInterface

UserDeveloperConverter.php in tests/modules/apigee_edge_test/src/UserDeveloperConverter.php

UserDeveloperSyncJobTrait.php in src/Job/UserDeveloperSyncJobTrait.php

File

src/UserDeveloperConverterInterface.php, line 31

Namespace

Drupal\apigee_edge

interface UserDeveloperConverterInterface {

  /**
   * Developer-user base field mapping.
   *
   * @var string[]
   */
  public const DEVELOPER_PROP_USER_BASE_FIELD_MAP = [
    'userName' => 'name',
    'email' => 'mail',
    'firstName' => 'first_name',
    'lastName' => 'last_name',
  ];

  /**
   * Converts Drupal user entity to a developer entity.
   *
   * Creates a new developer entity if it did not exist for a user or update
   * properties of the existing developer entity.
   *
   * It modifies only those properties that changed.
   *
   * @param \Drupal\user\UserInterface $user
   *   The Drupal user entity.
   *
   * @return \Drupal\apigee_edge\Structure\UserToDeveloperConversionResult
   *   The result of the conversion.
   */
  public function convertUser(UserInterface $user) : UserToDeveloperConversionResult;

  /**
   * Converts a developer entity to a Drupal user entity.
   *
   * Creates a new user entity if it did not exist for a developer or update
   * properties of the existing developer entity.
   *
   * It modifies only those properties that changed.
   *
   * @param \Drupal\apigee_edge\Entity\DeveloperInterface $developer
   *   The developer entity.
   *
   * @return \Drupal\apigee_edge\Structure\DeveloperToUserConversionResult
   *   The result of the conversion.
   */
  public function convertDeveloper(DeveloperInterface $developer) : DeveloperToUserConversionResult;

}

Members

Name	Modifiers	Type	Description	Overrides
UserDeveloperConverterInterface::convertDeveloper	public	function	Converts a developer entity to a Drupal user entity.	1
UserDeveloperConverterInterface::convertUser	public	function	Converts Drupal user entity to a developer entity.	1
UserDeveloperConverterInterface::DEVELOPER_PROP_USER_BASE_FIELD_MAP	public	constant	Developer-user base field mapping.