Public Member Functions
	__construct (\Magento\Webapi\Model\Config $config, WebApiCache $cache, \Magento\Webapi\Model\Config\ClassReflector $classReflector, \Magento\Framework\Reflection\TypeProcessor $typeProcessor, SerializerInterface $serializer=null)

	getServicesConfig ()

	getServiceMetadata ($serviceName)

	getServiceName ($interfaceName, $version, $preserveVersion=true)

	getRouteMetadata ($serviceName)

	getRoutesConfig ()

Data Fields
const	KEY_CLASS = 'class'

const	KEY_IS_SECURE = 'isSecure'

const	KEY_SERVICE_METHODS = 'methods'

const	KEY_METHOD = 'method'

const	KEY_IS_REQUIRED = 'inputRequired'

const	KEY_ACL_RESOURCES = 'resources'

const	KEY_ROUTES = 'routes'

const	KEY_ROUTE_METHOD = 'method'

const	KEY_ROUTE_PARAMS = 'parameters'

const	SERVICES_CONFIG_CACHE_ID = 'services-services-config'

const	ROUTES_CONFIG_CACHE_ID = 'routes-services-config'

const	REFLECTED_TYPES_CACHE_ID = 'soap-reflected-types'

Protected Member Functions
	initServicesMetadata ()

	initRoutesMetadata ()

Protected Attributes
	$services

	$routes

	$cache

	$config

	$classReflector

	$typeProcessor

Detailed Description

Service Metadata Model

Definition at line 16 of file ServiceMetadata.php.

Constructor & Destructor Documentation

◆ __construct()

__construct	(	\Magento\Webapi\Model\Config	$config,
		WebApiCache	$cache,
		\Magento\Webapi\Model\Config\ClassReflector	$classReflector,
		\Magento\Framework\Reflection\TypeProcessor	$typeProcessor,
		SerializerInterface	$serializer = `null`
	)

Initialize dependencies.

Parameters

\Magento\Webapi\Model\Config	$config
WebApiCache	$cache
\Magento\Webapi\Model\Config\ClassReflector	$classReflector
\Magento\Framework\Reflection\TypeProcessor	$typeProcessor
SerializerInterface \| null	$serializer

Definition at line 91 of file ServiceMetadata.php.

       {
         $this->config = $config;
         $this->cache = $cache;
         $this->classReflector = $classReflector;
         $this->typeProcessor = $typeProcessor;
         $this->serializer = $serializer ?: ObjectManager::getInstance()->get(SerializerInterface::class);
     }

Member Function Documentation

◆ getRouteMetadata()

getRouteMetadata ( $serviceName )

Retrieve specific service interface data with route.

Parameters

string $serviceName

Returns: array

Exceptions

Definition at line 253 of file ServiceMetadata.php.

     {
         $routesConfig = $this->getRoutesConfig();
         if (!isset($routesConfig[$serviceName]) || !is_array($routesConfig[$serviceName])) {
             throw new \RuntimeException(__('Requested service is not available: "%1"', $serviceName));
         }
         return $routesConfig[$serviceName];
     }

◆ getRoutesConfig()

getRoutesConfig ( )

Return routes loaded from cache if enabled or from files merged previously

Returns: array

Definition at line 267 of file ServiceMetadata.php.

     {
         if (null === $this->routes) {
             $routesConfig = $this->cache->load(self::ROUTES_CONFIG_CACHE_ID);
             $typesData = $this->cache->load(self::REFLECTED_TYPES_CACHE_ID);
             if ($routesConfig && is_string($routesConfig) && $typesData && is_string($typesData)) {
                 $this->routes = $this->serializer->unserialize($routesConfig);
                 $this->typeProcessor->setTypesData($this->serializer->unserialize($typesData));
             } else {
                 $this->routes = $this->initRoutesMetadata();
                 $this->cache->save(
                     $this->serializer->serialize($this->routes),
                     self::ROUTES_CONFIG_CACHE_ID
                 );
                 $this->cache->save(
                     $this->serializer->serialize($this->typeProcessor->getTypesData()),
                     self::REFLECTED_TYPES_CACHE_ID
                 );
             }
         }
         return $this->routes;
     }

◆ getServiceMetadata()

getServiceMetadata ( $serviceName )

Retrieve specific service interface data.

Parameters

string $serviceName

Returns: array

Exceptions

Definition at line 177 of file ServiceMetadata.php.

     {
         $servicesConfig = $this->getServicesConfig();
         if (!isset($servicesConfig[$serviceName]) || !is_array($servicesConfig[$serviceName])) {
             throw new \RuntimeException(__('Requested service is not available: "%1"', $serviceName));
         }
         return $servicesConfig[$serviceName];
     }

◆ getServiceName()

getServiceName	(	$interfaceName,
		$version,
		$preserveVersion = `true`
	)

Translate service interface name into service name.

Example:


