Mage_Core_Block_Abstract Class Reference

Inheritance diagram for Mage_Core_Block_Abstract:

List of all members.

Public Member Functions

getRequest ()

getParentBlock ()

setParentBlock (Mage_Core_Block_Abstract $block)

getAction ()

setLayout (Mage_Core_Model_Layout $layout)

getLayout ()

getIsAnonymous ()

setIsAnonymous ($flag)

getAnonSuffix ()

setAnonSuffix ($suffix)

getBlockAlias ()

setBlockAlias ($alias)

getName ()

setName ($name)

getSortedChildren ()

setAttribute ($name, $value=null)

setChild ($alias, $block)

unsetChild ($alias)

unsetCallChild ($alias, $callback, $result, $params)

unsetChildren ()

getChild ($name='')

getChildHtml ($name='', $useCache=true, $sorted=false)

getChildChildHtml ($name, $childName= '', $useCache=true, $sorted=false)

getSortedChildBlocks ()

getBlockHtml ($name)

insert ($block, $siblingName='', $after=false, $alias='')

append ($block, $alias='')

toHtml ()

getUrl ($route='', $params=array())

getUrlBase64 ($route='', $params=array())

getUrlEncoded ($route= '', $params=array())

getSkinUrl ($file=null, array $params=array())

getMessagesBlock ()

setMessagesBlock (Mage_Core_Block_Messages $block)

getHelper ($type)

helper ($name)

formatDate ($date=null, $format='short', $showTime=false)

formatTime ($time=null, $format='short', $showDate=false)

getModuleName ()

__ ()

getCacheKey ()

getCacheTags ()

getCacheLifetime ()

htmlEscape ($data, $allowedTags=null)

urlEscape ($data)

jsQuoteEscape ($data, $quote= '\'')

getNameInLayout ()

countChildren ()

Protected Member Functions

_construct ()

_prepareLayout ()

_getChildHtml ($name, $useCache=true)

_beforeChildToHtml ($name, $child)

_beforeToHtml ()

_afterToHtml ($html)

_toHtml ()

_getUrlModelClass ()

_getUrlModel ()

_loadCache ()

_saveCache ($data)

_beforeCacheUrl ()

_afterCacheUrl ($html)

Protected Attributes

$_name

$_layout

$_parent

$_alias

$_anonSuffix

$_children = array()

$_sortedChildren = array()

$_childrenHtmlCache = array()

$_request

$_messagesBlock = null

$_isAnonymous = false

$_parentBlock

Static Protected Attributes

static $_urlModel

Detailed Description

Definition at line 38 of file Abstract.php.

Member Function Documentation

__ ( )

Translate block sentence

Returns:: string

Definition at line 844 of file Abstract.php.

00845     {
00846         $args = func_get_args();
00847         $expr = new Mage_Core_Model_Translate_Expr(array_shift($args), $this->getModuleName());
00848         array_unshift($args, $expr);
00849         return Mage::app()->getTranslator()->translate($args);
00850     }

_afterCacheUrl ( $ html ) [protected]

Replace URLs from cache

Parameters:

string

$html

Returns:: string

Definition at line 986 of file Abstract.php.

00987     {
00988         if (Mage::app()->useCache('block_html')) {
00989             Mage::app()->setUseSessionVar(false);
00990             Varien_Profiler::start('CACHE_URL');
00991             $html = Mage::getSingleton('core/url')->sessionUrlVar($html);
00992             Varien_Profiler::stop('CACHE_URL');
00993         }
00994         return $html;
00995     }

_afterToHtml ( $ html ) [protected]

Processing block html after rendering

Parameters:

string

$html

Returns:: string

Reimplemented in Mage_Page_Block_Html.

Definition at line 663 of file Abstract.php.

00664     {
00665         return $html;
00666     }

_beforeCacheUrl ( ) [protected]

Prepare url for save to cache

Returns:: Mage_Core_Block_Abstract

