File Manager

📁 Media Files

📁 .. (Parent Directory) 📁 Query/ 🔧 Ads.php 🔧 AdsAsset.php 🔧 AdsAssetGroup.php 🔧 AdsAssetGroupAsset.php 🔧 AdsCampaign.php 🔧 AdsCampaignBudget.php 🔧 AdsCampaignCriterion.php 🔧 AdsCampaignLabel.php 🔧 AdsConversionAction.php 🔧 AdsReport.php 🔧 AssetFieldType.php 🔧 BillingSetupStatus.php 🔧 BudgetMetrics.php 🔧 BudgetRecommendations.php 🔧 CallToActionType.php 🔧 CampaignStatus.php 🔧 CampaignType.php 🔧 Connection.php 🔧 ExceptionTrait.php 🔧 LocationIDTrait.php 🔧 Merchant.php 🔧 MerchantMetrics.php 🔧 MerchantPriceBenchmarks.php 🔧 MerchantReport.php 🔧 Middleware.php 🔧 ReportTrait.php 🔧 Settings.php 🔧 ShoppingContentDateTrait.php 🔧 SiteVerification.php

⬆️ Upload Files

📁 Create Folder

📄 Create File

💻 Terminal

📦 Extract Archive

🔧 Edit: ExceptionTrait.php

PHP

Size: 5.90 KB | Modified: 2025-07-22 07:14:30

<?php
declare( strict_types=1 );

namespace Automattic\WooCommerce\GoogleListingsAndAds\API\Google;

use Automattic\WooCommerce\GoogleListingsAndAds\Vendor\Google\Service\Exception as GoogleServiceException;
use Automattic\WooCommerce\GoogleListingsAndAds\Vendor\GuzzleHttp\Exception\BadResponseException;
use Automattic\WooCommerce\GoogleListingsAndAds\Vendor\Psr\Http\Client\ClientExceptionInterface;
use Google\ApiCore\ApiException;
use Google\Rpc\Code;
use Exception;

/**
 * Trait ExceptionTrait
 *
 * @package Automattic\WooCommerce\GoogleListingsAndAds\API\Google
 */
