whitelabel-8.x-2.x-dev/src/Entity/WhiteLabelInterface.php

<?php

namespace Drupal\whitelabel\Entity;

use Drupal\Core\Entity\ContentEntityInterface;
use Drupal\Core\Entity\RevisionLogInterface;
use Drupal\entity_reference_revisions\EntityNeedsSaveInterface;
use Drupal\file\FileInterface;
use Drupal\user\EntityOwnerInterface;

/**
 * Provides an interface defining a white label entity.
 */
interface WhiteLabelInterface extends ContentEntityInterface, EntityOwnerInterface, EntityNeedsSaveInterface, RevisionLogInterface {

  /**
   * Gets a white label token.
   *
   * @return string
   *   The white label token.
   */
  public function getToken();

  /**
   * Set a white label token.
   *
   * @param string $token
   *   The white label token.
   *
   * @return $this
   */
  public function setToken($token);

  /**
   * Gets the white label site name visibility.
   *
   * @return string
   *   The white label site name visibility.
   */
  public function getNameDisplay();

  /**
   * Sets the white label site name visibility.
   *
   * @param string $value
   *   The white label site name visibility.
   *
   * @return $this
   */
  public function setNameDisplay($value);

  /**
   * Gets the white label site name.
   *
   * @return string
   *   The white label site name.
   */
  public function getName();

  /**
   * Sets the white label site name.
   *
   * @param string $name
   *   The white label site name.
   *
   * @return $this
   */
  public function setName($name);

  /**
   * Gets the white label slogan.
   *
   * @return string
   *   The white label slogan.
   */
  public function getSlogan();

  /**
   * Sets a white label slogan.
   *
   * @param string $slogan
   *   The white label slogan.
   *
   * @return $this
   */
  public function setSlogan($slogan);

  /**
   * Gets a white label logo.
   *
   * @return \Drupal\file\FileInterface
   *   The image file entity.
   */
  public function getLogo();

  /**
   * Sets a white label logo.
   *
   * @param \Drupal\file\FileInterface $file
   *   The image file entity.
   *
   * @return $this
   */
  public function setLogo(FileInterface $file);

  /**
   * Gets a white label theme.
   *
   * @return string|null
   *   The system name of the theme.
   */
  public function getTheme();

  /**
   * Sets a white label theme.
   *
   * @param string $theme
   *   The system name of the theme.
   *
   * @return $this
   */
  public function setTheme($theme);

  /**
   * Gets a white label palette.
   *
   * @return array
   *   An array of hex color codes, keyed by the color variable name.
   */
  public function getPalette();

  /**
   * Sets a white label palette.
   *
   * @param array $palette
   *   An array of hex color codes, keyed by the color variable name.
   *
   * @return $this
   */
  public function setPalette(array $palette);

}