Definition at line 972 of file Abstract.php.

00973     {
00974         if (Mage::app()->useCache('block_html')) {
00975             Mage::app()->setUseSessionVar(true);
00976         }
00977         return $this;
00978     }

_beforeChildToHtml	(	$	name,
		$	child
	)			`[protected]`

Prepare child block before generate html

Parameters:

	string	$name
	Mage_Core_Block_Abstract	$child

Definition at line 516 of file Abstract.php.

00517     {
00518     }

_beforeToHtml ( ) [protected]

Before rendering html, but after trying to load cache

Returns:: Mage_Core_Block_Abstract

Definition at line 615 of file Abstract.php.

00616     {
00617         return $this;
00618     }

_construct ( ) [protected]

Internal constructor, that is called from real constructor

Please override this one instead of overriding real __construct constructor

Reimplemented from Varien_Object.

Definition at line 134 of file Abstract.php.

00135     {
00136         /**
00137          * Please override this one instead of overriding real __construct constructor
00138          */
00139     }

_getChildHtml	(	$	name,
		$	useCache = `true`
	)			`[protected]`

Retrieve child block HTML

Parameters:

	string	$name
	boolean	$useCache

Returns:: string

Definition at line 491 of file Abstract.php.

00492     {
00493         if ($useCache && isset($this->_childrenHtmlCache[$name])) {
00494             return $this->_childrenHtmlCache[$name];
00495         }
00496 
00497         $child = $this->getChild($name);
00498 
00499         if (!$child) {
00500             $html = '';
00501         } else {
00502             $this->_beforeChildToHtml($name, $child);
00503             $html = $child->toHtml();
00504         }
00505 
00506         $this->_childrenHtmlCache[$name] = $html;
00507         return $html;
00508     }

_getUrlModel ( ) [protected]

Enter description here...

Returns:: Mage_Core_Model_Url

Definition at line 693 of file Abstract.php.

00694     {
00695         return Mage::getModel($this->_getUrlModelClass());;
00696     }

_getUrlModelClass ( ) [protected]

Enter description here...

Returns:: string

Reimplemented in Mage_Adminhtml_Block_Abstract, Mage_Adminhtml_Block_Html_Date, Mage_Adminhtml_Block_Html_Select, Mage_Adminhtml_Block_Messages, Mage_Adminhtml_Block_Page_Head, Mage_Adminhtml_Block_Template, and Mage_Adminhtml_Block_Text_List.

Definition at line 683 of file Abstract.php.

00684     {
00685         return 'core/url';
00686     }

_loadCache ( ) [protected]

Enter description here...

Returns:: unknown

Definition at line 899 of file Abstract.php.

00900     {
00901         if (is_null($this->getCacheLifetime()) || !Mage::app()->useCache('block_html')) {
00902             return false;
00903         }
00904         return Mage::app()->loadCache($this->getCacheKey());
00905     }

_prepareLayout ( ) [protected]

Preparing global layout

You can redefine this method in child classes for changin layout

Returns:: Mage_Core_Block_Abstract

Definition at line 211 of file Abstract.php.

00212     {
00213         return $this;
00214     }

_saveCache ( $ data ) [protected]

Enter description here...

Parameters:

unknown_type

$data

Returns:: Mage_Core_Block_Abstract

Definition at line 913 of file Abstract.php.

00914     {
00915         if (is_null($this->getCacheLifetime()) || !Mage::app()->useCache('block_html')) {
00916             return false;
00917         }
00918         Mage::app()->saveCache($data, $this->getCacheKey(), $this->getCacheTags(), $this->getCacheLifetime());
00919         return $this;
00920     }

_toHtml ( ) [protected]

Override this method in descendants to produce html

Returns:: string

Definition at line 673 of file Abstract.php.

00674     {
00675         return '';
00676     }

append	(	$	block,
		$	alias = `''`
	)

Append child block

