S2:EntryLite

From No LJ Ads Wiki

Jump to: navigation, search

Base class for both journal entries and comments.

S2 - EntryLite

[edit] Members

int depth Visual depth of entry. Top-level journal entries are always depth zero. Comments have a depth greater than or equal to one, depending on where the thread is rooted at.
string dom_id The DOM 'id' attribute you should put on your outer-most element (Read-only)
UserLite journal Journal the entry has been posted to
string[] link_keyseq An array of keys which you should pass to EntryLite.get_link(string) to produce an entry 'toolbar'. Does not contain nav_next and nav_prev for entries; you should retrieve those separately and put them somewhere appropriate for your layout.
string{} metadata Post metadata. Keys: 'music', 'mood' (Read-only)
string permalink_url A URL at which this specific entry can be viewed, for linking purposes. (Read-only)
UserLite poster Author of the entry, or null if an anonymous comment
string subject Subject. May contain HTML. Don't do substring chops on this. (Read-only)
DateTime system_time The system time (in GMT) this entry or comment was posted.
Tag[] tags Array of tags applied to this entry. (Read-only)
string text Entry Text; Use EntryLite.print_text() to print this so that the entry's trust level is not affected by your layer's trust level. (Read-only)
bool text_must_print_trusted Indicates that this entry's text contains some content that must be printed trusted, with EntryLite.print_text(), rather than printed directly from an untrusted context. Use this to fall back to a plain trusted print if you are doing something unusual with EntryLite.text. Most layers can just ignore this and always use EntryLite.print_text(). (Read-only)
DateTime time The user-specified time of the post, or the GMT time if it's a comment.
Image userpic The userpic selected to relate to this entry.

[edit] Methods

get_link(string key) : Link Get a link to some action related to this entry or comment. You can iterate over EntryLite.link_keyseq to get keys to pass in here to produce a 'toolbar' of links.
get_plain_subject() : string For Entries that can contain HTML subjects, this returns the subjeft without HTML. Comments can't have HTML in subjects, so this is equivalent to just using $.subject. The returned 'plain' subject may still contain HTML entities, so don't do substring chops on it either.
get_tags_text() : string Returns a string containing a <div> of class 'ljtags' with the tags for the entry. If there are no tags on the entry, returns a blank string. The string is formatted according to the 'text_tags' property.
print_linkbar() : void Print the link bar for this entry or comment.
print_text() : void Print the entry text. Doesn't print anything in some contexts, such as on a month view or in a collapsed comment.
time_display() : string Show the time of this post, with most useful information for user, and with tooltip for more.
time_display(string datefmt, string timefmt) : string Same as EntryLite.time_display() but with custom date format support.