class RestExampleClientController in Examples for Developers 3.x
Controller routines for rest example routes.
Hierarchy
- class \Drupal\Core\Controller\ControllerBase implements ContainerInjectionInterface uses LoggerChannelTrait, MessengerTrait, RedirectDestinationTrait, StringTranslationTrait
- class \Drupal\rest_example\Controller\RestExampleClientController
Expanded class hierarchy of RestExampleClientController
Related topics
File
- modules/
rest_example/ src/ Controller/ RestExampleClientController.php, line 15
Namespace
Drupal\rest_example\ControllerView source
class RestExampleClientController extends ControllerBase {
/**
* RestExampleClientCalls object.
*
* @var \Drupal\rest_example\RestExampleClientCalls
*/
private $restExampleClientCalls;
/**
* RestExampleClientController constructor.
*
* @param \Drupal\rest_example\RestExampleClientCalls $rest_example_client_calls
* RestExampleClientCalls service.
*/
public function __construct(RestExampleClientCalls $rest_example_client_calls) {
$this->restExampleClientCalls = $rest_example_client_calls;
}
/**
* {@inheritdoc}
*/
public static function create(ContainerInterface $container) {
return new static($container
->get('rest_example_client_calls'));
}
/**
* Retrieve a list of all nodes available on the remote site.
*
* Building the list as a table by calling the RestExampleClientCalls::index()
* and builds the list from the response of that.
*
* @throws \RuntimeException
* @throws \GuzzleHttp\Exception\GuzzleException
*/
public function indexAction() {
if (NULL === $this->configFactory
->get('rest_example.settings')
->get('server_url')) {
$this
->messenger()
->addWarning($this
->t('The remote endpoint service address have not been set. Please go and provide the credentials and the endpoint address on the <a href="@url">config page</a>.', [
'@url' => base_path() . 'examples/rest-client-settings',
]));
}
$build = [];
$nodes = $this->restExampleClientCalls
->index();
$build['intro'] = [
'#markup' => $this
->t('This is a list of nodes, of type <em>Rest Example Test</em>, on the remote server. From here you can create new node, edit and delete existing ones.'),
];
$build['node_table'] = [
'#type' => 'table',
'#header' => [
$this
->t('Title'),
$this
->t('Type'),
$this
->t('Created'),
$this
->t('Edit'),
$this
->t('Delete'),
],
'#empty' => t('There are no items on the remote system yet'),
];
if (!empty($nodes)) {
foreach ($nodes as $delta => $node) {
$build['node_table'][$delta]['title']['#plain_text'] = $node['title'];
$build['node_table'][$delta]['type']['#plain_text'] = $node['type'];
$build['node_table'][$delta]['created']['#plain_text'] = $node['created'];
$build['node_table'][$delta]['edit']['#plain_text'] = Link::createFromRoute($this
->t('Edit'), 'rest_example.client_actions_edit', [
'id' => $node['nid'],
])
->toString();
$build['node_table'][$delta]['delete']['#plain_tex'] = Link::createFromRoute($this
->t('Delete'), 'rest_example.client_actions_delete', [
'id' => $node['nid'],
])
->toString();
}
}
return $build;
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
ControllerBase:: |
protected | property | The configuration factory. | |
ControllerBase:: |
protected | property | The current user service. | 1 |
ControllerBase:: |
protected | property | The entity form builder. | |
ControllerBase:: |
protected | property | The entity type manager. | |
ControllerBase:: |
protected | property | The form builder. | 2 |
ControllerBase:: |
protected | property | The key-value storage. | 1 |
ControllerBase:: |
protected | property | The language manager. | 1 |
ControllerBase:: |
protected | property | The module handler. | 2 |
ControllerBase:: |
protected | property | The state service. | |
ControllerBase:: |
protected | function | Returns the requested cache bin. | |
ControllerBase:: |
protected | function | Retrieves a configuration object. | |
ControllerBase:: |
private | function | Returns the service container. | |
ControllerBase:: |
protected | function | Returns the current user. | 1 |
ControllerBase:: |
protected | function | Retrieves the entity form builder. | |
ControllerBase:: |
protected | function | Retrieves the entity type manager. | |
ControllerBase:: |
protected | function | Returns the form builder service. | 2 |
ControllerBase:: |
protected | function | Returns a key/value storage collection. | 1 |
ControllerBase:: |
protected | function | Returns the language manager service. | 1 |
ControllerBase:: |
protected | function | Returns the module handler. | 2 |
ControllerBase:: |
protected | function | Returns a redirect response object for the specified route. | |
ControllerBase:: |
protected | function | Returns the state storage service. | |
LoggerChannelTrait:: |
protected | property | The logger channel factory service. | |
LoggerChannelTrait:: |
protected | function | Gets the logger for a specific channel. | |
LoggerChannelTrait:: |
public | function | Injects the logger channel factory. | |
MessengerTrait:: |
protected | property | The messenger. | 27 |
MessengerTrait:: |
public | function | Gets the messenger. | 27 |
MessengerTrait:: |
public | function | Sets the messenger. | |
RedirectDestinationTrait:: |
protected | property | The redirect destination service. | 1 |
RedirectDestinationTrait:: |
protected | function | Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url. | |
RedirectDestinationTrait:: |
protected | function | Returns the redirect destination service. | |
RedirectDestinationTrait:: |
public | function | Sets the redirect destination service. | |
RestExampleClientController:: |
private | property | RestExampleClientCalls object. | |
RestExampleClientController:: |
public static | function |
Instantiates a new instance of this class. Overrides ControllerBase:: |
|
RestExampleClientController:: |
public | function | Retrieve a list of all nodes available on the remote site. | |
RestExampleClientController:: |
public | function | RestExampleClientController constructor. | |
StringTranslationTrait:: |
protected | property | The string translation service. | 4 |
StringTranslationTrait:: |
protected | function | Formats a string containing a count of items. | |
StringTranslationTrait:: |
protected | function | Returns the number of plurals supported by a given language. | |
StringTranslationTrait:: |
protected | function | Gets the string translation service. | |
StringTranslationTrait:: |
public | function | Sets the string translation service to use. | 2 |
StringTranslationTrait:: |
protected | function | Translates a string to the current language or to a given language. |