Parameters:

	Mage_Core_Block_Abstract\|string	$block
	string	$alias

Returns:: Mage_Core_Block_Abstract

Definition at line 604 of file Abstract.php.

00605     {
00606         $this->insert($block, '', true, $alias);
00607         return $this;
00608     }

countChildren ( )

Definition at line 962 of file Abstract.php.

00963     {
00964         return count($this->_children);
00965     }

formatDate	(	$	date = `null`,
		$	format = `'short'`,
		$	showTime = `false`
	)

Retrieve formating date

Parameters:

	string	$date
	string	$format
	bool	$showTime

Returns:: string

Definition at line 805 of file Abstract.php.

00806     {
00807         return $this->helper('core')->formatDate($date, $format, $showTime);
00808     }

formatTime	(	$	time = `null`,
		$	format = `'short'`,
		$	showDate = `false`
	)

Retrieve formating time

Parameters:

	string	$time
	string	$format
	bool	$showDate

Returns:: string

Definition at line 818 of file Abstract.php.

00819     {
00820         return $this->helper('core')->formatTime($time, $format, $showDate);
00821     }

getAction ( )

Retrieve current action object

Returns:: Mage_Core_Controller_Varien_Action

Reimplemented in Mage_Customer_Block_Newsletter, and Mage_Review_Block_Form.

Definition at line 184 of file Abstract.php.

00185     {
00186         return Mage::app()->getFrontController()->getAction();
00187     }

getAnonSuffix ( )

Definition at line 237 of file Abstract.php.

00238     {
00239         return $this->_anonSuffix;
00240     }

getBlockAlias ( )

Definition at line 248 of file Abstract.php.

00249     {
00250         return $this->_alias;
00251     }

getBlockHtml ( $ name )

Retrieve block html

Parameters:

string

$name

Returns:: string

Definition at line 526 of file Abstract.php.

00527     {
00528         if (!($layout = $this->getLayout()) && !($layout = Mage::app()->getFrontController()->getAction()->getLayout())) {
00529             return '';
00530         }
00531         if (!($block = $layout->getBlock($name))) {
00532             return '';
00533         }
00534         return $block->toHtml();
00535     }

getCacheKey ( )

Get Key for caching block content

Returns:: string

Reimplemented in Mage_Adminhtml_Block_Page_Menu, Mage_Catalog_Block_Navigation, and Mage_Page_Block_Html_Footer.

Definition at line 857 of file Abstract.php.

00858     {
00859         if (!$this->hasData('cache_key')) {
00860             $this->setCacheKey($this->getNameInLayout());
00861         }
00862         return $this->getData('cache_key');
00863     }

getCacheLifetime ( )

Get block cache life time

Returns:: int

Reimplemented in Mage_Adminhtml_Block_Page_Menu.

Definition at line 886 of file Abstract.php.

00887     {
00888         if (!$this->hasData('cache_lifetime')) {
00889             return null;
00890         }
00891         return $this->getData('cache_lifetime');
00892     }

getCacheTags ( )

Get tags array for saving cache

Returns:: array

Definition at line 870 of file Abstract.php.

00871     {
00872         if (!$this->hasData('cache_tags')) {
00873             $tags = array();
00874         } else {
00875             $tags = $this->getData('cache_tags');
00876         }
00877         $tags[] = 'block_html';
00878         return $tags;
00879     }

getChild ( $ name = '' )

Retrieve child block by name

Parameters:

string

$name

Returns:: mixed

Definition at line 420 of file Abstract.php.

00421     {
00422         if (''===$name) {
00423             return $this->_children;
00424         } elseif (isset($this->_children[$name])) {
00425             return $this->_children[$name];
00426         }
00427         return false;
00428     }

getChildChildHtml	(	$	name,
		$	childName = `''`,
		$	useCache = `true`,
		$	sorted = `false`
	)

Definition at line 458 of file Abstract.php.

