Informations
Contenu

Client de recherche

use \PublimmoPro\Client;

$Client = new Client('2121313', 'unecle');

$Client->setType(Client::PARKING)
       ->setDisponiblite(Client::AVAILABILITY_IS_AVAILABLE)
       ->query();

// ou obtenir un objet directement
$Client->query(43242);

Initialisation

Utilisez la classe PublimmoPro\Client pour pouvoir faire des requêtes à l'API.

use \PublimmoPro\Client;

// Indiquez l'ID d'agence Publimmo, et sa clé
$PublimmoClient = new Client(99999, 'key');

Méthodes

query(int $id = null)

Envoie la requête au webservice et récupère les résultats.

Paramètres

Param Type Description
$id int Optionnel, identifiant de l'objet à chercher

Retour

Pour les requêtes d'objet, une instance de PublimmoPro\ObjectEntity est retournée ou false si la requête n'a pas retourné de résultat.

Pour les requêtes de recherche, Une instance de PublimmoPro\ObjectCollection est retournée ou false si la requête n'a pas retourné de résultat.

Exemple

$Client->query(43284); // retourne un objet ObjectEntity

$Client->query(); // retourne un objet ObjectCollection

getQueryURL()

Retourne l'URL de la requête générée.

Paramètres

Pas de paramètres

Exemple

echo $Client->getQueryURL();

setCity(string $city)

Fonctionnement à vérifier

Permet de définir la localité dans laquelle effectuer la recherche.

Paramètres

Param Type Description
$city string Nom de la ville

Exemple

$Client->setCity('Lausanne');

setCityId(int $cityId)

Définit dans quelle ville rechercher.

Paramètres

Param Type Description
$cityId int Identifiant de la ville, se référer à la liste des communes ou à la recherche de communes

Exemple

$Client->setCityId(481);

setCountry(string $countryCode)

Définit le pays dans lequel les objets doivent être recherchés.

Paramètres

Param Type Description
$countryCode string Pays au format ISO 3166-alpha2. Exemple: 'fr', 'ch' ou 'de'

Exemple

$Client->setCountry('fr');

setCourtierId(int $id)

Définit l'identifiant du courtier afin de ne retourner que ses objets.

Paramètres

Param Type Description
$id int Identifiant du courtier

Exemple

$Client->setCourtierId(58495);

setDisponiblite(int $disponibility)

Définit la disponiblitité des objets à retourner.

Paramètres

Param Type Description
$disponiblitity int Identifiant de disponibilité

Constantes

  • Client::AVAILABILITY_IS_AVAILABLE
  • Client::AVAILABILITY_IS_RESERVED
  • Client::AVAILABILITY_IS_SOLD
  • Client::AVAILABILITY_IS_OPTION

Exemple

$Client->setDisponiblite(Client::AVAILABILITY_IS_AVAILABLE);

setDistance(int $distance)

Définit le rayon de recherche en km. Fonctionne de paire avec setCityId.

Paramètres

Param Type Description
$distance int Rayon de recherche

Exemple

$Client->setCityId(481)->setDistance(20);

setForeigners()

Définit que la recherche doit retourner les objets disponibles à la vente aux étrangers.

Paramètres

Pas de paramètres

Exemple

$Client->setForeigners();

setReference($ref)

Définit l'identifiant Publimmo ou la référence agence de l'objet à chercher.

Paramètres

Param Type Description
$ref mixed Identifiant Publimmo ou référence d'agence

Exemple

$Client->setReference(54589);
$Client->setReference('Villa 34');

setIds(int ...$ids)

Définit une liste d'identifiants d'objets à récupérer.

Paramètres

Param Type Description
$ids int Liste d'identifiants

Exemple

$Client->setIds(45894, 23489, 45495);

setLanguage(string $ul)

Définit la langue utilisateur.

Paramètres

Param Type Description
$ul string Langue au format ISO 3166-alpha2. Valeurs possibles : 'de', 'fr' ou 'en'

Exemple

