eduardostuart / face
Installs: 2 223
Dependents: 0
Suggesters: 0
Security: 0
Stars: 36
Watchers: 5
Forks: 5
Open Issues: 4
Requires
- php: >=5.6.4
- guzzlehttp/guzzle: ^6.3
- illuminate/support: ^5.4
Requires (Dev)
- graham-campbell/testbench: ^3.4
- mockery/mockery: ~0.9
- phpunit/phpunit: ~4.0|~5.0
This package is not auto-updated.
Last update: 2020-11-28 07:44:40 UTC
README
Table of contents
Installation
To get the latest version, require the project using composer:
composer require eduardostuart/face
Once installed, you need to register the Face Service provider
in your config/app.php
.
return [ // .... Face\FaceServiceProvider::class, ]
And add Face Facade into config/app.php.
return [ // .... 'Face' => Face\Facades\Face::class, ]
Configuration
To start using Laravel Face, you need to publish Face
configuration file.
php artisan vendor:publish --provider="Face\FaceServiceProvider"
You also need to add credentials (or custom settings) for services that your application utilizes. These informations should be placed in config/face.php
file.
How to use
Detect
Detect and analyzes human faces.
// ... use Face; $results = Face::detect('https://.../photo.jpg');
Albums
Create album
// ... use Face; $album = Face::createAlbum("my album name", [ "face-id-1", "face-id-2", ]); // $album->getName(); // $album->getTags(); // $album->getFaces(); // $album->toJson(); // $album->toArray();
Remove album
// ... use Face; if(Face::removeAlbum("album-id")){ echo "OK!"; }
Update album
// ... use Face; $albumUpdated = Face::updateAlbum("album-id", "new album name");
Get all albums
// ... use Face; $albums = Face::albums(); print_r($albums->toArray());
Get an album
// ... use Face; $album = Face::album("album-id"); echo $album->getName();
Add face into an album
// ... use Face; if(Face::addIntoAlbum("album-id", ["face-1-id","face-2-id"])){ echo "Added!"; }
Remove face from album
// ... use Face; if(Face::removeFaceFromAlbum("album-id", ["face-1-id","face-2-id"])){ echo "Removed!"; }
Search
Find one or more similar faces.
// ... use Face; $albumId = '1234'; $result = Face::search($albumId, 'https://.../photo.jpg'); // $result->getTotal(); // $result->getResults();
Get a Face
// ... use Face; $result = Face::getFace('face-id'); // $result->getAttributes(); // $result->getId(); // $result->getReference();
Providers
License
Face is open-sourced software licensed under the MIT license
Security
If you discover a security vulnerability within this package, please send an e-mail to Eduardo Stuart at hi@s.tuart.me. All security vulnerabilities will be promptly addressed.