class Error in Openlayers 7.3

Class Error.

@OpenlayersPlugin( id = "Error", arguments = { "@logger.channel.default", "@messenger" } )

Dummy class to avoid breaking the whole processing if a plugin class is missing.

Hierarchy

class \Drupal\openlayers\Types\Base extends \Drupal\Component\Plugin\PluginBase implements ObjectInterface
- class \Drupal\openlayers\Types\Error implements ComponentInterface, ControlInterface, LayerInterface, SourceInterface, StyleInterface

Expanded class hierarchy of Error

1 string reference to 'Error'

Openlayers::load in src/Openlayers.php: Create an object instance for an export.

File

src/Types/Error.php, line 27: Contains class Error.

Namespace

Drupal\openlayers\Types

View source

class Error extends Base implements ControlInterface, ComponentInterface, LayerInterface, SourceInterface, StyleInterface {

  /**
   * Contains the error message string.
   *
   * @var string
   */
  public $errorMessage;

  /**
   * The loggerChannel service.
   *
   * @var \Drupal\Core\Logger\LoggerChannelInterface
   */
  protected $loggerChannel;

  /**
   * The messenger service.
   *
   * @var \Drupal\service_container\Messenger\MessengerInterface
   */
  protected $messenger;

  /**
   * {@inheritdoc}
   */
  public function __construct($configuration, $plugin_id, $plugin_definition, LoggerChannelInterface $logger_channel, MessengerInterface $messenger) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->loggerChannel = $logger_channel;
    $this->messenger = $messenger;
    $this->errorMessage = 'Error while loading @type @machine_name having service @service.';
    if (!empty($configuration['errorMessage'])) {
      $this->errorMessage = $configuration['errorMessage'];
    }
  }

  /**
   * {@inheritdoc}
   */
  public function init() {
    $this->loggerChannel
      ->error($this
      ->getMessage(), array(
      'channel' => 'openlayers',
    ));
    $this->messenger
      ->addMessage($this
      ->getMessage(), 'error', FALSE);
    return parent::init();
  }

  /**
   * {@inheritdoc}
   */
  public function getMessage() {
    $machine_name = $this
      ->getMachineName();
    $service = $this
      ->getFactoryService() ? $this
      ->getFactoryService() : t('undefined');
    $type = isset($this->configuration['type']) ? $this->configuration['type'] : 'undefined';
    return t($this->errorMessage, array(
      '@machine_name' => $machine_name,
      '@service' => $service,
      '@type' => $type,
    ));
  }

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

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

  /**
   * {@inheritdoc}
   */
  public function setStyle(StyleInterface $style) {
  }

  /**
   * {@inheritdoc}
   */
  public function setSource(SourceInterface $source) {
  }

  /**
   * {@inheritdoc}
   */
  public function setVisible($visibility) {
  }

  /**
   * {@inheritdoc}
   */
  public function setOpacity($opacity) {
  }

  /**
   * {@inheritdoc}
   */
  public function setZIndex($zindex) {
  }

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

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

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

}

Members

