Public Member Functions | |
| getTopic ($topicName) | |
| getTopicHandlers ($topicName) | |
| getTopics () | |
Data Fields | |
| const | TOPICS = 'topics' |
| const | TOPIC_NAME = 'name' |
| const | TOPIC_HANDLERS = 'handlers' |
| const | TOPIC_REQUEST = 'request' |
| const | TOPIC_RESPONSE = 'response' |
| const | TOPIC_IS_SYNCHRONOUS = 'is_synchronous' |
| const | TOPIC_REQUEST_TYPE = 'request_type' |
| const | TOPIC_REQUEST_TYPE_CLASS = 'object_interface' |
| const | TOPIC_REQUEST_TYPE_METHOD = 'service_method_interface' |
| const | SCHEMA_METHOD_PARAMS = 'method_params' |
| const | SCHEMA_METHOD_RETURN_TYPE = 'method_return_type' |
| const | SCHEMA_METHOD_HANDLER = 'method_callback' |
| const | SCHEMA_METHOD_PARAM_NAME = 'param_name' |
| const | SCHEMA_METHOD_PARAM_POSITION = 'param_position' |
| const | SCHEMA_METHOD_PARAM_TYPE = 'param_type' |
| const | SCHEMA_METHOD_PARAM_IS_REQUIRED = 'is_required' |
| const | HANDLER_TYPE = 'type' |
| const | HANDLER_METHOD = 'method' |
| const | HANDLER_DISABLED = 'disabled' |
Detailed Description
Class for accessing to communication configuration.
@api
- Since
- 100.1.0
Definition at line 16 of file ConfigInterface.php.
Member Function Documentation
◆ getTopic()
| getTopic | ( | $topicName | ) |
Get configuration of the specified topic.
- Parameters
-
string $topicName
- Returns
- array
- Exceptions
-
LocalizedException
- Since
- 100.1.0
Implemented in Config.
◆ getTopicHandlers()
| getTopicHandlers | ( | $topicName | ) |
◆ getTopics()
| getTopics | ( | ) |
Get list of all declared topics and their configuration.
- Returns
- array
- Since
- 100.1.0
Implemented in Config.
Field Documentation
◆ HANDLER_DISABLED
| const HANDLER_DISABLED = 'disabled' |
Definition at line 41 of file ConfigInterface.php.
◆ HANDLER_METHOD
| const HANDLER_METHOD = 'method' |
Definition at line 40 of file ConfigInterface.php.
◆ HANDLER_TYPE
| const HANDLER_TYPE = 'type' |
Definition at line 39 of file ConfigInterface.php.
◆ SCHEMA_METHOD_HANDLER
| const SCHEMA_METHOD_HANDLER = 'method_callback' |
Definition at line 32 of file ConfigInterface.php.
◆ SCHEMA_METHOD_PARAM_IS_REQUIRED
| const SCHEMA_METHOD_PARAM_IS_REQUIRED = 'is_required' |
Definition at line 37 of file ConfigInterface.php.
◆ SCHEMA_METHOD_PARAM_NAME
| const SCHEMA_METHOD_PARAM_NAME = 'param_name' |
Definition at line 34 of file ConfigInterface.php.
◆ SCHEMA_METHOD_PARAM_POSITION
| const SCHEMA_METHOD_PARAM_POSITION = 'param_position' |
Definition at line 35 of file ConfigInterface.php.
◆ SCHEMA_METHOD_PARAM_TYPE
| const SCHEMA_METHOD_PARAM_TYPE = 'param_type' |
Definition at line 36 of file ConfigInterface.php.
◆ SCHEMA_METHOD_PARAMS
| const SCHEMA_METHOD_PARAMS = 'method_params' |
Definition at line 30 of file ConfigInterface.php.
◆ SCHEMA_METHOD_RETURN_TYPE
| const SCHEMA_METHOD_RETURN_TYPE = 'method_return_type' |
Definition at line 31 of file ConfigInterface.php.
◆ TOPIC_HANDLERS
| const TOPIC_HANDLERS = 'handlers' |
Definition at line 21 of file ConfigInterface.php.
◆ TOPIC_IS_SYNCHRONOUS
| const TOPIC_IS_SYNCHRONOUS = 'is_synchronous' |
Definition at line 24 of file ConfigInterface.php.
◆ TOPIC_NAME
| const TOPIC_NAME = 'name' |
Definition at line 20 of file ConfigInterface.php.
◆ TOPIC_REQUEST
| const TOPIC_REQUEST = 'request' |
Definition at line 22 of file ConfigInterface.php.
◆ TOPIC_REQUEST_TYPE
| const TOPIC_REQUEST_TYPE = 'request_type' |
Definition at line 25 of file ConfigInterface.php.
◆ TOPIC_REQUEST_TYPE_CLASS
| const TOPIC_REQUEST_TYPE_CLASS = 'object_interface' |
Definition at line 27 of file ConfigInterface.php.
◆ TOPIC_REQUEST_TYPE_METHOD
| const TOPIC_REQUEST_TYPE_METHOD = 'service_method_interface' |
Definition at line 28 of file ConfigInterface.php.
◆ TOPIC_RESPONSE
| const TOPIC_RESPONSE = 'response' |
Definition at line 23 of file ConfigInterface.php.
◆ TOPICS
| const TOPICS = 'topics' |
Definition at line 18 of file ConfigInterface.php.
The documentation for this interface was generated from the following file:
- vendor/magento/framework/Communication/ConfigInterface.php