meemalabs / laravel-media-recognition

src/Traits/CanRecognizeImages.php

<?php

namespace Meema\MediaRecognition\Traits;

use Exception;

trait CanRecognizeImages
{
    /**
     * The input image as base64-encoded bytes.
     *
     * @var string|null
     */
    protected ?string $blob = null;

    /**
     * Set the base64 encoded image.
     *
     * @param string $blob
     *
     * @return $this
     */
    public function blob(string $blob)
    {
        $this->blob = $blob;

        return $this;
    }

    /**
     * Sets the image to be analyzed.
     *
     * @return void
     * @throws \Exception
     */
    protected function setImageSettings(): void
    {
        $this->ensureSourceIsNotNull();

It seems like ensureSourceIsNotNull() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        if (is_string($this->blob)) {
            $this->settings['Image'] = [

The property settings does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

                'Bytes' => $this->blob,
            ];

            return;
        }

        $disk = $this->disk ?? config('media-recognition.disk');
        $bucketName = config("filesystems.disks.$disk.bucket");

        if (! $bucketName) {
            throw new Exception('Please make sure to set a S3 bucket name.');
        }

        $this->settings['Image'] = [
            'S3Object' => [
                'Bucket' => $bucketName,
                'Name' => $this->source,
            ],
        ];
    }

    /**
     * @param int|null $minConfidence
     * @param null $maxLabels

Are you sure the doc-type for parameter $maxLabels is correct as it would always require null to be passed?

     * @return mixed
     * @throws \Exception
     */
    public function detectImageLabels($minConfidence = null, $maxLabels = null)
    {
        $this->setImageSettings();

        $this->settings['MinConfidence'] = $minConfidence ?? config('media-recognition.min_confidence');

The property settings does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

        if (is_int($maxLabels)) {

The condition is_int($maxLabels) is always false.

            $this->settings['MaxLabels'] = $maxLabels;
        }

        $results = $this->client->detectLabels($this->settings);

        if (is_null($this->mediaId)) {
            return $results;
        }

        $this->updateOrCreate('labels', $results);

It seems like updateOrCreate() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        return $results;
    }

    /**
     * @param array $attributes
     * @return mixed
     * @throws \Exception
     */
    public function detectImageFaces($attributes = ['DEFAULT'])
    {
        $this->setImageSettings();

        $this->settings['Attributes'] = $attributes;

The property settings does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

        $results = $this->client->detectFaces($this->settings);

        if (is_null($this->mediaId)) {
            return $results;
        }

        $this->updateOrCreate('faces', $results);

        return $results;
    }

    /**
     * @param int|null $minConfidence
     * @return mixed
     * @throws \Exception
     */
    public function detectImageModeration($minConfidence = null)
    {
        $this->setImageSettings();

        $this->settings['MinConfidence'] = $minConfidence ?? config('media-recognition.min_confidence');

The property settings does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

        $results = $this->client->detectModerationLabels($this->settings);

        if (is_null($this->mediaId)) {
            return $results;
        }

        $this->updateOrCreate('moderation', $results);

        return $results;
    }

    /**
     * @param array|null $filters
     * @return mixed
     * @throws \Exception
     */
    public function detectImageText(array $filters = null)
    {
        $this->setImageSettings();

        if (is_array($filters)) {
            $this->settings['Filters'] = $filters;

The property settings does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

        }

        $results = $this->client->detectText($this->settings);

        if (is_null($this->mediaId)) {
            return $results;
        }

        $this->updateOrCreate('ocr', $results);

        return $results;
    }
}