SproutCMS

class WidgetArea

Stores information about an individual widget area, including the names of all widgets
that are allowed to be in this area.

• File: /sprout/Helpers/WidgetArea.php
• Namespace: Sprout\Helpers

Extending this class

<?php
/**
* New class description goes here
* 
* @author Your Name, 2024-11-25
**/
class NewClassName extends WidgetArea {
    
    /**
    * Returns the widget area which has the specified name.
    * Uses the widget areas defined in the sprout config.
    **/
    public function findAreaByName (string $name) {
        // Method code goes here
    }
    
    /**
    * Adds a widget to the list of widgets allowed for this area
    **/
    public function addDefault (string $widget_name, $settings) {
        // Method code goes here
    }
    
    /**
    * Gets the list of allowed widgets
    **/
    public function getWidgets () {
        // Method code goes here
    }
    
    /**
    * Adds a widget to the list of widgets allowed for this area
    **/
    public function addWidget (string $widget_name) {
        // Method code goes here
    }
    
    /**
    * Returns the index of this widget area
    **/
    public function getIndex () {
        // Method code goes here
    }
    
    /**
    * If the widget area is an embedding area
    **/
    public function isEmbed () {
        // Method code goes here
    }
    
    /**
    * Gets the orientation of the widget area
    **/
    public function getOrientation () {
        // Method code goes here
    }
    
    /**
    * If true, the widget area is an 'embedding' area.
    **/
    public function setEmbed ($embed) {
        // Method code goes here
    }
    
    /**
    * Sets the orientation of the widget area
    **/
    public function setOrientation (int $value) {
        // Method code goes here
    }
    
    /**
    * Sets the nice name of this widget area
    **/
    public function setNiceName (string $name) {
        // Method code goes here
    }
    
    /**
    * Returns the nice name of this widget area
    **/
    public function getNiceName () {
        // Method code goes here
    }
    
    /**
    * Returns the name of this widget area
    **/
    public function getName () {
        // Method code goes here
    }
    
    /**
    * Constructor
    **/
    public function __construct (string $name, int $index) {
        // Method code goes here
    }
    
}
?>