<?php
/**
 * 
 * Helper for public hrefs.
 * 
 * @category Solar
 * 
 * @package Solar_View_Helper
 * 
 * @author Paul M. Jones <hide@address.com>
 * 
 * @license http://opensource.org/licenses/bsd-license.php BSD
 * 
 * @version $Id: PublicHref.php 4285 2009-12-31 02:18:15Z pmjones $
 * 
 */
class Solar_View_Helper_PublicHref extends Solar_View_Helper
{
    /**
     * 
     * Internal URI object for creating links.
     * 
     * @var Solar_Uri_Public
     * 
     */
    protected $_uri = null;
    
    /**
     * 
     * Post-construction tasks to complete object construction.
     * 
     * @return void
     * 
     */
    protected function _postConstruct()
    {
        parent::_postConstruct();
        $this->_uri = Solar::factory('Solar_Uri_Public');
    }
    
    /**
     * 
     * Returns an href to a public resource.
     * 
     * @param Solar_Uri_Public|string $spec The public resource href specification.
     * 
     * @param bool $raw Return the resource string without escaping (default false).
     * 
     * @return string
     * 
     */
    public function publicHref($spec, $raw = false)
    {
        if ($spec instanceof Solar_Uri_Public) {
            // already a public uri object
            $href = $spec->get();
        } elseif (strpos($spec, '://')) {
            // use the href as-is
            $href = $spec;
        } else {
            // build-and-fetch the string as a public href
            $href = $this->_uri->quick($spec);
        }
        
        // return escaped or not?
        if ($raw) {
            return $href;
        } else {
            return $this->_view->escape($href);
        }
    }
}