symfony API

sfWebRequest Class

You are currently browsing
the website for symfony 1

Visit the Symfony2 website


« Back to API menu

1.1 API OpenSearch

Packages

You are currently browsing the symfony API for the 1.1 version. Switch to:
This version of symfony is not maintained anymore.
If some of your projects still use this version, consider upgrading as soon as possible.

sfWebRequest class.

Inheritence

sfWebRequest  <  sfRequest

Method Summary

Methods inherited from sfRequest

extractParameters , getAttribute , getAttributeHolder , getError , getErrorNames , getErrors , getMethod , getParameter , getParameterHolder , hasAttribute , hasError , hasErrors , hasParameter , initialize , removeError , setAttribute , setError , setErrors , setMethod , setParameter , __call , __construct

Method Details

  • (array) convertFileInformation ($taintedFiles) Browse code

    $taintedFiles An array representing uploaded file information

    Converts uploaded file array to a format following the $_GET and $POST naming convention.


    It's safe to pass an already converted array, in which case this method just returns the original array unmodified.

    returns An array of re-ordered uploaded file information

  • fixPhpFilesArray () Browse code

  • (array) getAcceptableContentTypes () Browse code

    Gets a list of content types acceptable by the client browser

    returns Languages ordered in the user browser preferences

  • (array) getCharsets () Browse code

    Gets a list of charsets acceptable by the client browser.

    returns List of charsets in preferable order

  • (mixed) getCookie ($name, $defaultValue) Browse code

    $name Cookie name
    $defaultValue Default value returned when no cookie with given name is found

    Gets a cookie value.

  • (array) getFile ($name) Browse code

    $name A file name

    Retrieves an array of file information.

    returns An associative array of file information, if the file exists, otherwise null

  • (int) getFileError ($name) Browse code

    $name A file name

    Retrieves a file error.

    returns One of the following error codes: - UPLOAD_ERR_OK (no error) - UPLOAD_ERR_INI_SIZE (the uploaded file exceeds the upload_max_filesize directive in php.ini) - UPLOAD_ERR_FORM_SIZE (the uploaded file exceeds the MAX_FILE_SIZE directive that was specified in the HTML form) - UPLOAD_ERR_PARTIAL (the uploaded file was only partially uploaded) - UPLOAD_ERR_NO_FILE (no file was uploaded)

  • (string) getFileExtension ($name) Browse code

    $name A file name

    Retrieves an extension for a given file.

    returns Extension for the file

  • (string) getFileName ($name) Browse code

    $name A file nam.

    Retrieves a file name.

    returns A file name, if the file exists, otherwise null

  • (array) getFileNames () Browse code

    Retrieves an array of file names.

    returns An indexed array of file names

  • (string) getFilePath ($name) Browse code

    $name A file name

    Retrieves a file path.

    returns A file path, if the file exists, otherwise null

  • (array) getFiles ($key) Browse code

    $key A key

    Retrieves an array of files.

    returns An associative array of files

  • (int) getFileSize ($name) Browse code

    $name A file name

    Retrieve a file size.

    returns A file size, if the file exists, otherwise null

  • (string) getFileType ($name) Browse code

    $name A file name

    Retrieves a file type.


    This may not be accurate. This is the mime-type sent by the browser
    during the upload.

    returns A file type, if the file exists, otherwise null

  • (string) getFileValue ($name, $key) Browse code

    $name A file name
    $key Value to search in the file

    Retrieves a file value.

    returns File value

  • (array) getFileValues ($name) Browse code

    $name A file name

    Retrieves all the values from a file.

    returns Associative list of the file values

  • (string) getFormat ($mimeType) Browse code

    $mimeType The associated mime type

    Gets the format associated with the mime type.

    returns The format (null if not found)

  • (string) getGetParameter ($name, $default) Browse code

    $name The GET parameter name
    $default The default value

    Returns the value of a GET parameter.

    returns The GET parameter value

  • getGetParameters () Browse code

  • (string) getHost () Browse code

    Returns current host name.

  • getHttpHeader () Browse code

  • (array) getLanguages () Browse code

    Gets a list of languages acceptable by the client browser

    returns Languages ordered in the user browser preferences

  • (string) getMethodName () Browse code

    Returns request method.

  • (string) getMimeType ($format) Browse code

    $format The format

    Gets the mime type associated with the format.

    returns The associated mime type (null if not found)

  • (string) getPathInfo () Browse code

    Retrieves the path info for the current web request.

    returns Path info

  • (array) getPathInfoArray () Browse code

    Returns the array that contains all request information ($_SERVER or $_ENV).


    This information is stored in the [sf_path_info_array] constant.

    returns Path information

  • (string) getPostParameter ($name, $default) Browse code

    $name The POST parameter name
    $default The default value

    Returns the value of a POST parameter.

    returns The POST parameter value

  • getPostParameters () Browse code

  • (string) getPreferredCulture ($cultures) Browse code

    $cultures An array of ordered cultures available

    Returns the preferred culture for the current request.

    returns The preferred culture

  • (string) getReferer () Browse code

    Returns referer.

  • (string) getRelativeUrlRoot () Browse code

    Retrieves relative root url.

    returns URL

  • (string) getRequestFormat () Browse code

    Gets the request format.


    If no format is defined by the user, it defaults to the sf_format request parameter if available.

    returns The request format

  • getRequestParameters () Browse code

  • (string) getScriptName () Browse code

    Returns current script name.

  • (string) getUri () Browse code

    Retrieves the uniform resource identifier for the current web request.

    returns Unified resource identifier

  • (string) getUriPrefix () Browse code

    Returns Uri prefix, including protocol, hostname and server port.

    returns Uniform resource identifier prefix

  • (string) getUrlParameter ($name, $default) Browse code

    $name The parameter name
    $default The default value

    Returns the value of a parameter passed as a URL segment.

    returns The parameter value

  • (bool) hasFile ($name) Browse code

    $name A file name

    Indicates whether or not a file exists.

    returns true, if the file exists, otherwise false

  • (bool) hasFileError ($name) Browse code

    $name A file name

    Indicates whether or not a file error exists.

    returns true, if the file error exists, otherwise false

  • (bool) hasFileErrors () Browse code

    Indicates whether or not any file errors occured.

    returns true, if any file errors occured, otherwise false

  • (boolean) hasFiles () Browse code

    Indicates whether or not any files exist.

    returns true, if any files exist, otherwise false

  • (bool) initialize ($dispatcher, $parameters, $attributes) Browse code

    $dispatcher An sfEventDispatcher instance
    $parameters An associative array of initialization parameters
    $attributes An associative array of initialization attributes

    Initializes this sfRequest.

    returns true, if initialization completes successfully, otherwise false

    throws sfInitializationException If an error occurs while initializing this sfRequest

  • (boolean) isAbsUri () Browse code

    See if the client is using absolute uri

    returns true, if is absolute uri otherwise false

  • (bool) isMethod ($method) Browse code

    $method The method name

    Checks if the request method is the given one.

    returns true if the current method is the given one, false otherwise

  • (boolean) isSecure () Browse code

    Returns true if the current request is secure (HTTPS protocol).

  • (bool) isXmlHttpRequest () Browse code

    Returns true if the request is a XMLHttpRequest.


    It works if your JavaScript library set an X-Requested-With HTTP header.
    Works with Prototype, Mootools, jQuery, and perhaps others.

    returns true if the request is an XMLHttpRequest, false otherwise

  • loadParameters () Browse code

    Loads GET, PATH_INFO and POST data into the parameter list.

  • (bool) moveFile ($name, $file, $fileMode, $create, $dirMode) Browse code

    $name A file name
    $file An absolute filesystem path to where you would like the file moved. This includes the new filename as well, since uploaded files are stored with random names
    $fileMode The octal mode to use for the new file
    $create Indicates that we should make the directory before moving the file
    $dirMode The octal mode to use when creating the directory

    Moves an uploaded file.

    returns true, if the file was moved, otherwise false

    throws sfFileException If a major error occurs while attempting to move the file

  • (array) parseRequestParameters () Browse code

    Parses the request parameters.


    This method notifies the request.filter_parameters event.

    returns An array of request parameters.

  • setFormat ($format, $mimeTypes) Browse code

    $format The format
    $mimeTypes The associated mime types (the preferred one must be the first as it will be used as the content type)

    Associates a format with mime types.

  • setRelativeUrlRoot ($value) Browse code

    $value Value for the url

    Sets the relative root url for the current web request.

  • setRequestFormat ($format) Browse code

    $format The request format

    Sets the request format.

  • splitHttpAcceptHeader ($header) Browse code

    $header Header to split

    Splits an HTTP header for the current web request.