NAME

BSE::TB::SiteCommon - methods common to the site and article objects

SYNOPSIS

  my @steps = $article->set_parents;
  my @sections = $site->children;

DESCRIPTION

Provides methods common to the Article and BSE::TB::Site objects.

USEFUL METHODS

menu_kids

Returns a list of children meant to be listed in menus.

menu_kids

Returns a list of allkids meant to be listed in menus.

add_file($cfg, %opts)

Add a file to the site or article.

Options:

• filename - the name of the file to add. This or file is required.

  If filename is in the BSE download directory BSE will take ownership of the file - you must not remove it.

• file - a file handle of the file to add. This or filename is required.

• displayName - the display name of the file. Required. eg. "foo.txt"

• contentType - the content type of the file. Guessed from displayName if not supplied.

• name - an identifier for the file. Required for global files, though that may change. Must unique within global files or within the article's files, depending where you're adding it.

• store - set to true to perform storage processing on the file.

• storage - the storage to store the file in if store is true. If blank or empty BSE will select store based on the configured rules.

dies with an error message on failure.

Returns a file object on success.

reorder_child($child_id, $after_id)

Change the order of children of $self so that $child_id is after $after_id.

If $after_id is zero then $child_id becomes the first child.

AUTHOR

Tony Cook <tony@develop-help.com>