PHP Class AppserverIo\Appserver\ServletEngine\Servlets\DhtmlServlet

The DHTML files are processed in the scope of the service() method. This gives developers access to all variables in the method's scope as to all members of the servlet.
Inheritance: extends AppserverIo\Psr\Servlet\Http\HttpServlet
Exibir arquivo Open project: appserver-io/appserver Class Usage Examples

Protected Properties

Property Type Description
$appBase string The path to the application base directory.
$baseDirectory string The path to the application server's base directory.
$poweredBy string The string for the X-POWERED-BY header.
$webappPath string The path to the actual web application -> the base directory for DHTML templates.

Public Methods

Method Description
getAppBase ( ) : string Returns the path to the application base directory.
getBaseDirectory ( ) : string Returns the absolute path to the base directory.
getPoweredBy ( ) : string Returns the string for the X-POWERED-BY header.
getWebappPath ( ) : string Returns the path to the web application.
init ( AppserverIo\Psr\Servlet\ServletConfigInterface $servletConfig ) : void Initializes the servlet with the passed configuration.
service ( AppserverIo\Psr\Servlet\ServletRequestInterface $servletRequest, AppserverIo\Psr\Servlet\ServletResponseInterface $servletResponse ) : void Processes the DHTML file specified as servlet name.

Method Details

getAppBase() public method

Returns the path to the application base directory.
public getAppBase ( ) : string
return string The application base directory

getBaseDirectory() public method

Returns the absolute path to the base directory.
public getBaseDirectory ( ) : string
return string The base directory

getPoweredBy() public method

Returns the string for the X-POWERED-BY header.
public getPoweredBy ( ) : string
return string The X-POWERED-BY header

getWebappPath() public method

Returns the path to the web application.
public getWebappPath ( ) : string
return string The path to the web application

init() public method

Initializes the servlet with the passed configuration.
public init ( AppserverIo\Psr\Servlet\ServletConfigInterface $servletConfig ) : void
$servletConfig AppserverIo\Psr\Servlet\ServletConfigInterface The configuration to initialize the servlet with
return void

service() public method

Processes the DHTML file specified as servlet name.
public service ( AppserverIo\Psr\Servlet\ServletRequestInterface $servletRequest, AppserverIo\Psr\Servlet\ServletResponseInterface $servletResponse ) : void
$servletRequest AppserverIo\Psr\Servlet\ServletRequestInterface The request instance
$servletResponse AppserverIo\Psr\Servlet\ServletResponseInterface The response sent back to the client
return void

Property Details

$appBase protected_oe property

The path to the application base directory.
protected string $appBase
return string

$baseDirectory protected_oe property

The path to the application server's base directory.
protected string $baseDirectory
return string

$poweredBy protected_oe property

The string for the X-POWERED-BY header.
protected string $poweredBy
return string

$webappPath protected_oe property

The path to the actual web application -> the base directory for DHTML templates.
protected string $webappPath
return string