class RecipeML in Recipe 8.2

Default style plugin to render RecipeML.

Plugin annotation


@ViewsStyle(
  id = "recipeml",
  title = @Translation("RecipeML"),
  help = @Translation("Generates RecipeML from a view."),
  theme = "recipe_view_recipeml",
  display_types = {"recipe"}
)

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
  - class \Drupal\views\Plugin\views\PluginBase implements DependentPluginInterface, ContainerFactoryPluginInterface, TrustedCallbackInterface, ViewsPluginInterface
    class \Drupal\views\Plugin\views\style\StylePluginBase
    class \Drupal\recipe\Plugin\views\style\RecipeML

Expanded class hierarchy of RecipeML

2 string references to 'RecipeML'

recipe.views.schema.yml in config/schema/recipe.views.schema.yml: config/schema/recipe.views.schema.yml
views.view.recipeml.yml in config/optional/views.view.recipeml.yml: config/optional/views.view.recipeml.yml

File

src/Plugin/views/style/RecipeML.php, line 41: Copyright (c) FormatData. All rights reserved.

Namespace

Drupal\recipe\Plugin\views\style

View source

class RecipeML extends StylePluginBase {

  /**
   * {@inheritdoc}
   */
  protected $usesRowPlugin = FALSE;

  /**
   * {@inheritdoc}
   */
  protected $usesGrouping = FALSE;

  /**
   * {@inheritdoc}
   */
  protected $usesFields = TRUE;

  /**
   * {@inheritdoc}
   */
  public function attachTo(array &$build, $display_id, Url $url, $title) {
    $url_options = [];
    $input = $this->view
      ->getExposedInput();
    if ($input) {
      $url_options['query'] = $input;
    }
    $url_options['absolute'] = TRUE;

    // Attach a link to the RecipeML, which is an alternate representation.
    $build['#attached']['html_head_link'][][] = [
      'rel' => 'alternate',
      'type' => 'text/xml',
      'title' => $title,
      'href' => $url
        ->setOptions($url_options)
        ->toString(),
    ];
  }

  /**
   * {@inheritdoc}
   */
  protected function defineOptions() {
    $options = parent::defineOptions();
    $options['title_field'] = [
      'default' => '',
    ];
    $options['version_field'] = [
      'default' => '',
    ];
    $options['source_field'] = [
      'default' => '',
    ];
    $options['time_fields'] = [
      'default' => [],
    ];
    $options['yield_qty_field'] = [
      'default' => '',
    ];
    $options['yield_unit_field'] = [
      'default' => '',
    ];
    $options['description_field'] = [
      'default' => '',
    ];
    $options['ingredients_field'] = [
      'default' => '',
    ];
    $options['directions_field'] = [
      'default' => '',
    ];
    return $options;
  }

