# Fonctions

Liste des divers fonctionnalités de l'objet Sirene.

# Informations

La fonction informations() vous permet de connaître l'état du service de l'API.

<?php
$result = $sirene->informations();

Le resultat retourne un tableau comme ceci :

array(5) {
  'etatService' =>
  string(2) "UP"
  'etatsDesServices' =>
  array(2) {
    'Collection' =>
    string(6) "string"
    'etatCollection' =>
    string(2) "UP"
  }
    ...
}

# Siren

La fonction siren(string $siren) vous permet de faire une recherche depuis un siren donné, les informations d'un ou plusieurs établissements vous seront donnez dans le tableau uniteLegale.

<?php
$result = $sirene->siren("<siren>");

Le resultat retourne un tableau comme ceci :

array(2) {
  'header' =>
  array(2) {
    'statut' =>
    int(200)
    'message' =>
    string(2) "OK"
  }
  'uniteLegale' =>
  array(x) {
    ...
  }
}

# Siret

La fonction siret(string $siren) vous permet de faire une recherche depuis un siret donné, les informations de l'établissement vous seront donnez dans le tableau etablissement.

<?php
$result = $sirene->siret("<siret>");

Le resultat retourne un tableau comme ceci si résultat trouvé:

array(2) {
  'header' =>
  array(2) {
    'statut' =>
    int(200)
    'message' =>
    string(2) "ok"
  }
  'etablissement' =>
  array(x) {
    ...
  }
}

# SearchEtablissement

La fonction searchEtablissement(array $params) vous permet de faire des recherches d'établissements avec des paramètres, les informations des établissements vous seront donnez dans le tableau etablissements, vous disposez aussi du nombre de résultat dans le tableau header.

<?php
$params = [
    "city" => "Bordeaux",
    "cp" => "33000"
];
$result = $sirene->searchEtablissement($params);

Le resultat retourne un tableau comme ceci si résultat trouvé:

array(2) {
  'header' =>
  array(5) {
    'statut' =>
    int(200)
    'message' =>
    string(2) "OK"
    'total' =>
    int(111937)
    'debut' =>
    int(0)
    'nombre' =>
    int(20)
  }
  'etablissements' =>
  array(20) {
    ...
  }
}

Voici les différents paramètres disponibles, chaque clé a une référence dans l'API sirene:

$list = [
    "city" => "libelleCommuneEtablissement",
    "cp" => "codePostalEtablissement",
    "company" => "denominationUniteLegale",
    "sigle" => "sigleUniteLegale",
    "ape" => "activitePrincipaleUniteLegale",
    "cj" => "categorieJuridiqueUniteLegale"
];

# Pagination

Avec cette même fonction searchEtablissement(array $params, string $tri = "siren", int $page = 0, int $nombre = 20), vous pouvez définir le nombre de résultat par page et l'ordre de tri par champ:

$result = $Sirene->searchEtablissement([
    "city" => "BORDEAUX"
], "siret", 0, 5);

Ici je tri par siret, affichage de la page 0 pour 5 résultats par page.

← Introduction