You are here

Home » API reference » Easychart 8.3 » Easychart.php

class Easychart in Easychart 8.3

Same name in this branch
  1. 8.3 src/Plugin/entity_embed/EntityEmbedDisplay/Easychart.php \Drupal\easychart\Plugin\entity_embed\EntityEmbedDisplay\Easychart
  2. 8.3 src/Plugin/Field/FieldFormatter/Easychart.php \Drupal\easychart\Plugin\Field\FieldFormatter\Easychart
  3. 8.3 src/Plugin/Field/FieldWidget/Easychart.php \Drupal\easychart\Plugin\Field\FieldWidget\Easychart
  4. 8.3 src/Plugin/Field/FieldType/Easychart.php \Drupal\easychart\Plugin\Field\FieldType\Easychart

Provides a default Easychart widget.

Plugin annotation


@FieldWidget(
  id = "easychart_default",
  label = @Translation("Chart"),
  field_types = {
    "easychart"
  }
)

Hierarchy

Expanded class hierarchy of Easychart

4 string references to 'Easychart'
easychart.info.yml in ./easychart.info.yml
easychart.info.yml
easychart.links.menu.yml in ./easychart.links.menu.yml
easychart.links.menu.yml
easychart.routing.yml in ./easychart.routing.yml
easychart.routing.yml
Easychart::formElement in src/Plugin/Field/FieldWidget/Easychart.php
Returns the form for a single field widget.

File

src/Plugin/Field/FieldWidget/Easychart.php, line 25
Contains \Drupal\easychart\Plugin\Field\FieldWidget\EasychartWidget.

Namespace

Drupal\easychart\Plugin\Field\FieldWidget
View source 
class Easychart extends WidgetBase {

  /**
   * {@inheritdoc}
   */
  public function formElement(FieldItemListInterface $items, $delta, array $element, array &$form, FormStateInterface $form_state) {

    // Get easychart entity field values.
    $field_name = $items
      ->getFieldDefinition()
      ->getName();
    $entity = $items
      ->getEntity();
    $values = $entity
      ->get($field_name)
      ->getValue();
    $config = \Drupal::config('easychart.settings');

    // Get the options.
    $options = '';
    if (file_exists('public://easychart-options.json')) {
      $options = file_get_contents('public://easychart-options.json');
    }
    $settings = [
      'easychartOptions' => $options,
      'easychartPresets' => $config
        ->get('presets'),
      'easychartTemplates' => $config
        ->get('templates'),
      'easychartCustomize' => \Drupal::currentUser()
        ->hasPermission('access full easychart configuration'),
    ];

    // Attach settings and libraries to render array.
    $element['#attached']['drupalSettings']['easychart'] = $settings;
    $element['#attached']['library'][] = 'easychart/easychart.widget';
    $element['#attached']['library'][] = 'easychart/lib.highcharts';
    $element['#attached']['library'][] = 'easychart/lib.easycharts.full';
    $element['container'] = array(
      '#prefix' => '<div class="easychart-wrapper clearfix entity-meta">',
      '#suffix' => '</div>',
      '#type' => 'container',
      '#attributes' => array(
        'class' => array(
          'entity-meta__header clearfix',
        ),
        'style' => array(
          'padding:0;',
        ),
      ),
    );
    $element['container']['config'] = array(
      '#description' => $this
        ->t('The configuration options as described at http://api.highcharts.com/highcharts'),
      '#type' => 'hidden',
      '#default_value' => isset($values[$delta]['config']) ? $values[$delta]['config'] : NULL,
      '#attributes' => array(
        'class' => array(
          'easychart-config',
        ),
      ),
    );
    $element['container']['csv'] = array(
      '#type' => 'hidden',
      '#description' => $this
        ->t('Your chart data in CSV format'),
      '#default_value' => isset($values[$delta]['csv']) ? $values[$delta]['csv'] : NULL,
      '#attributes' => array(
        'class' => array(
          'easychart-csv',
        ),
      ),
      '#element_validate' => array(
        array(
          get_called_class(),
          'validateCSVElement',
        ),
      ),
      '#csv_required' => $element['#required'],
    );
    $element['container']['csv_url'] = array(
      '#type' => 'hidden',
      '#description' => $this
        ->t('The URL to a CSV file'),
      '#default_value' => isset($values[$delta]['csv_url']) ? $values[$delta]['csv_url'] : NULL,
      '#attributes' => array(
        'class' => array(
          'easychart-csv-url',
        ),
      ),
    );
    $element['container']['preview'] = array(
      '#title' => $this
        ->t('Easychart'),
      '#markup' => '',
      '#prefix' => '<div class="easychart-embed"><div class="easychart-header"><span class="toggle">' . t('Toggle Fullscreen') . '</span></div>',
      '#suffix' => '</div>',
    );
    return $element;
  }

  /**
   * CSV validate method.
   *
   * @param $element
   *   The csv element.
   * @param FormStateInterface $form_state
   *   The form state interface.
   */
  public static function validateCSVElement($element, FormstateInterface $form_state) {
    if ($element['#csv_required'] && empty($element['#value'])) {
      $form_state
        ->setError($element, t('Please create an Easychart chart before saving.'));
    }
  }