  /**
   * {@inheritdoc}
   */
  public function buildOptionsForm(&$form, FormStateInterface $form_state) {
    parent::buildOptionsForm($form, $form_state);
    $initial_labels = [
      '' => $this
        ->t('- None -'),
    ];
    $view_fields_labels = $this->displayHandler
      ->getFieldLabels();
    $view_fields_labels = array_merge($initial_labels, $view_fields_labels);
    $form['title_field'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Title field'),
      '#description' => $this
        ->t('The field that is going to be used as the recipe title for each row.'),
      '#options' => $view_fields_labels,
      '#default_value' => $this->options['title_field'],
      '#required' => TRUE,
    ];
    $form['version_field'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Version field'),
      '#description' => $this
        ->t('The field that is going to be used as the recipe version for each row.'),
      '#options' => $view_fields_labels,
      '#default_value' => $this->options['version_field'],
    ];
    $form['source_field'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Source field'),
      '#description' => $this
        ->t('The field that is going to be used as the recipe source for each row.'),
      '#options' => $view_fields_labels,
      '#default_value' => $this->options['source_field'],
    ];
    $form['time_fields'] = [
      '#type' => 'checkboxes',
      '#title' => t('Preptime fields'),
      '#description' => t('Fields that will be used as the recipe preptimes for each row.  Selected fields must be integers.  Note that the RecipeML preptime element may encompass multiple time elements such as the cooking time or total time.  It is not limited to the preparation time.'),
      '#options' => $this->displayHandler
        ->getFieldLabels(),
      '#default_value' => $this->options['time_fields'],
      '#multiple' => TRUE,
    ];
    $form['yield_qty_field'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Yield quantity field'),
      '#description' => $this
        ->t('The field that is going to be used as the recipe yield quantity for each row.'),
      '#options' => $view_fields_labels,
      '#default_value' => $this->options['yield_qty_field'],
    ];
    $form['yield_unit_field'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Yield unit field'),
      '#description' => $this
        ->t('The field that is going to be used as the recipe yield unit for each row.'),
      '#options' => $view_fields_labels,
      '#default_value' => $this->options['yield_unit_field'],
    ];
    $form['description_field'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Description field'),
      '#description' => $this
        ->t('The field that is going to be used as the recipe description for each row.'),
      '#options' => $view_fields_labels,
      '#default_value' => $this->options['description_field'],
    ];
    $form['ingredients_field'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Ingredients field'),
      '#description' => $this
        ->t('The field that is going to be used as the recipe ingredients for each row.'),
      '#options' => $view_fields_labels,
      '#default_value' => $this->options['ingredients_field'],
      '#required' => TRUE,
    ];
    $form['directions_field'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Directions field'),
      '#description' => $this
        ->t('The field that is going to be used as the recipe directions for each row.'),
      '#options' => $view_fields_labels,
      '#default_value' => $this->options['directions_field'],
      '#required' => TRUE,
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function validate() {
    $errors = parent::validate();
    $required_options = [
      'title_field',
      'ingredients_field',
      'directions_field',
    ];
    foreach ($required_options as $required_option) {
      if (empty($this->options[$required_option])) {
        $errors[] = $this
          ->t('Style plugin requires specifying which views fields to use for recipes.');
        break;
      }
    }
    return $errors;
  }

  /**
   * {@inheritdoc}
   */
  public function submitOptionsForm(&$form, FormStateInterface $form_state) {
    parent::submitOptionsForm($form, $form_state);
    $time_fields = $form_state
      ->getValue([
      'style_options',
      'time_fields',
    ]);
    $form_state
      ->setValue([
      'style_options',
      'time_fields',
    ], array_filter($time_fields));
  }

  /**
   * {@inheritdoc}
   */
  public function render() {
    $view_fields_labels = $this->displayHandler
      ->getFieldLabels();
    $rows = [];
    foreach ($this->view->result as $row_index => $row) {
      $this->view->row_index = $row_index;
      $time_fields = [];
      $total_time = 0;
      foreach ($this->options['time_fields'] as $time_field) {
        if (empty($time_field)) {
          continue;
        }
        $time_value = $this
          ->getField($row_index, $time_field);
        $time_fields[] = [
          'type' => $view_fields_labels[$time_field],
          'qty' => $time_value,
          'timeunit' => 'minutes',
        ];
        $total_time += (int) $time_value
          ->__toString();
      }

      // Add a total time field if there is more than one time_field.
      if (count($time_fields) > 1) {
        $time_fields[] = [
          'type' => 'Total time',
          'qty' => $total_time,
          'timeunit' => 'minutes',
        ];
      }
      $rows[] = [
        'langcode' => $row->_entity
          ->language()
          ->getId(),
        'title' => $this
          ->getField($row_index, $this->options['title_field']),
        'version' => $this
          ->getField($row_index, $this->options['version_field']),
        'source' => $this
          ->getField($row_index, $this->options['source_field']),
        'time_fields' => $time_fields,
        'yield_qty' => $this
          ->getField($row_index, $this->options['yield_qty_field']),
        'yield_unit' => $this
          ->getField($row_index, $this->options['yield_unit_field']),
        'description' => $this
          ->getField($row_index, $this->options['description_field']),
        'ingredients' => $this
          ->getField($row_index, $this->options['ingredients_field']),
        'directions' => $this
          ->getField($row_index, $this->options['directions_field']),
      ];
    }
    $build = [
      '#theme' => $this
        ->themeFunctions(),
      '#view' => $this->view,
      '#options' => $this->options,
      '#rows' => $rows,
    ];
    unset($this->view->row_index);
    return $build;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
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::$definition	public	property	Plugins's definition
PluginBase::$displayHandler	public	property	The display object this plugin is for.
PluginBase::$options	public	property	Options for this plugin will be held here.
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.	1
PluginBase::$pluginId	protected	property	The plugin_id.
PluginBase::$renderer	protected	property	Stores the render API renderer.	3
PluginBase::$view	public	property	The top object of a view.	1
PluginBase::calculateDependencies	public	function	Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies	14
PluginBase::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create	62
PluginBase::DERIVATIVE_SEPARATOR		constant	A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::doFilterByDefinedOptions	protected	function	Do the work to filter out stored options depending on the defined options.
PluginBase::filterByDefinedOptions	public	function	Filter out stored options depending on the defined options. Overrides ViewsPluginInterface::filterByDefinedOptions
PluginBase::getAvailableGlobalTokens	public	function	Returns an array of available token replacements. Overrides ViewsPluginInterface::getAvailableGlobalTokens
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::getProvider	public	function	Returns the plugin provider. Overrides ViewsPluginInterface::getProvider
PluginBase::getRenderer	protected	function	Returns the render API renderer.	1
PluginBase::globalTokenForm	public	function	Adds elements for available core tokens to a form. Overrides ViewsPluginInterface::globalTokenForm
PluginBase::globalTokenReplace	public	function	Returns a string with any core tokens replaced. Overrides ViewsPluginInterface::globalTokenReplace
PluginBase::INCLUDE_ENTITY		constant	Include entity row languages when listing languages.
PluginBase::INCLUDE_NEGOTIATED		constant	Include negotiated languages when listing languages.
PluginBase::isConfigurable	public	function	Determines if the plugin is configurable.
PluginBase::listLanguages	protected	function	Makes an array of languages, optionally including special languages.
PluginBase::pluginTitle	public	function	Return the human readable name of the display. Overrides ViewsPluginInterface::pluginTitle
PluginBase::preRenderAddFieldsetMarkup	public static	function	Moves form elements into fieldsets for presentation purposes. Overrides ViewsPluginInterface::preRenderAddFieldsetMarkup
PluginBase::preRenderFlattenData	public static	function	Flattens the structure of form elements. Overrides ViewsPluginInterface::preRenderFlattenData
PluginBase::queryLanguageSubstitutions	public static	function	Returns substitutions for Views queries for languages.
PluginBase::setOptionDefaults	protected	function	Fills up the options of the plugin with defaults.
PluginBase::summaryTitle	public	function	Returns the summary of the settings in the display. Overrides ViewsPluginInterface::summaryTitle	6
PluginBase::themeFunctions	public	function	Provide a full list of possible theme templates used by this style. Overrides ViewsPluginInterface::themeFunctions	1
PluginBase::unpackOptions	public	function	Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away. Overrides ViewsPluginInterface::unpackOptions
PluginBase::usesOptions	public	function	Returns the usesOptions property. Overrides ViewsPluginInterface::usesOptions	8
PluginBase::viewsTokenReplace	protected	function	Replaces Views' tokens in a given string. The resulting string will be sanitized with Xss::filterAdmin.	1
PluginBase::VIEWS_QUERY_LANGUAGE_SITE_DEFAULT		constant	Query string to indicate the site default language.
PluginBase::__construct	public	function	Constructs a PluginBase object. Overrides PluginBase::__construct
RecipeML::$usesFields	protected	property	Does the style plugin for itself support to add fields to its output. Overrides StylePluginBase::$usesFields
RecipeML::$usesGrouping	protected	property	Does the style plugin support grouping of rows. Overrides StylePluginBase::$usesGrouping
RecipeML::$usesRowPlugin	protected	property	Whether or not this style uses a row plugin. Overrides StylePluginBase::$usesRowPlugin
RecipeML::attachTo	public	function
RecipeML::buildOptionsForm	public	function	Provide a form to edit options for this plugin. Overrides StylePluginBase::buildOptionsForm
RecipeML::defineOptions	protected	function	Information about options for all kinds of purposes will be held here. Overrides StylePluginBase::defineOptions
RecipeML::render	public	function	Render the display in this style. Overrides StylePluginBase::render
RecipeML::submitOptionsForm	public	function	Handle any special handling on the validate form. Overrides PluginBase::submitOptionsForm
RecipeML::validate	public	function	Validate that the plugin is correct and can be saved. Overrides StylePluginBase::validate
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.
StylePluginBase::$defaultFieldLabels	protected	property	Should field labels be enabled by default.	1
StylePluginBase::$groupingTheme	protected	property	The theme function used to render the grouping set.
StylePluginBase::$rendered_fields	protected	property	Stores the rendered field values, keyed by the row index and field name.
StylePluginBase::$rowTokens	protected	property	Store all available tokens row rows.
StylePluginBase::$usesOptions	protected	property	Denotes whether the plugin has an additional options form. Overrides PluginBase::$usesOptions
StylePluginBase::$usesRowClass	protected	property	Does the style plugin support custom css class for the rows.	3
StylePluginBase::buildSort	public	function	Called by the view builder to see if this style handler wants to interfere with the sorts. If so it should build; if it returns any non-TRUE value, normal sorting will NOT be added to the query.	1
StylePluginBase::buildSortPost	public	function	Called by the view builder to let the style build a second set of sorts that will come after any other sorts in the view.	1
StylePluginBase::defaultFieldLabels	public	function	Return TRUE if this style enables field labels by default.	1
StylePluginBase::destroy	public	function	Clears a plugin. Overrides PluginBase::destroy
StylePluginBase::elementPreRenderRow	public	function	#pre_render callback for view row field rendering.
StylePluginBase::evenEmpty	public	function	Should the output of the style plugin be rendered even if it's a empty view.	2
StylePluginBase::getField	public	function	Gets a rendered field.
StylePluginBase::getFieldValue	public	function	Get the raw field value.
StylePluginBase::getRowClass	public	function	Return the token replaced row class for the specified row.
StylePluginBase::init	public	function	Overrides \Drupal\views\Plugin\views\PluginBase::init(). Overrides PluginBase::init
StylePluginBase::preRender	public	function	Allow the style to do stuff before each row is rendered.
StylePluginBase::query	public	function	Add anything to the query that we might need to. Overrides PluginBase::query	1
StylePluginBase::renderFields	protected	function	Renders all of the fields for a given style and store them on the object.
StylePluginBase::renderGrouping	public	function	Group records as needed for rendering.
StylePluginBase::renderGroupingSets	public	function	Render the grouping sets.
StylePluginBase::renderRowGroup	protected	function	Renders a group of rows of the grouped view.
StylePluginBase::tokenizeValue	public	function	Take a value and apply token replacement logic to it.
StylePluginBase::trustedCallbacks	public static	function	Lists the trusted callbacks provided by the implementing class. Overrides PluginBase::trustedCallbacks
StylePluginBase::usesFields	public	function	Return TRUE if this style also uses fields.	3
StylePluginBase::usesGrouping	public	function	Returns the usesGrouping property.	3
StylePluginBase::usesRowClass	public	function	Returns the usesRowClass property.	3
StylePluginBase::usesRowPlugin	public	function	Returns the usesRowPlugin property.	10
StylePluginBase::usesTokens	public	function	Return TRUE if this style uses tokens.
StylePluginBase::validateOptionsForm	public	function	Validate the options form. Overrides PluginBase::validateOptionsForm
StylePluginBase::wizardForm	public	function	Provide a form in the views wizard if this style is selected.
StylePluginBase::wizardSubmit	public	function	Alter the options of a display before they are added to the view.	1
TrustedCallbackInterface::THROW_EXCEPTION		constant	Untrusted callbacks throw exceptions.
TrustedCallbackInterface::TRIGGER_SILENCED_DEPRECATION		constant	Untrusted callbacks trigger silenced E_USER_DEPRECATION errors.
TrustedCallbackInterface::TRIGGER_WARNING		constant	Untrusted callbacks trigger E_USER_WARNING errors.

You are here

class RecipeML in Recipe 8.2

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation