NewTopicsBlock
class NewTopicsBlock extends ForumBlockBase (View source)
Provides a 'New forum topics' block.
Traits
Provides the base implementation of a block plugin.
Handles context assignments for context-aware plugins.
Wrapper methods for \Drupal\Core\StringTranslation\TranslationInterface.
Provides a trait for the messenger service.
Provides a trait with typical behavior for plugins which have forms.
Wrapper methods for classes that needs typed data manager object.
Wrapper methods for \Drupal\Core\StringTranslation\TranslationInterface.
Provides dependency injection friendly methods for serialization.
Constants
| DERIVATIVE_SEPARATOR |
A string which is used to separate base plugin IDs from the derivative ID. |
Properties
| protected string | $pluginId | The plugin_id. |
from PluginBase |
| protected array | $pluginDefinition | The plugin implementation definition. |
from PluginBase |
| protected array | $configuration | Configuration information passed into the plugin. |
from PluginBase |
| protected ContextInterface[] | $context | The data objects representing the context of this plugin. |
from ContextAwarePluginBase |
| protected TypedDataManagerInterface | $typedDataManager | The typed data manager used for creating the data types. |
from TypedDataTrait |
| protected TranslationInterface | $stringTranslation | The string translation service. |
from StringTranslationTrait |
| protected array | $_serviceIds | An array of service IDs keyed by property name used for serialization. |
from DependencySerializationTrait |
| protected array | $_entityStorages | An array of entity type IDs keyed by the property name of their storages. |
from DependencySerializationTrait |
| protected MessengerInterface | $messenger | The messenger. |
from MessengerTrait |
| protected TransliterationInterface | $transliteration | The transliteration service. |
from BlockPluginTrait |
Methods
{@inheritdoc}
Creates context objects from any context mappings in configuration.
Gets the context definitions of the plugin.
Gets a specific context definition of the plugin.
Gets the value for a defined context.
Sets the value for a defined context.
Validates the set values for the defined contexts.
Translates a string to the current language or to a given language.
Formats a string containing a count of items.
Returns the number of plurals supported by a given language.
Gets the string translation service.
Gets a mapping of the expected assignment names to their context names.
Sets a mapping of the expected assignment names to their context names.
Wraps the context handler.
The maximum age for which this object may be cached.
Returns generic default configuration for block plugins.
Builds a form element for assigning a context to a given slot.
Builds the select query to use for this forum block.
Details
__construct(array $configuration, $plugin_id, $plugin_definition)
{@inheritdoc}
string
getPluginId()
Gets the plugin_id of the plugin instance.
string
getBaseId()
Gets the base_plugin_id of the plugin instance.
string|null
getDerivativeId()
Gets the derivative_id of the plugin instance.
array
getPluginDefinition()
Gets the definition of the plugin implementation.
bool
isConfigurable()
Determines if the plugin is configurable.
__get($name)
Implements magic __get() method.
protected ContextInterface[]
createContextFromConfiguration(array $context_configuration)
Creates context objects from any context mappings in configuration.
ContextDefinitionInterface[]
getContextDefinitions()
Gets the context definitions of the plugin.
ContextDefinitionInterface
getContextDefinition(string $name)
Gets a specific context definition of the plugin.
array
getContexts()
Gets the defined contexts.
ContextInterface
getContext(string $name)
Gets a defined context.
setContext(string $name, ContextInterface $context)
Set a context on this plugin.
array
getContextValues()
Gets the values for all defined contexts.
mixed
getContextValue(string $name)
Gets the value for a defined context.
$this
setContextValue(string $name, mixed $value)
Sets the value for a defined context.
ConstraintViolationListInterface
validateContexts()
Validates the set values for the defined contexts.
$this
setTypedDataManager(TypedDataManagerInterface $typed_data_manager)
Sets the typed data manager.
TypedDataManagerInterface
getTypedDataManager()
Gets the typed data manager.
protected TranslatableMarkup
t(string $string, array $args = [], array $options = [])
Translates a string to the current language or to a given language.
See \Drupal\Core\StringTranslation\TranslatableMarkup::__construct() for important security information and usage guidelines.
In order for strings to be localized, make them available in one of the ways supported by the
protected
formatPlural($count, $singular, $plural, array $args = [], array $options = [])
Formats a string containing a count of items.
protected
getNumberOfPlurals($langcode = NULL)
Returns the number of plurals supported by a given language.
protected TranslationInterface
getStringTranslation()
Gets the string translation service.
$this
setStringTranslation(TranslationInterface $translation)
Sets the string translation service to use.
__sleep()
{@inheritdoc}
__wakeup()
{@inheritdoc}
array
getContextMapping()
Gets a mapping of the expected assignment names to their context names.
$this
setContextMapping(array $context_mapping)
Sets a mapping of the expected assignment names to their context names.
protected ContextHandlerInterface
contextHandler()
Wraps the context handler.
string[]
getCacheContexts()
The cache contexts associated with this object.
These identify a specific variation/representation of the object.
Cache contexts are tokens: placeholders that are converted to cache keys by the @cache_contexts_manager service. The replacement value depends on the request context (the current URL, language, and so on). They're converted before storing an object in cache.
string[]
getCacheTags()
The cache tags associated with this object.
When this object is modified, these cache tags will be invalidated.
int
getCacheMaxAge()
The maximum age for which this object may be cached.
setMessenger(MessengerInterface $messenger)
Sets the messenger.
MessengerInterface
messenger()
Gets the messenger.
getFormClass($operation)
{@inheritdoc}
hasFormClass($operation)
{@inheritdoc}
label()
{@inheritdoc}
getConfiguration()
{@inheritdoc}
setConfiguration(array $configuration)
{@inheritdoc}
protected array
baseConfigurationDefaults()
Returns generic default configuration for block plugins.
defaultConfiguration()
{@inheritdoc}
setConfigurationValue($key, $value)
{@inheritdoc}
calculateDependencies()
{@inheritdoc}
access(AccountInterface $account, $return_as_object = FALSE)
{@inheritdoc}
protected AccessResult
blockAccess(AccountInterface $account)
Indicates whether the block should be shown.
Blocks with specific access checking should override this method rather than access(), in order to avoid repeating the handling of the $return_as_object argument.
buildConfigurationForm(array $form, FormStateInterface $form_state)
{@inheritdoc}
Creates a generic configuration form for all block types. Individual block plugins can add elements to this form by overriding BlockBase::blockForm(). Most block plugins should not override this method unless they need to alter the generic form elements.
blockForm($form, FormStateInterface $form_state)
{@inheritdoc}
validateConfigurationForm(array $form, FormStateInterface $form_state)
{@inheritdoc}
Most block plugins should not override this method. To add validation for a specific block type, override BlockBase::blockValidate().
blockValidate($form, FormStateInterface $form_state)
{@inheritdoc}
submitConfigurationForm(array $form, FormStateInterface $form_state)
{@inheritdoc}
Most block plugins should not override this method. To add submission handling for a specific block type, override BlockBase::blockSubmit().
blockSubmit($form, FormStateInterface $form_state)
{@inheritdoc}
getMachineNameSuggestion()
{@inheritdoc}
getPreviewFallbackString()
{@inheritdoc}
protected TransliterationInterface
transliteration()
Wraps the transliteration service.
setTransliteration(TransliterationInterface $transliteration)
Sets the transliteration service.
protected array
addContextAssignmentElement(ContextAwarePluginInterface $plugin, array $contexts)
Builds a form element for assigning a context to a given slot.
array
build()
Builds and returns the renderable array for this block plugin.
If a block should not be rendered because it has no content, then this method must also ensure to return no content: it must then only return an empty array, or an empty array with #cache set (with cacheability metadata indicating the circumstances for it being empty).
protected Select
buildForumQuery()
Builds the select query to use for this forum block.