From 2a7d8dc80e42f49edf7a4ba4a50fc4adb9f1ab1f Mon Sep 17 00:00:00 2001 From: Brent Shaffer Date: Wed, 20 May 2026 08:09:53 -0700 Subject: [PATCH] docs: fix phpdoc codeblocks in credentials classes --- src/Credentials/GCECredentials.php | 30 ++++++++-------- src/Credentials/ServiceAccountCredentials.php | 36 ++++++++++--------- 2 files changed, 35 insertions(+), 31 deletions(-) diff --git a/src/Credentials/GCECredentials.php b/src/Credentials/GCECredentials.php index ab6753bd81..ea8059e360 100644 --- a/src/Credentials/GCECredentials.php +++ b/src/Credentials/GCECredentials.php @@ -40,23 +40,25 @@ * It can be used to authorize requests using the AuthTokenMiddleware, but will * only succeed if being run on GCE: * - * use Google\Auth\Credentials\GCECredentials; - * use Google\Auth\Middleware\AuthTokenMiddleware; - * use GuzzleHttp\Client; - * use GuzzleHttp\HandlerStack; + * ``` + * use Google\Auth\Credentials\GCECredentials; + * use Google\Auth\Middleware\AuthTokenMiddleware; + * use GuzzleHttp\Client; + * use GuzzleHttp\HandlerStack; * - * $gce = new GCECredentials(); - * $middleware = new AuthTokenMiddleware($gce); - * $stack = HandlerStack::create(); - * $stack->push($middleware); + * $gce = new GCECredentials(); + * $middleware = new AuthTokenMiddleware($gce); + * $stack = HandlerStack::create(); + * $stack->push($middleware); * - * $client = new Client([ - * 'handler' => $stack, - * 'base_uri' => 'https://www.googleapis.com/taskqueue/v1beta2/projects/', - * 'auth' => 'google_auth' - * ]); + * $client = new Client([ + * 'handler' => $stack, + * 'base_uri' => 'https://www.googleapis.com/taskqueue/v1beta2/projects/', + * 'auth' => 'google_auth' + * ]); * - * $res = $client->get('myproject/taskqueues/myqueue'); + * $res = $client->get('myproject/taskqueues/myqueue'); + * ``` */ class GCECredentials extends CredentialsLoader implements SignBlobInterface, diff --git a/src/Credentials/ServiceAccountCredentials.php b/src/Credentials/ServiceAccountCredentials.php index 3d23f71af9..7f4c48e8db 100644 --- a/src/Credentials/ServiceAccountCredentials.php +++ b/src/Credentials/ServiceAccountCredentials.php @@ -39,26 +39,28 @@ * * Use it with AuthTokenMiddleware to authorize http requests: * - * use Google\Auth\Credentials\ServiceAccountCredentials; - * use Google\Auth\Middleware\AuthTokenMiddleware; - * use GuzzleHttp\Client; - * use GuzzleHttp\HandlerStack; + * ``` + * use Google\Auth\Credentials\ServiceAccountCredentials; + * use Google\Auth\Middleware\AuthTokenMiddleware; + * use GuzzleHttp\Client; + * use GuzzleHttp\HandlerStack; * - * $sa = new ServiceAccountCredentials( - * 'https://www.googleapis.com/auth/taskqueue', - * '/path/to/your/json/key_file.json' - * ); - * $middleware = new AuthTokenMiddleware($sa); - * $stack = HandlerStack::create(); - * $stack->push($middleware); + * $sa = new ServiceAccountCredentials( + * 'https://www.googleapis.com/auth/taskqueue', + * '/path/to/your/json/key_file.json' + * ); + * $middleware = new AuthTokenMiddleware($sa); + * $stack = HandlerStack::create(); + * $stack->push($middleware); * - * $client = new Client([ - * 'handler' => $stack, - * 'base_uri' => 'https://www.googleapis.com/taskqueue/v1beta2/projects/', - * 'auth' => 'google_auth' // authorize all requests - * ]); + * $client = new Client([ + * 'handler' => $stack, + * 'base_uri' => 'https://www.googleapis.com/taskqueue/v1beta2/projects/', + * 'auth' => 'google_auth' // authorize all requests + * ]); * - * $res = $client->get('myproject/taskqueues/myqueue'); + * $res = $client->get('myproject/taskqueues/myqueue'); + * ``` */ class ServiceAccountCredentials extends CredentialsLoader implements GetQuotaProjectInterface,