InsaneJournal

Home : Manage Accounts : Customize Advanced S2 Settings : Public Layer Browser : LiveJournal S2 Core, v1

[<< Advanced Customization]
[<< Public Layers] [View source: Raw Source Code | Syntax Highlighted]

Layer Info

author_email	webmaster@livejournal.com
author_name	LiveJournal Webmaster
majorversion	1
name	LiveJournal S2 Core, v1
redist_uniq	core1
type	core

Properties Set

color_comment_bar	`#d0d0ff`
comment_userpic_style	(empty)
control_strip_bgcolor	(empty)
control_strip_bordercolor	(empty)
control_strip_fgcolor	(empty)
control_strip_linkcolor	(empty)
custom_control_strip_colors	off
custom_css	(empty)
external_stylesheet	0
font_base	(empty)
font_fallback	none
include_default_stylesheet	1
lang_current	en
lang_dayname_long	`[` (empty), Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, `]`
lang_dayname_short	`[` (empty), Sun, Mon, Tue, Wed, Thu, Fri, Sat, `]`
lang_dayname_shorter	`[` (empty), S, M, T, W, T, F, S, `]`
lang_fmt_date_long	%%month%% %%dayord%%, %%yyyy%%
lang_fmt_date_long_day	%%day%%, %%month%% %%dayord%%, %%yyyy%%
lang_fmt_date_med	%%mon%%. %%dayord%%, %%yyyy%%
lang_fmt_date_med_day	%%da%%, %%mon%%. %%dayord%%, %%yyyy%%
lang_fmt_date_short	%%m%%/%%d%%/%%yy%%
lang_fmt_month_long	%%month%% %%yyyy%%
lang_fmt_month_med	%%mon%% %%yyyy%%
lang_fmt_month_short	%%m%%/%%yy%%
lang_fmt_time_short	%%hh%%:%%min%% %%a%%m
lang_monthname_long	`[` (empty), January, February, March, April, May, June, July, August, September, October, November, December, `]`
lang_monthname_short	`[` (empty), Jan, Feb, Mar, Apr, May, Jun, Jul, Aug, Sep, Oct, Nov, Dec, `]`
linked_stylesheet	(empty)
linklist_support	1
page_day_sortorder	forward
page_friends_items	20
page_month_textsubjects	1
page_recent_items	20
page_year_sortorder	forward
reg_firstdayofweek	sunday
tags_aware	0
text_comment_date	Date:
text_comment_from	From:
text_comment_frozen	Frozen
text_comment_ipaddr	IP Address:
text_comment_parent	Parent
text_comment_posted	Comment successfully posted.
text_comment_reply	Reply
text_comment_thread	Thread
text_day_next	Next Day
text_day_prev	Previous Day
text_edit_entry	Edit Entry
text_edit_tags	Edit Tags
text_entry_next	Next Entry
text_entry_prev	Previous Entry
text_icon_alt_private	[private post]
text_icon_alt_protected	[protected post]
text_max_comments	Maximum comments reached
text_mem_add	Add to Memories
text_meta_location	Current Location
text_meta_mood	Current Mood
text_meta_music	Current Music
text_month_form_btn	View
text_month_screened_comments	w/ Screened
text_multiform_btn	Perform Action
text_multiform_check	Select:
text_multiform_conf_delete	Delete selected comments?
text_multiform_des	Mass action on selected comments:
text_multiform_opt_delete	Delete
text_multiform_opt_deletespam	Delete as Spam
text_multiform_opt_freeze	Freeze
text_multiform_opt_screen	Screen
text_multiform_opt_track	Track This
text_multiform_opt_unfreeze	Unfreeze
text_multiform_opt_unscreen	Unscreen
text_multiform_opt_untrack	Untrack This
text_noentries_day	There were no entries on this day.
text_noentries_recent	There are no entries to display.
text_nosubject	(no subject)
text_permalink	Link
text_post_comment	Leave a comment
text_post_comment_friends	Leave a comment
text_poster_anonymous	(Anonymous)
text_read_comments	1 comment // # comments
text_read_comments_friends	1 comment // # comments
text_reply_back	Read Comments
text_reply_nocomments	Comments have been disabled for this post.
text_reply_nocomments_header	Comments Disabled:
text_replyform_header	Comment Form
text_skiplinks_back	Previous #
text_skiplinks_forward	Next #
text_tag_uses	1 use // # uses
text_tags	Tags: #
text_tags_page_header	Visible Tags
text_tell_friend	Tell a Friend
text_unwatch_comments	Untrack This
text_view_archive	Archive
text_view_friends	Friends
text_view_friends_comm	Members
text_view_friends_filter	Friends (Custom filter)
text_view_friendsfriends	Friends of Friends
text_view_friendsfriends_filter	Friends of Friends (Custom filter)
text_view_memories	Memories
text_view_month	View Subjects
text_view_recent	Recent Entries
text_view_userinfo	User Info
text_watch_comments	Track This
text_website_default_name	My Website
theme_bgcolor	(empty)
theme_bordercolor	(empty)
theme_linkcolor	(empty)
use_shared_pic	0
view_entry_disabled	0

Global Functions

`PalItem(int index, Color c) : PalItem`	Convenience constructor to make populating an array of PalItems (like in palimg_modify) easy.
`UserLite(string username) : UserLite`	Constructor for making a UserLite object from a username
`alternate(string a, string b) : string`	With each call, this function will alternate between the two values and return one of them. Useful for making tables whose rows alternate in background color.
`clean_url(string s) : string`	Returns the given URL back if it's a valid URL.
`control_strip_logged_out_userpic_css() :` `string`	Returns CSS for the userpic div in the logged out version of the control strip.
`ehtml(string s) : string`	Escapes all HTML tags and entities from the text
`end_css() : void`	Declare that you're done printing CSS and the output thus buffered should be cleaned and printed.
`etags(string s) : string`	Escapes all HTML tags (but not entities) from text
`eurl(string s) : string`	URL escape
`get_page() :` `Page`	Gets the top-level Page instance that LiveJournal ran the Page.print() method on.
`get_plural_phrase(int n, string prop) : string`	Picks the phrase with the proper plural form from those in the property $prop, passing $n to lang_map_plural(int) to get the proper form for the current language, and then substituting the # character with $n. Also, returned string is HTML-escaped.
`get_url(UserLite user, string view) : string`	Returns a URL to the specified view for the specified user. Views use the same names as elsewhere. (recent, friends, archive, month, userinfo)
`get_url(string user, string view) : string`	Returns a URL to the specified view for the specified user. Views use the same names as elsewhere. (recent, friends, archive, month, userinfo)
`htmlattr(string name, int value) : string`	If the value isn't blank, return in HTML attribute format with a leading space. HTML of name is not escaped.
`htmlattr(string name, string value) : string`	If the value isn't blank, return in HTML attribute format with a leading space. HTML of name is not escaped.
`int(string s) : int`	Convert the string to an integer and return
`journal_current_datetime() :` `DateTime`	Returns the current datetime in the timezone of the journal being viewed.
`lang_at_datetime(DateTime d) : string`	Returns a string saying "at {the data and time given}". Used in the core implementation of EntryPage and ReplyPage. i18nc layers should override this.
`lang_map_plural(int n) : int`
`lang_metadata_title(string which) : string`	Get a human-readable caption for a metadata key. Layers shouldn't override this, but should instead set the relevant string properties.
`lang_ordinal(int num) : string`	Make an ordinal number from a cardinal number
`lang_ordinal(string num) : string`	Make an ordinal number from a cardinal number. Don't override this, since the core layer implementation just calls [func[lang_ordinal(int)]], which i18nc layers should override.
`lang_page_of_pages(int pg, int pgs) : string`
`lang_user_wrote(UserLite u) : string`	Returns text describing that the user wrote something. i18nc layers should override this.
`lang_viewname(string viewid) : string`	Get some words representing a view
`pageview_unique_string() :` `string`	Returns a unique string for the remote user.
`palimg_gradient(string filename, PalItem start, PalItem end) : string`	Return a URL to the specified filename (relative to the palimg root) with its palette table made into a gradient. All palette entries between the inclusive indexes of $start and $end will fade from the colors in $start and $end. The palette indexes for the start and end can be between 0 and 255.
`palimg_modify(string filename, PalItem[] items) : string`	Return a URL to the specified filename (relative to the palimg root) with its palette table altered, once for each provided PalItem. Restrictions: only 7 palette entries may be modified, and the PalItem indexes must be 0-15.
`palimg_tint(string filename, Color bright) : string`	Return a URL to the specified filename (relative to the palimg root) with its palette table tinted. The given 'bright' color will be the new white, and darkest color remains black.
`palimg_tint(string filename, Color bright, Color dark) : string`	Return a URL to the specified filename (relative to the palimg root) with its palette table tinted. The given 'bright' color will be the new white, and the given 'dark' color is the new black.
`print_custom_control_strip_css() : void`	Prints the CSS for custom control strip colors, if the option is enabled. This should be called by print_stylesheet().
`print_stylesheet() : void`	Prints a stylesheet, the URL of which can be referenced by Page.stylesheet_url. This is another S2 entry point, in addition to Page.print().
`prop_init() : void`	This function is the first thing called and is the place to set properties based on the values of other properties. It's called before the style system looks at its builtin properties, so if you need to conditionally setup something based on your own custom properties, do it here. You can't print from this function.
`rand(int high) : int`	Returns a random integer between 1 and $high, inclusive.
`rand(int low, int high) : int`	Returns a random integer between $low and $high, inclusive.
`secs_to_string(int sec) : string`
`server_sig() : void`
`set_content_type(string text) : void`	Set the HTTP Content-type response header (for example, if outputting XML). Must be called before printing any data.
`set_handler(string eventname, string[][] commands) : void`
`start_css() : void`	Declare that you're about to start printing out CSS that should be buffered, then later cleaned when you call end_css(). WARNING: this is not re-entrant. You can't call start_css recursively.
`string(int i) : string`	Return the given integer as a string
`striphtml(string s) : string`	Similar to ehtml, but the HTML tags are stripped rather than escaped.
`style_is_active() : bool`	Returns if the style (layout and theme) calling it is active based on a hook. If hook isn't defined, returns true always.
`userinfoicon(UserLite user) : Image`
`userlite_as_string(UserLite ul) : string`	Deprecated function. Use ljuser() from now on.
`userlite_base_url(UserLite ul) : string`
`viewer_is_friend() : bool`	Returns true if the user viewing the page is both logged in, and is a friend of the journal being viewed. Always returns false for communities, since they cannot have friends.
`viewer_is_member() : bool`	Returns true if the user viewing the page is both logged in, and is a member of the community being viewed. Always returns false for personal journals, since they cannot have members.
`viewer_is_owner() : bool`	Returns true if the user viewing the page is both logged in, and is the owner of the content in question. Useful for returning links to manage information, or edit entries.
`viewer_logged_in() : bool`	Returns true if the user viewing the page is logged in. It's recommended that your page links to the site login page if the user isn't logged in.
`viewer_sees_ads() : bool`	Deprecated function. Use viewer_sees_hbox_(top\|bottom) or viewer_sees_vbox from now on.
`viewer_sees_control_strip() : bool`	Returns true if reader will see the built in control strip.
`viewer_sees_ebox() : bool`	True if the user has selected to see opaque content boxes between entries.
`viewer_sees_hbox_bottom() : bool`	True if opaque horizontal site-specific content box should be displayed to the user at the bottom of the page.
`viewer_sees_hbox_top() : bool`	True if opaque horizontal site-specific content box should be displayed to the user at the top of the page.
`viewer_sees_vbox() : bool`	True if opaque vertical site-specific content box should be displayed to the user.
`weekdays() : int[]`	Integers representing the days of the week. This will start on Monday (2) or Sunday (1) depending on the property setting for start-of-week and go to Sunday (1) or Saturday (7)
`zeropad(int n, int digits) : string`	Returns the number padded with zeroes so it has the amount of digits indicated.
`zeropad(string n, int digits) : string`	Returns the number padded with zeroes so it has the amount of digits indicated.

Classes

Alphabetical

Color
Comment
CommentInfo
Date
DateTime
DayPage
Entry
EntryLite
EntryPage
Friend
FriendsPage
Image
int
ItemRange
Link
MessagePage
MonthDay
MonthEntryInfo
MonthPage
Page
PalItem
RecentNav
RecentPage
Redirector
ReplyForm
ReplyPage
string
Tag
TagDetail
TagsPage
User
UserLink
UserLite
YearDay
YearMonth
YearPage
YearWeek
YearYear

Hierarchical

Color
CommentInfo
Date

DateTime

EntryLite

Comment
Entry

Image
int
ItemRange
Link
MonthEntryInfo
Page

DayPage
EntryPage
MessagePage
MonthPage
RecentPage

FriendsPage

ReplyPage
TagsPage
YearPage

PalItem
RecentNav
Redirector
ReplyForm
string
Tag

TagDetail

UserLink
UserLite

Friend
User

YearDay

MonthDay

YearMonth
YearWeek
YearYear

Color Class

Represents a color.

Members

`string as_string`	HTML hex encoded: #rrggbb
`int b`	Blue value, 0-255. (Read-only)
`int g`	Green value, 0-255. (Read-only)
`int r`	Red value, 0-255. (Read-only)

Methods

`Color(string s) : Color`	Constructor for color class. Lets you make a Color object from a string of form #rrggbb
`average(Color other) : Color`	Returns color averaged with $other color.
`blend(Color other, int value) : Color`	Returns color blended with $other color by percentage value (int between 0 and 100).
`blue() :` `int`	Get the blue value.
`blue(int b) : void`	Set the blue value. (0-255)
`clone() :` `Color`	Returns identical color.
`darker() :` `Color`	Returns a new color with lightness decreased by 30.
`darker(int amt) : Color`	Returns a new color with lightness decreased by amount given.
`green() :` `int`	Get the green value.
`green(int g) : void`	Set the green value. (0-255)
`hue() :` `int`	Get the hue value. (0-255)
`hue(int h) : void`	Set the hue value. (0-255)
`inverse() :` `Color`	Returns inverse of color.
`lighter() :` `Color`	Returns a new color with lightness increased by 30.
`lighter(int amt) : Color`	Returns a new color with lightness increased by amount given.
`lightness() :` `int`	Get the lightness value. (0-255)
`lightness(int v) : void`	Set the lightness value. (0-255)
`red() :` `int`	Get the red value.
`red(int r) : void`	Set the red value. (0-255)
`saturation() :` `int`	Get the saturation value. (0-255)
`saturation(int s) : void`	Set the saturation value. (0-255)
`set_hsl(int h, int s, int v) : void`	Set the HSL value for a color class.

Comment Class

Child class of EntryLite. A comment to a journal entry, or to another comment.

Members

`string anchor`	Direct link to comment, via HTML name anchors (Read-only)
`bool comment_posted`	True if comment was just posted by the current user. (Read-only)
`bool deleted`	True if comment has been deleted. Deleted comments still show up if they are the parent of a thread. (Read-only)
`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)
`bool frozen`	True if comment is in frozen state. (Read-only)
`bool full`	True if all information is available for this comment. False if only the subject, poster, and date are available. (collapsed threads)
`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 parent_url`	URL to parent comment, or blank if a top-level comment. (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
`Comment[] replies`	Comments replying to this comment.
`string reply_url`	URL to reply to this comment. (Read-only)
`bool screened`	True if comment is in screened state. (Read-only)
`int seconds_since_entry`	The number of elapsed seconds from the time of the journal entry until he comment was made. (Read-only)
`string subject`	Subject. May contain HTML. Don't do substring chops on this. (Read-only)
`Image subject_icon`	Subject icon, or null.
`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)
`int talkid`	Server stored ID number for this comment.
`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)
`string thread_url`	URL to view threaded rooted at this comment, or blank if comment has no children. (Read-only)
`DateTime time`	The user-specified time of the post, or the GMT time if it's a comment.
`DateTime time_poster`	The local time the comment appeared, in the commenter's timezone. Or undef if no anonymous comment, or commenter's timezone is unknown. (Read-only)
`DateTime time_remote`	The local time the comment appeared, in the remote user's (reader's) timezone. Or undef if no remote user, or remote user hasn't set their timezone. (Read-only)
`Image userpic`	The userpic selected to relate to this entry.

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_multiform_check() : void`	Prints the select checkbox in CSS class 'ljcomsel' with DOM id 'ljcomsel_$talkid' for a multi-action form started with EntryPage.print_multiform_start().
`print_reply_container() : void`	Prints the area in which the quickreply box will go. If no container is available, quickreply will not work.
`print_reply_container(string{} opts) : void`	Prints the area in which the quickreply box will go. You may 'class' which will be the CSS class used by the container. If no container is available, quickreply will not work.
`print_reply_link(string{} opts) : void`	Prints a link to reply to the comment. You may specify the link text in the 'linktext' option, and the link CSS class in 'class'. You may also specify the url of an image to use as a button in 'img_url'.
`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`	time_post, with customized date/time formats.

CommentInfo Class

Information about comments attached to something.

Members

`int count`	Current number of comments available to be read by the viewer.
`bool enabled`	Set to false if comments disabled journal-wide or just on this item.
`bool maxcomments`	Set to true if entry has reached a comment maximum.
`string post_url`	URL pointer to the 'Post Comments' view. (Read-only)
`string read_url`	URL pointer to the 'Read Comments' view. (Read-only)
`bool screened`	Set to true if there are screened comments and remote user can unscreen them.
`bool show_postlink`	Indicates whether the Post Comment link for this entry should be shown.
`bool show_readlink`	Indicates whether the Read Comments link for this entry should be shown.

Methods

`print() : void`	Print all comment related links
`print_postlink() : void`	Print the formatted link to the 'Post Comments' view
`print_readlink() : void`	Print the formatted link to the 'Read Comments' view

Date Class

Represents a date.

Members

`int day`	Day; 1-31.
`int month`	Month; 1-12.
`int year`	Year; 4 digits.

Methods

`compare(Date d) : int`	Compare two dates. Returns a negative number if d is before the subject in time, positive if it is after, or zero if the two dates are equal. When comparing a Date with a DateTime, the time on the bare Date value is assumed to be midnight.
`compare(DateTime d) : int`	Compare two dates. Returns a negative number if d is before the subject in time, positive if it is after, or zero if the two dates are equal. When comparing a Date with a DateTime, the time on the bare Date value is assumed to be midnight.
`date_format() :` `string`	Returns date formatted as normal. // SeeAlso: siteapi.core1.dateformats
`date_format(string fmt) : string`	Returns date formatted as indicated by $fmt. One of: short, med, long, med_day, long_day. Or a custom format. Default is 'short'. // SeeAlso: siteapi.core1.dateformats
`day_of_week() :` `int`	Returns the day of the week this date falls on, from Sunday=1 to Saturday=7

DateTime Class

Child class of Date. Represents both a date and time.

Members

`int day`	Day; 1-31.
`int hour`	Hour; 0-23.
`int min`	Minute; 0-59.
`int month`	Month; 1-12.
`int sec`	Second; 0-59.
`int year`	Year; 4 digits.

Methods

`compare(Date d) : int`	Compare two dates. Returns a negative number if d is before the subject in time, positive if it is after, or zero if the two dates are equal. When comparing a Date with a DateTime, the time on the bare Date value is assumed to be midnight.
`compare(DateTime d) : int`	Compare two dates. Returns a negative number if d is before the subject in time, positive if it is after, or zero if the two dates are equal. When comparing a Date with a DateTime, the time on the bare Date value is assumed to be midnight.
`date_format() :` `string`	Returns date formatted as normal. // SeeAlso: siteapi.core1.dateformats
`date_format(string fmt) : string`	Returns date formatted as indicated by $fmt. One of: short, med, long, med_day, long_day. Or a custom format. Default is 'short'. // SeeAlso: siteapi.core1.dateformats
`day_of_week() :` `int`	Returns the day of the week this date falls on, from Sunday=1 to Saturday=7
`time_format() :` `string`	Returns time formatted as normal. // SeeAlso: siteapi.core1.dateformats
`time_format(string fmt) : string`	Returns time formatted as indicated by $fmt, or normal if blank. // SeeAlso: siteapi.core1.dateformats

