Overview

Namespaces

  • Nethgui
    • Adapter
    • Authorization
    • Component
    • Controller
      • Collection
      • Table
    • Exception
    • Log
    • Model
    • Module
      • Help
      • Notification
    • Renderer
    • Serializer
    • System
    • Test
      • Tool
      • Unit
        • Nethgui
          • Adapter
            • ParameterSet
          • Authorization
          • Log
          • Module
            • Notification
          • Renderer
          • Serializer
          • System
          • Utility
          • View
        • Test
          • Tool
    • Utility
    • View
    • Widget
      • Xhtml
  • None
  • Test
    • Tool

Classes

  • AbstractController
  • CollectionController
  • CompositeController
  • ListComposite
  • NullRequest
  • RequestTest
  • TableController
  • TabsController

Interfaces

  • RequestHandlerInterface
  • RequestInterface
  • ValidationReportInterface
  • Overview
  • Namespace
  • Class
  • Deprecated

Interface RequestInterface

A Request is the input data to process

Direct known implementers

Nethgui\Controller\NullRequest
Namespace: Nethgui\Controller
Author: Davide Principi davide.principi@nethesis.it
Since: 1.0
Api
Located at Controller/RequestInterface.php
Methods summary
public mixed
# getParameter( string $parameterName )

Get a parameter value

Get a parameter value

Parameters

$parameterName

Returns

mixed

Api

public mixed
# getArgument( string $argumentName )

Get an argument value

Get an argument value

Deprecated

Parameters

$argumentName
$parameterName

Returns

mixed
public Nethgui\Controller\RequestInterface
# spawnRequest( string $subsetName, array $path = array() )

Spawn a new request.

Spawn a new request.

The request will receive a subset of parameters and arguments according to the $subsetName parameter.

Parameters

$subsetName
The name of parameters/arguments
$path
$path URL path segments values

Returns

Nethgui\Controller\RequestInterface

Api

public boolean
# hasParameter( string $parameterName )

Checks if $parameterName exists in the request

Checks if $parameterName exists in the request

Parameters

$parameterName

Returns

boolean

Api

public boolean
# hasArgument( string $argumentName )

Checks if $argumentName exists in the request

Checks if $argumentName exists in the request

Deprecated

since 1.2.4

Parameters

$argumentName

Returns

boolean
public array
# getParameterNames( )

Get a list of parameter names.

Get a list of parameter names.

Values submitted by the User are called "parameters".

Returns

array

See

getModuleArguments()

Api

public array
# getArgumentNames( )

Get a list of argument names

Get a list of argument names

Deprecated

since 1.2.4

Returns

array
public array
# getPath( )

URL (sub)path segments

URL (sub)path segments

Returns

array

See

getParameters()

Api

public boolean
# isEmpty( )

Indicates whether the request contains any parameter or not.

Indicates whether the request contains any parameter or not.

Returns

boolean

Api

public boolean
# isMutation( )

Indicates whether the request is a mutation request

Indicates whether the request is a mutation request

Returns

boolean

Api

public boolean
# isValidated( )

Tells if a request has been successfully validated

Tells if a request has been successfully validated

Returns

boolean

Api

public Nethgui\Authorization\UserInterface
# getUser( )

The User that has sent the request.

The User that has sent the request.

Returns

Nethgui\Authorization\UserInterface

Api

public string
# getExtension( )

Get the "file extension" of the request.

Get the "file extension" of the request.

"File extension" is the substring after the last "." character in the URL path.

Deprecated

since 1.2.4

Returns

string

See

Nethgui\Controller\RequestInterface::getFormat()
public string
# getLanguageCode( )

The requested output language, used to build the Translator

The requested output language, used to build the Translator

Returns

string

Api

public string
# getLocale( )

The RFC 4646 compliant request locale

The RFC 4646 compliant request locale

Returns

string

Since

1.7.0

Api

public string
# getFormat( )

The requested output format, used to build the Renderer object

The requested output format, used to build the Renderer object

Returns

string

Api

Constants summary
integer CONTENT_TYPE_UNSPECIFIED
# 0
integer CONTENT_TYPE_JSON
# 1
integer CONTENT_TYPE_HTML
# 2
Nethgui Framework API documentation generated by ApiGen