vendor/kreait/firebase-php/src/Firebase/ServiceAccount.php line 62

Open in your IDE?
  1. <?php
  3. declare(strict_types=1);
  5. namespace Kreait\Firebase;
  7. use Kreait\Firebase\Exception\InvalidArgumentException;
  8. use Kreait\Firebase\Util\JSON;
  9. use Throwable;
  11. /**
  12.  * @internal
  13.  */
  14. class ServiceAccount
  15. {
  16.     /**
  17.      * @var array{
  18.      *     project_id: string|null,
  19.      *     client_email: string|null,
  20.      *     private_key: string|null,
  21.      *     type?: string|null
  22.      * }|array<string, string|null> $data
  23.      */
  24.     private array $data = [];
  26.     public function getProjectId(): string
  27.     {
  28.         return $this->data['project_id'] ?? '';
  29.     }
  31.     public function getClientEmail(): string
  32.     {
  33.         return $this->data['client_email'] ?? '';
  34.     }
  36.     public function getPrivateKey(): string
  37.     {
  38.         return $this->data['private_key'] ?? '';
  39.     }
  41.     /**
  42.      * @return array{
  43.      *     project_id: string|null,
  44.      *     client_email: string|null,
  45.      *     private_key: string|null,
  46.      *     type: string|null
  47.      * }|array<string, string|null>
  48.      */
  49.     public function asArray(): array
  50.     {
  51.         $array = $this->data;
  52.         $array['type'] ??= 'service_account';
  54.         return $array;
  55.     }
  57.     /**
  58.      * @param self|string|array|mixed $value
  59.      *
  60.      * @throws InvalidArgumentException
  61.      */
  62.     public static function fromValue($value): self
  63.     {
  64.         if ($value instanceof self) {
  65.             return $value;
  66.         }
  68.         if (\is_string($value)) {
  69.             try {
  70.                 if (\str_starts_with($value, '{')) {
  71.                     return self::fromJson($value);
  72.                 }
  74.                 return self::fromJsonFile($value);
  75.             } catch (Throwable $e) {
  76.                 throw new InvalidArgumentException('Invalid service account: '.$e->getMessage(), $e->getCode(), $e);
  77.             }
  78.         }
  80.         if (\is_array($value)) {
  81.             try {
  82.                 return self::fromArray($value);
  83.             } catch (Throwable $e) {
  84.                 throw new InvalidArgumentException('Invalid service account: '.$e->getMessage(), $e->getCode(), $e);
  85.             }
  86.         }
  88.         throw new InvalidArgumentException('Invalid service account: Unsupported value');
  89.     }
  91.     /**
  92.      * @param array<string, string> $data
  93.      */
  94.     private static function fromArray(array $data): self
  95.     {
  96.         $type = $data['type'] ?? '';
  98.         if ($type !== 'service_account') {
  99.             throw new InvalidArgumentException(
  100.                 'A Service Account specification must have a field "type" with "service_account" as its value.'
  101.                 .' Please make sure you download the Service Account JSON file from the Service Accounts tab'
  102.                 .' in the Firebase Console, as shown in the documentation on'
  103.                 .' https://firebase.google.com/docs/admin/setup#add_firebase_to_your_app'
  104.             );
  105.         }
  107.         $serviceAccount = new self();
  108.         $serviceAccount->data = $data;
  110.         return $serviceAccount;
  111.     }
  113.     private static function fromJson(string $json): self
  114.     {
  115.         $config = JSON::decode($json, true);
  117.         return self::fromArray($config);
  118.     }
  120.     private static function fromJsonFile(string $filePath): self
  121.     {
  122.         try {
  123.             $file = new \SplFileObject($filePath);
  124.             $json = (string) $file->fread($file->getSize());
  125.         } catch (Throwable $e) {
  126.             throw new InvalidArgumentException("{$filePath} can not be read: {$e->getMessage()}");
  127.         }
  129.         try {
  130.             $serviceAccount = self::fromJson($json);
  131.         } catch (Throwable $e) {
  132.             throw new InvalidArgumentException(\sprintf('%s could not be parsed to a Service Account: %s', $filePath, $e->getMessage()));
  133.         }
  135.         return $serviceAccount;
  136.     }
  137. }