update docs

alanpilloud · Apr 9, 2019 · 87549c0 · 87549c0
1 parent c0732a2
commit 87549c0
Show file tree

Hide file tree

Showing 6 changed files with 28 additions and 11 deletions.
diff --git a/docs/_sidebar.md b/docs/_sidebar.md
@@ -1,6 +1,7 @@
 * SDK
   * [Démarrage](/sdk/demarrage.md)
   * [Recherche](/sdk/recherche.md)
+  * [Object Collection](/sdk/objectCollection.md)
   * [Détail d'objet](/sdk/objet.md)
 
 * API

diff --git a/docs/sdk/demarrage.md b/docs/sdk/demarrage.md
@@ -10,15 +10,8 @@ Ajoutez ce package à votre fichier composer.json
 "repositories": [
   ...
   {
-    "type": "package",
-    "package": {
-      "name": "publimmopro/phpsdk",
-      "version": "0.1.0",
-      "dist": {
-        "type": "zip",
-        "url": "https://github.com/alanpilloud/publimmopro-sdk-php/archive/master.zip"
-      }
-    }
+    "type": "vcs",
+    "url": "[email protected]:alanpilloud/publimmopro-sdk-php.git"
   }
   ...
 ],

diff --git a/docs/sdk/objectCollection.md b/docs/sdk/objectCollection.md
@@ -0,0 +1,3 @@
+# Object Collection
+
+`PublimmoPro\ObjectCollection` est une classe représentant une liste d'objets obtenue lors d'une recherche.
diff --git a/docs/sdk/recherche.md b/docs/sdk/recherche.md
@@ -1,10 +1,12 @@
 # Recherche
 
 ```php
+use \PublimmoPro\Client;
+
 $Client = new Client('2121313', 'unecle');
 
 $Client->setType(Client::PARKING)
-       ->setDisponiblite(AVAILABILITY_IS_AVAILABLE)
+       ->setDisponiblite(Client::AVAILABILITY_IS_AVAILABLE)
        ->query();
 ```
 

diff --git a/src/PublimmoPro/ObjectCollection.php b/src/PublimmoPro/ObjectCollection.php
@@ -36,7 +36,8 @@ public function get()
      *
      * @return mixed                       false or ObjectCollection
      */
-    public function filter(string $filter_type, $objects_to_filter){
+    public function filter(string $filter_type, $objects_to_filter)
+    {
         if (empty($objects_to_filter)){
             return false;
         }

diff --git a/tests/ObjectCollection.php b/tests/ObjectCollection.php
@@ -0,0 +1,17 @@
+<?php
+use PHPUnit\Framework\TestCase;
+use \PublimmoPro\ObjectCollection;
+
+final class ObjectCollectionTest extends TestCase
+{
+    private $queryResults;
+
+    public function setUp(): void
+    {
+        $this->queryResults = file_get_contents('resultdata.json');
+    }
+
+    public function testConstantsAreCorrectlySet(): void
+    {
+    }
+}
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# Object Collection

		`PublimmoPro\ObjectCollection` est une classe représentant une liste d'objets obtenue lors d'une recherche.