DayPage Class

Child class of Page. View entries by specifc day

Members

`string{} args`	Arguments from the URL's query string (after the question mark). S2 code can only access arguments starting with a period, and this period is not included in the hash key. (Read-only)
`string base_url`	The base URL of the journal being viewed. (Read-only)
`Link{} data_link`	Links to various machine-readable data sources relating to this page
`string[] data_links_order`	An array of data views which can be used to order the data_link hash
`Date date`	Date of the current day
`Entry[] entries`	Array of entries available to be seen by the viewer of the page
`string global_subtitle`	A sub-title selected by the user for their whole journal. (Read-only)
`string global_title`	A title selected by the user for their whole journal. (Read-only)
`bool has_entries`	True if there are entries on the specified day
`string head_content`	Extra tags supplied by the server to go in the <head> section of the output HTML document. Layouts should include this in the head section if they are writing HTML. (Read-only)
`User journal`	User whose journal is being viewed
`string journal_type`	Journal type, ex: 'P' (personal), 'C' (community), etc. (Read-only)
`UserLink[] linklist`	An array of UserLink objects defined by the user to be displayed on their journal. (Read-only)
`Date next_date`	Next day
`string next_url`	URL to next day (Read-only)
`Date prev_date`	Previous day
`string prev_url`	URL to previous day (Read-only)
`string stylesheet_url`	The URL to use in a link element for the server-supported external stylesheet to put stuff in it) (Read-only)
`DateTime time`	A DateTime object filled with the time (GMT) when the page was created. (Read-only)
`string view`	The view type (recent, friends, archive, month, day, entry) (Read-only)
`string{} view_url`	Links to top-level views where id equals the name of the view being linked to. (if one of views == $.view, already looking at that view) (Read-only)
`string[] views_order`	An array of view identifiers which can be used to order the views hash. (Read-only)

Methods

`get_latest_month() :` `YearMonth`	Returns information about the latest month the user posted (or the current month, if no posts), so that the page may include a mini-calendar or similar features.
`print() : void`	The main entry point that LiveJournal calls. Layouts should override this to create HTML that's the same for all view types, and use $this->title, $this->head and $this->body to include view-specific content into the template.
`print_ad(string type) : void`	Deprecated function. Use print_hbox_(top\|bottom) or print_vbox from now on.
`print_body() : void`	Call from Page.print() to render parts of the view that are specific to the view, eg print the recent set of journal entries, recent friends entries, or rows of user information
`print_control_strip() : void`	Prints a control strip for the user's convenience
`print_custom_head() : void`	Layers can override this to add extra HTML to the head section of the HTML document. Note that layouts are not intended to override this method.
`print_entry(Entry e) : void`	Output a journal entry. Layouts should override this and the inherited versions in RecentPage, FriendsPage and DayPage to change how entries display.
`print_entry_poster(Entry e) : void`	Output a line of text which says who posted an entry (just "user", or "user posting in somejournal")
`print_hbox_bottom() : void`	Prints an horizontal bar of site-specific content at the bottom of a journal.
`print_hbox_top() : void`	Prints an horizontal bar of site-specific content at the top of a journal.
`print_head() : void`	Print server side supplied head content. This is a fixed function, so you can't override it. See Page.print_custom_head() if you want to supply custom head content.
`print_linklist() : void`	Print the list of UserLink objects specified by the user.
`print_reply_container(string{} opts) : void`	Prints the area in which the quickreply box will go. Options you may specify are 'target' which will be the target id, and 'class' which will be the CSS class used by the container. If no container is available, quickreply will not work.
`print_reply_link(string{} opts) : void`	Prints a link to reply to the comment. You may specify the link text in the 'linktext' option, the link CSS class in 'class', and the target container in the 'target' option. You may also specify the url of an image to use as a button in 'img_url'.
`print_stylesheets() : void`	Prints all defined stylesheets, including default and user-defined ones.
`print_trusted(string key) : void`	Prints a trusted string by key.
`print_vbox() : void`	Prints an vertical bar of site-specific content on a journal.
`title() :` `string`	Return a relevant combination of Page.global_title and Page.view_title(). May be overridden in layout layers or left untouched for the core layer to handle.
`view_title() :` `string`	Return a title for this particular page, such as "Friends' Recent Entries" for the friends view, or a date for the day view. Should be overridden in i18n layers. Ideally, layout layers should never override this. See Page.title().
`visible_tag_list() : TagDetail[]`	Returns an array of tags that the logged in user can see for the journal being viewed.

Entry Class

Child class of EntryLite. A journal entry

Members

`CommentInfo comments`	Comment information on this entry
`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)
`bool end_day`	Is this the last entry of a day?
`int itemid`	Server stored ID number for this entry
`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)
`Image mood_icon`	Mood icon, or null.
`bool new_day`	Is this entry on a different day to the previous one?
`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 security`	The security level of the entry ('private', 'protected'), or blank if public. (Read-only)
`Image security_icon`	A little icon which should be displayed somewhere on an entry to represent the security setting
`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.

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.
`plain_subject() :` `string`	Return entry's subject as plain text, with all HTML removed.
`print_ebox() : void`	Prints a small horizontal bar of site-specific content between entries in a journal.
`print_link_next() : void`	Print the link to the next entry in this journal.
`print_link_prev() : void`	Print the link to the previous entry in this journal.
`print_linkbar() : void`	Print the link bar for this entry or comment.
`print_metadata() : void`
`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`	time_post, with customized date/time formats.
`viewer_sees_ebox() : bool`	True if opaque horizontal site-specific content boxes between entries should be displayed to the user.

EntryLite Class

Base class for both journal entries and comments.

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.

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`	time_post, with customized date/time formats.

EntryPage Class

Child class of Page. A page with a single journal entry and associated comments.

Members

`string{} args`	Arguments from the URL's query string (after the question mark). S2 code can only access arguments starting with a period, and this period is not included in the hash key. (Read-only)
`string base_url`	The base URL of the journal being viewed. (Read-only)
`ItemRange comment_pages`	Represents what comment page is being displayed.
`Comment[] comments`	Comments to journal entry, or at least some of them.
`Link{} data_link`	Links to various machine-readable data sources relating to this page
`string[] data_links_order`	An array of data views which can be used to order the data_link hash
`Entry entry`	Journal entry being viewed
`string global_subtitle`	A sub-title selected by the user for their whole journal. (Read-only)
`string global_title`	A title selected by the user for their whole journal. (Read-only)
`string head_content`	Extra tags supplied by the server to go in the <head> section of the output HTML document. Layouts should include this in the head section if they are writing HTML. (Read-only)
`User journal`	User whose journal is being viewed
`string journal_type`	Journal type, ex: 'P' (personal), 'C' (community), etc. (Read-only)
`UserLink[] linklist`	An array of UserLink objects defined by the user to be displayed on their journal. (Read-only)
`bool multiform_on`	Set to true if the multi-action is to be printed, which requires both comments and applicable permissions for the remote user.
`string stylesheet_url`	The URL to use in a link element for the server-supported external stylesheet to put stuff in it) (Read-only)
`DateTime time`	A DateTime object filled with the time (GMT) when the page was created. (Read-only)
`string view`	The view type (recent, friends, archive, month, day, entry) (Read-only)
`string{} view_url`	Links to top-level views where id equals the name of the view being linked to. (if one of views == $.view, already looking at that view) (Read-only)
`bool viewing_thread`	True if viewing a specific sub-thread of the comments. Style may which to hide the journal entry at this point, since the focus is the comments.
`string[] views_order`	An array of view identifiers which can be used to order the views hash. (Read-only)

Methods

`get_latest_month() :` `YearMonth`	Returns information about the latest month the user posted (or the current month, if no posts), so that the page may include a mini-calendar or similar features.
`print() : void`	The main entry point that LiveJournal calls. Layouts should override this to create HTML that's the same for all view types, and use $this->title, $this->head and $this->body to include view-specific content into the template.
`print_ad(string type) : void`	Deprecated function. Use print_hbox_(top\|bottom) or print_vbox from now on.
`print_body() : void`	Call from Page.print() to render parts of the view that are specific to the view, eg print the recent set of journal entries, recent friends entries, or rows of user information
`print_comment(Comment comment) : void`	Prints a full comment
`print_comment_partial(Comment comment) : void`	Prints a collapsed comment
`print_comments(Comment[] comments) : void`	Prints comments
`print_control_strip() : void`	Prints a control strip for the user's convenience
`print_custom_head() : void`	Layers can override this to add extra HTML to the head section of the HTML document. Note that layouts are not intended to override this method.
`print_entry(Entry e) : void`	Output a journal entry. Layouts should override this and the inherited versions in RecentPage, FriendsPage and DayPage to change how entries display.
`print_entry_poster(Entry e) : void`	Output a line of text which says who posted an entry (just "user", or "user posting in somejournal")
`print_hbox_bottom() : void`	Prints an horizontal bar of site-specific content at the bottom of a journal.
`print_hbox_top() : void`	Prints an horizontal bar of site-specific content at the top of a journal.
`print_head() : void`	Print server side supplied head content. This is a fixed function, so you can't override it. See Page.print_custom_head() if you want to supply custom head content.
`print_linklist() : void`	Print the list of UserLink objects specified by the user.
`print_multiform_actionline() : void`	Prints the line of the multiform giving instructions, options, and the submit button, using the text of the different $*text_multiform_ properties.
`print_multiform_end() : void`	Prints end of form tag to do a multi-comment action.
`print_multiform_start() : void`	Prints start of form tag and hidden elements to do a multi-comment action (multiple delete, screen, unscreen, etc...)
`print_reply_container(string{} opts) : void`	Prints the area in which the quickreply box will go. Options you may specify are 'target' which will be the target id, and 'class' which will be the CSS class used by the container. If no container is available, quickreply will not work.
`print_reply_link(string{} opts) : void`	Prints a link to reply to the comment. You may specify the link text in the 'linktext' option, the link CSS class in 'class', and the target container in the 'target' option. You may also specify the url of an image to use as a button in 'img_url'.
`print_stylesheets() : void`	Prints all defined stylesheets, including default and user-defined ones.
`print_trusted(string key) : void`	Prints a trusted string by key.
`print_vbox() : void`	Prints an vertical bar of site-specific content on a journal.
`title() :` `string`	Return a relevant combination of Page.global_title and Page.view_title(). May be overridden in layout layers or left untouched for the core layer to handle.
`view_title() :` `string`	Return a title for this particular page, such as "Friends' Recent Entries" for the friends view, or a date for the day view. Should be overridden in i18n layers. Ideally, layout layers should never override this. See Page.title().
`visible_tag_list() : TagDetail[]`	Returns an array of tags that the logged in user can see for the journal being viewed.

