SproutCMS

class Widgets

Provided functions for the display of widgets

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

Extending this class

<?php
/**
* New class description goes here
* 
* @author Your Name, 2024-11-25
**/
class NewClassName extends Widgets {
    
    /**
    * Draw the widgets for a specific area
    * 
    * The available widget areas are defined in the {@link /config/sprout.php} file.
    * Typically there are two areas defined, 'sidebar' and 'embedded'.
    **/
    public function renderArea (string $area_name) {
        // Method code goes here
    }
    
    /**
    * Render a widget area, and output directly
    **/
    public function area ($area_name) {
        // Method code goes here
    }
    
    /**
    * Does the specified widget area have widgets?
    **/
    public function hasWidgets (string $area_name) {
        // Method code goes here
    }
    
    /**
    * Check whether the widget is allowed to be displayed
    **/
    public function checkDisplayConditions (array $env, array $conditions) {
        // Method code goes here
    }
    
    /**
    * Render extra widget info for admins
    **/
    private function infobox ($inst) {
        // Method code goes here
    }
    
    /**
    * Instantiate, import settings, and render
    **/
    public function render (int $orientation, string $name, array $settings, string $pre_html, string $post_html, string $heading, string $template) {
        // Method code goes here
    }
    
    /**
    * Create an instance of a specific widget in memory
    **/
    public function instantiate (string $name) {
        // Method code goes here
    }
    
    /**
    * Remove a widget to the list of widgets for a specific area
    **/
    public function remove (int $area_id, string $name) {
        // Method code goes here
    }
    
    /**
    * Add a widget to the list of widgets for a specific area
    **/
    public function add (int $area_id, string $name, array $settings, string $heading, string $template) {
        // Method code goes here
    }
    
}
?>