SproutCMS

This is the code documentation for the SproutCMS project

class RefineBar

Provides the search refinement options in the admin UI

Extending this class

<?php
/**
* New class description goes here
* 
* @author Your Name, 2026-08-15
**/
class NewClassName extends RefineBar {
    
    /**
    * Return the operator to use in WHERE clauses, for a given field
    **/
    public function getOperator (string $field_name) {
        // Method code goes here
    }
    
    /**
    * Return a list of search widgets, in groups
    **/
    public function getGroups () {
        // Method code goes here
    }
    
    /**
    * Returns true if any of the refine bar widgets refer to the specified field
    **/
    public function hasField ($field_name) {
        // Method code goes here
    }
    
    /**
    * Renders the bar
    **/
    public function render () {
        // Method code goes here
    }
    
    public function setGroup ($name) {
        // Method code goes here
    }
    
    /**
    * Gets the bar
    **/
    public function get () {
        // Method code goes here
    }
    
    /**
    * Add a refine widget
    **/
    public function addWidget (RefineWidget $widget, string $operator) {
        // Method code goes here
    }
    
}
?>