$Client->setLanguage('de');

setLocationType(int $type)

Définit la durée du contrat de location.

Paramètres

Param Type Description
$type int Type de durée

Constantes

  • Client::LOCATION_TYPE_WEEK : Location à la semaine
  • Client::LOCATION_TYPE_SEASON : Location à la saison
  • Client::LOCATION_TYPE_YEAR : Location à l'année

Exemple

$Client->setLocationType(Client::LOCATION_TYPE_WEEK);

setNpaOrder(int $npaOrder)

Définit l'ordre des résultats en commencant par le Numréro Postal d'Acheminement spécifié.

Paramètres

Param Type Description
$npaOrder int NPA de la commune

Exemple

$Client->setNpaOrder(1800);

setRange(string $type, int $min, int $max)

Définit une fourchette de prix, surface ou chambres.

Paramètres

Param Type Description
$type string Type de valeur, "price", "surface" ou "room"
$min int Prix minimum désiré
$max int Prix maximum désiré

Exemple

$Client->setRange("price", 2000, 2900);

// définir plusieurs fourchettes
$Client->setRange("price", 2000, 2900)
       ->setRange("room", 3, 6);

setPromotionType(int $type)

Définit le type de promotion à récupérer.

Paramètres

Param Type Description
$type int Type de promotion

Constantes

  • Client::PROMOTION_TYPE_PROMOTION : retourne les objets dont le type est "promotion"
  • Client::PROMOTION_TYPE_NEW : retourne les objets de promotion et les appartments et maisons neuves
  • Client::PROMOTION_TYPE_NOT_PROMOTION : retourne les objets dont le type n'est pas "promotion"

Exemple

$Client->setPromotionType(Client::PROMOTION_TYPE_NEW);

setRegion(int $region)

Définit de quelle région doivent provenir les objets.

Paramètres

Param Type Description
$region int Identifiant de la région, se référer à la liste des régions

Exemple

$Client->setRegion(8);

setResidenceSecondaire(bool $state)

Définit si on souhaite obtenir des objets disponibles à la vente en résidence secondaire.

Paramètres

Param Type Description
$state bool true inclut les objets disponibles à la vente en résidence secondaire
false les exclut

Exemple

$Client->setResidenceSecondaire(true);

setSearchString(string $searchString)

Permet de définir un mot-clé de recherche.

Paramètres

Param Type Description
$searchString string Mot-clé à rechercher

Exemple

$Client->setSearchString('piscine');

setSelfOnly()

Fonction de réseau

Permet de ne récupérer que les résultats de l'agence, sans ceux du réseau.

Paramètres

Pas de paramètres

Exemple

$Client->selfOnly();

setOrder(int $sortBy, string $sortDirection = null)

Permet de définir le critère de tri et l'ordre.

Paramètres

Param Type Description
$sortBy int Critère de tri
$sortDirection string Optionnel, sens du tri, accepte 'asc' ou 'desc'

Constantes

  • Client::SORT_BY_PRICE
  • Client::SORT_BY_ROOMS
  • Client::SORT_BY_SURFACE
  • Client::SORT_BY_CREATED_AT

Exemple

$Client->setSort(Client::SORT_BY_PRICE);

$Client->setSort(Client::SORT_BY_PRICE, 'asc');

setTransaction(int $transaction)

Définit le type de transaction, acheter ou louer.

Paramètres

Param Type Description
$transaction int Type de transaction

Constantes de transaction

  • Client::BUY
  • Client::RENT

Exemple

$Client->setTransaction(Client::BUY);

setType(int ...$types)

Permet de faire une recherche d'objets selon les critères définis.

Paramètres

Param Type Description
$types int Liste de types, 1 à 6 types possibles

Constantes de types

  • Client::APPARTMENT
  • Client::BUILDING
  • Client::COMMERCIAL
  • Client::HOUSE
  • Client::LAND
  • Client::PARKING

Exemple

$Client->setType(Client::APPARTMENT,Client::HOUSE);​
Retour en haut