interface FieldTypeCategoryInterface

Same name and namespace in other branches
  1. 10 core/lib/Drupal/Core/Field/FieldTypeCategoryInterface.php \Drupal\Core\Field\FieldTypeCategoryInterface

Provides an object that returns the category info about the field type.

Hierarchy

Expanded class hierarchy of FieldTypeCategoryInterface

All classes that implement FieldTypeCategoryInterface

File

core/lib/Drupal/Core/Field/FieldTypeCategoryInterface.php, line 8

Namespace

Drupal\Core\Field
View source 
interface FieldTypeCategoryInterface {
    
    /**
     * Returns the field group label.
     *
     * @return string|\Stringable
     *   The category label.
     */
    public function getLabel() : string|\Stringable;
    
    /**
     * Returns the field group description.
     *
     * @return string|\Stringable
     *   The category description.
     */
    public function getDescription() : string|\Stringable;
    
    /**
     * Returns the field group weight.
     *
     * @return int
     *   The weight.
     */
    public function getWeight() : int;
    
    /**
     * Returns asset libraries for the field group.
     *
     * @return array
     *   The asset libraries to attach.
     */
    public function getLibraries() : array;

}

Members

Title Modifiers Object type Summary Overrides
FieldTypeCategoryInterface::getDescription public function Returns the field group description. 1
FieldTypeCategoryInterface::getLabel public function Returns the field group label. 1
FieldTypeCategoryInterface::getLibraries public function Returns asset libraries for the field group. 1
FieldTypeCategoryInterface::getWeight public function Returns the field group weight. 1

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.