interface PreferredFeatureInterface in Open Social 10.3.x

Provides an interface defining a preferred feature.

Hierarchy

• interface \Drupal\social_branding\PreferredFeatureInterface

File

modules/social_features/social_branding/src/PreferredFeatureInterface.php, line 8

Namespace

Drupal\social_branding

interface PreferredFeatureInterface {

  /**
   * Get the name of the preferred feature.
   *
   * @return string
   *   The preferred feature name.
   */
  public function getName() : string;

  /**
   * Get the weight of the preferred feature.
   *
   * @return int
   *   The preferred feature weight.
   */
  public function getWeight() : int;

  /**
   * Set the weight of this preferred feature.
   *
   * @param int $weight
   *   An integer used to indicate ordering, with higher weights
   *   sinking: e.g. -1 will be above 0 and 1 will be below 0.
   *
   * @return $this
   *   The class instance that this method is called on.
   */
  public function setWeight(int $weight) : self;

}

Members

Name	Modifiers	Type	Description	Overrides
PreferredFeatureInterface::getName	public	function	Get the name of the preferred feature.
PreferredFeatureInterface::getWeight	public	function	Get the weight of the preferred feature.
PreferredFeatureInterface::setWeight	public	function	Set the weight of this preferred feature.