class PageExampleController
Same name in other branches
- 8.x-1.x page_example/src/Controller/PageExampleController.php \Drupal\page_example\Controller\PageExampleController
- 4.0.x modules/page_example/src/Controller/PageExampleController.php \Drupal\page_example\Controller\PageExampleController
Controller routines for page example routes.
Hierarchy
- class \Drupal\Core\Controller\ControllerBase implements \Drupal\Core\DependencyInjection\ContainerInjectionInterface uses \Drupal\Core\Logger\LoggerChannelTrait, \Drupal\Core\Messenger\MessengerTrait, \Drupal\Core\Routing\RedirectDestinationTrait, \Drupal\Core\StringTranslation\StringTranslationTrait
- class \Drupal\page_example\Controller\PageExampleController extends \Drupal\Core\Controller\ControllerBase uses \Drupal\examples\Utility\DescriptionTemplateTrait
Expanded class hierarchy of PageExampleController
File
-
modules/
page_example/ src/ Controller/ PageExampleController.php, line 12
Namespace
Drupal\page_example\ControllerView source
class PageExampleController extends ControllerBase {
use DescriptionTemplateTrait;
/**
* {@inheritdoc}
*/
protected function getModuleName() {
return 'page_example';
}
/**
* Constructs a simple page.
*
* The router _controller callback, maps the path
* 'examples/page-example/simple' to this method.
*
* _controller callbacks return a renderable array for the content area of the
* page. The theme system will later render and surround the content with the
* appropriate blocks, navigation, and styling.
*/
public function simple() {
return [
'#markup' => '<p>' . $this->t('Simple page: The quick brown fox jumps over the lazy dog.') . '</p>',
];
}
/**
* A more complex _controller callback that takes arguments.
*
* This callback is mapped to the path
* 'examples/page-example/arguments/{first}/{second}'.
*
* The arguments in brackets are passed to this callback from the page URL.
* The placeholder names "first" and "second" can have any value but should
* match the callback method variable names; i.e. $first and $second.
*
* This function also demonstrates a more complex render array in the returned
* values. Instead of rendering the HTML with theme('item_list'), content is
* left un-rendered, and the theme function name is set using #theme. This
* content will now be rendered as late as possible, giving more parts of the
* system a chance to change it if necessary.
*
* Consult @link http://drupal.org/node/930760 Render Arrays documentation
* @endlink for details.
*
* @param string $first
* A string to use, should be a number.
* @param string $second
* Another string to use, should be a number.
*
* @throws \Symfony\Component\HttpKernel\Exception\AccessDeniedHttpException
* If the parameters are invalid.
*/
public function arguments($first, $second) {
// Make sure you don't trust the URL to be safe! Always check for exploits.
if (!is_numeric($first) || !is_numeric($second)) {
// We will just show a standard "access denied" page in this case.
throw new AccessDeniedHttpException();
}
$list[] = $this->t("First number was @number.", [
'@number' => $first,
]);
$list[] = $this->t("Second number was @number.", [
'@number' => $second,
]);
$list[] = $this->t('The total was @number.', [
'@number' => $first + $second,
]);
$render_array['page_example_arguments'] = [
// The theme function to apply to the #items.
'#theme' => 'item_list',
// The list itself.
'#items' => $list,
'#title' => $this->t('Argument Information'),
];
return $render_array;
}
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overriden Title | Overrides |
---|---|---|---|---|---|
ControllerBase::$configFactory | protected | property | The configuration factory. | ||
ControllerBase::$currentUser | protected | property | The current user service. | 3 | |
ControllerBase::$entityFormBuilder | protected | property | The entity form builder. | ||
ControllerBase::$entityTypeManager | protected | property | The entity type manager. | ||
ControllerBase::$formBuilder | protected | property | The form builder. | 1 | |
ControllerBase::$keyValue | protected | property | The key-value storage. | 1 | |
ControllerBase::$languageManager | protected | property | The language manager. | 1 | |
ControllerBase::$moduleHandler | protected | property | The module handler. | 1 | |
ControllerBase::$stateService | protected | property | The state service. | ||
ControllerBase::cache | protected | function | Returns the requested cache bin. | ||
ControllerBase::config | protected | function | Retrieves a configuration object. | ||
ControllerBase::container | private | function | Returns the service container. | ||
ControllerBase::create | public static | function | Instantiates a new instance of this class. | Overrides ContainerInjectionInterface::create | 49 |
ControllerBase::currentUser | protected | function | Returns the current user. | 3 | |
ControllerBase::entityFormBuilder | protected | function | Retrieves the entity form builder. | ||
ControllerBase::entityTypeManager | protected | function | Retrieves the entity type manager. | ||
ControllerBase::formBuilder | protected | function | Returns the form builder service. | 1 | |
ControllerBase::keyValue | protected | function | Returns a key/value storage collection. | 1 | |
ControllerBase::languageManager | protected | function | Returns the language manager service. | 1 | |
ControllerBase::moduleHandler | protected | function | Returns the module handler. | 1 | |
ControllerBase::redirect | protected | function | Returns a redirect response object for the specified route. | ||
ControllerBase::state | protected | function | Returns the state storage service. | ||
DescriptionTemplateTrait::description | public | function | Generate a render array with our templated content. | ||
DescriptionTemplateTrait::getDescriptionTemplatePath | protected | function | Get full path to the template. | ||
DescriptionTemplateTrait::getDescriptionVariables | protected | function | Variables to act as context to the twig template file. | 1 | |
LoggerChannelTrait::$loggerFactory | protected | property | The logger channel factory service. | ||
LoggerChannelTrait::getLogger | protected | function | Gets the logger for a specific channel. | ||
LoggerChannelTrait::setLoggerFactory | public | function | Injects the logger channel factory. | ||
MessengerTrait::$messenger | protected | property | The messenger. | 17 | |
MessengerTrait::messenger | public | function | Gets the messenger. | 17 | |
MessengerTrait::setMessenger | public | function | Sets the messenger. | ||
PageExampleController::arguments | public | function | A more complex _controller callback that takes arguments. | ||
PageExampleController::getModuleName | protected | function | Name of our module. | Overrides DescriptionTemplateTrait::getModuleName | |
PageExampleController::simple | public | function | Constructs a simple page. | ||
RedirectDestinationTrait::$redirectDestination | protected | property | The redirect destination service. | 1 | |
RedirectDestinationTrait::getDestinationArray | protected | function | Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url. | ||
RedirectDestinationTrait::getRedirectDestination | protected | function | Returns the redirect destination service. | ||
RedirectDestinationTrait::setRedirectDestination | public | function | Sets the redirect destination service. | ||
StringTranslationTrait::$stringTranslation | protected | property | The string translation service. | 3 | |
StringTranslationTrait::formatPlural | protected | function | Formats a string containing a count of items. | ||
StringTranslationTrait::getNumberOfPlurals | protected | function | Returns the number of plurals supported by a given language. | ||
StringTranslationTrait::getStringTranslation | protected | function | Gets the string translation service. | ||
StringTranslationTrait::setStringTranslation | public | function | Sets the string translation service to use. | 2 | |
StringTranslationTrait::t | protected | function | Translates a string to the current language or to a given language. |