Mise à jour de la documentation.

soosyze · May 1, 2021 · 022935a · 022935a
1 parent cdcdc77
commit 022935a
Show file tree

Hide file tree

Showing 3 changed files with 26 additions and 52 deletions.
diff --git a/README.md b/README.md
@@ -29,11 +29,13 @@ Manipulate your data with a QueryBuilder similar to SQL syntax.
 
 Support more than [85% of current PHP versions](https://w3techs.com/technologies/details/pl-php)
 
-| Version PHP                 | QueryFlatFile 1.4.x |
-|-----------------------------|---------------------|
-| <= 5.5                      | ✗ Unsupported       |
-| 5.6                         | ✓ Supported         |
-| 7.0 / 7.1 / 7.2 / 7.3 / 7.4 | ✓ Supported         |
+| Version PHP     | QueryFlatFile 1.4.x | QueryFlatFile 2.x |
+|-----------------|---------------------|-------------------|
+| <= 5.5          | ✗ Unsupported       | ✗ Unsupported     |
+| 5.6             | ✓ Supported         | ✗ Unsupported     |
+| 7.0 / 7.1       | ✓ Supported         | ✗ Unsupported     |
+| 7.2 / 7.3 / 7.4 | ✓ Supported         | ✓ Supported       |
+| 8.0             | ✗ Unsupported       | ✓ Supported       |
 
 ## Extensions
 
@@ -45,7 +47,6 @@ Support more than [85% of current PHP versions](https://w3techs.com/technologies
 ## Memory required
 
 The minimum amount of memory required depends on the amount of data you are going to process and the type of operations.
-To gain performance use the PHP 7.x versions and the `MsgPack` or `Igbinary` driver.
 
 ## Permission of files and directory
 
@@ -76,7 +77,7 @@ use Queryflatfile\Request;
 use Queryflatfile\TableBuilder;
 use Queryflatfile\Driver\Json;
 
-$bdd = new Schema('data', 'schema', new Json());
+$bdd = new Schema(__DIR__ . 'data', 'schema', new Json());
 $req = new Request($bdd);
 
 $bdd->createTableIfNotExists('user', function(TableBuilder $table){

diff --git a/README_fr.md b/README_fr.md
@@ -29,11 +29,13 @@ Manipulez vos données avec un QueryBuilder similaire à la syntaxe SQL.
 
 Support plus de [85% des versions PHP actuelles](https://w3techs.com/technologies/details/pl-php)
 
-| Version PHP                 | QueryFlatFile 1.4.x |
-|-----------------------------|---------------------|
-| <= 5.5                      | ✗ Non supporté      |
-| 5.6                         | ✓ Supporté          |
-| 7.0 / 7.1 / 7.2 / 7.3 / 7.4 | ✓ Supporté          |
+| Version PHP     | QueryFlatFile 1.4.x | QueryFlatFile 2.x |
+|-----------------|---------------------|-------------------|
+| <= 5.5          | ✗ Non supporté      | ✗ Non supporté    |
+| 5.6             | ✓ Supporté          | ✗ Non supporté    |
+| 7.0 / 7.1       | ✓ Supporté          | ✗ Non supporté    |
+| 7.2 / 7.3 / 7.4 | ✓ Supporté          | ✓ Supporté        |
+| 8.0             | ✗ Non supporté      | ✓ Supporté        |
 
 ## Extensions PHP
 

diff --git a/USAGE.md b/USAGE.md
@@ -354,14 +354,6 @@ Résultat(s) de la requête :
 |--------|
 | DUPOND |
 
-Si vous ne précisez pas la condition elle sera par défaut à `=`
-```php
-$request->select( 'name' )
-    ->from('user')
-    ->where('firstname', 'Jean')
-    ->fetch();
-```
-
 ### Where not equals
 
 Requête au format SQL :
@@ -788,13 +780,15 @@ Résultat(s) de la requête :
 
 ```php
 /**
- * @param string $table le nom de la table à joindre
- * @param string|Closure $column le nom de la colonne d'une des tables précédentes
- * ou une closure pour affiner les conditions
- * @param string|null $operator l'opérateur logique ou null pour une closure
- * @param string|null $value valeur
- * ou une colonne de la table jointe (au format nom_table.colonne)
- * ou null pour une closure
+ *
+ * @param string          $type     Type de la jointure.
+ * @param string          $table    Nom de la table à joindre
+ * @param string|\Closure $column   Nom de la colonne d'une des tables précédentes
+ *                                  ou une closure pour affiner les conditions.
+ * @param string|null     $operator Opérateur logique ou null pour une closure.
+ * @param string|null     $value    Valeur
+ *                                  ou une colonne de la table jointe (au format nom_table.colonne)
+ *                                  ou null pour une closure.
  */
 public function leftJoin( $table, $column, $operator = null, $value = null );
 public function rightJoin( $table, $column, $operator = null, $value = null );
@@ -1151,33 +1145,10 @@ interface DriverInterface
 Une fois votre propre driver créé, utiliser le à l'instanciation de votre base de données.
 ```php
 $bdd = new Queryflatfile\Schema();
-// En ne renseignant pas le dernier paramètre (le driver) les données seront stockées au format JSON par défaut
 $bdd->setConfig('data', 'schema', new Queryflatfile\DriverFormatX());
 ```
 
-Vous pouvez choisir d'hériter de la class `Queryflatfile\Dirver` au lieu d'implémenter l'interface.
-Cette class fournit un ensemble de méthode qui facilitera votre développement.
-```php
-
-# Queryflatfile\Dirver
-
-/* Implementation avec unlink() */
-$this->delete( $path, $fileName );
-/* Implementation avec getFile() */
-$this->has( $path, $fileName );
-/* Concatène le chemin, le nom du fichier et l'extension */
-$this->getFile( $path, $file );
-/* Déclenche une exception si le fichier n'existe pas */
-$this->isExist( $file )
-/* Déclenche une exception si le fichier n'a pas le droit d'écriture */
-$this->isWrite( $file );
-/* Déclenche une exception si le fichier n'a pas le droit d'être lu */
-$this->isRead( $file );
-```
-
-Il existe une deux autres implementations :
+Il existe une trois autres implementations :
 - `Txt` enregistrent le données dans un fichier texte,
 - `MsgPack` enregistrent le données en binaire grâce à l'extension `MsgPack`,
-- `Igbinary` enregistrent le données en binaire grâce à l'extension `Igbinary`.
-
-Cette interface sérialise vos données et les enregistres sous le format texte.
+- `Igbinary` enregistrent le données en binaire grâce à l'extension `Igbinary`.