class BookNavigation in Display Suite 8.4

Plugin that the book navigation.

Plugin annotation

@DsField(
  id = "book_navigation",
  title = @Translation("Book navigation"),
  entity_type = "node",
  provider = "book"
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\ds\Plugin\DsField\DsFieldBase implements ConfigurableInterface, DependentPluginInterface, DsFieldInterface
      • class \Drupal\ds\Plugin\DsField\Book\BookNavigation

File

src/Plugin/DsField/Book/BookNavigation.php, line 17

Namespace

Drupal\ds\Plugin\DsField\Book

class BookNavigation extends DsFieldBase {

  /**
   * {@inheritdoc}
   */
  public function isAllowed() {

    // We only allow the 'full' view mode.
    if ($this
      ->viewMode() != 'full') {
      return FALSE;
    }

    // Get all the allowed types.
    $types = \Drupal::config('book.settings')
      ->get('allowed_types');
    if (!empty($types)) {
      foreach ($types as $type) {
        if ($type) {
          return TRUE;
        }
      }
    }

    // Return false when there where no displays.
    return FALSE;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
BookNavigation::isAllowed	public	function	Returns if the field is allowed on the field UI screen. Overrides DsFieldBase::isAllowed
DependencySerializationTrait::$_entityStorages	protected	property	An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep	public	function		1
DependencySerializationTrait::__wakeup	public	function		2
DsFieldBase::build	public	function	Renders a field. Overrides DsFieldInterface::build	25
DsFieldBase::bundle	public	function	Gets the current bundle. Overrides DsFieldInterface::bundle
DsFieldBase::calculateDependencies	public	function	Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies
DsFieldBase::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create	7
DsFieldBase::defaultConfiguration	public	function	Gets default configuration for this plugin. Overrides ConfigurableInterface::defaultConfiguration	5
DsFieldBase::entity	public	function	Gets the current entity. Overrides DsFieldInterface::entity
DsFieldBase::formatters	public	function	Returns a list of possible formatters for this field. Overrides DsFieldInterface::formatters	3
DsFieldBase::getConfiguration	public	function	Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration	1
DsFieldBase::getEntityTypeId	public	function	Gets the current entity type. Overrides DsFieldInterface::getEntityTypeId
DsFieldBase::getFieldConfiguration	public	function	Gets the field configuration. Overrides DsFieldInterface::getFieldConfiguration
DsFieldBase::getName	public	function	Gets the field name. Overrides DsFieldInterface::getName
DsFieldBase::getTitle	public	function	Returns the title of the field. Overrides DsFieldInterface::getTitle	1
DsFieldBase::isMultiple	public	function	Defines if we are dealing with a multivalue field. Overrides DsFieldInterface::isMultiple	1
DsFieldBase::setConfiguration	public	function	Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration	1
DsFieldBase::settingsForm	public	function	The form that holds the settings for this plugin. Overrides DsFieldInterface::settingsForm	7
DsFieldBase::settingsSummary	public	function	Returns the summary of the chosen settings. Overrides DsFieldInterface::settingsSummary	7
DsFieldBase::viewMode	public	function	Gets the view mode. Overrides DsFieldInterface::viewMode
DsFieldBase::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object. Overrides PluginBase::__construct	8
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	1
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.	1
PluginBase::$pluginId	protected	property	The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR		constant	A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId	public	function	Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId	public	function	Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition	public	function	Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition	3
PluginBase::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable	public	function	Determines if the plugin is configurable.
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	1
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.