pm_Hook_WebServer
in package
implements
pm_Hook_Interface
Hook for injecting into web server configuration files
Tags
Interfaces, Classes and Traits
- pm_Hook_Interface
- Generic interface for hooks
Table of Contents
- getDomainApacheConfig() : string
- Retrieve string which will be inserted into <VirtualHost></VirtualHost> directive in vhost config
- getDomainIisConfig() : string
- Retrieve xml as string which will be inserted to Plesk IIS configurator
- getDomainNginxConfig() : string
- Retrieve string which will be inserted into server {...} directive in vhost config
- getDomainNginxProxyConfig() : string
- Retrieve string which will be inserted into server {...} directive in vhost config in case nginx is working in proxy mode
- getForwardingDomainApacheConfig() : string
- Retrieve string which will be inserted into <VirtualHost></VirtualHost> directive in vhost config of the forwarding domain
- getForwardingDomainIisConfig() : string
- Retrieve xml as string which will be inserted to Plesk IIS configurator for the forwarding domain
- getForwardingDomainNginxConfig() : string
- Retrieve string which will be inserted into server {...} directive in vhost config of the forwarding domain
- getWebmailApacheConfig() : string
- Retrieve string which will be inserted into <VirtualHost></VirtualHost> directive in webmail config
- getWebmailNginxConfig() : string
- Retrieve string which will be inserted into server {...} directive in webmail config
- processTemplate() : string
- Process the web server's template file and returns a new one if necessary
Methods
getDomainApacheConfig()
Retrieve string which will be inserted into <VirtualHost></VirtualHost> directive in vhost config
public
getDomainApacheConfig(pm_Domain $domain) : string
Parameters
- $domain : pm_Domain
Return values
string —getDomainIisConfig()
Retrieve xml as string which will be inserted to Plesk IIS configurator
public
getDomainIisConfig(pm_Domain $domain) : string
Parameters
- $domain : pm_Domain
Return values
string —getDomainNginxConfig()
Retrieve string which will be inserted into server {...} directive in vhost config
public
getDomainNginxConfig(pm_Domain $domain) : string
Parameters
- $domain : pm_Domain
Return values
string —getDomainNginxProxyConfig()
Retrieve string which will be inserted into server {...} directive in vhost config in case nginx is working in proxy mode
public
getDomainNginxProxyConfig(pm_Domain $domain) : string
Parameters
- $domain : pm_Domain
Return values
string —getForwardingDomainApacheConfig()
Retrieve string which will be inserted into <VirtualHost></VirtualHost> directive in vhost config of the forwarding domain
public
getForwardingDomainApacheConfig(pm_Domain $domain) : string
Parameters
- $domain : pm_Domain
Tags
Return values
string —getForwardingDomainIisConfig()
Retrieve xml as string which will be inserted to Plesk IIS configurator for the forwarding domain
public
getForwardingDomainIisConfig(pm_Domain $domain) : string
Parameters
- $domain : pm_Domain
Tags
Return values
string —getForwardingDomainNginxConfig()
Retrieve string which will be inserted into server {...} directive in vhost config of the forwarding domain
public
getForwardingDomainNginxConfig(pm_Domain $domain) : string
Parameters
- $domain : pm_Domain
Tags
Return values
string —getWebmailApacheConfig()
Retrieve string which will be inserted into <VirtualHost></VirtualHost> directive in webmail config
public
getWebmailApacheConfig(pm_Domain $domain, string $type) : string
Parameters
- $domain : pm_Domain
- $type : string
-
webmail type
Tags
Return values
string —getWebmailNginxConfig()
Retrieve string which will be inserted into server {...} directive in webmail config
public
getWebmailNginxConfig(pm_Domain $domain, string $type) : string
Parameters
- $domain : pm_Domain
- $type : string
-
webmail type
Tags
Return values
string —processTemplate()
Process the web server's template file and returns a new one if necessary
public
processTemplate(string $templateFile, string $content, pm_Domain|null $domain) : string
Parameters
- $templateFile : string
- $content : string
- $domain : pm_Domain|null