rapila
Static Public Member Functions | Public Attributes | List of all members
LinkUtil Class Reference

Static Public Member Functions

static redirectToManager ($mPath="", $mManager=null, $aParameters=array(), $bIncludeLanguage=null, $bPermanent=false)
 
static redirectToLanguage ($sLanguageId=null)
 
static redirect ($sLocation, $sHost=null, $sProtocol= 'default', $bPermanent=true)
 
static sendHTTPStatusCode ($iCode, $sName)
 
static sendCacheControlHeaders ($mLastModified, $mExpires=null)
 
static sendCacheControlHeadersForCache ($oCache)
 
static sendLastModifiedAndCheckModifiedSince ($mTimestamp)
 
static sendExpires ($mTimestamp)
 
static absoluteLink ($sLocation, $sHost=null, $mProtocolSetting= 'default', $bAbsoluteLinkMayBeOmitted=false)
 
static getProtocol (&$mProtocolSetting= 'default')
 
static isSSL ()
 
static linkToSelf ($mPath=null, $aParameters=null, $bIgnoreRequest=false)
 
static getRequestedParameters ($aOverrideParameters=array())
 
static link ($mPath=false, $mManager=null, $aParameters=array(), $mLanguage=null, $bIncludeLanguage=null)
 
static prepareLinkParameters ($aParameters)
 
static getHostName ($sDefaultHost=null)
 
static getDomainHolderEmail ($sDefaultSender= 'info')
 
static getUrlWithProtocolIfNotSet ($sUrl)
 
static getPrefixIfNotSet ($sString, $sDefaultPrefix= 'http://')
 

Public Attributes

const DATE_RFC2616 = 'D, d M Y H:i:s \G\M\T'
 

Member Function Documentation

static LinkUtil::absoluteLink (   $sLocation,
  $sHost = null,
  $mProtocolSetting = 'default',
  $bAbsoluteLinkMayBeOmitted = false 
)
static

Constructs an absolute link given a host-absolute location (starts with a slash)

Parameters
string$sLocationthe host-absolute location
string$sHostthe host name to link to. will be inferred from the HTTP Host or the host name configured in domain_holder/domain. Precedence is given to the former unless the linking/prefer_configured_domain setting is true
string$sProtocolwhether or not to link to the HTTPS version. 'default' reads the linking/ssl_in_absolute_links setting. 'auto' will use whatever is currently being used to access the site.
static LinkUtil::getPrefixIfNotSet (   $sString,
  $sDefaultPrefix = 'http://' 
)
static
Todo:
find a better more appropriate solution
static LinkUtil::prepareLinkParameters (   $aParameters)
static
Todo:
: check use of http_build_query()
static LinkUtil::redirect (   $sLocation,
  $sHost = null,
  $sProtocol = 'default',
  $bPermanent = true 
)
static

Redirects (locally by default). Use with LinkUtil::link()ed URLs (because this redirect does not add the base path/context MAIN_DIR_FE). Discards all buffered output and exits Pass $sHost = false to mark $sLocation as absolute URL

static LinkUtil::sendCacheControlHeaders (   $mLastModified,
  $mExpires = null 
)
static

Sends the cache control headers. Shortcut for calling sendLastModifiedAndCheckModifiedSince and sendExpires. • Last-Modified and checks If-Modified-Since for a match (if so, terminates and sends a 304 Not Modified status code) • Uses the given timestamp as base for calculation. If it is an object or a query, the updated-at field of the object (or the newest item that matches the query) is used. • You can call this method twice if you created a new cache file and don’t have any other timestamp. It will only output the headers once.

Parameters
$mLastModifiedThe last-modified date to send. Can be one of the following: • null to not send a last-modified (only applicable if the second argument is non-null) • A UNIX timestamp as an integer • A string to be parsed into a date using strtotime • A DateTime object • A Propel database object whose updated_at timestamp will be used • A Propel query that will find the object most recently updated and use its updated_at timestamp
$mExpiresThe expires header to send. Can be one of the following: • null to not send an expires header (only applicable if first argument is non-null) • A DateInterval object • A date interval spec in the form of Pxx (http://en.wikipedia.org/wiki/Iso8601#Durations) which will be added to today’s date • A UNIX timestamp as an integer • A string to be parsed into a date using strtotime • A DateTime object • A Cache object (which will be asked about the expiresTimestamp) • true to expire in a year (the maxiumum permitted by RFC2616) • false to mark as already expired (and to force re-evaluation)
static LinkUtil::sendCacheControlHeadersForCache (   $oCache)
static

Version of sendCacheControlHeaders that uses a cache object to calculate the last-modified timestamp

static LinkUtil::sendExpires (   $mTimestamp)
static

Sends an expires header.

Parameters
$mExpiresThe expires header to send. Can be one of the following: • A DateInterval object • A date interval spec in the form of Pxx (http://en.wikipedia.org/wiki/Iso8601#Durations) which will be added to today’s date • A UNIX timestamp as an integer • A string to be parsed into a date using strtotime • A DateTime object • A Cache object (which will be asked about the expiresTimestamp) • true to expire in a year (the maxiumum permitted by RFC2616) • false to mark as already expired (and to force re-evaluation)
static LinkUtil::sendLastModifiedAndCheckModifiedSince (   $mTimestamp)
static

Sends Last-Modified and checks If-Modified-Since for a match (if so, terminates and sends a 304 Not Modified status code). Uses the given timestamp as base for calculation. If it is an object or a query, the updated-at field of the object (or the newest item that matches the query) is used. You can call this method twice if you created a new cache file and don’t have any other timestamp. It will only output the headers once.

Parameters
$mTimestampThe last-modified date to send. Can be one of the following: • A UNIX timestamp as an integer • A string to be parsed into a date using strtotime • A DateTime object • A Propel database object whose updated_at timestamp will be used • A Propel query that will find the object most recently updated and use its updated_at timestamp

The documentation for this class was generated from the following file: