• Home
• Nexcessnet_Turpentine_Model_Varnish_Configurator_Abstract

PHP Class Nexcessnet_Turpentine_Model_Varnish_Configurator_Abstract

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Show file Open project: nexcess/magento-turpentine Class Usage Examples

Protected Properties

Property	Type	Description
$_options	array	options array
$_socket	Nexcessnet_Turpentine_Model_Varnish_Admin_Socket	The socket this configurator is based on

Public Methods

Method	Description
__construct ( $options = [] )
generate ( $doClean = true )
getAllowedHostsRegex ( ) : string	Get hosts as regex
getBaseUrlPathRegex ( ) : string	Get the base url path regex
getFromSocket ( Nexcessnet_Turpentine_Model_Varnish_Admin_Socket $socket ) : Nexcessnet_Turpentine_Model_Varnish_Configurator_Abstract	Get the correct version of a configurator from a socket
save ( string $generatedConfig ) : null	Save the generated config to the file specified in Magento config

Protected Methods

Method	Description
_cleanVcl ( string $dirtyVcl ) : string	Remove empty and commented out lines from the generated VCL
_cleanVclHelper ( string $line ) : boolean	Helper to filter out blank/commented lines for VCL cleaning
_formatTemplate ( string $template, array $vars ) : string	Format a template string, replacing {{keys}} with the appropriate values and remove unspecified keys
_getAdminBackend ( ) : string	Get the admin backend configuration string
_getAdminFrontname ( ) : string	Get the Magento admin frontname
_getAdvancedSessionValidationTargets ( ) : string	Get the advanced session validation restrictions
_getBaseUrlPaths ( ) : array	Get the path part of each store's base URL and static file URLs
_getCrawlerIps ( ) : array	Get the list of crawler IPs
_getCrawlerUserAgents ( ) : string	Get the regex formatted list of crawler user agents
_getCustomIncludeFilename ( $position = '' ) : string	Get the name of the custom include VCL file
_getCustomTemplateFilename ( ) : string	Get the custom VCL template, if it exists Returns 'null' if the file doesn't exist
_getDebugIps ( ) : array	Get the list of allowed debug IPs
_getDefaultBackend ( ) : string	Get the default backend configuration string
_getDefaultTtl ( ) : string	Get the default cache TTL from Magento config
_getEnableCaching ( ) : string	Get the Enable Caching value
_getEnableDebugHeaders ( ) : string	Get whether debug headers should be enabled or not
_getForceCacheStatic ( ) : string	Get the Force Static Caching option
_getGenerateSession ( ) : string	Get the Generate Session
_getGenerateSessionEnd ( ) : string	Get the Generate Session
_getGenerateSessionExpires ( ) : string	Get the Generate Session Expires
_getGenerateSessionStart ( ) : string	Get the Generate Session
_getGetParamExcludes ( ) : string	Format the GET variable excludes for insertion in a regex
_getGracePeriod ( ) : string	Get the grace period for vcl_fetch
_getIgnoreGetParameters ( )
_getLruFactor ( ) : string	Get the time to increase a cached objects TTL on cache hit (in seconds).
_getNormalizeCookieRegex ( ) : string	Get the regex for cookie normalization
_getNormalizeCookieTarget ( ) : string	Get the hostname for cookie normalization
_getNormalizeHostTarget ( ) : string	Get the hostname for host normalization from Magento's base URL
_getSimpleHashStatic ( ) : string	Get the Force Static Caching option
_getStaticExtensions ( ) : string	Format the list of static cache extensions
_getStaticTtl ( ) : string	Get the static caching TTL
_getTemplateVars ( ) : array	Build the list of template variables to apply to the VCL template
_getUrlExcludes ( ) : string	Format the URL exclusions for insertion in a regex. Admin frontname and API are automatically added.
_getUrlTtls ( ) : string	Format the by-url TTL value list
_getVclFilename ( ) : string	Get the name of the file to save the VCL to
_getVclTemplateFilename ( string $baseFilename ) : string	Get the full path for a given template filename
_sendUnModifiedUrlToBackend ( ) : boolean
_vcl_acl ( string $name, array $hosts ) : string	Format a VCL ACL declaration
_vcl_backend ( string $name, string $host, string $port, array $options = [] ) : string	Format a VCL backend declaration
_vcl_call ( string $subroutine ) : string	Format a VCL subroutine call
_vcl_director ( string $name, array $backendOptions ) : string	Format a VCL director declaration, for load balancing
_vcl_director_backend ( string $host, string $port, string $probeUrl = '', array $options = [] ) : string	Format a VCL backend declaration to put inside director
_vcl_get_probe ( string $probeUrl ) : string	Format a VCL probe declaration to put in backend which is in director
_vcl_sub_allowed_hosts_regex ( ) : string	Get the Host normalization sub routine
_vcl_sub_https_redirect_fix ( ) : string	When using Varnish as front door listen on port 80 and Nginx/Apache listen on port 443 for HTTPS, the fix will keep the url parameters when redirect from HTTP to HTTPS.
_vcl_sub_maintenance_allowed_ips ( ) : string	Get the allowed IPs when in maintenance mode
_vcl_sub_normalize_encoding ( ) : string	Get the Accept-Encoding normalization sub routine
_vcl_sub_normalize_host ( ) : string	Get the Host normalization sub routine
_vcl_sub_normalize_user_agent ( ) : string	Get the User-Agent normalization sub routine
_vcl_sub_synth ( ) : string	Get the allowed IPs when in maintenance mode
_vcl_sub_synth_https_fix ( ) : string	vcl_synth for fixing https

Method Details

Property Details