trait ExceptionTrait {

/**
	 * Check if the ApiException contains a specific error.
	 *
	 * @param ApiException $exception  Exception to check.
	 * @param string       $error_code Error code we are checking.
	 *
	 * @return bool
	 */
	protected function has_api_exception_error( ApiException $exception, string $error_code ): bool {
		$meta = $exception->getMetadata();
		if ( empty( $meta ) || ! is_array( $meta ) ) {
			return false;
		}

foreach ( $meta as $data ) {
			if ( empty( $data['errors'] ) || ! is_array( $data['errors'] ) ) {
				continue;
			}

foreach ( $data['errors'] as $error ) {
				if ( in_array( $error_code, $error['errorCode'], true ) ) {
					return true;
				}
			}
		}

return false;
	}

/**
	 * Returns a list of detailed errors from an exception instance that extends ApiException
	 * or GoogleServiceException. Other Exception instances will also be converted to an array
	 * in the same structure.
	 *
	 * The following are the example sources of ApiException, GoogleServiceException,
	 * and other Exception in order:
	 *
	 * @link https://github.com/googleads/google-ads-php/blob/v28.0.0/src/Google/Ads/GoogleAds/V20/Services/Client/CustomerServiceClient.php#L313
	 * @link https://github.com/googleapis/google-api-php-client/blob/v2.16.1/src/Http/REST.php#L119-L135
	 * @link https://github.com/googleapis/google-api-php-client/blob/v2.16.1/src/Service/Resource.php#L86-L174
	 *
	 * @param ApiException|GoogleServiceException|Exception $exception Exception to check.
	 *
	 * @return array
	 */
	protected function get_exception_errors( Exception $exception ): array {
		if ( $exception instanceof ApiException ) {
			return $this->get_api_exception_errors( $exception );
		}

if ( $exception instanceof GoogleServiceException ) {
			return $this->get_google_service_exception_errors( $exception );
		}

// Fallback for handling other Exception instances.
		$code = $exception->getCode();
		return [ $code => $exception->getMessage() ];
	}

/**
	 * Returns a list of detailed errors from an ApiException.
	 * If no errors are found the default Exception message is returned.
	 *
	 * @param ApiException $exception Exception to check.
	 *
	 * @return array
	 */
	private function get_api_exception_errors( ApiException $exception ): array {
		$errors = [];
		$meta   = $exception->getMetadata();

if ( is_array( $meta ) ) {
			foreach ( $meta as $data ) {
				if ( empty( $data['errors'] ) || ! is_array( $data['errors'] ) ) {
					continue;
				}

foreach ( $data['errors'] as $error ) {
					if ( empty( $error['message'] ) ) {
						continue;
					}

if ( ! empty( $error['errorCode'] ) && is_array( $error['errorCode'] ) ) {
						$error_code = reset( $error['errorCode'] );
					} else {
						$error_code = 'ERROR';
					}

$errors[ $error_code ] = $error['message'];
				}
			}
		}

$errors[ $exception->getStatus() ] = $exception->getBasicMessage();
		return $errors;
	}

/**
	 * Returns a list of detailed errors from a GoogleServiceException.
	 *
	 * @param GoogleServiceException $exception Exception to check.
	 *
	 * @return array
	 */
	private function get_google_service_exception_errors( GoogleServiceException $exception ): array {
		$errors = [];

if ( ! is_null( $exception->getErrors() ) ) {
			foreach ( $exception->getErrors() as $error ) {
				if ( ! isset( $error['message'] ) ) {
					continue;
				}

$error_code            = $error['reason'] ?? 'ERROR';
				$errors[ $error_code ] = $error['message'];
			}
		}

if ( 0 === count( $errors ) ) {
			$errors['unknown'] = __( 'An unknown error occurred in the Shopping Content Service.', 'google-listings-and-ads' );
		}

return $errors;
	}

/**
	 * Get an error message from a ClientException.
	 *
	 * @param ClientExceptionInterface $exception     Exception to check.
	 * @param string                   $default_error Default error message.
	 *
	 * @return string
	 */
	protected function client_exception_message( ClientExceptionInterface $exception, string $default_error ): string {
		if ( $exception instanceof BadResponseException ) {
			$response = json_decode( $exception->getResponse()->getBody()->getContents(), true );
			$message  = $response['message'] ?? false;
			return $message ? $default_error . ': ' . $message : $default_error;
		}
		return $default_error;
	}

/**
	 * Map a gRPC code to HTTP status code.
	 *
	 * @param ApiException $exception Exception to check.
	 *
	 * @return int The HTTP status code.
	 *
	 * @see Google\Rpc\Code for the list of gRPC codes.
	 */
	protected function map_grpc_code_to_http_status_code( ApiException $exception ) {
		switch ( $exception->getCode() ) {
			case Code::OK:
				return 200;

case Code::CANCELLED:
				return 499;

case Code::UNKNOWN:
				return 500;

case Code::INVALID_ARGUMENT:
				return 400;

case Code::DEADLINE_EXCEEDED:
				return 504;

case Code::NOT_FOUND:
				return 404;

case Code::ALREADY_EXISTS:
				return 409;

case Code::PERMISSION_DENIED:
				return 403;

case Code::UNAUTHENTICATED:
				return 401;

case Code::RESOURCE_EXHAUSTED:
				return 429;

case Code::FAILED_PRECONDITION:
				return 400;

case Code::ABORTED:
				return 409;

case Code::OUT_OF_RANGE:
				return 400;

case Code::UNIMPLEMENTED:
				return 501;

case Code::INTERNAL:
				return 500;

case Code::UNAVAILABLE:
				return 503;

case Code::DATA_LOSS:
				return 500;

default:
				return 500;
		}
	}
}

Supports: PHP, ASPX, HTML, JavaScript, CSS and other text-based files

📥 Download

File manager