\Magento\Customer\Api\CustomerAccountInterface::class, 'V1', false => customerCustomerAccount
\Magento\Customer\Api\CustomerAddressInterface::class, 'V1', true  => customerCustomerAddressV1

Parameters

  
    string $interfaceName 
    string $version 
    bool $preserveVersion Should version be preserved during interface name conversion into service name

  
  

Returns
string

Exceptions

Avoid duplication of words in service name

Definition at line 202 of file ServiceMetadata.php.

     {
         if (!preg_match(\Magento\Webapi\Model\Config::SERVICE_CLASS_PATTERN, $interfaceName, $matches)) {
             $apiClassPattern = "#^(.+?)\\\\(.+?)\\\\Api\\\\(.+?)(Interface)?$#";
             preg_match($apiClassPattern, $interfaceName, $matches);
         }
 
         if (!empty($matches)) {
             $moduleNamespace = $matches[1];
             $moduleName = $matches[2];
             $moduleNamespace = ($moduleNamespace == 'Magento') ? '' : $moduleNamespace;
             if ($matches[4] === 'Interface') {
                 $matches[4] = $matches[3];
             }
             $serviceNameParts = explode('\\', trim($matches[4], '\\'));
             if ($moduleName == $serviceNameParts[0]) {
                 $moduleName = '';
             }
             $parentServiceName = $moduleNamespace . $moduleName . array_shift($serviceNameParts);
             array_unshift($serviceNameParts, $parentServiceName);
             if ($preserveVersion) {
                 $serviceNameParts[] = $version;
             }
         } elseif (preg_match(\Magento\Webapi\Model\Config::API_PATTERN, $interfaceName, $matches)) {
             $moduleNamespace = $matches[1];
             $moduleName = $matches[2];
             $moduleNamespace = ($moduleNamespace == 'Magento') ? '' : $moduleNamespace;
             $serviceNameParts = explode('\\', trim($matches[3], '\\'));
             if ($moduleName == $serviceNameParts[0]) {
                 $moduleName = '';
             }
             $parentServiceName = $moduleNamespace . $moduleName . array_shift($serviceNameParts);
             array_unshift($serviceNameParts, $parentServiceName);
             if ($preserveVersion) {
                 $serviceNameParts[] = $version;
             }
         } else {
             throw new \InvalidArgumentException(sprintf('The service interface name "%s" is invalid.', $interfaceName));
         }
         return lcfirst(implode('', $serviceNameParts));
     }

◆ getServicesConfig()

getServicesConfig ( )

Return services loaded from cache if enabled or from files merged previously

Returns: array

Definition at line 147 of file ServiceMetadata.php.

     {
         if (null === $this->services) {
             $servicesConfig = $this->cache->load(self::SERVICES_CONFIG_CACHE_ID);
             $typesData = $this->cache->load(self::REFLECTED_TYPES_CACHE_ID);
             if ($servicesConfig && is_string($servicesConfig) && $typesData && is_string($typesData)) {
                 $this->services = $this->serializer->unserialize($servicesConfig);
                 $this->typeProcessor->setTypesData($this->serializer->unserialize($typesData));
             } else {
                 $this->services = $this->initServicesMetadata();
                 $this->cache->save(
                     $this->serializer->serialize($this->services),
                     self::SERVICES_CONFIG_CACHE_ID
                 );
                 $this->cache->save(
                     $this->serializer->serialize($this->typeProcessor->getTypesData()),
                     self::REFLECTED_TYPES_CACHE_ID
                 );
             }
         }
         return $this->services;
     }

◆ initRoutesMetadata()

initRoutesMetadata ( )

protected

Collect the list of services with routes and request types for use in REST.

Returns: array

Definition at line 295 of file ServiceMetadata.php.

     {
         $routes = $this->getServicesConfig();
         foreach ($this->config->getServices()[Converter::KEY_ROUTES] as $url => $routeData) {
             foreach ($routeData as $method => $data) {
                 $serviceClass = $data[Converter::KEY_SERVICE][Converter::KEY_SERVICE_CLASS];
                 $version = explode('/', ltrim($url, '/'))[0];
                 $serviceName = $this->getServiceName($serviceClass, $version);
                 $methodName = $data[Converter::KEY_SERVICE][Converter::KEY_METHOD];
                 $routes[$serviceName][self::KEY_ROUTES][$url][$method][self::KEY_ROUTE_METHOD] = $methodName;
                 $routes[$serviceName][self::KEY_ROUTES][$url][$method][self::KEY_ROUTE_PARAMS]
                     = $data[Converter::KEY_DATA_PARAMETERS];
             }
         }
         return $routes;
     }

◆ initServicesMetadata()

initServicesMetadata ( )

protected

Collect the list of services metadata

Returns: array

