You are here

Home » API reference » IP Geolocation Views & Maps 8 » RecentVisistorsMapBlock.php

class RecentVisistorsMapBlock in IP Geolocation Views & Maps 8

IPGV&M: Set my location .

Plugin annotation


@Block(
  id = "recent_visitors_map",
  admin_label = @Translation("IPGV&M: Map (Google) most recent visitors"),
  category = @Translation("IP Geoloc"),
)

Hierarchy

Expanded class hierarchy of RecentVisistorsMapBlock

File

src/Plugin/Block/RecentVisistorsMapBlock.php, line 17

Namespace

Drupal\ip_geoloc\Plugin\Block
View source 
class RecentVisistorsMapBlock extends BlockBase {

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

    // Calling the set location form in block
    // TODO find a way to add subject.
    $block['subject'] = $this
      ->t('Recent visitors');
    $config = $this
      ->getConfiguration();
    $how_many = $config['ip_geoloc_recent_visitors_map_number_of_visitors'] ? $config['ip_geoloc_recent_visitors_map_number_of_visitors'] : 20;
    $block = [];
    if ($how_many > 0) {
      $map_style = $config['ip_geoloc_recent_visitors_map_div_style'] ? $config['ip_geoloc_recent_visitors_map_div_style'] : IP_GEOLOC_MAP_DIV_DEFAULT_STYLE;
      $locations = ip_geoloc_get_recent_visitor_locations($how_many);
      $map_options = $config['ip_geoloc_recent_visitors_map_options'] ? $config['ip_geoloc_recent_visitors_map_options'] : IP_GEOLOC_RECENT_VISITORS_MAP_OPTIONS;

      // TODO check if it is correct.
      $block = [
        '#theme' => 'ip_geoloc_visitor_map',
        '#locations' => $locations,
        '#div_id' => 'ip-geoloc-block-recent-visitors-map',
        '#map_options' => $map_options,
        '#map_style' => $map_style,
      ];
    }
    return $block;
  }

  /**
   * {@inheritdoc}
   */
  public function getCacheMaxAge() {
    return 0;
  }

  /**
   * {@inheritdoc}
   */
  public function blockForm($form, FormStateInterface $form_state) {
    $form = parent::blockForm($form, $form_state);

    // Retrieve existing configuration for this block.
    $config = $this
      ->getConfiguration();

    // Add fields for block configuration.
    $form['ip_geoloc_recent_visitors_map_number_of_visitors'] = [
      '#type' => 'textfield',
      '#title' => t('Number of recent visitor locations to show on the map.'),
      '#default_value' => $config['ip_geoloc_recent_visitors_map_number_of_visitors'] ? $config['ip_geoloc_recent_visitors_map_number_of_visitors'] : 20,
      '#description' => t('Must be greater than 0. Clustering is not supported, all markers are shown individually.'),
    ];
    $form['ip_geoloc_recent_visitors_map_div_style'] = [
      '#type' => 'textfield',
      '#title' => t('CSS style attribute(s) applied to the HTML DIV element that is placeholding the map'),
      '#default_value' => $config['ip_geoloc_recent_visitors_map_div_style'] ? $config['ip_geoloc_recent_visitors_map_div_style'] : IP_GEOLOC_MAP_DIV_DEFAULT_STYLE,
      '#description' => t('The default %default_style results in a map of 300 pixels high, with a width bounded by the element that contains it. Do not enter quotes or equal signs.', [
        '%default_style' => IP_GEOLOC_MAP_DIV_DEFAULT_STYLE,
      ]),
    ];
    $form['ip_geoloc_recent_visitors_map_options'] = [
      '#type' => 'textfield',
      '#size' => 120,
      '#title' => t('Map options'),
      '#default_value' => $config['ip_geoloc_recent_visitors_map_options'] ? $config['ip_geoloc_recent_visitors_map_options'] : IP_GEOLOC_RECENT_VISITORS_MAP_OPTIONS,
      '#description' => t("The default %default_options produces a world map zoomed in to level 2. A list of map options can be found <a href='!google_map_docs'>here</a>. Remember to separate options with comma's, not semi-colons, and make sure your quotes match.", [
        '%default_options' => IP_GEOLOC_RECENT_VISITORS_MAP_OPTIONS,
        '!google_map_docs' => IP_GEOLOC_DOC_GOOGLE_MAP_OPTIONS,
      ]),
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function blockSubmit($form, FormStateInterface $form_state) {

    // Migration comment:  Part of ip_geoloc_block_save for recent_visitors_map delta
    // Save options common to all maps.
    $this->configuration['ip_geoloc_recent_visitors_map_div_style'] = $form_state
      ->get('ip_geoloc_recent_visitors_map_div_style');

    // TODO Review function.
    ip_geoloc_save_map_options('ip_geoloc_recent_visitors_map_options', $form_state
      ->get('ip_geoloc_recent_visitors_map_options'));
    $this->configuration['ip_geoloc_recent_visitors_map_number_of_visitors'] = $form_state
      ->get('ip_geoloc_recent_visitors_map_number_of_visitors');
  }

}

Members

Namesort descending Modifiers Type Description Overrides
BlockPluginInterface::BLOCK_LABEL_VISIBLE constant Indicates the block label (title) should be displayed to end users.
BlockPluginTrait::$transliteration protected property The transliteration service.
BlockPluginTrait::access public function
BlockPluginTrait::baseConfigurationDefaults protected function Returns generic default configuration for block plugins.
BlockPluginTrait::blockAccess protected function Indicates whether the block should be shown. 16
BlockPluginTrait::blockValidate public function 3
BlockPluginTrait::buildConfigurationForm public function 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. 2
BlockPluginTrait::calculateDependencies public function
BlockPluginTrait::defaultConfiguration public function 19
BlockPluginTrait::getConfiguration public function 1
BlockPluginTrait::getMachineNameSuggestion public function 1
BlockPluginTrait::getPreviewFallbackString public function 3
BlockPluginTrait::label public function
BlockPluginTrait::setConfiguration public function
BlockPluginTrait::setConfigurationValue public function
BlockPluginTrait::setTransliteration public function Sets the transliteration service.
BlockPluginTrait::submitConfigurationForm public function Most block plugins should not override this method. To add submission handling for a specific block type, override BlockBase::blockSubmit().
BlockPluginTrait::transliteration protected function Wraps the transliteration service.
BlockPluginTrait::validateConfigurationForm public function Most block plugins should not override this method. To add validation for a specific block type, override BlockBase::blockValidate(). 1
BlockPluginTrait::__construct public function 22
ContextAwarePluginAssignmentTrait::addContextAssignmentElement protected function Builds a form element for assigning a context to a given slot.
ContextAwarePluginAssignmentTrait::contextHandler protected function Wraps the context handler.
ContextAwarePluginBase::$context protected property The data objects representing the context of this plugin.
ContextAwarePluginBase::$contexts Deprecated private property Data objects representing the contexts passed in the plugin configuration.
ContextAwarePluginBase::createContextFromConfiguration protected function Overrides ContextAwarePluginBase::createContextFromConfiguration
ContextAwarePluginBase::getCacheContexts public function The cache contexts associated with this object. Overrides CacheableDependencyInterface::getCacheContexts 9
ContextAwarePluginBase::getCacheTags public function The cache tags associated with this object. Overrides CacheableDependencyInterface::getCacheTags 4
ContextAwarePluginBase::getContext public function This code is identical to the Component in order to pick up a different Context class. Overrides ContextAwarePluginBase::getContext
ContextAwarePluginBase::getContextDefinition public function Overrides ContextAwarePluginBase::getContextDefinition
ContextAwarePluginBase::getContextDefinitions public function Overrides ContextAwarePluginBase::getContextDefinitions
ContextAwarePluginBase::getContextMapping public function Gets a mapping of the expected assignment names to their context names. Overrides ContextAwarePluginInterface::getContextMapping
ContextAwarePluginBase::getContexts public function Gets the defined contexts. Overrides ContextAwarePluginInterface::getContexts
ContextAwarePluginBase::getContextValue public function Gets the value for a defined context. Overrides ContextAwarePluginInterface::getContextValue
ContextAwarePluginBase::getContextValues public function Gets the values for all defined contexts. Overrides ContextAwarePluginInterface::getContextValues
ContextAwarePluginBase::setContext public function Set a context on this plugin. Overrides ContextAwarePluginBase::setContext
ContextAwarePluginBase::setContextMapping public function Sets a mapping of the expected assignment names to their context names. Overrides ContextAwarePluginInterface::setContextMapping
ContextAwarePluginBase::setContextValue public function Sets the value for a defined context. Overrides ContextAwarePluginBase::setContextValue
ContextAwarePluginBase::validateContexts public function Validates the set values for the defined contexts. Overrides ContextAwarePluginInterface::validateContexts
ContextAwarePluginBase::__get public function Implements magic __get() method.
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
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.
PluginWithFormsTrait::getFormClass public function
PluginWithFormsTrait::hasFormClass public function
RecentVisistorsMapBlock::blockForm public function Overrides BlockPluginTrait::blockForm
RecentVisistorsMapBlock::blockSubmit public function Overrides BlockPluginTrait::blockSubmit
RecentVisistorsMapBlock::build public function Builds and returns the renderable array for this block plugin. Overrides BlockPluginInterface::build
RecentVisistorsMapBlock::getCacheMaxAge public function The maximum age for which this object may be cached. Overrides ContextAwarePluginBase::getCacheMaxAge
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.
TypedDataTrait::$typedDataManager protected property The typed data manager used for creating the data types.
TypedDataTrait::getTypedDataManager public function Gets the typed data manager. 2
TypedDataTrait::setTypedDataManager public function Sets the typed data manager. 2