Getting started

This guide will explain how to get started with JsonMapper. With JsonMapper the goal is to map a JSON response to a PHP object. In this guide we will be using the Chuck Norris facts API. For more details on the API see https://api.chucknorris.io

In order to get the JSON data we need to call https://api.chucknorris.io/jokes/random which will return the following structure:

{
    "icon_url" : "https://assets.chucknorris.host/img/avatar/chuck-norris.png",
    "id" : "1UfPOdHSTvqXGQWlqfyoKw",
    "url" : "https://api.chucknorris.io/jokes/1UfPOdHSTvqXGQWlqfyoKw",
    "value" : "Chuck Norris doesn't get old, he levels up."
}

From that structure a PHP object can be derived

<?php
 
class ChuckNorrisFact
{
    public string $icon_url;
    public string $id;
    public string $url;
    public string $value;
}

Mapping the JSON to the PHP object is now very simple with the use of JsonMapper

<?php
 
// Fetch the data from the api endpoint
$data = file_get_contents('https://api.chucknorris.io/jokes/random');
 
// Create a mapper for a Chuck Norris fact
$mapper = (new \JsonMapper\JsonMapperFactory())->bestFit();
$chuckNorrisFact = new ChuckNorrisFact();
 
// Map the data using JsonMapper
$mapper->mapObjectFromString($data, $chuckNorrisFact);