combodo/itop-client-bundle

iTop rest client bundle for symfony

2.1.0 2022-04-26 12:02 UTC

Requires

• php: ^7.1|^8
• guzzlehttp/guzzle: >=6.3
• mtdowling/jmespath.php: >=2.4
• symfony/framework-bundle: 4.4.* || 5.*

Requires (Dev)

• phpmd/phpmd: ^2.6
• phpunit/phpunit: ^7
• squizlabs/php_codesniffer: ^3.3

Conflicts

• symfony/symfony: <=3

AGPL-3.0-only

• bruno DA SILVA

README

iTop rest client bundle for symfony

This bundle help you consume iTop rest webservices

Installation

Step 1: Download the Bundle

Open a command console, enter your project directory and execute the following command to download the latest stable version of this bundle:

$ composer require combodo/itop-client-bundle

This command requires you to have Composer installed globally, as explained in the installation chapter of the Composer documentation.

Step 2: configure itop serveur

# app/config/config.yml
combodo_itop_client:
    servers:
        itop_server_foo:
            base_url:  "%it_combodo.base_url%"
            auth_user: "%it_combodo.auth_user%"
            auth_pwd:  "%it_combodo.auth_pwd%"
            extra_headers: "%it_combodo.extra_headers%"

This bundle will create a service named itop_client.rest_client.itop_server_foo that you can then uses in your code.

Step 3: Start using it

each operation follow the structure available in otop documentation: follow this struc: https://www.itophub.io/wiki/page?id=latest%3Aadvancedtopics%3Arest_json#operationcore_create

you can use the service container or uses service injection by adding a Combodo\ItopClientBundle\RestClient\RestClient $foo in your service constructor.

use Combodo\ItopClientBundle\RestClient\RequestOperation\Core\RequestOperationCoreCreate;
use Combodo\ItopClientBundle\RestClient\RestClient;

class Foo
{
    /**
     * @var RestClient
     */
    private $client;
    public function __construct(RestClient $client) 
    {    
        $this->client = $client;
    }

    public function bar()
    {
        $operation = new RequestOperationCoreCreate(
            'Class',
            'id',
            'my comment',
            [
                'title'             => 'foo',
                'description'       => 'bar',
                'caller_email'      => '[e-mail]',
            ]
        );
        
        $this->client->executeOperation($operation);
    }    
}