Mage_Page_Block_Html_Head Class Reference

Inheritance diagram for Mage_Page_Block_Html_Head:

List of all members.

Public Member Functions
	addCss ($name, $params="")
	addJs ($name, $params="")
	addCssIe ($name, $params="")
	addJsIe ($name, $params="")
	addItem ($type, $name, $params=null, $if=null, $cond=null)
	removeItem ($type, $name)
	getCssJsHtml ()
	getChunkedItems ($items, $prefix='', $maxLen=450)
	getContentType ()
	getMediaType ()
	getCharset ()
	setTitle ($title)
	getTitle ()
	getDefaultTitle ()
	getDescription ()
	getKeywords ()
	getRobots ()
	getIncludes ()
Protected Member Functions
	_construct ()

---

Detailed Description

Definition at line 34 of file Head.php.

---

Member Function Documentation

_construct

(

)

[protected]

Internal constructor, that is called from real constructor

Please override this one instead of overriding real __construct constructor

Please override this one instead of overriding real __construct constructor

Reimplemented from Mage_Core_Block_Abstract.

Definition at line 36 of file Head.php.

    {
        $this->setTemplate('page/html/head.phtml');
    }

addCss	(	$	name,
		$	params = ""
	)

Definition at line 41 of file Head.php.

    {
        $this->addItem('skin_css', $name, $params);
        return $this;
    }

addCssIe	(	$	name,
		$	params = ""
	)

Definition at line 53 of file Head.php.

    {
        $this->addItem('skin_css', $name, $params, 'IE');
        return $this;
    }

addItem	(	$	type,
		$	name,
		$	params = null,
		$	if = null,
		$	cond = null
	)

Definition at line 65 of file Head.php.

    {
        if ($type==='skin_css' && empty($params)) {
            $params = 'media="all"';
        }
        $this->_data['items'][$type.'/'.$name] = array(
            'type'   => $type,
            'name'   => $name,
            'params' => $params,
            'if'     => $if,
            'cond'   => $cond,
       );
        return $this;
    }

addJs	(	$	name,
		$	params = ""
	)

Definition at line 47 of file Head.php.

    {
        $this->addItem('js', $name, $params);
        return $this;
    }

addJsIe	(	$	name,
		$	params = ""
	)

Definition at line 59 of file Head.php.

    {
        $this->addItem('js', $name, $params, 'IE');
        return $this;
    }

getCharset

(

)

Definition at line 196 of file Head.php.

    {
        if (empty($this->_data['charset'])) {
            $this->_data['charset'] = Mage::getStoreConfig('design/head/default_charset');
        }
        return $this->_data['charset'];
    }

getChunkedItems	(	$	items,
		$	prefix = '',
		$	maxLen = 450
	)

Definition at line 165 of file Head.php.

    {
        $chunks = array();
        $chunk = $prefix;
        foreach ($items as $i=>$item) {
            if (strlen($chunk.','.$item)>$maxLen) {
                $chunks[] = $chunk;
                $chunk = $prefix;
            }
            $chunk .= ','.$item;
        }
        $chunks[] = $chunk;
        return $chunks;
    }

getContentType

(

)

Definition at line 180 of file Head.php.

    {
        if (empty($this->_data['content_type'])) {
            $this->_data['content_type'] = $this->getMediaType().'; charset='.$this->getCharset();
        }
        return $this->_data['content_type'];
    }

getCssJsHtml

(

)

