Browse Source

Merge pull request #21637 from owncloud/reformat-irequest

fix identation in public/irequest.php
tags/v9.0beta1
Thomas Müller 8 years ago
parent
commit
3317dd0a8e
1 changed files with 16 additions and 4 deletions
  1. 16
    4
      lib/public/irequest.php

+ 16
- 4
lib/public/irequest.php View File

* Returns all params that were received, be it from the request * Returns all params that were received, be it from the request
* *
* (as GET or POST) or through the URL by the route * (as GET or POST) or through the URL by the route
*
* @return array the array with all parameters * @return array the array with all parameters
* @since 6.0.0 * @since 6.0.0
*/ */


/** /**
* Checks if the CSRF check was correct * Checks if the CSRF check was correct
*
* @return bool true if CSRF check passed * @return bool true if CSRF check passed
* @since 6.0.0 * @since 6.0.0
*/ */
/** /**
* Returns an ID for the request, value is not guaranteed to be unique and is mostly meant for logging * Returns an ID for the request, value is not guaranteed to be unique and is mostly meant for logging
* If `mod_unique_id` is installed this value will be taken. * If `mod_unique_id` is installed this value will be taken.
*
* @return string * @return string
* @since 8.1.0 * @since 8.1.0
*/ */
* and `forwarded_for_headers` has been configured then the IP address * and `forwarded_for_headers` has been configured then the IP address
* specified in this header will be returned instead. * specified in this header will be returned instead.
* Do always use this instead of $_SERVER['REMOTE_ADDR'] * Do always use this instead of $_SERVER['REMOTE_ADDR']
*
* @return string IP address * @return string IP address
* @since 8.1.0 * @since 8.1.0
*/ */
/** /**
* Returns the server protocol. It respects reverse proxy servers and load * Returns the server protocol. It respects reverse proxy servers and load
* balancers. * balancers.
*
* @return string Server protocol (http or https) * @return string Server protocol (http or https)
* @since 8.1.0 * @since 8.1.0
*/ */
public function getHttpProtocol(); public function getHttpProtocol();


/** /**
* Returns the request uri, even if the website uses one or more
* reverse proxies
* @return string
* Returns the request uri, even if the website uses one or more
* reverse proxies
*
* @return string
* @since 8.1.0 * @since 8.1.0
*/
*/
public function getRequestUri(); public function getRequestUri();


/** /**
* Get raw PathInfo from request (not urldecoded) * Get raw PathInfo from request (not urldecoded)
*
* @throws \Exception * @throws \Exception
* @return string Path info * @return string Path info
* @since 8.1.0 * @since 8.1.0


/** /**
* Get PathInfo from request * Get PathInfo from request
*
* @throws \Exception * @throws \Exception
* @return string|false Path info or false when not found * @return string|false Path info or false when not found
* @since 8.1.0 * @since 8.1.0
/** /**
* Returns the script name, even if the website uses one or more * Returns the script name, even if the website uses one or more
* reverse proxies * reverse proxies
*
* @return string the script name * @return string the script name
* @since 8.1.0 * @since 8.1.0
*/ */


/** /**
* Checks whether the user agent matches a given regex * Checks whether the user agent matches a given regex
*
* @param array $agent array of agent names * @param array $agent array of agent names
* @return bool true if at least one of the given agent matches, false otherwise * @return bool true if at least one of the given agent matches, false otherwise
* @since 8.1.0 * @since 8.1.0
/** /**
* Returns the unverified server host from the headers without checking * Returns the unverified server host from the headers without checking
* whether it is a trusted domain * whether it is a trusted domain
*
* @return string Server host * @return string Server host
* @since 8.1.0 * @since 8.1.0
*/ */
/** /**
* Returns the server host from the headers, or the first configured * Returns the server host from the headers, or the first configured
* trusted domain if the host isn't in the trusted list * trusted domain if the host isn't in the trusted list
*
* @return string Server host * @return string Server host
* @since 8.1.0 * @since 8.1.0
*/ */

Loading…
Cancel
Save