class BlogEntry extends BlogPost implements MigratableObject (View source)

deprecated since version 2.0

Properties

string $PublishDate
string $AuthorNames from  BlogPost
int $ParentID
string $Date
string $Tags

Methods

public
null|string
RoleOf(null|int|Member $member = null)

Determine the role of the given member.

from  BlogPost
public
bool
isAuthor(null|Member $member = null)

Determine if the given member is an author of this post.

from  BlogPost
public
getCMSFields()

{@inheritdoc}

from  BlogPost
public
getCandidateAuthors()

Gets the list of author candidates to be assigned as authors of this blog post.

from  BlogPost
public
bool
canEditAuthors(null|int|Member $member = null)

Determine if this user can edit the authors list.

from  BlogPost
protected
null|Member
getMember(null|int|Member $member = null)

No description

from  BlogPost
public
bool
canCreateCategories(null|int|Member $member = null)

Determine whether user can create new categories.

from  BlogPost
public
bool
canCreateTags(null|int|Member $member = null)

Determine whether user can create new tags.

from  BlogPost
public
onBeforePublish()

{@inheritdoc}

from  BlogPost
public
onAfterWrite()

{@inheritdoc}

from  BlogPost
public
canView($member = null)

{@inheritdoc}

from  BlogPost
public
canPublish($member = null)

{@inheritdoc}

from  BlogPost
public
canEdit($member = null)

{@inheritdoc}

from  BlogPost
public
string
Excerpt(int $wordsToDisplay = 30)

Returns the post excerpt.

from  BlogPost
public
string
getMonthlyArchiveLink(string $type = 'day')

Returns a monthly archive link for the current blog post.

from  BlogPost
public
string
getYearlyArchiveLink()

Returns a yearly archive link for the current blog post.

from  BlogPost
public
getCredits()

Resolves static and dynamic authors linked to this post.

from  BlogPost
protected
getDynamicCredits()

Resolves dynamic authors linked to this post.

from  BlogPost
protected
getStaticCredits()

Resolves static authors linked to this post.

from  BlogPost
public
array
fieldLabels(bool $includeRelations = true)

Sets the label for BlogPost.Title to 'Post Title' (Rather than 'Page name').

from  BlogPost
public
string|null
getDate()

Proxy method for displaying the publish date in rss feeds.

from  BlogPost
protected
onBeforeWrite()

{@inheritdoc}

from  BlogPost
Categories()

No description

from  BlogPost
Tags()

No description

from  BlogPost
Authors()

No description

from  BlogPost
Parent()

No description

from  BlogPost
public
canCreate($member = null)

{@inheritdoc}

public
up()

Migrate the object up to the current version.

public
array
TagNames() deprecated

Safely split and parse all distinct tags assigned to this BlogEntry.

Details

null|string RoleOf(null|int|Member $member = null)

Determine the role of the given member.

Call be called via template to determine the current user.

Parameters

null|int|Member $member

Return Value

null|string

Examples

"Hello $RoleOf($CurrentMember.ID)"

bool isAuthor(null|Member $member = null)

Determine if the given member is an author of this post.

Parameters

null|Member $member

Return Value

bool

getCMSFields()

{@inheritdoc}

SS_List getCandidateAuthors()

Gets the list of author candidates to be assigned as authors of this blog post.

Return Value

SS_List

bool canEditAuthors(null|int|Member $member = null)

Determine if this user can edit the authors list.

Parameters

null|int|Member $member

Return Value

bool

protected null|Member getMember(null|int|Member $member = null)

No description

Parameters

null|int|Member $member

Return Value

null|Member

bool canCreateCategories(null|int|Member $member = null)

Determine whether user can create new categories.

Parameters

null|int|Member $member

Return Value

bool

bool canCreateTags(null|int|Member $member = null)

Determine whether user can create new tags.

Parameters

null|int|Member $member

Return Value

bool

onBeforePublish()

{@inheritdoc}

Update the PublishDate to now if the BlogPost would otherwise be published without a date.

onAfterWrite()

{@inheritdoc}

Sets blog relationship on all categories and tags assigned to this post.

canView($member = null)

{@inheritdoc}

Parameters

$member

canPublish($member = null)

{@inheritdoc}

Parameters

$member

canEdit($member = null)

{@inheritdoc}

Parameters

$member

string Excerpt(int $wordsToDisplay = 30)

Returns the post excerpt.

Parameters

int $wordsToDisplay

Return Value

string

Returns a monthly archive link for the current blog post.

Parameters

string $type

Return Value

string

Returns a yearly archive link for the current blog post.

Return Value

string

ArrayList getCredits()

Resolves static and dynamic authors linked to this post.

Return Value

ArrayList

protected ArrayList getDynamicCredits()

Resolves dynamic authors linked to this post.

Return Value

ArrayList

protected ArrayList getStaticCredits()

Resolves static authors linked to this post.

Return Value

ArrayList

array fieldLabels(bool $includeRelations = true)

Sets the label for BlogPost.Title to 'Post Title' (Rather than 'Page name').

Parameters

bool $includeRelations

Return Value

array

string|null getDate()

Proxy method for displaying the publish date in rss feeds.

protected onBeforeWrite()

{@inheritdoc}

ManyManyList Categories()

No description

Return Value

ManyManyList

ManyManyList Tags()

No description

Return Value

ManyManyList

ManyManyList Authors()

No description

Return Value

ManyManyList

Blog Parent()

No description

Return Value

Blog

canCreate($member = null)

{@inheritdoc}

Parameters

$member

up()

Migrate the object up to the current version.

array TagNames() deprecated

deprecated since version 2.0

Safely split and parse all distinct tags assigned to this BlogEntry.

Return Value

array