00459     {
00460         if (empty($name)) {
00461             return '';
00462         }
00463         $child = $this->getChild($name);
00464         if (!$child) {
00465             return '';
00466         }
00467         return $child->getChildHtml($childName, $useCache, $sorted);
00468     }

getChildHtml	(	$	name = `''`,
		$	useCache = `true`,
		$	sorted = `false`
	)

Retrieve child block HTML

Parameters:

	string	$name
	boolean	$useCache

Returns:: string

Reimplemented in Mage_Page_Block_Html_Footer.

Definition at line 437 of file Abstract.php.

00438     {
00439         if ('' === $name) {
00440             if ($sorted) {
00441                 $children = array();
00442                 foreach ($this->getSortedChildren() as $childName) {
00443                     $children[$childName] = $this->getLayout()->getBlock($childName);
00444                 }
00445             } else {
00446                 $children = $this->getChild();
00447             }
00448             $out = '';
00449             foreach ($children as $child) {
00450                 $out .= $this->_getChildHtml($child->getBlockAlias(), $useCache);
00451             }
00452             return $out;
00453         } else {
00454             return $this->_getChildHtml($name, $useCache);
00455         }
00456     }

getHelper ( $ type )

Enter description here...

Parameters:

string

$type

Returns:: Mage_Core_Block_Abstract

Definition at line 777 of file Abstract.php.

00778     {
00779         return $this->getLayout()->getBlockSingleton($type);
00780         //return $this->helper($type);
00781     }

getIsAnonymous ( )

Definition at line 226 of file Abstract.php.

00227     {
00228         return $this->_isAnonymous;
00229     }

getLayout ( )

Retrieve layout object

Returns:: Mage_Core_Model_Layout

Definition at line 221 of file Abstract.php.

00222     {
00223         return $this->_layout;
00224     }

getMessagesBlock ( )

Retrieve messages block

Returns:: Mage_Core_Block_Messages

Reimplemented in Mage_Compiler_Block_Process.

Definition at line 751 of file Abstract.php.

00752     {
00753         if (is_null($this->_messagesBlock)) {
00754             return $this->getLayout()->getMessagesBlock();
00755         }
00756         return $this->_messagesBlock;
00757     }

getModuleName ( )

Retrieve module name of block

Returns:: string

Definition at line 828 of file Abstract.php.

00829     {
00830         $module = $this->getData('module_name');
00831         if (is_null($module)) {
00832             $class = get_class($this);
00833             $module = substr($class, 0, strpos($class, '_Block'));
00834             $this->setData('module_name', $module);
00835         }
00836         return $module;
00837     }

getName ( )

Reimplemented in Mage_Catalog_Block_Layer_Filter_Abstract.

Definition at line 259 of file Abstract.php.

00260     {
00261         return $this->_name;
00262     }

getNameInLayout ( )

Definition at line 957 of file Abstract.php.

00958     {
00959         return $this->_getData('name_in_layout');
00960     }

getParentBlock ( )

Retrieve parent block

Returns:: Mage_Core_Block_Abstract

Definition at line 162 of file Abstract.php.

00163     {
00164         return $this->_parentBlock;
00165     }

getRequest ( )

Retrieve request object

Returns:: Mage_Core_Controller_Request_Http

Definition at line 146 of file Abstract.php.

00147     {
00148         if ($controller = Mage::app()->getFrontController()) {
00149             $this->_request = $controller->getRequest();
00150         }
00151         else {
00152             throw new Exception(Mage::helper('core')->__("Can't retrieve request object"));
00153         }
00154         return $this->_request;
00155     }

getSkinUrl	(	$	file = `null`,
		array $	params = `array()`
	)

Retrieve url of skins file

Parameters:

	string	$file path to file in skin
	array	$params

Returns:: string

Definition at line 741 of file Abstract.php.

00742     {
00743         return Mage::getDesign()->getSkinUrl($file, $params);
00744     }

getSortedChildBlocks ( )

Obtain sorted child blocks

