SproutCMS

class Request

Get information about the incoming HTTP request.

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

Extending this class

<?php
/**
* New class description goes here
* 
* @author Your Name, 2026-09-16
**/
class NewClassName extends Request {
    
    /**
    * Get the headers as an array.
    * 
    * All keys are lowercase.
    **/
    public function getHeaders () {
        // Method code goes here
    }
    
    /**
    * Returns quality factor at which the client accepts content type.
    **/
    public function acceptsAtQuality (string $type, boolean $explicit_check) {
        // Method code goes here
    }
    
    /**
    * Compare the q values for given array of content types and return the one with the highest value.
    * If items are found to have the same q value, the first one encountered in the given array wins.
    * If all items in the given array have a q value of 0, FALSE is returned.
    **/
    public function preferredAccept (array $types, boolean $explicit_check) {
        // Method code goes here
    }
    
    /**
    * Parses client's HTTP Accept request header, and builds array structure representing it.
    **/
    protected function parseAcceptHeader () {
        // Method code goes here
    }
    
    /**
    * Returns boolean of whether client accepts content type.
    **/
    public function accepts (string $type, boolean $explicit_check) {
        // Method code goes here
    }
    
    /**
    * Tests if the current request is an AJAX request by checking the X-Requested-With HTTP
    * request header that most popular JS frameworks now set for AJAX calls.
    **/
    public function isAjax () {
        // Method code goes here
    }
    
    /**
    * Returns current request method.
    **/
    public function method () {
        // Method code goes here
    }
    
    /**
    * Returns the users IP address, accounting for proxy forwarding
    **/
    public function userIp () {
        // Method code goes here
    }
    
    /**
    * Returns the HTTP referrer, or the default if the referrer is not set.
    **/
    public function referrer (mixed $default) {
        // Method code goes here
    }
    
    /**
    * Returns the current request protocol, based on $_SERVER['https']. In CLI
    * mode, NULL will be returned.
    **/
    public function protocol () {
        // Method code goes here
    }
    
}
?>