NAME

Article - article objects for BSE.


SYNOPSIS

  use BSE::API qw(bse_make_article);
  my $article = bse_make_article(...)
  my $article = Articles->getByPkey($id);


DESCRIPTION

Implements the base article object for BSE.


USEFUL METHODS

id
parentid
displayOrder
title
titleImage
body
thumbImage
thumbWidth
thumbHeight
imagePos
release
expire
keyword
template
threshold
summaryLength
generator
level
listed
lastModified
flags
customDate1
customDate2
customStr1
customStr2
customInt1
customInt2
customInt3
customInt4
lastModifiedBy
created
createdBy
author
pageTitle
force_dynamic
cached_dynamic
inherit_siteuser_rights
metaDescription
metaKeywords
summary
menu
titleAlias
linkAlias
category

Simple column accessors.

section

Return the article's section.

parent

Return the article's parent.

is_dynamic

Return true if the article is rendered dynamically.

is_accessible_to($group)

Return true if the article is accessible to the supplied siteuser group or group id.

is_access_controlled

Return true if the article is access controlled.

all_parents

Return a list of all parents.

admin

Return the admin link for the article.

is_linked

Return true if the article can be linked to.

is_expired

Returns true if the article expiry date has passed.

is_released

Returns true if the article release date has passed (ie. the article has been released.)

listed_in_menu

Return true if the article should be listed in menus.

ancestors

Returns a list of ancestors of self.

is_descendant_of($ancestor)

Return true if self is a decsendant of the supplied article or article id.

should_generate

Return true if this article should have pages generated, either for static content or for dynamic.


BASE CLASSES

the BSE::TB::SiteCommon manpage

the BSE::TB::TagOwner manpage

the Squirrel::Row manpage


AUTHOR

Tony Cook <tony@develop-help.com>