Overview

Namespaces

  • DcGeneral
    • Clipboard
    • Contao
      • Callback
      • Compatibility
      • DataDefinition
        • Definition
      • Dca
        • Builder
          • Legacy
        • Definition
        • Palette
        • Populator
      • Event
      • View
        • Contao2BackendView
          • Event
    • Controller
    • Data
    • DataDefinition
      • Builder
      • Definition
        • Properties
        • View
          • Panel
      • ModelRelationship
      • Palette
        • Builder
          • Event
        • Condition
          • Palette
          • Property
    • EnvironmentPopulator
    • Event
    • Exception
    • Factory
      • Event
    • Panel
    • View
      • Event

Classes

  • BackendBindings
  • InputProvider
  • Overview
  • Namespace
  • Class
  • Tree
  • Deprecated
  • Todo

Class InputProvider

Class InputProvider.

This class is the Contao binding of an input provider.

DcGeneral\Contao\InputProvider implements DcGeneral\InputProviderInterface
Namespace: DcGeneral\Contao
Package: DcGeneral\Contao
Located at Contao/InputProvider.php
Methods summary
public mixed
# getParameter( string $strKey, boolean $blnRaw = false )

Retrieve a request parameter.

Retrieve a request parameter.

Parameters

$strKey
string
$strKey The name of the parameter to be retrieved.
$blnRaw
boolean
$blnRaw Boolean flag to determine if the content shall be returned RAW or rather be stripped of potential malicious content.

Returns

mixed

Implementation of

DcGeneral\InputProviderInterface::getParameter()
public DcGeneral\InputProviderInterface
# setParameter( string $strKey, mixed $varValue )

Save/change a request parameter.

Save/change a request parameter.

Parameters

$strKey
string
$strKey The name of the parameter to be stored.
$varValue
mixed
$varValue The value to be stored.

Returns

DcGeneral\InputProviderInterface

Implementation of

DcGeneral\InputProviderInterface::setParameter()
public DcGeneral\InputProviderInterface
# unsetParameter( string $strKey )

Unset a request parameter.

Unset a request parameter.

Parameters

$strKey
string
$strKey The name of the parameter to be removed.

Returns

DcGeneral\InputProviderInterface

Implementation of

DcGeneral\InputProviderInterface::unsetParameter()
public boolean
# hasParameter( string $strKey )

Determines if a request parameter is defined.

Determines if a request parameter is defined.

Parameters

$strKey
string
$strKey The name of the parameter to be checked.

Returns

boolean

Implementation of

DcGeneral\InputProviderInterface::hasParameter()
public mixed
# getValue( string $strKey, boolean $blnRaw = false )

Retrieve a request value.

Retrieve a request value.

Parameters

$strKey
string
$strKey The name of the value to be retrieved.
$blnRaw
boolean
$blnRaw Boolean flag to determine if the content shall be returned RAW or rather be stripped of potential malicious content.

Returns

mixed

Implementation of

DcGeneral\InputProviderInterface::getValue()
public DcGeneral\InputProviderInterface
# setValue( string $strKey, mixed $varValue )

Save/change a request value.

Save/change a request value.

Parameters

$strKey
string
$strKey The name of the value to be stored.
$varValue
mixed
$varValue The value to be stored.

Returns

DcGeneral\InputProviderInterface

Implementation of

DcGeneral\InputProviderInterface::setValue()
public DcGeneral\InputProviderInterface
# unsetValue( string $strKey )

Unset a request value.

Unset a request value.

Parameters

$strKey
string
$strKey The name of the value to be removed.

Returns

DcGeneral\InputProviderInterface

Implementation of

DcGeneral\InputProviderInterface::unsetValue()
public boolean
# hasValue( string $strKey )

Determines if a request value is defined.

Determines if a request value is defined.

Parameters

$strKey
string
$strKey The name of the value to be checked.

Returns

boolean

Implementation of

DcGeneral\InputProviderInterface::hasValue()
public mixed
# getPersistentValue( string $strKey )

Retrieve a persistent value.

Retrieve a persistent value.

Parameters

$strKey
string
$strKey The name of the value to be retrieved.

Returns

mixed

Implementation of

DcGeneral\InputProviderInterface::getPersistentValue()
public DcGeneral\InputProviderInterface
# setPersistentValue( string $strKey, mixed $varValue )

Save/change a persistent value.

Save/change a persistent value.

Parameters

$strKey
string
$strKey The name of the value to be stored.
$varValue
mixed
$varValue The value to be stored.

Returns

DcGeneral\InputProviderInterface

Implementation of

DcGeneral\InputProviderInterface::setPersistentValue()
public boolean
# hasPersistentValue( string $strKey )

Determines if a persistent value is defined.

Determines if a persistent value is defined.

Parameters

$strKey
string
$strKey The name of the value to be checked.

Returns

boolean

Implementation of

DcGeneral\InputProviderInterface::hasPersistentValue()
public string
# getRequestUrl( )

Retrieve the current request url.

Retrieve the current request url.

Returns

string

Implementation of

DcGeneral\InputProviderInterface::getRequestUrl()
contao-community-alliance/dc-general API documentation generated by ApiGen 2.8.0