<?php

namespace Drupal\dds_global_content;

use Drupal\Component\Plugin\DerivativeInspectionInterface;
use Drupal\Component\Plugin\PluginInspectionInterface;
use Drupal\Core\Config\Config;
use Drupal\Core\Form\FormStateInterface;

interface GlobalContentPluginInterface extends PluginInspectionInterface, DerivativeInspectionInterface {

  /**
   * Returns an array of names of content types for use in the administration
   * interface.
   *
   * @return array
   */
  public function getTypeNames();

  /**
   * Tells whether the plugin supports tokens or not.
   *
   * @return bool
   */
  public function hasTokenSupport();

  /**
   * @param $setting
   *
   * @return mixed|null
   */
  public function getRenderSettings($setting);

  /**
   * @param ViewableGlobalContent $view
   * @param string $key
   *
   * @return mixed
   */
  public function value(ViewableGlobalContent $view, $key = '');

  /**
   * @param GlobalContent $view
   *
   * @return array
   *   A render array to render the global content type.
   */
  public function render(ViewableGlobalContent $view);

  /**
   * @param GlobalContent $globalContent
   *
   * @return array
   *   A render array to render a summery of the global content type.
   */
  public function summary(GlobalContent $globalContent);

  /**
   * @param \Drupal\dds_global_content\GlobalContent $globalContent
   *
   * @return array
   */
  public function formBuilder(GlobalContent $globalContent);

  /**
   * @param array $form
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *
   * @return bool
   */
  public function validate(&$form, FormStateInterface $form_state);

  /**
   * @param \Drupal\dds_global_content\GlobalContent $globalContent
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   */
  public function submit(GlobalContent $globalContent, FormStateInterface $form_state);

  /**
   * @param \Drupal\Core\Config\Config $config
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *
   * @return array
   */
  public function settingsForm(Config $config, FormStateInterface $form_state);

  /**
   * @param \Drupal\Core\Config\Config $config
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *
   * @return bool
   */
  public function settingsValidate(Config $config, FormStateInterface $form_state);

  /**
   * @param \Drupal\Core\Config\Config $config
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   */
  public function settingsSubmit(Config $config, FormStateInterface $form_state);

}