Definition at line 110 of file ServiceMetadata.php.

     {
         $services = [];
         foreach ($this->config->getServices()[Converter::KEY_SERVICES] as $serviceClass => $serviceVersionData) {
             foreach ($serviceVersionData as $version => $serviceData) {
                 $serviceName = $this->getServiceName($serviceClass, $version);
                 foreach ($serviceData[Converter::KEY_METHODS] as $methodName => $methodMetadata) {
                     $services[$serviceName][self::KEY_SERVICE_METHODS][$methodName] = [
                         self::KEY_METHOD => $methodName,
                         self::KEY_IS_REQUIRED => (bool)$methodMetadata[Converter::KEY_SECURE],
                         self::KEY_IS_SECURE => $methodMetadata[Converter::KEY_SECURE],
                         self::KEY_ACL_RESOURCES => $methodMetadata[Converter::KEY_ACL_RESOURCES],
                     ];
                     $services[$serviceName][self::KEY_CLASS] = $serviceClass;
                 }
                 $reflectedMethodsMetadata = $this->classReflector->reflectClassMethods(
                     $serviceClass,
                     $services[$serviceName][self::KEY_SERVICE_METHODS]
                 );
                 $services[$serviceName][self::KEY_SERVICE_METHODS] = array_merge_recursive(
                     $services[$serviceName][self::KEY_SERVICE_METHODS],
                     $reflectedMethodsMetadata
                 );
                 $services[$serviceName][Converter::KEY_DESCRIPTION] = $this->classReflector->extractClassDescription(
                     $serviceClass
                 );
             }
         }
 
         return $services;
     }

Field Documentation

◆ $cache

$cache

protected

Definition at line 60 of file ServiceMetadata.php.

◆ $classReflector

$classReflector

protected

Definition at line 70 of file ServiceMetadata.php.

◆ $config

$config

protected

Definition at line 65 of file ServiceMetadata.php.

◆ $routes

$routes

protected

Definition at line 55 of file ServiceMetadata.php.

◆ $services

$services

protected

#- #-

Definition at line 48 of file ServiceMetadata.php.

◆ $typeProcessor

$typeProcessor

protected

Definition at line 75 of file ServiceMetadata.php.

◆ KEY_ACL_RESOURCES

const KEY_ACL_RESOURCES = 'resources'

Definition at line 31 of file ServiceMetadata.php.

◆ KEY_CLASS

const KEY_CLASS = 'class'

#+ Keys that a used for service config internal representation.

Definition at line 21 of file ServiceMetadata.php.

◆ KEY_IS_REQUIRED

const KEY_IS_REQUIRED = 'inputRequired'

Definition at line 29 of file ServiceMetadata.php.

◆ KEY_IS_SECURE

const KEY_IS_SECURE = 'isSecure'

Definition at line 23 of file ServiceMetadata.php.

◆ KEY_METHOD

const KEY_METHOD = 'method'

Definition at line 27 of file ServiceMetadata.php.

◆ KEY_ROUTE_METHOD

const KEY_ROUTE_METHOD = 'method'

Definition at line 35 of file ServiceMetadata.php.

◆ KEY_ROUTE_PARAMS

const KEY_ROUTE_PARAMS = 'parameters'

Definition at line 37 of file ServiceMetadata.php.

◆ KEY_ROUTES

const KEY_ROUTES = 'routes'

Definition at line 33 of file ServiceMetadata.php.

◆ KEY_SERVICE_METHODS

const KEY_SERVICE_METHODS = 'methods'

Definition at line 25 of file ServiceMetadata.php.

◆ REFLECTED_TYPES_CACHE_ID

const REFLECTED_TYPES_CACHE_ID = 'soap-reflected-types'

Definition at line 43 of file ServiceMetadata.php.

◆ ROUTES_CONFIG_CACHE_ID

const ROUTES_CONFIG_CACHE_ID = 'routes-services-config'

Definition at line 41 of file ServiceMetadata.php.

◆ SERVICES_CONFIG_CACHE_ID

const SERVICES_CONFIG_CACHE_ID = 'services-services-config'

Definition at line 39 of file ServiceMetadata.php.

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

vendor/magento/module-webapi/Model/ServiceMetadata.php

string	$interfaceName
string	$version
bool	$preserveVersion	Should version be preserved during interface name conversion into service name

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getRouteMetadata()

◆ getRoutesConfig()

◆ getServiceMetadata()

◆ getServiceName()

◆ getServicesConfig()

◆ initRoutesMetadata()

◆ initServicesMetadata()

Field Documentation

◆ $cache

◆ $classReflector

◆ $config

◆ $routes

◆ $services

◆ $typeProcessor

◆ KEY_ACL_RESOURCES

◆ KEY_CLASS

◆ KEY_IS_REQUIRED

◆ KEY_IS_SECURE

◆ KEY_METHOD

◆ KEY_ROUTE_METHOD

◆ KEY_ROUTE_PARAMS

◆ KEY_ROUTES

◆ KEY_SERVICE_METHODS

◆ REFLECTED_TYPES_CACHE_ID

◆ ROUTES_CONFIG_CACHE_ID

◆ SERVICES_CONFIG_CACHE_ID