Friend Class

Child class of UserLite. Represents a friends or friendof list

Members

`Color bgcolor`	Background color selected for friend
`Link{} data_link`	Links to various machine-readable data sources relating to this user
`string[] data_links_order`	An array of data views which can be used to order the data_link hash
`Color fgcolor`	Foreground color selected for friend
`string journal_type`	Type of account: P (personal), C (community), Y (syndicated), S (shared), I (external identity) etc (Read-only)
`string[] link_keyseq`	Array of keys which can be passed into the get_link
`string name`	User's formatted name, ex: John Q. Public (Read-only)
`string username`	Canonical Username, ex: johnqpub. Note that if journal_type is an external identity, there will be no username, so this field will be a display version of their URL, longer than 15 characters, and with characters other than a-z, 0-9 and underscore. (Read-only)

Methods

`as_string() :` `string`
`base_url() :` `string`	Returns URL of user's journal.
`equals(UserLite u) : bool`	Returns true if the two user objects refer to the same user. Use this rather than comparing usernames, since usernames aren't globally unique.
`get_link(string key) : Link`	Returns a link based on the given key, or null if the link is unavailable
`ljuser() :` `string`	Returns an LJ user tag for the user.
`ljuser(Color link_color) : string`	Returns an LJ user tag for the user. The color of the link will be link_color.
`print() : void`
`print_linkbar() : void`	Print the link bar for this user/journal.
`tag_manage_url() :` `string`	Returns URL to user's tag management page.

FriendsPage Class

Child class of RecentPage. Friends most recent entries

Members

`string{} args`	Arguments from the URL's query string (after the question mark). S2 code can only access arguments starting with a period, and this period is not included in the hash key. (Read-only)
`string base_url`	The base URL of the journal being viewed. (Read-only)
`Link{} data_link`	Links to various machine-readable data sources relating to this page
`string[] data_links_order`	An array of data views which can be used to order the data_link hash
`Entry[] entries`	Array of entries available to be seen by the viewer of the page.
`bool filter_active`	If true, some kind of filter is in effect. If this filter has a name, it will be included in FriendsPage.filter_name
`string filter_name`	The name of the filter in effect, if it has a name. This is only used when 'custom' FriendsPage.filter_active is true.
`Friend{} friends`	A mapping from friend username to color association information. There will only be keys for friends whose entries are in the entries array.
`string friends_mode`	The 'mode' of this view. An empty string indicates a normal friends view, while 'friendsfriends' indicates the Friends-of-friends view.
`string friends_title`	A user-selected title for their friends page. (Read-only)
`string global_subtitle`	A sub-title selected by the user for their whole journal. (Read-only)
`string global_title`	A title selected by the user for their whole journal. (Read-only)
`string head_content`	Extra tags supplied by the server to go in the <head> section of the output HTML document. Layouts should include this in the head section if they are writing HTML. (Read-only)
`User journal`	User whose journal is being viewed
`string journal_type`	Journal type, ex: 'P' (personal), 'C' (community), etc. (Read-only)
`UserLink[] linklist`	An array of UserLink objects defined by the user to be displayed on their journal. (Read-only)
`RecentNav nav`
`string stylesheet_url`	The URL to use in a link element for the server-supported external stylesheet to put stuff in it) (Read-only)
`DateTime time`	A DateTime object filled with the time (GMT) when the page was created. (Read-only)
`string view`	The view type (recent, friends, archive, month, day, entry) (Read-only)
`string{} view_url`	Links to top-level views where id equals the name of the view being linked to. (if one of views == $.view, already looking at that view) (Read-only)
`string[] views_order`	An array of view identifiers which can be used to order the views hash. (Read-only)

Methods

`get_latest_month() :` `YearMonth`	Returns information about the latest month the user posted (or the current month, if no posts), so that the page may include a mini-calendar or similar features.
`print() : void`	The main entry point that LiveJournal calls. Layouts should override this to create HTML that's the same for all view types, and use $this->title, $this->head and $this->body to include view-specific content into the template.
`print_ad(string type) : void`	Deprecated function. Use print_hbox_(top\|bottom) or print_vbox from now on.
`print_body() : void`	Call from Page.print() to render parts of the view that are specific to the view, eg print the recent set of journal entries, recent friends entries, or rows of user information
`print_control_strip() : void`	Prints a control strip for the user's convenience
`print_custom_head() : void`	Layers can override this to add extra HTML to the head section of the HTML document. Note that layouts are not intended to override this method.
`print_entry(Entry e) : void`	Output a journal entry. Layouts should override this and the inherited versions in RecentPage, FriendsPage and DayPage to change how entries display.
`print_entry_poster(Entry e) : void`	Output a line of text which says who posted an entry (just "user", or "user posting in somejournal")
`print_hbox_bottom() : void`	Prints an horizontal bar of site-specific content at the bottom of a journal.
`print_hbox_top() : void`	Prints an horizontal bar of site-specific content at the top of a journal.
`print_head() : void`	Print server side supplied head content. This is a fixed function, so you can't override it. See Page.print_custom_head() if you want to supply custom head content.
`print_linklist() : void`	Print the list of UserLink objects specified by the user.
`print_reply_container(string{} opts) : void`	Prints the area in which the quickreply box will go. Options you may specify are 'target' which will be the target id, and 'class' which will be the CSS class used by the container. If no container is available, quickreply will not work.
`print_reply_link(string{} opts) : void`	Prints a link to reply to the comment. You may specify the link text in the 'linktext' option, the link CSS class in 'class', and the target container in the 'target' option. You may also specify the url of an image to use as a button in 'img_url'.
`print_stylesheets() : void`	Prints all defined stylesheets, including default and user-defined ones.
`print_trusted(string key) : void`	Prints a trusted string by key.
`print_vbox() : void`	Prints an vertical bar of site-specific content on a journal.
`title() :` `string`	Return a relevant combination of Page.global_title and Page.view_title(). May be overridden in layout layers or left untouched for the core layer to handle.
`view_title() :` `string`	Return a title for this particular page, such as "Friends' Recent Entries" for the friends view, or a date for the day view. Should be overridden in i18n layers. Ideally, layout layers should never override this. See Page.title().
`visible_tag_list() : TagDetail[]`	Returns an array of tags that the logged in user can see for the journal being viewed.

Image Class

Represents an image.

Members

`string alttext`	Default alternative text for image
`string{} extra`	Extra params for img tag (Read-only)
`int height`	Height in pixels
`string url`	URL of the image (Read-only)
`int width`	Width in pixels

Methods

`as_string() :` `string`	Return the HTML tag for this image
`as_string(string alttext) : string`	Return an HTML tag for this Image with given alttext
`as_string(string{} opts) : string`	Return the HTML for an image, Supported keys are 'href' to create a link to the image source and 'a_attr' which adds attributes to the anchor tag if a link is to be printed.
`print() : void`	Print an HTML tag for this Image
`print(string alttext) : void`	Print an HTML tag for this Image with given alttext
`print(string{} opts) : void`	Print the HTML for an image, Supported keys are 'href' to create a link to the image source and 'a_attr' which adds attributes to the anchor tag if a link is to be printed.
`set_url(string url) : void`	Sets the URL, doing any necessary escaping.

int Class

An integer number. This isn't really a class, as suggested by its lower-case name. Parameters of type int pass by value, unlike all variables of real object types, which pass by reference. Instead, this is just a pseudo-class which provides convenience methods on instances of integers. The other pseudo-class is string.

Methods

`compare(int n) : int`	Compare one integer with another. Returns a negative number if n is less than the subject, positive if greater or zero if the two are numerically equal.
`zeropad(int digits) : string`	Return the integer as a string formatted at least $digits characters long, left-padded with zeroes.

ItemRange Class

Represents a range of items which optionally contain items.

Members

`bool all_subitems_displayed`	True if the subitems in this range represent the entire set. In this case, all of the URL members are blank.
`int current`	The currently-active item.
`int from_subitem`	The index of the first subitem in this range.
`int num_subitems_displayed`	The number of subitems in this range.
`int to_subitem`	The index of the last subitem in this range.
`int total`	The total number of items that are navigable to.
`int total_subitems`	The number of subitems.
`string url_first`	URL for the 'first' link. Blank if already on the first page. (Read-only)
`string url_last`	URL for the 'last' link. Blank if already on the last page. (Read-only)
`string url_next`	URL for the 'next' link. Blank if there isn't a next URL. (Read-only)
`string url_prev`	URL for the 'previous' link. Blank if there isn't a previous URL. (Read-only)

Methods

`print() : void`	Prints the item range links
`print(string labeltext) : void`	Prints the item range links with the given $labeltext
`url_of(int n) : string`	Returns the URL to use to link to the nth item

Link Class

A link or button

Members

`string caption`	The caption for the link (Read-only)
`Image icon`	A suggestion from the server as to which icon to use. layouts/users can override this of course. alt text works similarly to Link.caption.
`string url`	URL which the link points to (Read-only)

Methods

`as_string() :` `string`	Return the button HTML link.
`print_button() : void`	Output this Link as a clickable button using Link.icon

MessagePage Class

Child class of Page. A page showing an error or confirmation message.

Members

