Download the PHP package devsyril/tg-cni-reader without Composer

On this page you can find all versions of the php package devsyril/tg-cni-reader. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Informations about the package tg-cni-reader

tg-document-reader

Togolese Identity Documents OCR Processor — Extrait et valide les données des pièces d'identité togolaises par OCR.

PHP Licence


Table des matières


Présentation

tg-document-reader est une bibliothèque PHP qui utilise Tesseract OCR pour lire automatiquement les informations sur les pièces d'identité togolaises :

La bibliothèque extrait, structure et valide l'ensemble des champs présents sur chaque document.


Fonctionnalités


Documents supportés

Document Faces MRZ Formats image supportés
CNI Recto + Verso TD1 (3 lignes, I<...) JPEG, PNG, PDF
Passeport Recto uniquement TD3 (2 lignes, P<...) JPEG, PNG, PDF
Permis de conduire Recto + Verso Aucun JPEG, PNG, PDF

Prérequis système

Logiciel Rôle Installation
PHP >= 8.1 Langage d'exécution php.net
Composer Gestionnaire de dépendances PHP getcomposer.org
Tesseract OCR Moteur OCR GitHub UB-Mannheim (Windows), sudo apt install tesseract-ocr (Linux), brew install tesseract (macOS)
Données linguistiques françaises Reconnaissance du français Inclus dans tessdata/fra.traineddata
Ghostscript Conversion PDF → image (optionnel) ghostscript.com
Extension PHP GD ou Imagick Manipulation d'images Incluse par défaut (GD)

Installation


Utilisation

1. Syntaxe de base

2. CNI (Carte Nationale d'Identité)

Champs CNI : card_number, last_name, first_name, birth_date, sex, birth_place, birth_prefecture, profession, issue_date, expiry_date, police_office_number, size, blood_type, address, tel, particular_sign, document_number, father_first_name, father_last_name, mother_first_name, mother_last_name, person_to_contact_name, person_to_contact_address, person_to_contact_tel, country.

3. Permis de conduire

Champs permis : last_name, first_name, birth_date, sex, birth_place, issue_date, expiry_date, license_number, categories, genre, blood_type, nationality, address, restrictions, cni_or_passport_number.

4. Passeport

Champs passeport (MRZ) : passport_number, last_name, first_name, birth_date, sex, expiry_date, issuing_country, nationality, personal_number.

Champs passeport (texte visible) : full_name_visible, given_names_visible, birth_date_visible, birth_place_visible, issue_date_visible, expiry_date_visible, profession_visible, authority_visible.

5. Détection automatique du type de document

6. Accès aux données extraites

Chaque champ est un objet ValueStat contenant :


Architecture du package

Structure des dossiers

Diagramme de dépendances

Chaque driver :

  1. Reçoit les chemins d'images (1 ou 2 selon le type)
  2. Exécute l'OCR via ImageReader
  3. Parse les lignes texte avec son parseur dédié
  4. Valide les données avec son validateur dédié
  5. Retourne un DocumentResult normalisé

Tests

Structure des tests

Dossier Contenu Description
tests/Unit/ Cni*Test, License*Test, Passport*Test, MrzParserTest, DicsTest, DocumentProcessorFactoryTest Tests unitaires par driver
tests/Integration/ CniFixturesTest, CniPipelineTest Tests d'intégration avec données OCR réelles

48 tests au total, couvrant :


Dépendances

Production

Package Version Rôle
php >=8.1 Langage d'exécution
thiagoalessio/tesseract_ocr ^2.13 Wrapper PHP pour Tesseract OCR
spatie/pdf-to-image ^3.0 Conversion PDF → image
intervention/image ^3.0 Manipulation d'images
ramsey/uuid ^4.7 Génération d'UUID

Développement

Package Version Rôle
phpunit/phpunit ^11.0 Framework de tests unitaires

Licence

Ce projet est distribué sous licence MIT.


All versions of tg-cni-reader with dependencies

PHP Build Version
Package Version
Requires php Version >=8.1
thiagoalessio/tesseract_ocr Version ^2.13
spatie/pdf-to-image Version ^3.0
intervention/image Version ^3.0
ramsey/uuid Version ^4.7
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package devsyril/tg-cni-reader contains the following files

Loading the files please wait ...