Name	Modifiers	Type	Description	Overrides
Base::$attached	protected	property	Holds all the attachment used by this object.	6
Base::$collection	protected	property	Holds the Collection object.
Base::$id	protected	property	A unique ID for the object.
Base::$options	protected	property	The array containing the options.	6
Base::addObject	public	function	Add an object into the collection of the parent object. Overrides ObjectInterface::addObject
Base::attached	public	function	Returns a list of attachments for building the render array. Overrides ObjectInterface::attached	6
Base::clearOption	public	function	Remove an option. Overrides ObjectInterface::clearOption
Base::dependencies	public	function	Defines dependencies. Overrides ObjectInterface::dependencies	3
Base::getClassDirectory	public	function	Returns the path to the plugin directory. Overrides ObjectInterface::getClassDirectory
Base::getClassPath	public	function	Returns the path to the class file. Overrides ObjectInterface::getClassPath
Base::getCollection	public	function	Return the Collection object linked to the object. Overrides ObjectInterface::getCollection
Base::getConfiguration	public	function	Return the object configuration. Overrides ObjectInterface::getConfiguration
Base::getDependencies	public	function	Return all the dependencies objects of the parent object. Overrides ObjectInterface::getDependencies
Base::getDescription	public	function	Return the description of the object. Overrides ObjectInterface::getDescription
Base::getExport	public	function	Return an object, CTools Exportable. Overrides ObjectInterface::getExport
Base::getFactoryService	public	function	Return the Factory Service of the object. Overrides ObjectInterface::getFactoryService
Base::getId	public	function	Return the object unique ID. Overrides ObjectInterface::getId
Base::getJS	public	function	!Attention! This function will remove any option that is named after a plugin type e.g.: layers, controls, styles, interactions, components . Overrides ObjectInterface::getJS	6
Base::getMachineName	public	function	Return the unique machine name of the object. Overrides ObjectInterface::getMachineName
Base::getName	public	function	Return the human name of the object. Overrides ObjectInterface::getName
Base::getObjects	public	function	Return an array of OL objects indexed by their type. Overrides ObjectInterface::getObjects
Base::getOption	public	function	Returns an option. Overrides ObjectInterface::getOption
Base::getOptions	public	function	Return the options array. Overrides ObjectInterface::getOptions
Base::getParents	public	function	Returns an array with the maps this object is attached on. Overrides ObjectInterface::getParents
Base::getPluginDescription	public	function	Return the description of the object's plugin. Overrides ObjectInterface::getPluginDescription
Base::getProvider	public	function	Return the module that provides this plugin. Overrides ObjectInterface::getProvider
Base::getType	public	function	The type of this object. Overrides ObjectInterface::getType
Base::getWeight	public	function	Get the weight of an object. Overrides ObjectInterface::getWeight
Base::i18nStringsRefresh	public	function	Refresh string translations. Overrides ObjectInterface::i18nStringsRefresh	1
Base::initCollection	public	function	Initializes the Collection, Import objects from options, Import the current object. Overrides ObjectInterface::initCollection
Base::isAsynchronous	public	function	Whether or not this object has to be processed asynchronously. Overrides ObjectInterface::isAsynchronous	3
Base::optionsForm	public	function	@TODO What is this return? If it is the form, why is form by reference? Overrides ObjectInterface::optionsForm	54
Base::optionsFormSubmit	public	function	Submit callback for the options form. Overrides ObjectInterface::optionsFormSubmit	11
Base::optionsFormValidate	public	function	Validation callback for the options form. Overrides ObjectInterface::optionsFormValidate
Base::optionsToObjects	public	function	Return a flat array containing Openlayers Objects from the options array. Overrides ObjectInterface::optionsToObjects	9
Base::postBuild	public	function	Invoked after an objects render array is built. Overrides ObjectInterface::postBuild	13
Base::preBuild	public	function	Invoked before an objects render array is built. Overrides ObjectInterface::preBuild	4
Base::removeObject	public	function	Remove an object from the collection. Overrides ObjectInterface::removeObject
Base::resetCollection	public	function	Reset the object's Collection. Overrides ObjectInterface::resetCollection
Base::setFactoryService	public	function	Set the Factory Service of the object. Overrides ObjectInterface::setFactoryService
Base::setId	public	function	Set the object ID. Overrides ObjectInterface::setId
Base::setOption	public	function	Set an option. Overrides ObjectInterface::setOption
Base::setOptions	public	function	Set the options array. Overrides ObjectInterface::setOptions
Base::setWeight	public	function	Set the weight of an object. Overrides ObjectInterface::setWeight
Error::$errorMessage	public	property	Contains the error message string.
Error::$loggerChannel	protected	property	The loggerChannel service.
Error::$messenger	protected	property	The messenger service.
Error::getMessage	public	function
Error::getOpacity	public	function	Return the opacity of the layer (between 0 and 1). Overrides LayerInterface::getOpacity
Error::getSource	public	function	Returns the source of this layer. Overrides LayerInterface::getSource
Error::getStyle	public	function	Returns the style of this layer. Overrides LayerInterface::getStyle
Error::getVisible	public	function	Return the visibility of the layer. Overrides LayerInterface::getVisible
Error::getZIndex	public	function	Return the Z-index of the layer. Overrides LayerInterface::getZIndex
Error::init	public	function	Initializes the object. Overrides Base::init
Error::setOpacity	public	function	Set the opacity of the layer. Overrides LayerInterface::setOpacity
Error::setSource	public	function	Set the source of this layer. Overrides LayerInterface::setSource
Error::setStyle	public	function	Set the style of this layer. Overrides LayerInterface::setStyle
Error::setVisible	public	function	Set the visibility of the layer. Overrides LayerInterface::setVisible
Error::setZIndex	public	function	Set Z-index of the layer, which is used to order layers before rendering. Overrides LayerInterface::setZIndex
Error::__construct	public	function

You are here

class Error in Openlayers 7.3

Hierarchy

File

Namespace

Members

API Navigation