README

Professional API consumer/receiver (Consumidor profissional de API)

This component have two features (Suported methods):

GET (to get all - para receber todos)
PATCH (to get one - para receber um)
POST (add new element - adicionar novo elemento)
PUT (update one elemet - actualizar um alemento)
DELETE (delete one element - eliminar um elemento)

Important

All methods return object, if no receive data in 15 s, or to happen one error return object:

class stdClass#5 (2) {
  public $status => int(500)
  public $message => string(21) "Internal Server Error"
}

Require

Necessary PHP 8.0 or more, ext-curl 7.81.0 or more (Necessário PHP 8.0 ou superior, ext-curl 7.81.0 ou superior)

Install

composer require ngomafortuna/apireceiver

Syntax and mode of use

$client = new CurlAPIClient($url);

var_dump($client->get());

Example

use Ngomafortuna\Apireceiver\CurlAPIClient;

require_once PATH . '/vendor/autoload.php';

$url = "url/api"; // set url

$client = new CurlAPIClient($url);

// GET
var_dump($client->get()); 

// PATCH 
$data = ['id' => 29];
var_dump($client->patch($data));

// POST 
$data = [
    'name' => 'Minha Rosa',
    'email' => 'minha.rosa@lovecorp.ao' 
  ];
var_dump($client->post($data));

// PUT 
$data = [
    'id' => 30,
    'name' => 'Minha Rosa Updated',
    'email' => 'minha.rosa@lovecorp.ao'  
  ];
var_dump($client->put($data));

// DELETE
$data = ['id' => 30];
var_dump($client->delete($data));

Results

// GET result
class stdClass#34 (2) {
  public $data =>
  class stdClass#32 (27) {
    public $0 => class stdClass#5 (3) {
      public $id => int(27)
      public $name => string(13) "Ngoma Fortuna"
      public $email => string(21) "ngoma.fortuna@mtec.ao"
    }
    public $1 => class stdClass#6 (3) {
      public $id => int(28)
      public $name => string(12) "Rosa Fortuna"
      public $email => string(20) "rosa.fortuna@mtec.ao"
    }
    public $2 => class stdClass#7 (3) {
      public $id => int(29)
      public $name => string(17) "Lucrécia Fortuna"
      public $email => string(24) "lucrecia.fortuna@mtec.ao"
    }
  }
  public $status =>
  class stdClass#33 (2) {
    public $number => int(200)
    public $message => string(12) "OK (Success)"
  }
}


class stdClass#32 (27) {
}
...

// PATCH
class stdClass#7 (2) {
  public $data =>
    class stdClass#5 (3) {
      public $id => int(29)
      public $name => string(17) "Lucrécia Fortuna"
      public $email => string(24) "lucrecia.fortuna@mtec.ao"
    }
  public $status =>
    class stdClass#6 (2) {
      public $number => int(200)
      public $message => string(12) "OK (Success)"
    }
}

// POST
class stdClass#7 (2) {
  public $data =>
    class stdClass#5 (1) {
      public $message => string(25) "User created successfully"
    }
  public $status =>
    class stdClass#6 (2) {
      public $number => int(200)
      public $message => string(12) "OK (Success)"
    }
}

// PUT
class stdClass#7 (2) {
  public $data =>
    class stdClass#5 (1) {
      public $message => string(25) "User updated successfully"
    }
  public $status =>
    class stdClass#6 (2) {
      public $number => int(200)
      public $message => string(12) "OK (Success)"
    }
}

// DELETE
class stdClass#7 (2) {
  public $data =>
    class stdClass#5 (1) {
      public $message => string(25) "User deleted successfully"
    }
  public $status =>
    class stdClass#6 (2) {
      public $number => int(200)
      public $message => string(12) "OK (Success)"
    }
}

ngomafortuna / apireceiver

Maintainers

Details