Returns:: array

Definition at line 475 of file Abstract.php.

00476     {
00477         $children = array();
00478         foreach ($this->getSortedChildren() as $childName) {
00479             $children[$childName] = $this->getLayout()->getBlock($childName);
00480         }
00481         return $children;
00482     }

getSortedChildren ( )

Definition at line 275 of file Abstract.php.

00276     {
00277         return $this->_sortedChildren;
00278     }

getUrl	(	$	route = `''`,
		$	params = `array()`
	)

Generate url by route and parameters

Parameters:

	string	$route
	array	$params

Returns:: string

Reimplemented in Mage_Adminhtml_Block_Sales_Order_View, Mage_ProductAlert_Block_Price, and Mage_ProductAlert_Block_Stock.

Definition at line 705 of file Abstract.php.

00706     {
00707         return $this->_getUrlModel()->getUrl($route, $params);
00708     }

getUrlBase64	(	$	route = `''`,
		$	params = `array()`
	)

Generate base64-encoded url by route and parameters

Parameters:

	string	$route
	array	$params

Returns:: string

Definition at line 717 of file Abstract.php.

00718     {
00719         return Mage::helper('core')->urlEncode($this->getUrl($route, $params));
00720     }

getUrlEncoded	(	$	route = `''`,
		$	params = `array()`
	)

Generate url-encoded url by route and parameters

Parameters:

	string	$route
	array	$params

Returns:: string

Definition at line 729 of file Abstract.php.

00730     {
00731         return Mage::helper('core')->urlEncode($this->getUrl($route, $params));
00732     }

helper ( $ name )

Enter description here...

Parameters:

string

$name

Returns:: Mage_Core_Block_Abstract

Definition at line 789 of file Abstract.php.

00790     {
00791         if ($this->getLayout()) {
00792             return $this->getLayout()->helper($name);
00793         }
00794         return Mage::helper($name);
00795     }

htmlEscape	(	$	data,
		$	allowedTags = `null`
	)

Escape html entities

Parameters:

	mixed	$data
	array	$allowedTags

Returns:: mixed

Definition at line 929 of file Abstract.php.

00930     {
00931         return $this->helper('core')->htmlEscape($data, $allowedTags);
00932     }

insert	(	$	block,
		$	siblingName = `''`,
		$	after = `false`,
		$	alias = `''`
	)

Insert child block

Parameters:

	Mage_Core_Block_Abstract\|string	$block
	string	$siblingName
	boolean	$after
	string	$alias

Returns:: object $this

Definition at line 546 of file Abstract.php.

00547     {
00548         if (is_string($block)) {
00549             $block = $this->getLayout()->getBlock($block);
00550         }
00551         if (!$block) {
00552             /*
00553              * if we don't have block - don't throw exception because
00554              * block can simply removed using layout method remove
00555              */
00556             //Mage::throwException(Mage::helper('core')->__('Invalid block name to set child %s: %s', $alias, $block));
00557             return $this;
00558         }
00559         if ($block->getIsAnonymous()) {
00560             $this->setChild('', $block);
00561             $name = $block->getNameInLayout();
00562         } elseif ('' != $alias) {
00563             $this->setChild($alias, $block);
00564             $name = $block->getNameInLayout();
00565         } else {
00566             $name = $block->getNameInLayout();
00567             $this->setChild($name, $block);
00568         }
00569 
00570         if (''===$siblingName) {
00571             if ($after) {
00572                 array_push($this->_sortedChildren, $name);
00573             }
00574             else {
00575                 array_unshift($this->_sortedChildren, $name);
00576             }
00577         } else {
00578             $key = array_search($siblingName, $this->_sortedChildren);
00579             if (false!==$key) {
00580                 if ($after) {
00581                     $key++;
00582                 }
00583                 array_splice($this->_sortedChildren, $key, 0, $name);
00584             } else {
00585                 if ($after) {
00586                     array_push($this->_sortedChildren, $name);
00587                 }
00588                 else {
00589                     array_unshift($this->_sortedChildren, $name);
00590                 }
00591             }
00592         }
00593 
00594         return $this;
00595     }

