visualn-8.x-1.x-dev/src/Core/DrawerSkinInterface.php

<?php

namespace Drupal\visualn\Core;

use Drupal\visualn\Core\VisualNPluginInterface;
use Drupal\Core\Plugin\PluginFormInterface;
use Drupal\Core\Form\FormStateInterface;
use Drupal\visualn\WindowParametersInterface;

/**
 * Defines an interface for VisualN Drawer Skin plugins.
 *
 * @see \Drupal\visualn\Core\DrawerSkinBase
 *
 * @ingroup drawer_skin_plugins
 */
interface DrawerSkinInterface extends VisualNPluginInterface, PluginFormInterface, WindowParametersInterface {

  /**
   * Extract drawer configuration array values from $form_state for drawer configuration form.
   *
   * @param array $form
   *
   * @param  \Drupal\Core\Form\FormStateInterface $form_state
   *
   * @return array $values
   *   An array of drawer_config values.
   */
  public function extractFormValues($form, FormStateInterface $form_state);

  /**
   * Get current skin instance UID.
   *
   * @todo: The methods could be moved into VisualNPluginInterface with a more
   *   generic name, e.g. getPluginUid() though currently used only by skin
   *   plugins but may be useful for combined drawers etc.
   */
  public function getSkinUid();

  /**
   * Set current skin instance UID.
   */
  public function setSkinUid($suid);

}