diff --git a/renovate.json b/renovate.json new file mode 100644 index 0000000..ee8c906 --- /dev/null +++ b/renovate.json @@ -0,0 +1,5 @@ +{ + "extends": [ + "config:base" + ] +} diff --git a/src/Contracts/MediaRecognition.php b/src/Contracts/MediaRecognition.php index 7dab8bc..fd75c61 100644 --- a/src/Contracts/MediaRecognition.php +++ b/src/Contracts/MediaRecognition.php @@ -7,9 +7,9 @@ interface MediaRecognition /** * Sets the source/path where the file is stored. * - * @param string $source - * @param string|null $mimeType - * @param int|null $mediaId + * @param string $source + * @param string|null $mimeType + * @param int|null $mediaId * @return $this */ public function source(string $source, string $mimeType = null, int $mediaId = null); @@ -17,9 +17,9 @@ public function source(string $source, string $mimeType = null, int $mediaId = n /** * Sets the source/path where the file is stored. * - * @param string $path - * @param string|null $mimeType - * @param int|null $mediaId + * @param string $path + * @param string|null $mimeType + * @param int|null $mediaId * @return $this */ public function path(string $path, string $mimeType = null, int $mediaId = null); @@ -27,9 +27,10 @@ public function path(string $path, string $mimeType = null, int $mediaId = null) /** * Detects labels/objects in an image or video. * - * @param int|null $minConfidence - * @param int|null $maxLabels + * @param int|null $minConfidence + * @param int|null $maxLabels * @return mixed + * * @throws \Exception */ public function detectLabels($minConfidence = null, $maxLabels = null); @@ -37,9 +38,10 @@ public function detectLabels($minConfidence = null, $maxLabels = null); /** * Detects labels/objects in an image. * - * @param int|null $minConfidence - * @param int|null $maxLabels + * @param int|null $minConfidence + * @param int|null $maxLabels * @return mixed + * * @throws \Exception */ public function detectImageLabels($minConfidence = null, $maxLabels = null); @@ -47,9 +49,10 @@ public function detectImageLabels($minConfidence = null, $maxLabels = null); /** * Detects labels/objects in a video. * - * @param int|null $minConfidence - * @param int|null $maxLabels + * @param int|null $minConfidence + * @param int|null $maxLabels * @return mixed + * * @throws \Exception */ public function detectVideoLabels($minConfidence = null, $maxLabels = null); @@ -57,8 +60,9 @@ public function detectVideoLabels($minConfidence = null, $maxLabels = null); /** * Detects faces in an image or video & analyzes them. * - * @param array $attributes + * @param array $attributes * @return mixed + * * @throws \Exception */ public function detectFaces($attributes = ['DEFAULT']); @@ -66,8 +70,9 @@ public function detectFaces($attributes = ['DEFAULT']); /** * Detects faces in an image & analyzes them. * - * @param array $attributes + * @param array $attributes * @return mixed + * * @throws \Exception */ public function detectImageFaces($attributes = ['DEFAULT']); @@ -75,8 +80,9 @@ public function detectImageFaces($attributes = ['DEFAULT']); /** * Detects faces in an image & analyzes them. * - * @param array $attributes + * @param array $attributes * @return mixed + * * @throws \Exception */ public function detectVideoFaces($attributes = ['DEFAULT']); @@ -85,8 +91,9 @@ public function detectVideoFaces($attributes = ['DEFAULT']); * Detects moderation labels in an image or video. * This can be useful for children-friendly images or NSFW images/videos. * - * @param int|null $minConfidence + * @param int|null $minConfidence * @return mixed + * * @throws \Exception */ public function detectModeration($minConfidence = null); @@ -95,8 +102,9 @@ public function detectModeration($minConfidence = null); * Detects moderation labels in an image. * This can be useful for children-friendly images or NSFW images. * - * @param int|null $minConfidence + * @param int|null $minConfidence * @return mixed + * * @throws \Exception */ public function detectImageModeration($minConfidence = null); @@ -105,8 +113,9 @@ public function detectImageModeration($minConfidence = null); * Detects moderation labels in an video. * This can be useful for children-friendly videos or NSFW videos. * - * @param int|null $minConfidence + * @param int|null $minConfidence * @return mixed + * * @throws \Exception */ public function detectVideoModeration($minConfidence = null); @@ -114,8 +123,9 @@ public function detectVideoModeration($minConfidence = null); /** * Detects text in an image or video (OCR). * - * @param array|null $filters + * @param array|null $filters * @return mixed + * * @throws \Exception */ public function detectText(array $filters = null); @@ -123,8 +133,9 @@ public function detectText(array $filters = null); /** * Detects text in an image (OCR). * - * @param array|null $filters + * @param array|null $filters * @return mixed + * * @throws \Exception */ public function detectImageText(array $filters = null); @@ -132,8 +143,9 @@ public function detectImageText(array $filters = null); /** * Detects text in a video (OCR). * - * @param array|null $filters + * @param array|null $filters * @return mixed + * * @throws \Exception */ public function detectVideoText(array $filters = null); @@ -141,9 +153,10 @@ public function detectVideoText(array $filters = null); /** * Get the "faces" from the video analysis. * - * @param string $jobId - * @param int $mediaId + * @param string $jobId + * @param int $mediaId * @return \Aws\Result + * * @throws \Exception */ public function getFacesByJobId(string $jobId, int $mediaId); @@ -151,9 +164,10 @@ public function getFacesByJobId(string $jobId, int $mediaId); /** * Get the labels from the video analysis. * - * @param string $jobId - * @param int $mediaId + * @param string $jobId + * @param int $mediaId * @return \Aws\Result + * * @throws \Exception */ public function getLabelsByJobId(string $jobId, int $mediaId); @@ -161,9 +175,10 @@ public function getLabelsByJobId(string $jobId, int $mediaId); /** * Get the "content moderation" from the video analysis. * - * @param string $jobId - * @param int $mediaId + * @param string $jobId + * @param int $mediaId * @return \Aws\Result + * * @throws \Exception */ public function getContentModerationByJobId(string $jobId, int $mediaId); @@ -171,9 +186,10 @@ public function getContentModerationByJobId(string $jobId, int $mediaId); /** * Get the "text detection" from the video analysis. * - * @param string $jobId - * @param int $mediaId + * @param string $jobId + * @param int $mediaId * @return \Aws\Result + * * @throws \Exception */ public function getTextDetectionByJobId(string $jobId, int $mediaId); diff --git a/src/Events/FacialAnalysisCompleted.php b/src/Events/FacialAnalysisCompleted.php index 34fe6b2..0050b96 100644 --- a/src/Events/FacialAnalysisCompleted.php +++ b/src/Events/FacialAnalysisCompleted.php @@ -18,7 +18,7 @@ class FacialAnalysisCompleted * Create a new event instance. * * @param $message - * @param int|null $mediaId + * @param int|null $mediaId */ public function __construct($message, int $mediaId = null) { diff --git a/src/Events/LabelAnalysisCompleted.php b/src/Events/LabelAnalysisCompleted.php index a5981c8..2e30c7f 100644 --- a/src/Events/LabelAnalysisCompleted.php +++ b/src/Events/LabelAnalysisCompleted.php @@ -18,7 +18,7 @@ class LabelAnalysisCompleted * Create a new event instance. * * @param $message - * @param int|null $mediaId + * @param int|null $mediaId */ public function __construct($message, int $mediaId = null) { diff --git a/src/Events/ModerationAnalysisCompleted.php b/src/Events/ModerationAnalysisCompleted.php index b8d7e4b..aedefae 100644 --- a/src/Events/ModerationAnalysisCompleted.php +++ b/src/Events/ModerationAnalysisCompleted.php @@ -18,7 +18,7 @@ class ModerationAnalysisCompleted * Create a new event instance. * * @param $message - * @param int|null $mediaId + * @param int|null $mediaId */ public function __construct($message, int $mediaId = null) { diff --git a/src/Events/TextAnalysisCompleted.php b/src/Events/TextAnalysisCompleted.php index ea04378..28a69de 100644 --- a/src/Events/TextAnalysisCompleted.php +++ b/src/Events/TextAnalysisCompleted.php @@ -18,7 +18,7 @@ class TextAnalysisCompleted * Create a new event instance. * * @param $message - * @param int|null $mediaId + * @param int|null $mediaId */ public function __construct($message, int $mediaId = null) { diff --git a/src/Http/Controllers/IncomingWebhookController.php b/src/Http/Controllers/IncomingWebhookController.php index 40ffcc3..554421d 100644 --- a/src/Http/Controllers/IncomingWebhookController.php +++ b/src/Http/Controllers/IncomingWebhookController.php @@ -52,9 +52,10 @@ public function __invoke() } /** - * @param string $type - * @param array $message - * @param int|null $mediaId + * @param string $type + * @param array $message + * @param int|null $mediaId + * * @throws \Exception */ public function fireEventFor(string $type, array $message, int $mediaId = null) diff --git a/src/Http/Middleware/VerifySignature.php b/src/Http/Middleware/VerifySignature.php index 96921fd..d2157f5 100644 --- a/src/Http/Middleware/VerifySignature.php +++ b/src/Http/Middleware/VerifySignature.php @@ -12,8 +12,8 @@ class VerifySignature /** * Handle an incoming request. * - * @param \Illuminate\Http\Request $request - * @param \Closure $next + * @param \Illuminate\Http\Request $request + * @param \Closure $next * @return mixed */ public function handle($request, Closure $next) diff --git a/src/Jobs/StartFaceDetection.php b/src/Jobs/StartFaceDetection.php index 6bd09e6..f636389 100644 --- a/src/Jobs/StartFaceDetection.php +++ b/src/Jobs/StartFaceDetection.php @@ -34,10 +34,10 @@ class StartFaceDetection implements ShouldQueue /** * Create a new job instance. * - * @param string $path - * @param string|null $mimeType - * @param int|null $mediaId - * @param string $faceAttribute + * @param string $path + * @param string|null $mimeType + * @param int|null $mediaId + * @param string $faceAttribute */ public function __construct(string $path, $mimeType = null, $mediaId = null, $faceAttribute = 'DEFAULT') { @@ -51,6 +51,7 @@ public function __construct(string $path, $mimeType = null, $mediaId = null, $fa * Execute the job. * * @return void + * * @throws \Exception */ public function handle() diff --git a/src/Jobs/StartLabelDetection.php b/src/Jobs/StartLabelDetection.php index d7ab720..92a9fda 100644 --- a/src/Jobs/StartLabelDetection.php +++ b/src/Jobs/StartLabelDetection.php @@ -36,11 +36,11 @@ class StartLabelDetection implements ShouldQueue /** * Create a new job instance. * - * @param string $path - * @param string|null $mimeType - * @param int|null $mediaId - * @param int|null $minConfidence - * @param int $maxResults + * @param string $path + * @param string|null $mimeType + * @param int|null $mediaId + * @param int|null $minConfidence + * @param int $maxResults */ public function __construct(string $path, $mimeType = null, $mediaId = null, $minConfidence = null, $maxResults = 1000) { @@ -55,6 +55,7 @@ public function __construct(string $path, $mimeType = null, $mediaId = null, $mi * Execute the job. * * @return void + * * @throws \Exception */ public function handle() diff --git a/src/Jobs/StartModerationDetection.php b/src/Jobs/StartModerationDetection.php index 416bca1..b159356 100644 --- a/src/Jobs/StartModerationDetection.php +++ b/src/Jobs/StartModerationDetection.php @@ -34,10 +34,10 @@ class StartModerationDetection implements ShouldQueue /** * Create a new job instance. * - * @param string $path - * @param string|null $mimeType - * @param int|null $mediaId - * @param int|null $minConfidence + * @param string $path + * @param string|null $mimeType + * @param int|null $mediaId + * @param int|null $minConfidence */ public function __construct(string $path, $mimeType = null, $mediaId = null, $minConfidence = null) { @@ -51,6 +51,7 @@ public function __construct(string $path, $mimeType = null, $mediaId = null, $mi * Execute the job. * * @return void + * * @throws \Exception */ public function handle() diff --git a/src/Jobs/StartTextDetection.php b/src/Jobs/StartTextDetection.php index af84850..4bfcf52 100644 --- a/src/Jobs/StartTextDetection.php +++ b/src/Jobs/StartTextDetection.php @@ -34,10 +34,10 @@ class StartTextDetection implements ShouldQueue /** * Create a new job instance. * - * @param string $path - * @param string|null $mimeType - * @param int|null $mediaId - * @param array $filters + * @param string $path + * @param string|null $mimeType + * @param int|null $mediaId + * @param array $filters */ public function __construct(string $path, $mimeType = null, $mediaId = null, $filters = []) { @@ -51,6 +51,7 @@ public function __construct(string $path, $mimeType = null, $mediaId = null, $fi * Execute the job. * * @return void + * * @throws \Exception */ public function handle() diff --git a/src/MediaRecognitionManager.php b/src/MediaRecognitionManager.php index b89420b..c1e4aeb 100644 --- a/src/MediaRecognitionManager.php +++ b/src/MediaRecognitionManager.php @@ -13,7 +13,7 @@ class MediaRecognitionManager extends Manager /** * Get a driver instance. * - * @param string|null $name + * @param string|null $name * @return mixed */ public function engine($name = null) @@ -25,6 +25,7 @@ public function engine($name = null) * Create an Amazon MediaRecognition Converter instance. * * @return \Meema\MediaRecognition\Recognizers\Rekognition + * * @throws \Exception */ public function createMediaRecognitionDriver(): Rekognition @@ -43,8 +44,8 @@ public function createMediaRecognitionDriver(): Rekognition /** * Sets the Recognition client. * - * @param array $config - * @param \Aws\Credentials\Credentials $credentials + * @param array $config + * @param \Aws\Credentials\Credentials $credentials * @return \Aws\Rekognition\RekognitionClient */ protected function setMediaRecognitionClient(array $config, Credentials $credentials): RekognitionClient @@ -59,7 +60,7 @@ protected function setMediaRecognitionClient(array $config, Credentials $credent /** * Get credentials of AWS. * - * @param array $credentials + * @param array $credentials * @return \Aws\Credentials\Credentials */ protected function getCredentials(array $credentials): Credentials diff --git a/src/Models/MediaRecognition.php b/src/Models/MediaRecognition.php index 76f65b0..e9198bd 100644 --- a/src/Models/MediaRecognition.php +++ b/src/Models/MediaRecognition.php @@ -18,6 +18,7 @@ * @property array $ocr * @property \Illuminate\Support\Carbon|null $created_at * @property \Illuminate\Support\Carbon|null $updated_at + * * @method static \Illuminate\Database\Eloquent\Builder|MediaRecognition newModelQuery() * @method static \Illuminate\Database\Eloquent\Builder|MediaRecognition newQuery() * @method static \Illuminate\Database\Eloquent\Builder|MediaRecognition query() diff --git a/src/Recognizers/Rekognition.php b/src/Recognizers/Rekognition.php index 68909cd..455d6c7 100644 --- a/src/Recognizers/Rekognition.php +++ b/src/Recognizers/Rekognition.php @@ -36,7 +36,8 @@ class Rekognition implements MediaRecognitionInterface /** * Construct converter. * - * @param \Aws\Rekognition\RekognitionClient $client + * @param \Aws\Rekognition\RekognitionClient $client + * * @throws \Exception */ public function __construct(RekognitionClient $client) @@ -57,9 +58,10 @@ public function getClient(): RekognitionClient /** * Detects labels/objects in an image. * - * @param int|null $minConfidence - * @param int|null $maxLabels + * @param int|null $minConfidence + * @param int|null $maxLabels * @return \Aws\Result + * * @throws \Exception */ public function detectLabels($minConfidence = null, $maxLabels = null) @@ -86,8 +88,9 @@ public function detectLabels($minConfidence = null, $maxLabels = null) /** * Detects faces in an image & analyzes them. * - * @param array $attributes + * @param array $attributes * @return \Aws\Result + * * @throws \Exception */ public function detectFaces($attributes = ['DEFAULT']) @@ -117,8 +120,9 @@ public function detectFaces($attributes = ['DEFAULT']) * Detects moderation labels in an image. * This can be useful for children-friendly images or NSFW images. * - * @param int|null $minConfidence + * @param int|null $minConfidence * @return \Aws\Result + * * @throws \Exception */ public function detectModeration($minConfidence = null) @@ -145,8 +149,9 @@ public function detectModeration($minConfidence = null) /** * Detects text in an image (OCR). * - * @param array|null $filters + * @param array|null $filters * @return \Aws\Result + * * @throws \Exception */ public function detectText(array $filters = null) @@ -174,6 +179,7 @@ public function detectText(array $filters = null) * @param $type * @param $results * @return mixed + * * @throws \Exception */ protected function updateOrCreate($type, $results) @@ -187,9 +193,10 @@ protected function updateOrCreate($type, $results) } /** - * @param string $jobId - * @param string $type + * @param string $jobId + * @param string $type * @return void + * * @throws \Exception */ protected function updateJobId(string $jobId, string $type) @@ -205,9 +212,9 @@ protected function updateJobId(string $jobId, string $type) } /** - * @param array $results - * @param string $type - * @param int $mediaId + * @param array $results + * @param string $type + * @param int $mediaId * @return void */ protected function updateVideoResults(array $results, string $type, int $mediaId) diff --git a/src/Traits/CanRecognizeImages.php b/src/Traits/CanRecognizeImages.php index 0f49453..b8fbb26 100644 --- a/src/Traits/CanRecognizeImages.php +++ b/src/Traits/CanRecognizeImages.php @@ -16,8 +16,7 @@ trait CanRecognizeImages /** * Set the base64 encoded image. * - * @param string $blob - * + * @param string $blob * @return $this */ public function blob(string $blob) @@ -31,6 +30,7 @@ public function blob(string $blob) * Sets the image to be analyzed. * * @return void + * * @throws \Exception */ protected function setImageSettings(): void @@ -61,9 +61,10 @@ protected function setImageSettings(): void } /** - * @param int|null $minConfidence - * @param null $maxLabels + * @param int|null $minConfidence + * @param null $maxLabels * @return mixed + * * @throws \Exception */ public function detectImageLabels($minConfidence = null, $maxLabels = null) @@ -88,8 +89,9 @@ public function detectImageLabels($minConfidence = null, $maxLabels = null) } /** - * @param array $attributes + * @param array $attributes * @return mixed + * * @throws \Exception */ public function detectImageFaces($attributes = ['DEFAULT']) @@ -110,8 +112,9 @@ public function detectImageFaces($attributes = ['DEFAULT']) } /** - * @param int|null $minConfidence + * @param int|null $minConfidence * @return mixed + * * @throws \Exception */ public function detectImageModeration($minConfidence = null) @@ -132,8 +135,9 @@ public function detectImageModeration($minConfidence = null) } /** - * @param array|null $filters + * @param array|null $filters * @return mixed + * * @throws \Exception */ public function detectImageText(array $filters = null) diff --git a/src/Traits/CanRecognizeVideos.php b/src/Traits/CanRecognizeVideos.php index ed90395..789e7d8 100644 --- a/src/Traits/CanRecognizeVideos.php +++ b/src/Traits/CanRecognizeVideos.php @@ -12,6 +12,7 @@ trait CanRecognizeVideos * * @param $type - used to create a readable identifier. * @return void + * * @throws \Exception */ protected function setVideoSettings($type): void @@ -49,9 +50,10 @@ protected function setVideoSettings($type): void /** * Starts asynchronous detection of labels/objects in a stored video. * - * @param int|null $minConfidence - * @param int $maxResults + * @param int|null $minConfidence + * @param int $maxResults * @return \Aws\Result + * * @throws \Exception */ public function detectVideoLabels($minConfidence = null, $maxResults = 1000) @@ -70,8 +72,9 @@ public function detectVideoLabels($minConfidence = null, $maxResults = 1000) } /** - * @param array $attributes + * @param array $attributes * @return mixed + * * @throws \Exception */ public function detectVideoFaces($attributes = 'DEFAULT') @@ -92,8 +95,9 @@ public function detectVideoFaces($attributes = 'DEFAULT') /** * Starts asynchronous detection of unsafe content in a stored video. * - * @param int|null $minConfidence + * @param int|null $minConfidence * @return mixed + * * @throws \Exception */ public function detectVideoModeration($minConfidence = null) @@ -114,8 +118,9 @@ public function detectVideoModeration($minConfidence = null) /** * Starts asynchronous detection of text in a stored video. * - * @param array|null $filters + * @param array|null $filters * @return mixed + * * @throws \Exception */ public function detectVideoText(array $filters = null) @@ -138,9 +143,10 @@ public function detectVideoText(array $filters = null) /** * Get the labels from the video analysis. * - * @param string $jobId - * @param int|null $mediaId + * @param string $jobId + * @param int|null $mediaId * @return \Aws\Result + * * @throws \Exception */ public function getLabelsByJobId(string $jobId, int $mediaId = null) @@ -161,9 +167,10 @@ public function getLabelsByJobId(string $jobId, int $mediaId = null) /** * Get the faces from the video analysis. * - * @param string $jobId - * @param int|null $mediaId + * @param string $jobId + * @param int|null $mediaId * @return \Aws\Result + * * @throws \Exception */ public function getFacesByJobId(string $jobId, int $mediaId = null) @@ -184,9 +191,10 @@ public function getFacesByJobId(string $jobId, int $mediaId = null) /** * Get the "content moderation" from the video analysis. * - * @param string $jobId - * @param int|null $mediaId + * @param string $jobId + * @param int|null $mediaId * @return \Aws\Result + * * @throws \Exception */ public function getContentModerationByJobId(string $jobId, int $mediaId = null) @@ -207,9 +215,10 @@ public function getContentModerationByJobId(string $jobId, int $mediaId = null) /** * Get the faces from a video analysis. * - * @param string $jobId - * @param int|null $mediaId + * @param string $jobId + * @param int|null $mediaId * @return \Aws\Result + * * @throws \Exception */ public function getTextDetectionByJobId(string $jobId, int $mediaId = null) diff --git a/src/Traits/InteractsWithStorage.php b/src/Traits/InteractsWithStorage.php index 8e4a03d..5caae98 100644 --- a/src/Traits/InteractsWithStorage.php +++ b/src/Traits/InteractsWithStorage.php @@ -35,7 +35,7 @@ trait InteractsWithStorage /** * Set which S3 disk to use. * - * @param string $disk + * @param string $disk * @return $this */ public function disk(string $disk) @@ -48,9 +48,9 @@ public function disk(string $disk) /** * The equivalent of the S3 Key / the path of the file inside the bucket. * - * @param string $source - * @param string|null $mimeType - * @param int|null $mediaId + * @param string $source + * @param string|null $mimeType + * @param int|null $mediaId * @return $this */ public function source(string $source, string $mimeType = null, int $mediaId = null) @@ -65,9 +65,9 @@ public function source(string $source, string $mimeType = null, int $mediaId = n /** * Alias of source(). * - * @param string $source - * @param string|null $mimeType - * @param int|null $mediaId + * @param string $source + * @param string|null $mimeType + * @param int|null $mediaId * @return $this */ public function path(string $source, string $mimeType = null, int $mediaId = null) @@ -79,6 +79,7 @@ public function path(string $source, string $mimeType = null, int $mediaId = nul * Ensures the source/path not to be null if it is null it will thrown an exception. * * @return void + * * @throws \Exception */ public function ensureSourceIsNotNull() diff --git a/src/Traits/Recognizable.php b/src/Traits/Recognizable.php index d5f225d..2dee056 100644 --- a/src/Traits/Recognizable.php +++ b/src/Traits/Recognizable.php @@ -20,8 +20,8 @@ public function recognition(): \Illuminate\Database\Eloquent\Relations\MorphOne /** * Start a media "recognition". * - * @param string $path - * @param string|null $mimeType + * @param string $path + * @param string|null $mimeType * @return \Meema\MediaRecognition\Contracts\MediaRecognition */ public function recognize(string $path, string $mimeType = null)