`string{} args`	Arguments from the URL's query string (after the question mark). S2 code can only access arguments starting with a period, and this period is not included in the hash key. (Read-only)
`string base_url`	The base URL of the journal being viewed. (Read-only)
`Link{} data_link`	Links to various machine-readable data sources relating to this page
`string[] data_links_order`	An array of data views which can be used to order the data_link hash
`string global_subtitle`	A sub-title selected by the user for their whole journal. (Read-only)
`string global_title`	A title selected by the user for their whole journal. (Read-only)
`string head_content`	Extra tags supplied by the server to go in the <head> section of the output HTML document. Layouts should include this in the head section if they are writing HTML. (Read-only)
`User journal`	User whose journal is being viewed
`string journal_type`	Journal type, ex: 'P' (personal), 'C' (community), etc. (Read-only)
`string[] link_keyseq`	A list of links, indicated by key, that should be displayed alongside this error. They should ideally be displayed in a similar way to the entry links displayed on the entry page.
`UserLink[] linklist`	An array of UserLink objects defined by the user to be displayed on their journal. (Read-only)
`Link{} links`	An associative array of links to be displayed alongside this message. Iterate over MessagePage.link_keyseq to find the keys.
`string message`	The body of the message. Do not print this directly; use MessagePage.print_body() instead. (Read-only)
`string stylesheet_url`	The URL to use in a link element for the server-supported external stylesheet to put stuff in it) (Read-only)
`DateTime time`	A DateTime object filled with the time (GMT) when the page was created. (Read-only)
`string title`	The title of the message. (Read-only)
`string view`	The view type (recent, friends, archive, month, day, entry) (Read-only)
`string{} view_url`	Links to top-level views where id equals the name of the view being linked to. (if one of views == $.view, already looking at that view) (Read-only)
`string[] views_order`	An array of view identifiers which can be used to order the views hash. (Read-only)

Methods

`get_latest_month() :` `YearMonth`	Returns information about the latest month the user posted (or the current month, if no posts), so that the page may include a mini-calendar or similar features.
`print() : void`	The main entry point that LiveJournal calls. Layouts should override this to create HTML that's the same for all view types, and use $this->title, $this->head and $this->body to include view-specific content into the template.
`print_ad(string type) : void`	Deprecated function. Use print_hbox_(top\|bottom) or print_vbox from now on.
`print_body() : void`	Call from Page.print() to render parts of the view that are specific to the view, eg print the recent set of journal entries, recent friends entries, or rows of user information
`print_control_strip() : void`	Prints a control strip for the user's convenience
`print_custom_head() : void`	Layers can override this to add extra HTML to the head section of the HTML document. Note that layouts are not intended to override this method.
`print_entry(Entry e) : void`	Output a journal entry. Layouts should override this and the inherited versions in RecentPage, FriendsPage and DayPage to change how entries display.
`print_entry_poster(Entry e) : void`	Output a line of text which says who posted an entry (just "user", or "user posting in somejournal")
`print_hbox_bottom() : void`	Prints an horizontal bar of site-specific content at the bottom of a journal.
`print_hbox_top() : void`	Prints an horizontal bar of site-specific content at the top of a journal.
`print_head() : void`	Print server side supplied head content. This is a fixed function, so you can't override it. See Page.print_custom_head() if you want to supply custom head content.
`print_linklist() : void`	Print the list of UserLink objects specified by the user.
`print_links() : void`	Print the links from the MessagePage.links and MessagePage.link_keyseq members. Layouts will probably want to override this.
`print_message() : void`	Print the message. Call this rather than printing MessagePage.message directly.
`print_reply_container(string{} opts) : void`	Prints the area in which the quickreply box will go. Options you may specify are 'target' which will be the target id, and 'class' which will be the CSS class used by the container. If no container is available, quickreply will not work.
`print_reply_link(string{} opts) : void`	Prints a link to reply to the comment. You may specify the link text in the 'linktext' option, the link CSS class in 'class', and the target container in the 'target' option. You may also specify the url of an image to use as a button in 'img_url'.
`print_stylesheets() : void`	Prints all defined stylesheets, including default and user-defined ones.
`print_trusted(string key) : void`	Prints a trusted string by key.
`print_vbox() : void`	Prints an vertical bar of site-specific content on a journal.
`title() :` `string`	Return a relevant combination of Page.global_title and Page.view_title(). May be overridden in layout layers or left untouched for the core layer to handle.
`view_title() :` `string`	Return a title for this particular page, such as "Friends' Recent Entries" for the friends view, or a date for the day view. Should be overridden in i18n layers. Ideally, layout layers should never override this. See Page.title().
`visible_tag_list() : TagDetail[]`	Returns an array of tags that the logged in user can see for the journal being viewed.

MonthDay Class

Child class of YearDay. Summaries of posts on a given day on the MonthPage.

Members

`Date date`	Date of day
`int day`	Day of month number
`Entry[] entries`	Only populated on the month view. Entry text not present.
`bool has_entries`	True if there are entries on this day.
`int num_entries`	Number of entries made on this day
`string url`	A URL to view the day, if there are entries, else blank. (Read-only)

Methods

print_subjectlist() : void Print a list of entry summaries including subjects

MonthEntryInfo Class

A month the user has journal entries, along with information to link to it.

Members

`Date date`	Date of month, with day of zero.
`string redir_key`	The 'redir_key' parameter for a Redirector instance. (Read-only)
`string url`	URL for the MonthPage month view. (Read-only)

MonthPage Class

Child class of Page. A page which contains a list of posts made in that month

Members

`string{} args`	Arguments from the URL's query string (after the question mark). S2 code can only access arguments starting with a period, and this period is not included in the hash key. (Read-only)
`string base_url`	The base URL of the journal being viewed. (Read-only)
`Link{} data_link`	Links to various machine-readable data sources relating to this page
`string[] data_links_order`	An array of data views which can be used to order the data_link hash
`Date date`	Date of this month, with day of zero.
`MonthDay[] days`	One entry for each day of the month.
`string global_subtitle`	A sub-title selected by the user for their whole journal. (Read-only)
`string global_title`	A title selected by the user for their whole journal. (Read-only)
`string head_content`	Extra tags supplied by the server to go in the <head> section of the output HTML document. Layouts should include this in the head section if they are writing HTML. (Read-only)
`User journal`	User whose journal is being viewed
`string journal_type`	Journal type, ex: 'P' (personal), 'C' (community), etc. (Read-only)
`UserLink[] linklist`	An array of UserLink objects defined by the user to be displayed on their journal. (Read-only)
`MonthEntryInfo[] months`	Other months this journal has entries.
`Date next_date`	Date of next month, with day of zero, or null if none.
`string next_url`	URL of next month, or empty string if none. (Read-only)
`Date prev_date`	Date of previous month, with day of zero, or null if none.
`string prev_url`	URL of previous month, or empty string if none. (Read-only)
`Redirector redir`	Necessary to make a form which POSTs to a redirector
`string stylesheet_url`	The URL to use in a link element for the server-supported external stylesheet to put stuff in it) (Read-only)
`DateTime time`	A DateTime object filled with the time (GMT) when the page was created. (Read-only)
`string view`	The view type (recent, friends, archive, month, day, entry) (Read-only)
`string{} view_url`	Links to top-level views where id equals the name of the view being linked to. (if one of views == $.view, already looking at that view) (Read-only)
`string[] views_order`	An array of view identifiers which can be used to order the views hash. (Read-only)

Methods

`get_latest_month() :` `YearMonth`	Returns information about the latest month the user posted (or the current month, if no posts), so that the page may include a mini-calendar or similar features.
`print() : void`	The main entry point that LiveJournal calls. Layouts should override this to create HTML that's the same for all view types, and use $this->title, $this->head and $this->body to include view-specific content into the template.
`print_ad(string type) : void`	Deprecated function. Use print_hbox_(top\|bottom) or print_vbox from now on.
`print_body() : void`	Call from Page.print() to render parts of the view that are specific to the view, eg print the recent set of journal entries, recent friends entries, or rows of user information
`print_control_strip() : void`	Prints a control strip for the user's convenience
`print_custom_head() : void`	Layers can override this to add extra HTML to the head section of the HTML document. Note that layouts are not intended to override this method.
`print_entry(Entry e) : void`	Output a journal entry. Layouts should override this and the inherited versions in RecentPage, FriendsPage and DayPage to change how entries display.
`print_entry_poster(Entry e) : void`	Output a line of text which says who posted an entry (just "user", or "user posting in somejournal")
`print_hbox_bottom() : void`	Prints an horizontal bar of site-specific content at the bottom of a journal.
`print_hbox_top() : void`	Prints an horizontal bar of site-specific content at the top of a journal.
`print_head() : void`	Print server side supplied head content. This is a fixed function, so you can't override it. See Page.print_custom_head() if you want to supply custom head content.
`print_linklist() : void`	Print the list of UserLink objects specified by the user.
`print_reply_container(string{} opts) : void`	Prints the area in which the quickreply box will go. Options you may specify are 'target' which will be the target id, and 'class' which will be the CSS class used by the container. If no container is available, quickreply will not work.
`print_reply_link(string{} opts) : void`	Prints a link to reply to the comment. You may specify the link text in the 'linktext' option, the link CSS class in 'class', and the target container in the 'target' option. You may also specify the url of an image to use as a button in 'img_url'.
`print_stylesheets() : void`	Prints all defined stylesheets, including default and user-defined ones.
`print_trusted(string key) : void`	Prints a trusted string by key.
`print_vbox() : void`	Prints an vertical bar of site-specific content on a journal.
`title() :` `string`	Return a relevant combination of Page.global_title and Page.view_title(). May be overridden in layout layers or left untouched for the core layer to handle.
`view_title() :` `string`	Return a title for this particular page, such as "Friends' Recent Entries" for the friends view, or a date for the day view. Should be overridden in i18n layers. Ideally, layout layers should never override this. See Page.title().
`visible_tag_list() : TagDetail[]`	Returns an array of tags that the logged in user can see for the journal being viewed.

Page Class

Base template for all views

Members

