Bric::Util::Burner::Mason - Bric::Util::Burner subclass to publish business assets using Mason formatting assets.

$LastChangedRevision$

$LastChangedDate: 2005-05-22 11:43:46 -0700 (Sun, 22 May 2005) $

 use Bric::Util::Burner::Mason;

 # Create a new Mason burner using the settings from $burner
 $mason_burner = Bric::Util::Burner::Mason->new($burner);

 # burn an asset, get back a list of resources
 @resources = $mason_burner->burn_one($ba, $at, $oc, $cat);

This module handles burning business assets using Mason formatting assets.

$obj = Bric::Util::Burner::Mason->new($burner);

Creates a new Mason burner object. Takes a single parameters - CW$burner - which is a Bric::Util::Burner object. The new object will has its attributes initialized by the passed object.

Publishes an asset. Returns a list of resources burned. Parameters are:

*

$ba A business asset object to publish.

*

$at A asset type object for CW$ba

*

$oc An output channel object to use for the publish

*

cat A category in which to publish. Compiles the template found in CW$template. If the compile succeeds with no errors, CWchk_syntax() returns true. Otherwise, it returns false, and the error will be in the CW$err variable passed by reference. Throws: NONE. Side Effects: NONE. Notes: NONE. Finds the first instance of the template with the name CW$tmpl_name in the URI directory hierarchy in CW$uri. Returns the template path, if it exists, and undef if it does not. For example:

  my $uri = '/foo/bar/bletch';
  my $tmpl_name = 'story.mc';
  my $template = $burner->find_template($uri, $tmpl_name);

The find_template() method will look first for '/foo/bar/bletch/story.mc', and return that string if the template exists. If it doesn't, it'll look for '/foo/bar/story.mc'. If it doesn't find that, it'll look for '/foo/story.mc' and then '/story.mc'. If it finds none of these, it will rutrn null (or an empty list in an array context. Throws: NONE. Side Effects: NONE. Notes: Uses HTML::Mason::Interp->comp_exists() internally to determine if the template exists. Returns the path to the first template it finds in CW@tmpl_list. It uses find_template() (see above) to examine each template in CW@tmpl_list in turn. Thus, this method looks down the directory hierarchy of each template in CW@tmpl_list before moving on to the next one. For example:

  my @tmpl_list = ('/foo/bar/story.mc', '/sci/anthro/fizzle.mc');
  my $template =  $burner->find_first_template(@tmpl_list)

In this example, find_first_template will return the name of the first template it finds in this order:

*

/foo/bar/story.mc'

*

/foo/story.mc'

*

/story.mc'

*

/sci/anthro/fizzle.mc'

*

/sci/fizzle.mc'

*

/fizzle.mc' If no template is found to exist, find_first_template will return undef (or an empty list in an array context). Throws: NONE. Side Effects: NONE. Notes: See also find_template() above. A method to be called from template space. Use this method to display paginated elements. If this method is used, the burn system will run once for every page element listed in CW\@paginated_element_names (or just CW$paginated_element_name) in the story; this is so that autohandlers will be called when appropriate. All arguments after the first argument will be passed to the template executed as its CW%ARGS hash. Throws: NONE. Side Effects: NONE. Notes: NONE. A method to be called from template space. This method will find the mason element associated with the element passed in and call CW$m->comp. All arguments after the first argument will be passed to the template executed as its CW%ARGS hash. Throws: NONE. Side Effects: NONE. Notes: NONE. A method to be called from template space. This is a sprintf version of CW$b->display_element(), i.e. it returns as a string of HTML what would have been displayed with CW$b->display_element(). Throws: NONE. Side Effects: NONE. Notes: NONE.

  % unless ($burner->get_more_pages) {
        <h3>Last page</h3>
  % }

Returns true if more pages remain to be burned, and false if not. Only enumerated when CWdisplay_pages() is being used to output pages. Throws: NONE. Side Effects: NONE. Notes: NONE. This method is designed to be called from within a template. When passed a true value, it causes the burner to burn the current story and page again, creating another file. This is useful for creating multi-file output without extra paginated subelements. For example, if you need to create an index of stories, and you only want to list 10 on a page over multiple pages, you can use this method to force the burner to burn as many pages as you need to get the job done. When the burner prepares to burn the page again, it resets the CWburn_again attribute. So you'll need to set it for every page for which another page burned. Throws: NONE. Side Effects: NONE. Notes: NONE. This method can be used in an autohandler template. It calls the next template in the chain, whether its the next autohandler down the line or the template itself. Throws: NONE. Side Effects: NONE. Notes: This is a wrapper around masons 'call_next' method. We wrap it here to make sure we have control over the burn process at this level if we need it. It also gives us the opportunity to tailor the verbiage to suit our application better. Writes out the current page and starts a new one. Throws:

*

Unable to open file for writing. Side Effects: NONE. Notes: NONE.

NONE.

Adds a Bric::Dist::Resource object to this burn. Throws: NONE. Side Effects: NONE. Notes: NONE. Given an element (a business asset/data tile) return the template element that formats it. Throws: NONE. Side Effects: NONE. Notes: NONE. Return the current element in this context. Throws: NONE. Side Effects: NONE. Notes: NONE. Return the current element type in this context. Throws: NONE. Side Effects: NONE. Notes: NONE. Push and pops an element from the element stack. As a story is burned, the burn process can travel down several elements deep. This stack records the order in which each element was transversed so when the burn process exits an element, the correct and current element is at the top of the stack. Throws: NONE. Side Effects: NONE. Notes: NONE. Common code used by CW$b->display_element and CW$b->sdisplay_element. It directly displays the HTML for display_element, while it returns the HTML as a string for sdisplay_element. Throws: NONE. Side Effects: NONE. Notes: NONE.

_interp_args()

Returns HTML::Mason->Interp arguments, with custom tags set. Throws: NONE. Side Effects: NONE. Notes: NONE. HTML::Mason::Compiler pre-process filter, to allow custom mason tags. Pre-processor checks the tagset for the context, which can be PREVIEW_MODE, BURN_MODE or SYNTAX_MODE, and processes the tags according to the context. Throws: NONE. Side Effects: NONE. Notes: NONE.

NONE.

Garth Webb gtgarth@perijove.comlt

Sam Tregar gtstregar@about-inc.comlt

David Wheeler gtdavid@wheeler.netlt

Bric, Bric::Util::Burner