class LayoutStringContext

Pass-through context used when an unknown argument is encountered.

Hierarchy

class LayoutHandler
- class LayoutContext
  - class LayoutStringContext

Expanded class hierarchy of LayoutStringContext

2 string references to 'LayoutStringContext'

layout_autoload_info in core/modules/layout/layout.module: Implements hook_autoload_info().
layout_layout_context_info in core/modules/layout/includes/layout.layout.inc: Implements hook_layout_context_info().

File

core/modules/layout/plugins/context/layout_context.inc, line 396: Class that holds information relating to a layout's context.

View source

class LayoutStringContext extends LayoutContext {
  function type() {
    return 'string';
  }

  function label() {
    return t('String pass-through');
  }

  /**
   * Return a summary for this context.
   */
  public function getAdminSummary($path = NULL) {
    $argument_parts = explode('/', $path);
    $argument_parts[$this->position] = '<strong>' . $argument_parts[$this->position] . '</strong>';

    return t('Position @index:', array('@index' => $this->position + 1)) . ' ' . implode('/', $argument_parts);
  }
}

Members

Name	Modifiers	Type	Description
LayoutContext::form		function	Settings form for configuring this context item.
LayoutContext::formSubmit		function	Submit handler for the settings form for this context item.
LayoutContext::formValidate		function	Validate handler for the settings form for this context item.
LayoutContext::isA		function	Check if this context matches a plugin name.
LayoutContext::setData		function	Set the data for this context.
LayoutContext::setDataFromRouter	public	function	Set the context data from the router item.
LayoutContext::setDataFromRouterMap Deprecated		function	Set the context data from the router item map.
LayoutContext::USAGE_TYPE_ALL		constant	All possible context types.
LayoutContext::USAGE_TYPE_CUSTOM		constant	Declares a LayoutContext to be a manually specified custom context.
LayoutContext::USAGE_TYPE_MENU		constant	Declares a LayoutContext to be provided based on a menu item or path.
LayoutContext::USAGE_TYPE_RELATIONSHIP		constant	Declares a LayoutContext is provided by a relationship to another context.
LayoutContext::USAGE_TYPE_SYSTEM		constant	Declares a LayoutContext to be a system-wide context
LayoutContext::__construct		function	Constructor for LayoutContext objects. Overrides LayoutHandler::__construct
LayoutHandler::toArray		function	Convert this object's properties to an array.
LayoutStringContext::getAdminSummary	public	function	Return a summary for this context. Overrides LayoutContext::getAdminSummary
LayoutStringContext::label		function	Assemble a human-readable label of this object. Overrides LayoutContext::label
LayoutStringContext::type		function	Return the indicator for this context, i.e. "entity", "string". Overrides LayoutContext::type