`string{} args`	Arguments from the URL's query string (after the question mark). S2 code can only access arguments starting with a period, and this period is not included in the hash key. (Read-only)
`string base_url`	The base URL of the journal being viewed. (Read-only)
`Link{} data_link`	Links to various machine-readable data sources relating to this page
`string[] data_links_order`	An array of data views which can be used to order the data_link hash
`string global_subtitle`	A sub-title selected by the user for their whole journal. (Read-only)
`string global_title`	A title selected by the user for their whole journal. (Read-only)
`string head_content`	Extra tags supplied by the server to go in the <head> section of the output HTML document. Layouts should include this in the head section if they are writing HTML. (Read-only)
`User journal`	User whose journal is being viewed
`string journal_type`	Journal type, ex: 'P' (personal), 'C' (community), etc. (Read-only)
`UserLink[] linklist`	An array of UserLink objects defined by the user to be displayed on their journal. (Read-only)
`string stylesheet_url`	The URL to use in a link element for the server-supported external stylesheet to put stuff in it) (Read-only)
`DateTime time`	A DateTime object filled with the time (GMT) when the page was created. (Read-only)
`string view`	The view type (recent, friends, archive, month, day, entry) (Read-only)
`string{} view_url`	Links to top-level views where id equals the name of the view being linked to. (if one of views == $.view, already looking at that view) (Read-only)
`string[] views_order`	An array of view identifiers which can be used to order the views hash. (Read-only)

Methods

`get_latest_month() :` `YearMonth`	Returns information about the latest month the user posted (or the current month, if no posts), so that the page may include a mini-calendar or similar features.
`print() : void`	The main entry point that LiveJournal calls. Layouts should override this to create HTML that's the same for all view types, and use $this->title, $this->head and $this->body to include view-specific content into the template.
`print_ad(string type) : void`	Deprecated function. Use print_hbox_(top\|bottom) or print_vbox from now on.
`print_body() : void`	Call from Page.print() to render parts of the view that are specific to the view, eg print the recent set of journal entries, recent friends entries, or rows of user information
`print_control_strip() : void`	Prints a control strip for the user's convenience
`print_custom_head() : void`	Layers can override this to add extra HTML to the head section of the HTML document. Note that layouts are not intended to override this method.
`print_entry(Entry e) : void`	Output a journal entry. Layouts should override this and the inherited versions in RecentPage, FriendsPage and DayPage to change how entries display.
`print_entry_poster(Entry e) : void`	Output a line of text which says who posted an entry (just "user", or "user posting in somejournal")
`print_hbox_bottom() : void`	Prints an horizontal bar of site-specific content at the bottom of a journal.
`print_hbox_top() : void`	Prints an horizontal bar of site-specific content at the top of a journal.
`print_head() : void`	Print server side supplied head content. This is a fixed function, so you can't override it. See Page.print_custom_head() if you want to supply custom head content.
`print_linklist() : void`	Print the list of UserLink objects specified by the user.
`print_reply_container(string{} opts) : void`	Prints the area in which the quickreply box will go. Options you may specify are 'target' which will be the target id, and 'class' which will be the CSS class used by the container. If no container is available, quickreply will not work.
`print_reply_link(string{} opts) : void`	Prints a link to reply to the comment. You may specify the link text in the 'linktext' option, the link CSS class in 'class', and the target container in the 'target' option. You may also specify the url of an image to use as a button in 'img_url'.
`print_stylesheets() : void`	Prints all defined stylesheets, including default and user-defined ones.
`print_trusted(string key) : void`	Prints a trusted string by key.
`print_vbox() : void`	Prints an vertical bar of site-specific content on a journal.
`title() :` `string`	Return a relevant combination of Page.global_title and Page.view_title(). May be overridden in layout layers or left untouched for the core layer to handle.
`view_title() :` `string`	Return a title for this particular page, such as "Friends' Recent Entries" for the friends view, or a date for the day view. Should be overridden in i18n layers. Ideally, layout layers should never override this. See Page.title().
`visible_tag_list() : TagDetail[]`	Returns an array of tags that the logged in user can see for the journal being viewed.

PalItem Class

A specification for a numbered palette index in a GIF or PNG to be changed to a certain color

Members

`Color color`	Color to put at specified index.
`int index`	Integer palette index.

RecentNav Class

Navigation position within a RecentPage or FriendsPage and URLs to move about.

Members

`int backward_count`	Number of items we'd be potentially seeing going backward.
`int backward_skip`	Number of items we'd be skipping going back more.
`string backward_url`	URL to go backward in time, or blank if furthest back server will allow. (Read-only)
`int count`	Indicates how many entries we're currently seeing
`int forward_count`	Number of items we'd be potentially seeing going forward.
`int forward_skip`	Number of items we'd be skipping going forward.
`string forward_url`	URL to go forward in time, or blank if furthest forward. (Read-only)
`int skip`	Indicates how many entries are being skipped back.
`int version`	Currently version 1. A new method of navigation has been frequently discussed, so this is planning for the future

RecentPage Class

Child class of Page. Most recent entries page, formally known as the LASTN view in the previous style system

Members

`string{} args`	Arguments from the URL's query string (after the question mark). S2 code can only access arguments starting with a period, and this period is not included in the hash key. (Read-only)
`string base_url`	The base URL of the journal being viewed. (Read-only)
`Link{} data_link`	Links to various machine-readable data sources relating to this page
`string[] data_links_order`	An array of data views which can be used to order the data_link hash
`Entry[] entries`	Array of entries available to be seen by the viewer of the page.
`string global_subtitle`	A sub-title selected by the user for their whole journal. (Read-only)
`string global_title`	A title selected by the user for their whole journal. (Read-only)
`string head_content`	Extra tags supplied by the server to go in the <head> section of the output HTML document. Layouts should include this in the head section if they are writing HTML. (Read-only)
`User journal`	User whose journal is being viewed
`string journal_type`	Journal type, ex: 'P' (personal), 'C' (community), etc. (Read-only)
`UserLink[] linklist`	An array of UserLink objects defined by the user to be displayed on their journal. (Read-only)
`RecentNav nav`
`string stylesheet_url`	The URL to use in a link element for the server-supported external stylesheet to put stuff in it) (Read-only)
`DateTime time`	A DateTime object filled with the time (GMT) when the page was created. (Read-only)
`string view`	The view type (recent, friends, archive, month, day, entry) (Read-only)
`string{} view_url`	Links to top-level views where id equals the name of the view being linked to. (if one of views == $.view, already looking at that view) (Read-only)
`string[] views_order`	An array of view identifiers which can be used to order the views hash. (Read-only)

Methods

`get_latest_month() :` `YearMonth`	Returns information about the latest month the user posted (or the current month, if no posts), so that the page may include a mini-calendar or similar features.
`print() : void`	The main entry point that LiveJournal calls. Layouts should override this to create HTML that's the same for all view types, and use $this->title, $this->head and $this->body to include view-specific content into the template.
`print_ad(string type) : void`	Deprecated function. Use print_hbox_(top\|bottom) or print_vbox from now on.
`print_body() : void`	Call from Page.print() to render parts of the view that are specific to the view, eg print the recent set of journal entries, recent friends entries, or rows of user information
`print_control_strip() : void`	Prints a control strip for the user's convenience
`print_custom_head() : void`	Layers can override this to add extra HTML to the head section of the HTML document. Note that layouts are not intended to override this method.
`print_entry(Entry e) : void`	Output a journal entry. Layouts should override this and the inherited versions in RecentPage, FriendsPage and DayPage to change how entries display.
`print_entry_poster(Entry e) : void`	Output a line of text which says who posted an entry (just "user", or "user posting in somejournal")
`print_hbox_bottom() : void`	Prints an horizontal bar of site-specific content at the bottom of a journal.
`print_hbox_top() : void`	Prints an horizontal bar of site-specific content at the top of a journal.
`print_head() : void`	Print server side supplied head content. This is a fixed function, so you can't override it. See Page.print_custom_head() if you want to supply custom head content.
`print_linklist() : void`	Print the list of UserLink objects specified by the user.
`print_reply_container(string{} opts) : void`	Prints the area in which the quickreply box will go. Options you may specify are 'target' which will be the target id, and 'class' which will be the CSS class used by the container. If no container is available, quickreply will not work.
`print_reply_link(string{} opts) : void`	Prints a link to reply to the comment. You may specify the link text in the 'linktext' option, the link CSS class in 'class', and the target container in the 'target' option. You may also specify the url of an image to use as a button in 'img_url'.
`print_stylesheets() : void`	Prints all defined stylesheets, including default and user-defined ones.
`print_trusted(string key) : void`	Prints a trusted string by key.
`print_vbox() : void`	Prints an vertical bar of site-specific content on a journal.
`title() :` `string`	Return a relevant combination of Page.global_title and Page.view_title(). May be overridden in layout layers or left untouched for the core layer to handle.
`view_title() :` `string`	Return a title for this particular page, such as "Friends' Recent Entries" for the friends view, or a date for the day view. Should be overridden in i18n layers. Ideally, layout layers should never override this. See Page.title().
`visible_tag_list() : TagDetail[]`	Returns an array of tags that the logged in user can see for the journal being viewed.

Redirector Class

A redirector makes either a GET URL which redirects to a pretty URL or an HTML form which posts to a URL that redirects to a pretty URL. This class exists because it's often desirable to use a form to end up at a URL, instead of doing a GET request. It's also used in cases where finding the previous or next URL would incur database overhead which would be wasteful, considering most people don't click previous/next links. Instead, the system will give you a Redirector object which has a URL that'll do the lookup for you later, followed by a redirect.

Members

`string type`	(Read-only)
`string url`	(Read-only)
`string user`	(Read-only)
`string vhost`	(Read-only)

Methods

`end_form() : void`	Prints a form close tag.
`get_url(string redir_key) : void`	Returns a GET URL, given a redir_key
`print_hiddens() : void`	Prints the necessary hidden elements for a form. Called automatically by Redirector.start_form().
`start_form() : void`	Starts an inline HTML form, then calls Redirector.print_hiddens(). You can also make it yourself, using Redirector.url, if you need special form attributes.

ReplyForm Class

This class will be used more in the future to set options on the reply form before it's printed out by the system. The system has to print it since it contains sensitive information which can't be made available to S2.

Members

bool subj_icons Whether user has enabled subject icons or not. Currently read-only until policy is decided on whether layers should be able to change it (rather than changing it in the user preferences) (Read-only)

Methods

print() : void Prints the reply form

ReplyPage Class

Child class of Page. A page to reply to a journal entry or comment

Members