jsQuoteEscape	(	$	data,
		$	quote = `'\''`
	)

Escape quotes in java scripts

Parameters:

	mixed	$data
	string	$quote

Returns:: mixed

Definition at line 952 of file Abstract.php.

00953     {
00954         return $this->helper('core')->jsQuoteEscape($data, $quote);
00955     }

setAnonSuffix ( $ suffix )

Definition at line 242 of file Abstract.php.

00243     {
00244         $this->_anonSuffix = $suffix;
00245         return $this;
00246     }

setAttribute	(	$	name,
		$	value = `null`
	)

Set block attribute value

Wrapper for method "setData"

Parameters:

	string	$name
	mixed	$value

Returns:: Mage_Core_Block_Abstract

Definition at line 289 of file Abstract.php.

00290     {
00291         return $this->setData($name, $value);
00292     }

setBlockAlias ( $ alias )

Definition at line 253 of file Abstract.php.

00254     {
00255         $this->_alias = $alias;
00256         return $this;
00257     }

setChild	(	$	alias,
		$	block
	)

Set child block

Parameters:

	string	$name
	Mage_Core_Block_Abstract	$block

Returns:: Mage_Core_Block_Abstract

See also:: self.insert()

Definition at line 301 of file Abstract.php.

00302     {
00303         if (is_string($block)) {
00304             $block = $this->getLayout()->getBlock($block);
00305         }
00306         /**
00307          * @see self::insert()
00308          */
00309         if (!$block) {
00310             return $this;
00311         }
00312         if ($block->getIsAnonymous()) {
00313 
00314             $suffix = $block->getAnonSuffix();
00315             if (empty($suffix)) {
00316                 $suffix = 'child'.sizeof($this->_children);
00317             }
00318             $blockName = $this->getNameInLayout().'.'.$suffix;
00319 
00320             if ($this->getLayout()) {
00321                 $this->getLayout()
00322                 ->unsetBlock($block->getNameInLayout())
00323                 ->setBlock($blockName, $block);
00324             }
00325 
00326             $block->setNameInLayout($blockName);
00327             $block->setIsAnonymous(false);
00328 
00329             if (empty($alias)) {
00330                 $alias = $blockName;
00331             }
00332         }
00333 
00334         $block->setParentBlock($this);
00335         $block->setBlockAlias($alias);
00336 
00337         $this->_children[$alias] = $block;
00338 
00339         return $this;
00340     }

setIsAnonymous ( $ flag )

Definition at line 231 of file Abstract.php.

00232     {
00233         $this->_isAnonymous = $flag;
00234         return $this;
00235     }

setLayout ( Mage_Core_Model_Layout $ layout )

Set layout object

Parameters:

Mage_Core_Model_Layout

$layout

Returns:: Mage_Core_Block_Abstract

Definition at line 195 of file Abstract.php.

00196     {
00197         $this->_layout = $layout;
00198         Mage::dispatchEvent('core_block_abstract_prepare_layout_before', array('block' => $this));
00199         $this->_prepareLayout();
00200         Mage::dispatchEvent('core_block_abstract_prepare_layout_after', array('block' => $this));
00201         return $this;
00202     }

setMessagesBlock ( Mage_Core_Block_Messages $ block )

Set messages block

Parameters:

Mage_Core_Block_Messages

$block

Returns:: Mage_Core_Block_Abstract

Definition at line 765 of file Abstract.php.

00766     {
00767         $this->_messagesBlock = $block;
00768         return $this;
00769     }

setName ( $ name )

Definition at line 264 of file Abstract.php.

00265     {
00266         if (!empty($this->_name) && $this->getLayout()) {
00267             $this->getLayout()
00268             ->unsetBlock($this->_name)
00269             ->setBlock($name, $this);
00270         }
00271         $this->_name = $name;
00272         return $this;
00273     }

