dorian/collection

"Implmentation du concept de Collection"

1.0.1 2018-01-20 08:49 UTC

Requires (Dev)

• phpunit/phpunit: ^6.5

MIT

• Dorian Grelu

README

1. Description

L'object Collection hérite de la logique des collections d'objets communs à différents langages comme JAVA, C# etc... L'avantage d'utiliser ce type d'objet est de pouvoir appliquer une certaine logique, comme le classement, et pourquoi pas la pile et la file de priorité. Une implémentation de l'interface Comparable avec la méthode compareTo a été efefctuée. Cela permet de classer automatiquement si on le désire, une collection d'objet de même type. Ce concept est hérité de JAVA et permet de classer rapidement et simplement une Collection, sans avoir à écrire des tones et des tones de code. De plus le trie effectué sur la Collection utilise l'algorithme Quick Sort qui offre une bonne compléxité pour ce type d'opération.

2. Installation

Pour utiliser cette librairie, il suffit d'utiliser composer:

composer require dorian/collection

3. Utilisation

1. Contexte

   Il est impératif d'utiliser l'autoloader de composer:

   Dans un premier temps il est donc necessaire d'initialiser composer via la commande composer init. Cette commande permet l'initialisation d'un projet utilisant ce gestionnaire de dépendance. Il faut donc ensuite executer la commande suivante:

   composer require dorian/collection
   

   Il faut ensuite inclre l'autloader de composer en intégrant dans votre fichier PHP:

   require '/vendor/autoload.php';
   

2. Création d'une nouvelle Collection simple sans paramètre:

   use Dorian\Collection\Collection;
   
   $uneCollection= new Collection();
   $uneCollection->add("bonjour");   
   $uneCollection->add(22);   
   var_dump($uneCollection->toArray());
   
   
   /* Affiche 
   [
      "bonjour",
      22
   ]
   */

   Le constructeur de la Class Collection prends peut prendre deux tableaux en paramètre.

   /**
   * Collection constructor.
   * @param array|null $params
   */
   public function __construct(?array $params=[]);

   Le premier paramètre $array peut créer une collection à partie d'un tableau existant.

   Le second paramètre $params prends en paramètres les différents paramètres comme le type d'objets contenu dans la collection, ou bien si l'on veut activer l'auto-sort. Voici la structure du tableau de paramètres:

   private $params = [
      "isJson" => false, //Création de la collection à partir d'une chaine json
      "sorted" => false, //auto-sort désactivé par défaut 
      "comparable" => false, //Trier des éléments de type Comparable
      "type" => null //Type d'éléments de la collection
    ];

3. Création d'une collection Auto-sort

   Il existe la possibilité de créer une collection auto-triée. De la sorte à ce que lors de l'ajout ou modification d'un élément dans la collection, cette dernière soit capable de placer l'élément dans la bonne case. La collection sera triée dans l'ordre croissant. Si la collection est composée d'élements de type comparable, cette dernière sera triée par le biais de l'algorithme quick sort.

   //Collection auto-triée composée d'éléments Mixed
       $collection = new Collection([
          "sorted"=>true,
          "comparable"=>false
       ]);
   
   //Collection auto-triée composée d'éléments Comparable
       $collection = new Collection([], [
          "sorted"=>true,
          "comparable"=>true
       ]);

   Pour que des objets soient de type Comparable il suffit d'implémenter l'interface Comparable imposant la définition de la méthode compareTo.

   Voici la signature de la méthode:

      /**
      * Doit retourner:
      * -1 si l'élement courant est plus petit
      * 0 si lesdeux éléments sont égaux
      * 1 si l'élement courant est plus grand
      **/
      public function compareTo($object):int

4. Trie d'une collection non auto-triée

   Il est possible de trier une collection si cette dernière ne l'est pas de manière automatique.

       $collection = new Collection();
       $collection->add(10);
       $collection->add(1);
       $collection->add(5);
       $collection->sort(); //trie manuel de la collection

   Il y a possibilité de forcer le tri d'une collection classique par le biais d'éléments comparables.

      $collection = new Collection();
      $collection->add(new Object1());
      $collection->add(new Object2());
      $collection->add(new Object3());
      $collection->sort(true); //trie manuel de la collection

   Il suffit de donner la valeur true à la méthode sort qui forcera le trie par le biais de comparable. Si le type comparable est définit de bas eil n'est pas nécéssaire de mettre ce paramètre à true.

       $collection = new Collection(["comparable"=>true]);
       $collection->add(new Object1());
       $collection->add(new Object2());
       $collection->add(new Object3());
       $collection->sort(true); //trie manuel de la collection

5. Valorisation d'une collection

   Il est très simple de valoriser une collection, et plusieurs méthodes peuvent être utilisées.

      $collection =  new Collection(["type"=>"string"]);
      $collection->add("Dorian");
      $collection->add("Michel");
      $collection->add("Samuel");
   
      //Vérifier si la collection contient un objet
      $collection->contains("Dorian");
   
      //récupérer les valeurs
      $collection->getObject("Samuel");
      $collection->get(2);
   
      //Vérifier si une clef existe
      $collection->exist(0);
   
      //Suppression
      $collection->removeObject("Dorian");
      $collection->remove(1);
      $collection->removeAll();
   
      //Clonage
      $collectionClonee = $collection->clone();