`string{} args`	Arguments from the URL's query string (after the question mark). S2 code can only access arguments starting with a period, and this period is not included in the hash key. (Read-only)
`string base_url`	The base URL of the journal being viewed. (Read-only)
`Link{} data_link`	Links to various machine-readable data sources relating to this page
`string[] data_links_order`	An array of data views which can be used to order the data_link hash
`Entry entry`	The journal entry for this talk page
`ReplyForm form`	The reply form.
`string global_subtitle`	A sub-title selected by the user for their whole journal. (Read-only)
`string global_title`	A title selected by the user for their whole journal. (Read-only)
`string head_content`	Extra tags supplied by the server to go in the <head> section of the output HTML document. Layouts should include this in the head section if they are writing HTML. (Read-only)
`User journal`	User whose journal is being viewed
`string journal_type`	Journal type, ex: 'P' (personal), 'C' (community), etc. (Read-only)
`UserLink[] linklist`	An array of UserLink objects defined by the user to be displayed on their journal. (Read-only)
`EntryLite replyto`	The object which is being replied to, either the entry or a comment
`string stylesheet_url`	The URL to use in a link element for the server-supported external stylesheet to put stuff in it) (Read-only)
`DateTime time`	A DateTime object filled with the time (GMT) when the page was created. (Read-only)
`string view`	The view type (recent, friends, archive, month, day, entry) (Read-only)
`string{} view_url`	Links to top-level views where id equals the name of the view being linked to. (if one of views == $.view, already looking at that view) (Read-only)
`string[] views_order`	An array of view identifiers which can be used to order the views hash. (Read-only)

Methods

`get_latest_month() :` `YearMonth`	Returns information about the latest month the user posted (or the current month, if no posts), so that the page may include a mini-calendar or similar features.
`print() : void`	The main entry point that LiveJournal calls. Layouts should override this to create HTML that's the same for all view types, and use $this->title, $this->head and $this->body to include view-specific content into the template.
`print_ad(string type) : void`	Deprecated function. Use print_hbox_(top\|bottom) or print_vbox from now on.
`print_body() : void`	Call from Page.print() to render parts of the view that are specific to the view, eg print the recent set of journal entries, recent friends entries, or rows of user information
`print_control_strip() : void`	Prints a control strip for the user's convenience
`print_custom_head() : void`	Layers can override this to add extra HTML to the head section of the HTML document. Note that layouts are not intended to override this method.
`print_entry(Entry e) : void`	Output a journal entry. Layouts should override this and the inherited versions in RecentPage, FriendsPage and DayPage to change how entries display.
`print_entry_poster(Entry e) : void`	Output a line of text which says who posted an entry (just "user", or "user posting in somejournal")
`print_hbox_bottom() : void`	Prints an horizontal bar of site-specific content at the bottom of a journal.
`print_hbox_top() : void`	Prints an horizontal bar of site-specific content at the top of a journal.
`print_head() : void`	Print server side supplied head content. This is a fixed function, so you can't override it. See Page.print_custom_head() if you want to supply custom head content.
`print_linklist() : void`	Print the list of UserLink objects specified by the user.
`print_reply_container(string{} opts) : void`	Prints the area in which the quickreply box will go. Options you may specify are 'target' which will be the target id, and 'class' which will be the CSS class used by the container. If no container is available, quickreply will not work.
`print_reply_link(string{} opts) : void`	Prints a link to reply to the comment. You may specify the link text in the 'linktext' option, the link CSS class in 'class', and the target container in the 'target' option. You may also specify the url of an image to use as a button in 'img_url'.
`print_stylesheets() : void`	Prints all defined stylesheets, including default and user-defined ones.
`print_trusted(string key) : void`	Prints a trusted string by key.
`print_vbox() : void`	Prints an vertical bar of site-specific content on a journal.
`title() :` `string`	Return a relevant combination of Page.global_title and Page.view_title(). May be overridden in layout layers or left untouched for the core layer to handle.
`view_title() :` `string`	Return a title for this particular page, such as "Friends' Recent Entries" for the friends view, or a date for the day view. Should be overridden in i18n layers. Ideally, layout layers should never override this. See Page.title().
`visible_tag_list() : TagDetail[]`	Returns an array of tags that the logged in user can see for the journal being viewed.

string Class

A series of characters. This isn't really a class, as suggested by its lower-case name. Parameters of type string pass by value, unlike all variables of real object types, which pass by reference. Instead, this is just a pseudo-class which provides convenience methods on instances of strings. The other pseudo-class is int.

Methods

`compare(string s) : int`	Compare one string with another. Returns a negative number if n is alphabetically before the subject, positive if greater or zero if the two are equal. Note that this function currently does a simple ASCII compare, not a proper unicode-aware sort.
`contains(string sub) : bool`	Return true if string contains $sub
`css_keyword() :` `string`	If the string is syntactically valid as a CSS keyword (only letters and spaces) returns it, else returns an empty string.
`css_keyword(string[] allowed) : string`	Same as string.css_keyword() except also imposes a whitelist of valid keywords given in $allowed.
`css_keyword_list() :` `string`	Analyses the string as a space-separated list of CSS keywords and returns a string containing the items that are syntactically acceptable.
`css_keyword_list(string[] allowed) : string`	Same as string.css_keyword_list() except also imposes a whitelist of valid keywords given in $allowed.
`css_length_value() :` `string`	If the string contains a valid CSS length value, returns a canonical version. Else returns an empty string.
`css_string() :` `string`	Returns the string escaped and quoted as a CSS string literal, safe for insertion into a stylesheet.
`css_url_value() :` `string`	If the string contains a valid HTTP or HTTPS URL it is returned. Otherwise, an empty string is returned.
`ends_with(string sub) : bool`	Returns true if string ends in $sub
`length() :` `int`	Return the number of characters in the string.
`lower() :` `string`	Returns string in lower case.
`repeat(int n) : string`	Returns the string repeated n times
`starts_with(string sub) : bool`	Returns true if string begins with $sub
`substr(int start, int length) : string`	Returns up to $length characters from string, skipping $start characters from the beginning.
`upper() :` `string`	Returns string in upper case
`upperfirst() :` `string`	Return string with the first character capitalized.

Tag Class

Represents a tag in its most basic form.

Members

`string name`	Textual representation of this tag. (Read-only)
`string url`	URL to view entries with this tag. (Read-only)

TagDetail Class

Child class of Tag. A rich structure with lots of information about a Tag.

Members

`string name`	Textual representation of this tag. (Read-only)
`int{} security_counts`	How many times this tag has used this security. The keys are which security, one of: public, private, friends, group. The value is the count of times the tag is used on entries with that security level. (Read-only)
`string url`	URL to view entries with this tag. (Read-only)
`int use_count`	Count of how many times this tag has been used. (Read-only)
`string visibility`	The visibility level for this tag. Based on the entries it's used on. Can be one of: public, private, friends, group. (Read-only)

TagsPage Class

Child class of Page. A detail page listing a user's tags.

Members

`string{} args`	Arguments from the URL's query string (after the question mark). S2 code can only access arguments starting with a period, and this period is not included in the hash key. (Read-only)
`string base_url`	The base URL of the journal being viewed. (Read-only)
`Link{} data_link`	Links to various machine-readable data sources relating to this page
`string[] data_links_order`	An array of data views which can be used to order the data_link hash
`string global_subtitle`	A sub-title selected by the user for their whole journal. (Read-only)
`string global_title`	A title selected by the user for their whole journal. (Read-only)
`string head_content`	Extra tags supplied by the server to go in the <head> section of the output HTML document. Layouts should include this in the head section if they are writing HTML. (Read-only)
`User journal`	User whose journal is being viewed
`string journal_type`	Journal type, ex: 'P' (personal), 'C' (community), etc. (Read-only)
`UserLink[] linklist`	An array of UserLink objects defined by the user to be displayed on their journal. (Read-only)
`string stylesheet_url`	The URL to use in a link element for the server-supported external stylesheet to put stuff in it) (Read-only)
`TagDetail[] tags`	List of tags visible to the user viewing the page.
`DateTime time`	A DateTime object filled with the time (GMT) when the page was created. (Read-only)
`string view`	The view type (recent, friends, archive, month, day, entry) (Read-only)
`string{} view_url`	Links to top-level views where id equals the name of the view being linked to. (if one of views == $.view, already looking at that view) (Read-only)
`string[] views_order`	An array of view identifiers which can be used to order the views hash. (Read-only)

Methods

`get_latest_month() :` `YearMonth`	Returns information about the latest month the user posted (or the current month, if no posts), so that the page may include a mini-calendar or similar features.
`print() : void`	The main entry point that LiveJournal calls. Layouts should override this to create HTML that's the same for all view types, and use $this->title, $this->head and $this->body to include view-specific content into the template.
`print_ad(string type) : void`	Deprecated function. Use print_hbox_(top\|bottom) or print_vbox from now on.
`print_body() : void`	Call from Page.print() to render parts of the view that are specific to the view, eg print the recent set of journal entries, recent friends entries, or rows of user information
`print_control_strip() : void`	Prints a control strip for the user's convenience
`print_custom_head() : void`	Layers can override this to add extra HTML to the head section of the HTML document. Note that layouts are not intended to override this method.
`print_entry(Entry e) : void`	Output a journal entry. Layouts should override this and the inherited versions in RecentPage, FriendsPage and DayPage to change how entries display.
`print_entry_poster(Entry e) : void`	Output a line of text which says who posted an entry (just "user", or "user posting in somejournal")
`print_hbox_bottom() : void`	Prints an horizontal bar of site-specific content at the bottom of a journal.
`print_hbox_top() : void`	Prints an horizontal bar of site-specific content at the top of a journal.
`print_head() : void`	Print server side supplied head content. This is a fixed function, so you can't override it. See Page.print_custom_head() if you want to supply custom head content.
`print_linklist() : void`	Print the list of UserLink objects specified by the user.
`print_reply_container(string{} opts) : void`	Prints the area in which the quickreply box will go. Options you may specify are 'target' which will be the target id, and 'class' which will be the CSS class used by the container. If no container is available, quickreply will not work.
`print_reply_link(string{} opts) : void`	Prints a link to reply to the comment. You may specify the link text in the 'linktext' option, the link CSS class in 'class', and the target container in the 'target' option. You may also specify the url of an image to use as a button in 'img_url'.
`print_stylesheets() : void`	Prints all defined stylesheets, including default and user-defined ones.
`print_trusted(string key) : void`	Prints a trusted string by key.
`print_vbox() : void`	Prints an vertical bar of site-specific content on a journal.
`title() :` `string`	Return a relevant combination of Page.global_title and Page.view_title(). May be overridden in layout layers or left untouched for the core layer to handle.
`view_title() :` `string`	Return a title for this particular page, such as "Friends' Recent Entries" for the friends view, or a date for the day view. Should be overridden in i18n layers. Ideally, layout layers should never override this. See Page.title().
`visible_tag_list() : TagDetail[]`	Returns an array of tags that the logged in user can see for the journal being viewed.

