ProviderMetadata

32class ProviderMetadata extends AbstractDataTransferObject33{34    public const KEY_ID = 'id';35    public const KEY_NAME = 'name';36    public const KEY_DESCRIPTION = 'description';37    public const KEY_TYPE = 'type';38    public const KEY_CREDENTIALS_URL = 'credentialsUrl';39    public const KEY_AUTHENTICATION_METHOD = 'authenticationMethod';40    public const KEY_LOGO_PATH = 'logoPath';41    /**42     * @var string The provider's unique identifier.43     */44    protected string $id;45    /**46     * @var string The provider's display name.47     */48    protected string $name;49    /**50     * @var string|null The provider's description.51     */52    protected ?string $description;53    /**54     * @var ProviderTypeEnum The provider type.55     */56    protected ProviderTypeEnum $type;57    /**58     * @var string|null The URL where users can get credentials.59     */60    protected ?string $credentialsUrl;61    /**62     * @var RequestAuthenticationMethod|null The authentication method.63     */64    protected ?RequestAuthenticationMethod $authenticationMethod;65    /**66     * @var string|null The full path to the provider's logo image file.67     */68    protected ?string $logoPath;69    /**70     * Constructor.71     *72     * @since 0.1.073     * @since 1.2.0 Added optional $description parameter.74     * @since 1.3.0 Added optional $logoPath parameter.75     *76     * @param string $id The provider's unique identifier.77     * @param string $name The provider's display name.78     * @param ProviderTypeEnum $type The provider type.79     * @param string|null $credentialsUrl The URL where users can get credentials.80     * @param RequestAuthenticationMethod|null $authenticationMethod The authentication method.81     * @param string|null $description The provider's description.82     * @param string|null $logoPath The full path to the provider's logo image file.83     * @throws InvalidArgumentException If the provider ID contains invalid characters.84     */85    public function __construct(string $id, string $name, ProviderTypeEnum $type, ?string $credentialsUrl = null, ?RequestAuthenticationMethod $authenticationMethod = null, ?string $description = null, ?string $logoPath = null)86    {87        if (!preg_match('/^[a-z0-9\-_]+$/', $id)) {88            throw new InvalidArgumentException(sprintf(89                // phpcs:ignore Generic.Files.LineLength.TooLong90                'Invalid provider ID "%s". Only lowercase alphanumeric characters, hyphens, and underscores are allowed.',91                $id92            ));93        }94        $this->id = $id;95        $this->name = $name;96        $this->description = $description;97        $this->type = $type;98        $this->credentialsUrl = $credentialsUrl;99        $this->authenticationMethod = $authenticationMethod;100        $this->logoPath = $logoPath;101    }102    /**103     * Gets the provider's unique identifier.104     *105     * @since 0.1.0106     *107     * @return string The provider ID.108     */109    public function getId(): string110    {111        return $this->id;