  /**
   * {@inheritdoc}
   */
  public function massageFormValues(array $values, array $form, FormStateInterface $form_state) {

    // The EasychartWidget form element returns an associative array with hidden
    // form elements, so we need to re-assign those values at the right $values
    // array keys.
    $i = 0;
    foreach ($values as &$value) {
      $value = $values[$i]['container'];
      $i++;
    }
    return $values;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
AllowedTagsXssTrait::allowedTags public function Returns a list of tags allowed by AllowedTagsXssTrait::fieldFilterXss().
AllowedTagsXssTrait::displayAllowedTags public function Returns a human-readable list of allowed tags for display in help texts.
AllowedTagsXssTrait::fieldFilterXss public function Filters an HTML string to prevent XSS vulnerabilities.
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
Easychart::formElement public function Returns the form for a single field widget. Overrides WidgetInterface::formElement
Easychart::massageFormValues public function Massages the form values into the format expected for field values. Overrides WidgetBase::massageFormValues
Easychart::validateCSVElement public static function CSV validate method.
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.
PluginSettingsBase::$defaultSettingsMerged protected property Whether default settings have been merged into the current $settings.
PluginSettingsBase::$thirdPartySettings protected property The plugin settings injected by third party modules.
PluginSettingsBase::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies 6
PluginSettingsBase::defaultSettings public static function Defines the default settings for this plugin. Overrides PluginSettingsInterface::defaultSettings 42
PluginSettingsBase::getSetting public function Returns the value of a setting, or its default value if absent. Overrides PluginSettingsInterface::getSetting
PluginSettingsBase::getSettings public function Returns the array of settings, including defaults for missing settings. Overrides PluginSettingsInterface::getSettings
PluginSettingsBase::getThirdPartyProviders public function Gets the list of third parties that store information. Overrides ThirdPartySettingsInterface::getThirdPartyProviders
PluginSettingsBase::getThirdPartySetting public function Gets the value of a third-party setting. Overrides ThirdPartySettingsInterface::getThirdPartySetting
PluginSettingsBase::getThirdPartySettings public function Gets all third-party settings of a given module. Overrides ThirdPartySettingsInterface::getThirdPartySettings
PluginSettingsBase::mergeDefaults protected function Merges default settings values into $settings.
PluginSettingsBase::onDependencyRemoval public function Informs the plugin that some configuration it depends on will be deleted. Overrides PluginSettingsInterface::onDependencyRemoval 3
PluginSettingsBase::setSetting public function Sets the value of a setting for the plugin. Overrides PluginSettingsInterface::setSetting
PluginSettingsBase::setSettings public function Sets the settings for the plugin. Overrides PluginSettingsInterface::setSettings
PluginSettingsBase::setThirdPartySetting public function Sets the value of a third-party setting. Overrides ThirdPartySettingsInterface::setThirdPartySetting
PluginSettingsBase::unsetThirdPartySetting public function Unsets a third-party setting. Overrides ThirdPartySettingsInterface::unsetThirdPartySetting
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.
WidgetBase::$fieldDefinition protected property The field definition.
WidgetBase::$settings protected property The widget settings. Overrides PluginSettingsBase::$settings
WidgetBase::addMoreAjax public static function Ajax callback for the "Add another item" button.
WidgetBase::addMoreSubmit public static function Submission handler for the "Add another item" button.
WidgetBase::afterBuild public static function After-build handler for field elements in a form.
WidgetBase::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create 5
WidgetBase::errorElement public function Assigns a field-level validation error to the right widget sub-element. Overrides WidgetInterface::errorElement 8
WidgetBase::extractFormValues public function Extracts field values from submitted form values. Overrides WidgetBaseInterface::extractFormValues 2
WidgetBase::flagErrors public function Reports field-level validation errors against actual form elements. Overrides WidgetBaseInterface::flagErrors 2
WidgetBase::form public function Creates a form element for a field. Overrides WidgetBaseInterface::form 3
WidgetBase::formMultipleElements protected function Special handling to create form elements for multiple values. 1
WidgetBase::formSingleElement protected function Generates the form element for a single copy of the widget.
WidgetBase::getFieldSetting protected function Returns the value of a field setting.
WidgetBase::getFieldSettings protected function Returns the array of field settings.
WidgetBase::getFilteredDescription protected function Returns the filtered field description.
WidgetBase::getWidgetState public static function Retrieves processing information about the widget from $form_state. Overrides WidgetBaseInterface::getWidgetState
WidgetBase::getWidgetStateParents protected static function Returns the location of processing information within $form_state.
WidgetBase::handlesMultipleValues protected function Returns whether the widget handles multiple values.
WidgetBase::isApplicable public static function Returns if the widget can be used for the provided field. Overrides WidgetInterface::isApplicable 4
WidgetBase::isDefaultValueWidget protected function Returns whether the widget used for default value form.
WidgetBase::settingsForm public function Returns a form to configure settings for the widget. Overrides WidgetInterface::settingsForm 16
WidgetBase::settingsSummary public function Returns a short summary for the current widget settings. Overrides WidgetInterface::settingsSummary 15
WidgetBase::setWidgetState public static function Stores processing information about the widget in $form_state. Overrides WidgetBaseInterface::setWidgetState
WidgetBase::__construct public function Constructs a WidgetBase object. Overrides PluginBase::__construct 5