setParentBlock ( Mage_Core_Block_Abstract $ block )

Set parent block

Parameters:

Mage_Core_Block_Abstract

$block

Returns:: Mage_Core_Block_Abstract

Definition at line 173 of file Abstract.php.

00174     {
00175         $this->_parentBlock = $block;
00176         return $this;
00177     }

toHtml ( ) [final]

Produce and return block's html output

It is a final method, but you can override _toHmtl() method in descendants if needed

Returns:: string

Definition at line 627 of file Abstract.php.

00628     {
00629         Mage::dispatchEvent('core_block_abstract_to_html_before', array('block' => $this));
00630 
00631         if (Mage::getStoreConfig('advanced/modules_disable_output/'.$this->getModuleName())) {
00632             return '';
00633         }
00634 
00635         if (!($html = $this->_loadCache())) {
00636             $translate = Mage::getSingleton('core/translate');
00637             /* @var $translate Mage_Core_Model_Translate */
00638             if ($this->hasData('translate_inline')) {
00639                 $translate->setTranslateInline($this->getData('translate_inline'));
00640             }
00641 
00642             $this->_beforeToHtml();
00643             $html = $this->_toHtml();
00644             $this->_saveCache($html);
00645 
00646             if ($this->hasData('translate_inline')) {
00647                 $translate->setTranslateInline(true);
00648             }
00649         }
00650 
00651         $html = $this->_afterToHtml($html);
00652         Mage::dispatchEvent('core_block_abstract_to_html_after', array('block' => $this));
00653 
00654         return $html;
00655     }

unsetCallChild	(	$	alias,
		$	callback,
		$	result,
		$	params
	)

Call a child and unset it, if callback matched result

$params will pass to child callback $params may be array, if called from layout with elements with same name, for example: ...<foo>value_1</foo><foo>value_2</foo><foo>value_3</foo>

Or, if called like this: ...<foo>value_1</foo><bar>value_2</bar><baz>value_3</baz>

then it will be $params1, $params2, $params3

It is no difference anyway, because they will be transformed in appropriate way.

Parameters:

	string	$alias
	string	$callback
	mixed	$result
	array	$params

Returns:: Mage_Core_Block_Abstract

Definition at line 383 of file Abstract.php.

00384     {
00385         $child = $this->getChild($alias);
00386         if ($child) {
00387             $args     = func_get_args();
00388             $alias    = array_shift($args);
00389             $callback = array_shift($args);
00390             $result   = (string)array_shift($args);
00391             if (!is_array($params)) {
00392                 $params = $args;
00393             }
00394 
00395             if ($result == call_user_func_array(array(&$child, $callback), $params)) {
00396                 $this->unsetChild($alias);
00397             }
00398         }
00399         return $this;
00400     }

unsetChild ( $ alias )

Unset child block

Parameters:

string

$name

Returns:: Mage_Core_Block_Abstract

Definition at line 348 of file Abstract.php.

00349     {
00350         if (isset($this->_children[$alias])) {
00351             unset($this->_children[$alias]);
00352         }
00353 
00354         if (!empty($this->_sortedChildren)) {
00355             $key = array_search($alias, $this->_sortedChildren);
00356             if ($key!==false) {
00357                 unset($this->_sortedChildren[$key]);
00358             }
00359         }
00360 
00361         return $this;
00362     }

unsetChildren ( )

Unset all children blocks

Returns:: Mage_Core_Block_Abstract

Definition at line 407 of file Abstract.php.

00408     {
00409         $this->_children = array();
00410         $this->_sortedChildren = array();
00411         return $this;
00412     }

urlEscape ( $ data )

Escape html entities in url

Parameters:

string

$data

Returns:: string

Definition at line 940 of file Abstract.php.

00941     {
00942         return $this->helper('core')->urlEscape($data);
00943     }

