Same name in other branches
  1. 4.x src/Entity/QuickTabsInstanceInterface.php \Drupal\quicktabs\Entity\QuickTabsInstanceInterface

Interface for QuickTabsInstance.

Hierarchy

Expanded class hierarchy of QuickTabsInstanceInterface

All classes that implement QuickTabsInstanceInterface

File

src/Entity/QuickTabsInstanceInterface.php, line 10

Namespace

Drupal\quicktabs\Entity
View source
interface QuickTabsInstanceInterface extends ConfigEntityInterface {
    
    /**
     * Returns the label for the current instance.
     *
     * @return string
     *   Label string.
     */
    public function getLabel();
    
    /**
     * Returns the machine name of the plugin that will render this instance.
     *
     * @return string
     *   Renderer name string.
     */
    public function getRenderer();
    
    /**
     * Returns the array of options that current instance will use to build a tab.
     *
     * @return array
     *   Instance options array.
     */
    public function getOptions() : array;
    
    /**
     * Returns boolean value of empty tabs setting.
     *
     * @return bool
     *   Empty tabs setting.
     */
    public function getHideEmptyTabs();
    
    /**
     * Returns the number of the default tab for this instance.
     *
     * @return string
     *   Default tab number.
     */
    public function getDefaultTab();
    
    /**
     * Returns the array of data that will be used to build the tabs.
     *
     * @return array
     *   Data for tabs.
     */
    public function getConfigurationData();
    
    /**
     * Sets the configuration data array.
     *
     * @param array $configuration_data
     *   Configuration data array.
     */
    public function setConfigurationData(array $configuration_data);

}

Members

Title Sort descending Modifiers Object type Summary Overrides
QuickTabsInstanceInterface::getConfigurationData public function Returns the array of data that will be used to build the tabs. 1
QuickTabsInstanceInterface::getDefaultTab public function Returns the number of the default tab for this instance. 1
QuickTabsInstanceInterface::getHideEmptyTabs public function Returns boolean value of empty tabs setting. 1
QuickTabsInstanceInterface::getLabel public function Returns the label for the current instance. 1
QuickTabsInstanceInterface::getOptions public function Returns the array of options that current instance will use to build a tab. 1
QuickTabsInstanceInterface::getRenderer public function Returns the machine name of the plugin that will render this instance. 1
QuickTabsInstanceInterface::setConfigurationData public function Sets the configuration data array. 1