IntegrationService Class Reference

Inheritance diagram for IntegrationService:

Public Member Functions
	__construct (IntegrationFactory $integrationFactory, IntegrationOauthService $oauthService)
	create (array $integrationData)
	update (array $integrationData)
	delete ($integrationId)
	get ($integrationId)
	findByName ($name)
	findByConsumerId ($consumerId)
	findActiveIntegrationByConsumerId ($consumerId)
	getSelectedResources ($integrationId)

Protected Member Functions
	_loadIntegrationById ($integrationId)
	_addOauthConsumerData (IntegrationModel $integration)
	_addOauthTokenData (IntegrationModel $integration)

Protected Attributes
	$_integrationFactory
	$_oauthService

Detailed Description

Integration Service.

This service is used to interact with integrations.

Definition at line 19 of file IntegrationService.php.

Constructor & Destructor Documentation

__construct()

__construct	(	IntegrationFactory	$integrationFactory,
		IntegrationOauthService	$oauthService
	)

Construct and initialize Integration Factory

Parameters

IntegrationFactory	$integrationFactory
IntegrationOauthService	$oauthService

Definition at line 37 of file IntegrationService.php.

    {
        $this->_integrationFactory = $integrationFactory;
        $this->_oauthService = $oauthService;
    }

Member Function Documentation

_addOauthConsumerData()

_addOauthConsumerData ( IntegrationModel  $integration )

protected

Add oAuth consumer key and secret.

Parameters

IntegrationModel

$integration

Returns

void

Definition at line 159 of file IntegrationService.php.

    {
        if ($integration->getId()) {
            $consumer = $this->_oauthService->loadConsumer($integration->getConsumerId());
            $integration->setData('consumer_key', $consumer->getKey());
            $integration->setData('consumer_secret', $consumer->getSecret());
        }
    }

_addOauthTokenData()

_addOauthTokenData ( IntegrationModel  $integration )

protected

Add oAuth token and token secret.

Parameters

IntegrationModel

$integration

Returns

void

Definition at line 174 of file IntegrationService.php.

    {
        if ($integration->getId()) {
            $accessToken = $this->_oauthService->getAccessToken($integration->getConsumerId());
            if ($accessToken) {
                $integration->setData('token', $accessToken->getToken());
                $integration->setData('token_secret', $accessToken->getSecret());
            }
        }
    }

_loadIntegrationById()

_loadIntegrationById (   $integrationId )

protected

Load integration by id.

Parameters

int

$integrationId

Returns

IntegrationModel

Exceptions

Definition at line 144 of file IntegrationService.php.

    {
        $integration = $this->_integrationFactory->create()->load($integrationId);
        if (!$integration->getId()) {
            throw new IntegrationException(__('The integration with ID "%1" doesn\'t exist.', $integrationId));
        }
        return $integration;
    }

create()

create

(

array

$integrationData

)

{Create a new Integration

Parameters

array

$integrationData

Returns

IntegrationModel

Exceptions

}

Implements IntegrationServiceInterface.

Definition at line 46 of file IntegrationService.php.

    {
        $this->_checkIntegrationByName($integrationData['name']);
        $integration = $this->_integrationFactory->create()->setData($integrationData);
        $integration->save();
        $consumerName = 'Integration' . $integration->getId();
        $consumer = $this->_oauthService->createConsumer(['name' => $consumerName]);
        $integration->setConsumerId($consumer->getId());
        $integration->save();
        return $integration;
    }

delete()

delete

(

$integrationId

)

{Delete an Integration.

Parameters

int

$integrationId

Returns

array Integration data

Exceptions

}

Implements IntegrationServiceInterface.

Definition at line 76 of file IntegrationService.php.

    {
        $integration = $this->_loadIntegrationById($integrationId);
        $data = $integration->getData();
        $integration->delete();
        return $data;
    }

findActiveIntegrationByConsumerId()

findActiveIntegrationByConsumerId

(

$consumerId

)

{Get the details of an active Integration by consumer_id.

Parameters

int

$consumerId

Returns

IntegrationModel

}

Implements IntegrationServiceInterface.

Definition at line 116 of file IntegrationService.php.

    {
        $integration = $this->_integrationFactory->create()->loadActiveIntegrationByConsumerId($consumerId);
        return $integration;
    }

findByConsumerId()

findByConsumerId

(

$consumerId

)

{Get the details of an Integration by consumer_id.

Parameters

int

$consumerId

Returns

IntegrationModel

}

Implements IntegrationServiceInterface.

Definition at line 107 of file IntegrationService.php.

    {
        $integration = $this->_integrationFactory->create()->load($consumerId, 'consumer_id');
        return $integration;
    }

findByName()

findByName

(

$name

)

{Find Integration by name.

Parameters

string

$integrationName

Returns

IntegrationModel

}

Implements IntegrationServiceInterface.

Definition at line 98 of file IntegrationService.php.

    {
        $integration = $this->_integrationFactory->create()->load($name, 'name');
        return $integration;
    }

get()

get

(

$integrationId

)

{Get the details of a specific Integration.

Parameters

int

$integrationId

Returns

IntegrationModel

Exceptions

}

Implements IntegrationServiceInterface.

Definition at line 87 of file IntegrationService.php.

    {
        $integration = $this->_loadIntegrationById($integrationId);
        $this->_addOauthConsumerData($integration);
        $this->_addOauthTokenData($integration);
        return $integration;
    }

getSelectedResources()

getSelectedResources

(

$integrationId

)

{Return an array of selected resources for an integration.

Parameters

int

$integrationId

Returns

array

}

Implements IntegrationServiceInterface.

Definition at line 188 of file IntegrationService.php.

    {
        $integration = $this->get($integrationId);
        $data = $integration->getData();

        $selectedResourceIds = [];
        if ($data && isset($data['resource']) && is_array($data['resource'])) {
            $selectedResourceIds = $data['resource'];
        }
        return $selectedResourceIds;
    }

update()

update

(

array

$integrationData

)

{Update an Integration.

Parameters

array

$integrationData

Returns

IntegrationModel

Exceptions

}

Implements IntegrationServiceInterface.

Definition at line 61 of file IntegrationService.php.

    {
        $integration = $this->_loadIntegrationById($integrationData['integration_id']);
        //If name has been updated check if it conflicts with an existing integration
        if ($integration->getName() != $integrationData['name']) {
            $this->_checkIntegrationByName($integrationData['name']);
        }
        $integration->addData($integrationData);
        $integration->save();
        return $integration;
    }

Field Documentation

$_integrationFactory

$_integrationFactory

protected

Definition at line 24 of file IntegrationService.php.

$_oauthService

$_oauthService

protected

Definition at line 29 of file IntegrationService.php.

---

The documentation for this class was generated from the following file:

• vendor/magento/module-integration/Model/IntegrationService.php