w3-tools.com - Free Webmaster Tools and Resources
  		w3-tools.com - Free Webmaster Tools and Resources
 Free Webmaster Tools and Resources

 



PEAR Manual

This manual is provided as a courtesy. It is not an official source. Please check pear.php.net for updated information.

PEAR Manual

PEAR Manual
PEAR Manual
PrevNext

getBlockList()

getBlockList() -- Returns a list of blocks within a template.

Synopsis

require_once 'HTML/Template/Sigma.php';

array HTML_Template_Sigma::getBlockList ([string $parent = '__global__' [, bool $recursive = FALSE]])

Description

Returns a list of blocks within a template.

If $recursive is FALSE, it returns just a 'flat' array of $parent's direct subblocks. If $recursive is TRUE, it builds a tree of template blocks using $parent as root. Tree structure is compatible with PEAR::Tree's Memory_Array driver.

Parameter

string $parent

parent block name

boolean $recursive

whether to return a tree of child blocks (TRUE) or a 'flat' array (FALSE)

Return value

return a list of child blocks

See

see HTML_Template_Sigma::blockExists(), HTML_Template_Sigma::getPlaceholderList()

Throws

Table 40-1. Possible PEAR_Error values

Error codeError messageReasonSolution
SIGMA_BLOCK_NOT_FOUNDCannot find block '$parent'There is no block $parent in the templateCheck the block name spelling, check whether you added all the necessary blocks to the template

Note

This function can not be called statically.

PrevHomeNext
get()UpgetCurrentBlock()

Newsletter
Join to our newsletter and receive news and updates about our site.
Your name: 
E-mail address: 
Action: 
 

Hosted by

Search
Google
Web w3-tools.com

Links
  What is my IP? Find your IP address!     Valid XHTML 1.0 Transitional  
Copyright © 2006. by w3-tools.com. All rights reserved