From b9b69ef1f9b341b5a22afe0c7360c636450791dd Mon Sep 17 00:00:00 2001 From: Houssain Amrani Date: Wed, 28 Dec 2022 19:10:13 +0100 Subject: [PATCH 1/3] docs: add docblocks to Utils --- .../packages/sqlcommenter-laravel/src/Utils.php | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/php/sqlcommenter-php/packages/sqlcommenter-laravel/src/Utils.php b/php/sqlcommenter-php/packages/sqlcommenter-laravel/src/Utils.php index 387835ab..900d1ffb 100644 --- a/php/sqlcommenter-php/packages/sqlcommenter-laravel/src/Utils.php +++ b/php/sqlcommenter-php/packages/sqlcommenter-laravel/src/Utils.php @@ -19,6 +19,12 @@ class Utils { + /** + * Format query comments. + * + * @param array $comments + * @return string + */ public static function formatComments(array $comments): string { if (empty($comments)) { @@ -34,6 +40,12 @@ public static function formatComments(array $comments): string ) . "*/"; } + /** + * Encode URL. + * + * @param string $input + * @return string + */ private static function customUrlEncode(string $input): string { $encodedString = urlencode($input); From ead309c4f78868689bd1c43148d6e6c688469b83 Mon Sep 17 00:00:00 2001 From: Houssain Amrani Date: Wed, 28 Dec 2022 19:10:26 +0100 Subject: [PATCH 2/3] docs: add docblock to Opentelemetry --- .../packages/sqlcommenter-laravel/src/Opentelemetry.php | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/php/sqlcommenter-php/packages/sqlcommenter-laravel/src/Opentelemetry.php b/php/sqlcommenter-php/packages/sqlcommenter-laravel/src/Opentelemetry.php index b793c487..d49da145 100644 --- a/php/sqlcommenter-php/packages/sqlcommenter-laravel/src/Opentelemetry.php +++ b/php/sqlcommenter-php/packages/sqlcommenter-laravel/src/Opentelemetry.php @@ -21,6 +21,11 @@ class Opentelemetry { + /** + * Get the underlying Opentelemetry values. + * + * @return array + */ public static function getOpentelemetryValues() { $carrier = []; From 8ddd0ef8d9e53ca9b9319cadabf2476402194380 Mon Sep 17 00:00:00 2001 From: Houssain Amrani Date: Wed, 28 Dec 2022 19:10:44 +0100 Subject: [PATCH 3/3] fix: Undefined array key "controller" --- .../sqlcommenter-laravel/src/Database/Connection.php | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/php/sqlcommenter-php/packages/sqlcommenter-laravel/src/Database/Connection.php b/php/sqlcommenter-php/packages/sqlcommenter-laravel/src/Database/Connection.php index 790783fa..fbd5bffd 100644 --- a/php/sqlcommenter-php/packages/sqlcommenter-laravel/src/Database/Connection.php +++ b/php/sqlcommenter-php/packages/sqlcommenter-laravel/src/Database/Connection.php @@ -37,6 +37,12 @@ protected function run($query, $bindings, \Closure $callback) ); } + /** + * Append SQL comments to the underlying query. + * + * @param string $query + * @return string + */ private function appendSqlComments(string $query): string { static $configurationKey = 'google_sqlcommenter.include'; @@ -52,7 +58,7 @@ private function appendSqlComments(string $query): string if (config("{$configurationKey}.controller", true) && !empty($action['controller'])) { $comments['controller'] = explode("@", class_basename($action['controller']))[0]; } - if (config("{$configurationKey}.action", true) && !empty($action and $action['controller'] && str_contains($action['controller'], '@'))) { + if (config("{$configurationKey}.action", true) && !empty($action) && !empty($action['controller']) && str_contains($action['controller'], '@')) { $comments['action'] = explode("@", class_basename($action['controller']))[1]; } if (config("{$configurationKey}.route", true)) {