User Class

Child class of UserLite. A more information-rich userinfo structure

Members

`Link{} data_link`	Links to various machine-readable data sources relating to this user
`string[] data_links_order`	An array of data views which can be used to order the data_link hash
`Image default_pic`	Information about default userpic
`string journal_type`	Type of account: P (personal), C (community), Y (syndicated), S (shared), I (external identity) etc (Read-only)
`string[] link_keyseq`	Array of keys which can be passed into the get_link
`string name`	User's formatted name, ex: John Q. Public (Read-only)
`string username`	Canonical Username, ex: johnqpub. Note that if journal_type is an external identity, there will be no username, so this field will be a display version of their URL, longer than 15 characters, and with characters other than a-z, 0-9 and underscore. (Read-only)
`string userpic_listing_url`	URL of a page listing this user's userpics (Read-only)
`string website_name`	'pretty' name of user's website (Read-only)
`string website_url`	URL pointer to user's website (Read-only)

Methods

`as_string() :` `string`
`base_url() :` `string`	Returns URL of user's journal.
`equals(UserLite u) : bool`	Returns true if the two user objects refer to the same user. Use this rather than comparing usernames, since usernames aren't globally unique.
`get_link(string key) : Link`	Returns a link based on the given key, or null if the link is unavailable
`ljuser() :` `string`	Returns an LJ user tag for the user.
`ljuser(Color link_color) : string`	Returns an LJ user tag for the user. The color of the link will be link_color.
`print() : void`
`print_linkbar() : void`	Print the link bar for this user/journal.
`tag_manage_url() :` `string`	Returns URL to user's tag management page.

UserLink Class

A user-defined link to an outside resource.

Members

`UserLink[] children`	Not Implemented: An array of child UserLink objects. (Read-only)
`bool is_heading`	Is this link a heading or category name? If so, it has no url and a list of children. (Read-only)
`string title`	The title or label for the link (Read-only)
`string url`	The url to which the link points (Read-only)

UserLite Class

A 'lite' version of a User which the system often has more readily-available than a full version.

Members

`Link{} data_link`	Links to various machine-readable data sources relating to this user
`string[] data_links_order`	An array of data views which can be used to order the data_link hash
`string journal_type`	Type of account: P (personal), C (community), Y (syndicated), S (shared), I (external identity) etc (Read-only)
`string[] link_keyseq`	Array of keys which can be passed into the get_link
`string name`	User's formatted name, ex: John Q. Public (Read-only)
`string username`	Canonical Username, ex: johnqpub. Note that if journal_type is an external identity, there will be no username, so this field will be a display version of their URL, longer than 15 characters, and with characters other than a-z, 0-9 and underscore. (Read-only)

Methods

`as_string() :` `string`
`base_url() :` `string`	Returns URL of user's journal.
`equals(UserLite u) : bool`	Returns true if the two user objects refer to the same user. Use this rather than comparing usernames, since usernames aren't globally unique.
`get_link(string key) : Link`	Returns a link based on the given key, or null if the link is unavailable
`ljuser() :` `string`	Returns an LJ user tag for the user.
`ljuser(Color link_color) : string`	Returns an LJ user tag for the user. The color of the link will be link_color.
`print() : void`
`print_linkbar() : void`	Print the link bar for this user/journal.
`tag_manage_url() :` `string`	Returns URL to user's tag management page.

YearDay Class

Information on how to link to a day in the year archive

Members

`Date date`	Date of day
`int day`	Day of month number
`int num_entries`	Number of entries made on this day
`string url`	A URL to view the day, if there are entries, else blank. (Read-only)

YearMonth Class

A month on the YearPage.

Members

`bool has_entries`	If this is false, you probably don't want to display this month.
`int month`	The number of the month
`Date next_date`	Date of next month, with day of zero, or null if none.
`string next_url`	A url to link to in order to view the next month. (Read-only)
`Date prev_date`	Date of previous month, with day of zero, or null if none.
`string prev_url`	A url to link to in order to view the previous month. (Read-only)
`string url`	A url to link to in order to view this month. (Read-only)
`YearWeek[] weeks`	An array of the weeks of the month (for ease of building a row-per-week calendar)
`int year`	The number of the year

Methods

`month_format() :` `string`	Returns month formatted long (February 1980) // SeeAlso: siteapi.core1.dateformats
`month_format(string fmt) : string`	Returns time formatted as indicated by $fmt, or 'long' if blank. // SeeAlso: siteapi.core1.dateformats

YearPage Class

Child class of Page. Entire calendar page for a single year.

Members

`string{} args`	Arguments from the URL's query string (after the question mark). S2 code can only access arguments starting with a period, and this period is not included in the hash key. (Read-only)
`string base_url`	The base URL of the journal being viewed. (Read-only)
`Link{} data_link`	Links to various machine-readable data sources relating to this page
`string[] data_links_order`	An array of data views which can be used to order the data_link hash
`string global_subtitle`	A sub-title selected by the user for their whole journal. (Read-only)
`string global_title`	A title selected by the user for their whole journal. (Read-only)
`string head_content`	Extra tags supplied by the server to go in the <head> section of the output HTML document. Layouts should include this in the head section if they are writing HTML. (Read-only)
`User journal`	User whose journal is being viewed
`string journal_type`	Journal type, ex: 'P' (personal), 'C' (community), etc. (Read-only)
`UserLink[] linklist`	An array of UserLink objects defined by the user to be displayed on their journal. (Read-only)
`YearMonth[] months`	12 months objects, even if no entries are in that month.
`string stylesheet_url`	The URL to use in a link element for the server-supported external stylesheet to put stuff in it) (Read-only)
`DateTime time`	A DateTime object filled with the time (GMT) when the page was created. (Read-only)
`string view`	The view type (recent, friends, archive, month, day, entry) (Read-only)
`string{} view_url`	Links to top-level views where id equals the name of the view being linked to. (if one of views == $.view, already looking at that view) (Read-only)
`string[] views_order`	An array of view identifiers which can be used to order the views hash. (Read-only)
`int year`	The year being viewed
`YearYear[] years`	Information for linking to other years

Methods

`get_latest_month() :` `YearMonth`	Returns information about the latest month the user posted (or the current month, if no posts), so that the page may include a mini-calendar or similar features.
`print() : void`	The main entry point that LiveJournal calls. Layouts should override this to create HTML that's the same for all view types, and use $this->title, $this->head and $this->body to include view-specific content into the template.
`print_ad(string type) : void`	Deprecated function. Use print_hbox_(top\|bottom) or print_vbox from now on.
`print_body() : void`	Call from Page.print() to render parts of the view that are specific to the view, eg print the recent set of journal entries, recent friends entries, or rows of user information
`print_control_strip() : void`	Prints a control strip for the user's convenience
`print_custom_head() : void`	Layers can override this to add extra HTML to the head section of the HTML document. Note that layouts are not intended to override this method.
`print_entry(Entry e) : void`	Output a journal entry. Layouts should override this and the inherited versions in RecentPage, FriendsPage and DayPage to change how entries display.
`print_entry_poster(Entry e) : void`	Output a line of text which says who posted an entry (just "user", or "user posting in somejournal")
`print_hbox_bottom() : void`	Prints an horizontal bar of site-specific content at the bottom of a journal.
`print_hbox_top() : void`	Prints an horizontal bar of site-specific content at the top of a journal.
`print_head() : void`	Print server side supplied head content. This is a fixed function, so you can't override it. See Page.print_custom_head() if you want to supply custom head content.
`print_linklist() : void`	Print the list of UserLink objects specified by the user.
`print_month(YearMonth m) : void`	Print the calendar cell for the given month
`print_reply_container(string{} opts) : void`	Prints the area in which the quickreply box will go. Options you may specify are 'target' which will be the target id, and 'class' which will be the CSS class used by the container. If no container is available, quickreply will not work.
`print_reply_link(string{} opts) : void`	Prints a link to reply to the comment. You may specify the link text in the 'linktext' option, the link CSS class in 'class', and the target container in the 'target' option. You may also specify the url of an image to use as a button in 'img_url'.
`print_stylesheets() : void`	Prints all defined stylesheets, including default and user-defined ones.
`print_trusted(string key) : void`	Prints a trusted string by key.
`print_vbox() : void`	Prints an vertical bar of site-specific content on a journal.
`print_year_links() : void`	Print the navigation links to move between years
`title() :` `string`	Return a relevant combination of Page.global_title and Page.view_title(). May be overridden in layout layers or left untouched for the core layer to handle.
`view_title() :` `string`	Return a title for this particular page, such as "Friends' Recent Entries" for the friends view, or a date for the day view. Should be overridden in i18n layers. Ideally, layout layers should never override this. See Page.title().
`visible_tag_list() : TagDetail[]`	Returns an array of tags that the logged in user can see for the journal being viewed.

YearWeek Class

Represents a week on the YearMonth on the YearPage.

Members

`YearDay[] days`	An array of the days of the week (0=sunday)
`int post_empty`	How many days at the end of the week are blank? (From next month)
`int pre_empty`	How many days at the start of the week are blank? (From previous month)

Methods

print() : void Print formatted week

YearYear Class

Information on how to link to a year in the year archive

Members

`bool displayed`	If this is the year currently being displayed, this will be true.
`string url`	URL to link to for this year. (Read-only)
`int year`	Number of the year, eg 2001.