Definition at line 86 of file Head.php.

    {
//        return '';
        $lines = array();
        $baseJs = Mage::getBaseUrl('js');
        $html = '';

        $script = '<script type="text/javascript" src="%s" %s></script>';
        $stylesheet = '<link rel="stylesheet" type="text/css" href="%s" %s />';
        $alternate = '<link rel="alternate" type="%s" href="%s" %s />';

        foreach ($this->_data['items'] as $item) {
            if (!is_null($item['cond']) && !$this->getData($item['cond'])) {
                continue;
            }
            $if = !empty($item['if']) ? $item['if'] : '';
            switch ($item['type']) {
                case 'js':
                    #$lines[$if]['other'][] = sprintf($script, $baseJs.$item['name'], $item['params']);
                    $lines[$if]['script'][] = $item['name'];
                    break;

                case 'js_css':
                    //proxying css will require real-time prepending path to all image urls, should we do it?
                    $lines[$if]['other'][] = sprintf($stylesheet, $baseJs.$item['name'], $item['params']);
                    #$lines[$if]['stylesheet'][] = $item['name'];
                    break;

                case 'skin_js':
                    $lines[$if]['other'][] = sprintf($script, $this->getSkinUrl($item['name']), $item['params']);
                    break;

                case 'skin_css':
                    $lines[$if]['other'][] = sprintf($stylesheet, $this->getSkinUrl($item['name']), $item['params']);
                    break;

                case 'rss':
                    $lines[$if]['other'][] = sprintf($alternate, 'application/rss+xml'/*'text/xml' for IE?*/, $item['name'], $item['params']);
                    break;
            }
        }

        foreach ($lines as $if=>$items) {
            if (!empty($if)) {
                $html .= '<!--[if '.$if.']>'."\n";
            }
            if (!empty($items['script'])) {
                $scriptItems = array();
                if (Mage::getStoreConfigFlag('dev/js/merge_files')) {
                    $scriptItems = $this->getChunkedItems($items['script'], 'index.php?c=auto&amp;f=');
                } else {
                    $scriptItems = $items['script'];
                }
                foreach ($scriptItems as $item) {
                    $html .= sprintf($script, $baseJs.$item, '') . "\n";
                }
//                foreach (array_chunk($items['script'], 15) as $chunk) {
//                    $html .= sprintf($script, $baseJs.'index.php/x.js?f='.join(',',$chunk), '')."\n";
//                }
            }
            if (!empty($items['stylesheet'])) {
                foreach ($this->getChunkedItems($items['stylesheet'], $baseJs.'index.php?c=auto&amp;f=') as $item) {
                    $html .= sprintf($stylesheet, $item, '')."\n";
                }
//                foreach (array_chunk($items['stylesheet'], 15) as $chunk) {
//                    $html .= sprintf($stylesheet, $baseJs.'index.php/x.css?f='.join(',',$chunk), '')."\n";
//                }
            }
            if (!empty($items['other'])) {
                $html .= join("\n", $items['other'])."\n";
            }
            if (!empty($if)) {
                $html .= '<![endif]-->'."\n";
            }
        }

        return $html;
    }

getDefaultTitle

(

)

Definition at line 219 of file Head.php.

    {
        return Mage::getStoreConfig('design/head/default_title');
    }

getDescription

(

)

Definition at line 224 of file Head.php.

    {
        if (empty($this->_data['description'])) {
            $this->_data['description'] = Mage::getStoreConfig('design/head/default_description');
        }
        return $this->_data['description'];
    }

getIncludes

(

)

Get miscellanious scripts/styles to be included in head before head closing tag

Returns:

string

Definition at line 253 of file Head.php.

    {
        if (empty($this->_data['includes'])) {
            $this->_data['includes'] = Mage::getStoreConfig('design/head/includes');
        }
        return $this->_data['includes'];
    }

getKeywords

(

)

Definition at line 232 of file Head.php.

    {
        if (empty($this->_data['keywords'])) {
            $this->_data['keywords'] = Mage::getStoreConfig('design/head/default_keywords');
        }
        return $this->_data['keywords'];
    }

getMediaType

(

)

Definition at line 188 of file Head.php.

    {
        if (empty($this->_data['media_type'])) {
            $this->_data['media_type'] = Mage::getStoreConfig('design/head/default_media_type');
        }
        return $this->_data['media_type'];
    }

getRobots

(

)

Definition at line 240 of file Head.php.

    {
        if (empty($this->_data['robots'])) {
            $this->_data['robots'] = Mage::getStoreConfig('design/head/default_robots');
        }
        return $this->_data['robots'];
    }

getTitle

(

)

Definition at line 211 of file Head.php.

    {
        if (empty($this->_data['title'])) {
            $this->_data['title'] = $this->getDefaultTitle();
        }
        return htmlspecialchars(html_entity_decode($this->_data['title'], ENT_QUOTES, 'UTF-8'));
    }

removeItem	(	$	type,
		$	name
	)

Definition at line 80 of file Head.php.

    {
        unset($this->_data['items'][$type.'/'.$name]);
        return $this;
    }

setTitle

(

$

title

)

Definition at line 204 of file Head.php.

    {
        $this->_data['title'] = Mage::getStoreConfig('design/head/title_prefix').' '.$title
            .' '.Mage::getStoreConfig('design/head/title_suffix');
        return $this;
    }

---

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

• app/code/core/Mage/Page/Block/Html/Head.php