ahmadmayahi / php-google-vision

src/Detectors/Face.php

<?php

declare(strict_types=1);

namespace AhmadMayahi\Vision\Detectors;

use AhmadMayahi\Vision\Contracts\Detectable;
use AhmadMayahi\Vision\Contracts\File;
use AhmadMayahi\Vision\Data\Face as FaceData;
use AhmadMayahi\Vision\Data\Vertex as VertexData;
use AhmadMayahi\Vision\Detectors\Face\DrawBoxAroundFaces;
use AhmadMayahi\Vision\Enums\Color;
use AhmadMayahi\Vision\Enums\Likelihood;
use AhmadMayahi\Vision\Support\AbstractDetector;
use AhmadMayahi\Vision\Support\Image;
use AhmadMayahi\Vision\Traits\Arrayable;
use AhmadMayahi\Vision\Traits\Jsonable;
use Generator;
use Google\Cloud\Vision\V1\FaceAnnotation;
use Google\Cloud\Vision\V1\ImageAnnotatorClient;
use Google\Cloud\Vision\V1\Vertex;
use Google\Protobuf\Internal\RepeatedField;

/**
 * Face Detection detects multiple faces within an image along with the associated key facial attributes
 * such as emotional state or wearing headwear.
 *
 * @see https://cloud.google.com/vision/docs/detecting-faces
 */
class Face extends AbstractDetector implements Detectable
{
    use Arrayable;
    use Jsonable;

    public function __construct(protected ImageAnnotatorClient $imageAnnotatorClient, protected File $file, protected Image $image)
    {
    }

    public function getOriginalResponse(): RepeatedField
    {
        $response = $this
            ->imageAnnotatorClient
            ->faceDetection($this->file->toVisionFile());

        return $response->getFaceAnnotations();
    }

    /**
     * @return Generator|null
     */
    public function detect(): ?Generator
    {
        $faces = $this->getOriginalResponse();

        if (0 === $faces->count()) {
            return null;
        }

        /** @var FaceAnnotation $face */
        foreach ($faces as $face) {
            $vertices = $face->getBoundingPoly()->getVertices();

            $bounds = array_map(function (Vertex $vertex) {
                return new VertexData($vertex->getX(), $vertex->getY());
            }, iterator_to_array($vertices));

            yield new FaceData(
                anger: Likelihood::fromKey($face->getAngerLikelihood()),

It seems like AhmadMayahi\Vision\Enums\Likelihood::fromKey($face->getAngerLikelihood()) can also be of type null; however, parameter $anger of AhmadMayahi\Vision\Data\Face::__construct() does only seem to accept string, maybe add an additional type check?

                joy: Likelihood::fromKey($face->getJoyLikelihood()),

It seems like AhmadMayahi\Vision\Enums\Likelihood::fromKey($face->getJoyLikelihood()) can also be of type null; however, parameter $joy of AhmadMayahi\Vision\Data\Face::__construct() does only seem to accept string, maybe add an additional type check?

                surprise: Likelihood::fromKey($face->getSurpriseLikelihood()),

It seems like AhmadMayahi\Vision\Enums\Likelihood::fromKey($face->getSurpriseLikelihood()) can also be of type null; however, parameter $surprise of AhmadMayahi\Vision\Data\Face::__construct() does only seem to accept string, maybe add an additional type check?

                blurred: Likelihood::fromKey($face->getBlurredLikelihood()),

It seems like AhmadMayahi\Vision\Enums\Likelihood::fromKey($face->getBlurredLikelihood()) can also be of type null; however, parameter $blurred of AhmadMayahi\Vision\Data\Face::__construct() does only seem to accept string, maybe add an additional type check?

                headwear: Likelihood::fromKey($face->getHeadwearLikelihood()),

It seems like AhmadMayahi\Vision\Enums\Likelihood::fromKey($face->getHeadwearLikelihood()) can also be of type null; however, parameter $headwear of AhmadMayahi\Vision\Data\Face::__construct() does only seem to accept string, maybe add an additional type check?

                underExposed: Likelihood::fromKey($face->getUnderExposedLikelihood()),

It seems like AhmadMayahi\Vision\Enums\Likelihood::fromKey($face->getUnderExposedLikelihood()) can also be of type null; however, parameter $underExposed of AhmadMayahi\Vision\Data\Face::__construct() does only seem to accept string, maybe add an additional type check?

                bounds: $bounds,
                detectionConfidence: $face->getDetectionConfidence(),
                landmarking: $face->getLandmarkingConfidence(),
            );
        }
    }

    public function drawBoxAroundFaces(int $borderColor = Color::GREEN): Image
    {
        return (new DrawBoxAroundFaces($this, $this->image))
            ->borderColor($borderColor)
            ->draw();
    }
}