Member Data Documentation

$_alias [protected]

Definition at line 67 of file Abstract.php.

$_anonSuffix [protected]

Definition at line 74 of file Abstract.php.

$_children = array() [protected]

Definition at line 81 of file Abstract.php.

$_childrenHtmlCache = array() [protected]

Definition at line 95 of file Abstract.php.

$_isAnonymous = false [protected]

Definition at line 116 of file Abstract.php.

$_layout [protected]

Definition at line 53 of file Abstract.php.

$_messagesBlock = null [protected]

Definition at line 109 of file Abstract.php.

$_name [protected]

Reimplemented in Mage_Adminhtml_Block_Catalog_Product_Edit_Tab_Options_Option, and Mage_Adminhtml_Block_Catalog_Product_Edit_Tab_Options_Type_Abstract.

Definition at line 46 of file Abstract.php.

$_parent [protected]

Definition at line 60 of file Abstract.php.

$_parentBlock [protected]

Definition at line 123 of file Abstract.php.

$_request [protected]

Definition at line 102 of file Abstract.php.

$_sortedChildren = array() [protected]

Definition at line 88 of file Abstract.php.

$_urlModel [static, protected]

Definition at line 125 of file Abstract.php.

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

app/code/core/Mage/Core/Block/Abstract.php


Public Member Functions
	getRequest ()
	getParentBlock ()
	setParentBlock (Mage_Core_Block_Abstract $block)
	getAction ()
	setLayout (Mage_Core_Model_Layout $layout)
	getLayout ()
	getIsAnonymous ()
	setIsAnonymous ($flag)
	getAnonSuffix ()
	setAnonSuffix ($suffix)
	getBlockAlias ()
	setBlockAlias ($alias)
	getName ()
	setName ($name)
	getSortedChildren ()
	setAttribute ($name, $value=null)
	setChild ($alias, $block)
	unsetChild ($alias)
	unsetCallChild ($alias, $callback, $result, $params)
	unsetChildren ()
	getChild ($name='')
	getChildHtml ($name='', $useCache=true, $sorted=false)
	getChildChildHtml ($name, $childName= '', $useCache=true, $sorted=false)
	getSortedChildBlocks ()
	getBlockHtml ($name)
	insert ($block, $siblingName='', $after=false, $alias='')
	append ($block, $alias='')
	toHtml ()
	getUrl ($route='', $params=array())
	getUrlBase64 ($route='', $params=array())
	getUrlEncoded ($route= '', $params=array())
	getSkinUrl ($file=null, array $params=array())
	getMessagesBlock ()
	setMessagesBlock (Mage_Core_Block_Messages $block)
	getHelper ($type)
	helper ($name)
	formatDate ($date=null, $format='short', $showTime=false)
	formatTime ($time=null, $format='short', $showDate=false)
	getModuleName ()
	__ ()
	getCacheKey ()
	getCacheTags ()
	getCacheLifetime ()
	htmlEscape ($data, $allowedTags=null)
	urlEscape ($data)
	jsQuoteEscape ($data, $quote= '\'')
	getNameInLayout ()
	countChildren ()
Protected Member Functions
	_construct ()
	_prepareLayout ()
	_getChildHtml ($name, $useCache=true)
	_beforeChildToHtml ($name, $child)
	_beforeToHtml ()
	_afterToHtml ($html)
	_toHtml ()
	_getUrlModelClass ()
	_getUrlModel ()
	_loadCache ()
	_saveCache ($data)
	_beforeCacheUrl ()
	_afterCacheUrl ($html)
Protected Attributes
	$_name
	$_layout
	$_parent
	$_alias
	$_anonSuffix
	$_children = array()
	$_sortedChildren = array()
	$_childrenHtmlCache = array()
	$_request
	$_messagesBlock = null
	$_isAnonymous = false
	$_parentBlock
Static Protected Attributes
static	$_urlModel