Config Class Reference

Inheritance diagram for Config:

Public Member Functions
	__construct (WebapiCache $cache, Reader $configReader, SerializerInterface $serializer=null)
	getServices ()

Data Fields
const	CACHE_ID = 'webapi_config'
const	SERVICE_CLASS_PATTERN = '/^(.+?)\\\\(.+?)\\\\Service\\\\(V\d+)+(\\\\.+)Interface$/'
const	API_PATTERN = '/^(.+?)\\\\(.+?)\\\\Api(\\\\.+)Interface$/'

Protected Attributes
	$cache
	$configReader
	$services

Detailed Description

This class gives access to consolidated web API configuration from <Module_Name>/etc/webapi.xml files.

@api

Since

100.0.2

Definition at line 20 of file Config.php.

Constructor & Destructor Documentation

__construct()

__construct	(	WebapiCache	$cache,
		Reader	$configReader,
		SerializerInterface	$serializer = null
	)

Initialize dependencies.

Parameters

WebapiCache	$cache
Reader	$configReader
SerializerInterface | null	$serializer

Definition at line 58 of file Config.php.

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

Member Function Documentation

getServices()

getServices

(

)

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

Returns

array

Since

100.2.4

}

Implements ConfigInterface.

Definition at line 71 of file Config.php.

    {
        if (null === $this->services) {
            $services = $this->cache->load(self::CACHE_ID);
            if ($services && is_string($services)) {
                $this->services = $this->serializer->unserialize($services);
            } else {
                $this->services = $this->configReader->read();
                $this->cache->save($this->serializer->serialize($this->services), self::CACHE_ID);
            }
        }
        return $this->services;
    }

Field Documentation

$cache

$cache

protected

Definition at line 34 of file Config.php.

$configReader

$configReader

protected

Definition at line 39 of file Config.php.

$services

$services

protected

Definition at line 44 of file Config.php.

API_PATTERN

const API_PATTERN = '/^(.+?)\\\\(.+?)\\\\Api(\\\\.+)Interface$/'

Definition at line 29 of file Config.php.

CACHE_ID

const CACHE_ID = 'webapi_config'

Definition at line 22 of file Config.php.

SERVICE_CLASS_PATTERN

const SERVICE_CLASS_PATTERN = '/^(.+?)\\\\(.+?)\\\\Service\\\\(V\d+)+(\\\\.+)Interface$/'

Pattern for Web API interface name.

Definition at line 27 of file Config.php.

---

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

• vendor/magento/module-webapi/Model/Config.php