API Documentation

Zend/View/Helper/ServerUrl.php

Show: inherited
Table of Contents

Zend Framework

LICENSE

This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.

Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_View  
Subpackage
Helper  
Version
$Id: ServerUrl.php 24594 2012-01-05 21:27:01Z matthew $  

\Zend_View_Helper_ServerUrl

Package: Zend\View\Helper

Helper for returning the current server URL (optionally with request URI)

Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Properties

Propertyprotectedstring  $_host= ''

Host (including port)

Details
Type
string
Propertyprotectedstring  $_scheme= ''

Scheme

Details
Type
string

Methods

methodpublic__construct( ) : void

Constructor

methodpublicgetHost( ) : string

Returns host

Returns
Type Description
string host
methodpublicgetScheme( ) : string

Returns scheme (typically http or https)

Returns
Type Description
string scheme (typically http or https)
methodpublicserverUrl( string|boolean $requestUri = null ) : string

View helper entry point: Returns the current host's URL like http://site.com

Parameters
Name Type Description
$requestUri string|boolean

[optional] if true, the request URI found in $_SERVER will be appended as a path. If a string is given, it will be appended as a path. Default is to not append any path.

Returns
Type Description
string server url
methodpublicsetHost( string $host ) : \Zend_View_Helper_ServerUrl

Sets host

Parameters
Name Type Description
$host string

new host

Returns
Type Description
\Zend_View_Helper_ServerUrl fluent interface, returns self
methodpublicsetScheme( string $scheme ) : \Zend_View_Helper_ServerUrl

Sets scheme (typically http or https)

Parameters
Name Type Description
$scheme string

new scheme (typically http or https)

Returns
Type Description
\Zend_View_Helper_ServerUrl fluent interface, returns self
Documentation was generated by DocBlox 0.15.1.