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
external_stylesheet	0
font_base
font_fallback	none
lang_current	en
lang_dayname_long	List: (, Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday)
lang_dayname_short	List: (, Sun, Mon, Tue, Wed, Thu, Fri, Sat)
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	List: (, January, February, March, April, May, June, July, August, September, October, November, December)
lang_monthname_short	List: (, Jan, Feb, Mar, Apr, May, Jun, Jul, Aug, Sep, Oct, Nov, Dec)
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_reply	Reply
text_comment_thread	Thread
text_day_next	Next Day
text_day_prev	Previous Day
text_icon_alt_private	[private post]
text_icon_alt_protected	[protected post]
text_max_comments	Maximum comments reached
text_meta_mood	Current Mood
text_meta_music	Current Music
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_freeze	Freeze
text_multiform_opt_screen	Screen
text_multiform_opt_unfreeze	Unfreeze
text_multiform_opt_unscreen	Unscreen
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_skiplinks_back	Previous #
text_skiplinks_forward	Next #
text_tags	Tags: #
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_month	View Subjects
text_view_recent	Recent Entries
text_view_userinfo	User Info
text_website_default_name	My Website
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.
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.
ehtml(string s) : string	Escapes all HTML tags and entities from the text
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
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_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
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_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.
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
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.
userinfoicon(UserLite user) : Image
userlite_as_string(UserLite ul) : string	Access to the LJ::ljuser function
userlite_base_url(UserLite ul) : string
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.
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 MonthDay MonthEntryInfo MonthPage Page PalItem RecentNav RecentPage Redirector ReplyForm ReplyPage string Tag User UserLink UserLite YearDay YearMonth YearPage YearWeek YearYear

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

Color Class
Represents a color.

Members

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

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.
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	(Read-only) Direct link to comment, via HTML name anchors
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	(Read-only) The DOM 'id' attribute you should put on your outer-most element
bool frozen	(Read-only) True if comment is in frozen state.
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	(Read-only) Post metadata. Keys: 'music', 'mood'
string parent_url	(Read-only) URL to parent comment, or blank if a top-level comment.
string permalink_url	(Read-only) A URL at which this specific entry can be viewed, for linking purposes.
UserLite poster	Author of the entry, or null if an anonymous comment
Comment[] replies	Comments replying to this comment.
string reply_url	(Read-only) URL to reply to this comment.
bool screened	(Read-only) True if comment is in screened state.
string subject	(Read-only) Subject. May contain HTML. Don't do substring chops on this.
Image subject_icon	Subject icon, or null.
Tag[] tags	(Read-only) Array of tags applied to this entry.
int talkid	Server stored ID number for this comment.
string text	(Read-only) Text (will be blank on some viewtypes, like 'month' view, or with collapsed threads)
string thread_url	(Read-only) URL to view threaded rooted at this comment, or blank if comment has no children.
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_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().

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	(Read-only) URL pointer to the 'Post Comments' view.
string read_url	(Read-only) URL pointer to the 'Read Comments' view.
bool screened	Set to true if there are screened comments and remote user can unscreen them.

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

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

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	(Read-only) 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.
string base_url	(Read-only) The base URL of the journal being viewed.
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	(Read-only) A sub-title selected by the user for their whole journal.
string global_title	(Read-only) A title selected by the user for their whole journal.
bool has_entries	True if there are entries on the specified day
string head_content	(Read-only) 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.
User journal	User whose journal is being viewed
string journal_type	(Read-only) Journal type, ex: 'P' (personal), 'C' (community), etc.
UserLink[] linklist	(Read-only) An array of UserLink objects defined by the user to be displayed on their journal.
Date next_date	Next day
string next_url	(Read-only) URL to next day
Date prev_date	Previous day
string prev_url	(Read-only) URL to previous day
string stylesheet_url	(Read-only) The URL to use in a link element for the server-supported external stylesheet to put stuff in it)
DateTime time	(Read-only) A DateTime object filled with the time (GMT) when the page was created.
string view	(Read-only) The view type (recent, friends, archive, month, day, entry)
string{} view_url	(Read-only) 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)
string[] views_order	(Read-only) An array of view identifiers which can be used to order the views hash.

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_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_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_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.
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() : Tag[]	Returns a list 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	(Read-only) The DOM 'id' attribute you should put on your outer-most element
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	(Read-only) Post metadata. Keys: 'music', 'mood'
Image mood_icon	Mood icon, or null.
bool new_day	Is this entry on a different day to the previous one?
string permalink_url	(Read-only) A URL at which this specific entry can be viewed, for linking purposes.
UserLite poster	Author of the entry, or null if an anonymous comment
string security	(Read-only) The security level of the entry ('private', 'protected'), or blank if public.
Image security_icon	A little icon which should be displayed somewhere on an entry to represent the security setting
string subject	(Read-only) Subject. May contain HTML. Don't do substring chops on this.
Tag[] tags	(Read-only) Array of tags applied to this entry.
string text	(Read-only) Text (will be blank on some viewtypes, like 'month' view, or with collapsed threads)
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_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

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	(Read-only) The DOM 'id' attribute you should put on your outer-most element
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	(Read-only) Post metadata. Keys: 'music', 'mood'
string permalink_url	(Read-only) A URL at which this specific entry can be viewed, for linking purposes.
UserLite poster	Author of the entry, or null if an anonymous comment
string subject	(Read-only) Subject. May contain HTML. Don't do substring chops on this.
Tag[] tags	(Read-only) Array of tags applied to this entry.
string text	(Read-only) Text (will be blank on some viewtypes, like 'month' view, or with collapsed threads)
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.

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

Members

string{} args	(Read-only) 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.
string base_url	(Read-only) The base URL of the journal being viewed.
ItemRange comment_pages	Represents what comment page is being displayed.
Comment[] comments	Comments to journal entry, or at least some of them.
Entry entry	Journal entry being viewed
string global_subtitle	(Read-only) A sub-title selected by the user for their whole journal.
string global_title	(Read-only) A title selected by the user for their whole journal.
string head_content	(Read-only) 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.
User journal	User whose journal is being viewed
string journal_type	(Read-only) Journal type, ex: 'P' (personal), 'C' (community), etc.
UserLink[] linklist	(Read-only) An array of UserLink objects defined by the user to be displayed on their journal.
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	(Read-only) The URL to use in a link element for the server-supported external stylesheet to put stuff in it)
DateTime time	(Read-only) A DateTime object filled with the time (GMT) when the page was created.
string view	(Read-only) The view type (recent, friends, archive, month, day, entry)
string{} view_url	(Read-only) 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)
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	(Read-only) An array of view identifiers which can be used to order the views hash.

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_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_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_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...)
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() : Tag[]	Returns a list 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
Color fgcolor	Foreground color selected for friend
string journal_type	(Read-only) Type of account: P (personal), C (community), Y (syndicated), S (shared), I (external identity) etc
string name	(Read-only) User's formatted name, ex: John Q. Public
string username	(Read-only) 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.

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.
print() : void
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	(Read-only) 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.
string base_url	(Read-only) The base URL of the journal being viewed.
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	(Read-only) A user-selected title for their friends page.
string global_subtitle	(Read-only) A sub-title selected by the user for their whole journal.
string global_title	(Read-only) A title selected by the user for their whole journal.
string head_content	(Read-only) 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.
User journal	User whose journal is being viewed
string journal_type	(Read-only) Journal type, ex: 'P' (personal), 'C' (community), etc.
UserLink[] linklist	(Read-only) An array of UserLink objects defined by the user to be displayed on their journal.
RecentNav nav
string stylesheet_url	(Read-only) The URL to use in a link element for the server-supported external stylesheet to put stuff in it)
DateTime time	(Read-only) A DateTime object filled with the time (GMT) when the page was created.
string view	(Read-only) The view type (recent, friends, archive, month, day, entry)
string{} view_url	(Read-only) 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)
string[] views_order	(Read-only) An array of view identifiers which can be used to order the views hash.

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_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_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_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.
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() : Tag[]	Returns a list 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
int height	Height in pixels
string url	(Read-only) URL of the image
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

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	(Read-only) URL for the 'first' link. Blank if already on the first page.
string url_last	(Read-only) URL for the 'last' link. Blank if already on the last page.
string url_next	(Read-only) URL for the 'next' link. Blank if there isn't a next URL.
string url_prev	(Read-only) URL for the 'previous' link. Blank if there isn't a previous URL.

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	(Read-only) The caption for the link
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	(Read-only) URL which the link points to

Methods

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

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	(Read-only) A URL to view the day, if there are entries, else blank.

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	(Read-only) The 'redir_key' parameter for a Redirector instance.
string url	(Read-only) URL for the MonthPage month view.

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

Members

string{} args	(Read-only) 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.
string base_url	(Read-only) The base URL of the journal being viewed.
Date date	Date of this month, with day of zero.
MonthDay[] days	One entry for each day of the month.
string global_subtitle	(Read-only) A sub-title selected by the user for their whole journal.
string global_title	(Read-only) A title selected by the user for their whole journal.
string head_content	(Read-only) 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.
User journal	User whose journal is being viewed
string journal_type	(Read-only) Journal type, ex: 'P' (personal), 'C' (community), etc.
UserLink[] linklist	(Read-only) An array of UserLink objects defined by the user to be displayed on their journal.
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	(Read-only) URL of next month, or empty string if none.
Date prev_date	Date of previous month, with day of zero, or null if none.
string prev_url	(Read-only) URL of previous month, or empty string if none.
Redirector redir	Necessary to make a form which POSTs to a redirector
string stylesheet_url	(Read-only) The URL to use in a link element for the server-supported external stylesheet to put stuff in it)
DateTime time	(Read-only) A DateTime object filled with the time (GMT) when the page was created.
string view	(Read-only) The view type (recent, friends, archive, month, day, entry)
string{} view_url	(Read-only) 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)
string[] views_order	(Read-only) An array of view identifiers which can be used to order the views hash.

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_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_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_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.
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() : Tag[]	Returns a list of tags that the logged in user can see for the journal being viewed.

Page Class
Base template for all views

Members

string{} args	(Read-only) 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.
string base_url	(Read-only) The base URL of the journal being viewed.
string global_subtitle	(Read-only) A sub-title selected by the user for their whole journal.
string global_title	(Read-only) A title selected by the user for their whole journal.
string head_content	(Read-only) 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.
User journal	User whose journal is being viewed
string journal_type	(Read-only) Journal type, ex: 'P' (personal), 'C' (community), etc.
UserLink[] linklist	(Read-only) An array of UserLink objects defined by the user to be displayed on their journal.
string stylesheet_url	(Read-only) The URL to use in a link element for the server-supported external stylesheet to put stuff in it)
DateTime time	(Read-only) A DateTime object filled with the time (GMT) when the page was created.
string view	(Read-only) The view type (recent, friends, archive, month, day, entry)
string{} view_url	(Read-only) 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)
string[] views_order	(Read-only) An array of view identifiers which can be used to order the views hash.

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_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_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_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.
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() : Tag[]	Returns a list 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	(Read-only) URL to go backward in time, or blank if furthest back server will allow.
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	(Read-only) URL to go forward in time, or blank if furthest forward.
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	(Read-only) 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.
string base_url	(Read-only) The base URL of the journal being viewed.
Entry[] entries	Array of entries available to be seen by the viewer of the page.
string global_subtitle	(Read-only) A sub-title selected by the user for their whole journal.
string global_title	(Read-only) A title selected by the user for their whole journal.
string head_content	(Read-only) 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.
User journal	User whose journal is being viewed
string journal_type	(Read-only) Journal type, ex: 'P' (personal), 'C' (community), etc.
UserLink[] linklist	(Read-only) An array of UserLink objects defined by the user to be displayed on their journal.
RecentNav nav
string stylesheet_url	(Read-only) The URL to use in a link element for the server-supported external stylesheet to put stuff in it)
DateTime time	(Read-only) A DateTime object filled with the time (GMT) when the page was created.
string view	(Read-only) The view type (recent, friends, archive, month, day, entry)
string{} view_url	(Read-only) 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)
string[] views_order	(Read-only) An array of view identifiers which can be used to order the views hash.

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_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_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_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.
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() : Tag[]	Returns a list 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

(Read-only) 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)

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	(Read-only) 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.
string base_url	(Read-only) The base URL of the journal being viewed.
Entry entry	The journal entry for this talk page
ReplyForm form	The reply form.
string global_subtitle	(Read-only) A sub-title selected by the user for their whole journal.
string global_title	(Read-only) A title selected by the user for their whole journal.
string head_content	(Read-only) 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.
User journal	User whose journal is being viewed
string journal_type	(Read-only) Journal type, ex: 'P' (personal), 'C' (community), etc.
UserLink[] linklist	(Read-only) An array of UserLink objects defined by the user to be displayed on their journal.
EntryLite replyto	The object which is being replied to, either the entry or a comment
string stylesheet_url	(Read-only) The URL to use in a link element for the server-supported external stylesheet to put stuff in it)
DateTime time	(Read-only) A DateTime object filled with the time (GMT) when the page was created.
string view	(Read-only) The view type (recent, friends, archive, month, day, entry)
string{} view_url	(Read-only) 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)
string[] views_order	(Read-only) An array of view identifiers which can be used to order the views hash.

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_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_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_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.
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() : Tag[]	Returns a list 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

contains(string sub) : bool	Return true if string contains $sub
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.

Members

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

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

Members

Image default_pic	Information about default userpic
string journal_type	(Read-only) Type of account: P (personal), C (community), Y (syndicated), S (shared), I (external identity) etc
string name	(Read-only) User's formatted name, ex: John Q. Public
string username	(Read-only) 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.
string userpic_listing_url	(Read-only) URL of a page listing this user's userpics
string website_name	(Read-only) 'pretty' name of user's website
string website_url	(Read-only) URL pointer to user's website

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.
print() : void
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	(Read-only) Not Implemented: An array of child UserLink objects.
bool is_heading	(Read-only) Is this link a heading or category name? If so, it has no url and a list of children.
string title	(Read-only) The title or label for the link
string url	(Read-only) The url to which the link points

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

Members

string journal_type	(Read-only) Type of account: P (personal), C (community), Y (syndicated), S (shared), I (external identity) etc
string name	(Read-only) User's formatted name, ex: John Q. Public
string username	(Read-only) 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.

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.
print() : void
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	(Read-only) A URL to view the day, if there are entries, else blank.

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	(Read-only) A url to link to in order to view the next month.
Date prev_date	Date of previous month, with day of zero, or null if none.
string prev_url	(Read-only) A url to link to in order to view the previous month.
string url	(Read-only) A url to link to in order to view this month.
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	(Read-only) 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.
string base_url	(Read-only) The base URL of the journal being viewed.
string global_subtitle	(Read-only) A sub-title selected by the user for their whole journal.
string global_title	(Read-only) A title selected by the user for their whole journal.
string head_content	(Read-only) 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.
User journal	User whose journal is being viewed
string journal_type	(Read-only) Journal type, ex: 'P' (personal), 'C' (community), etc.
UserLink[] linklist	(Read-only) An array of UserLink objects defined by the user to be displayed on their journal.
YearMonth[] months	12 months objects, even if no entries are in that month.
string stylesheet_url	(Read-only) The URL to use in a link element for the server-supported external stylesheet to put stuff in it)
DateTime time	(Read-only) A DateTime object filled with the time (GMT) when the page was created.
string view	(Read-only) The view type (recent, friends, archive, month, day, entry)
string{} view_url	(Read-only) 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)
string[] views_order	(Read-only) An array of view identifiers which can be used to order the views hash.
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_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_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_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_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() : Tag[]	Returns a list 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	(Read-only) URL to link to for this year.
int year	Number of the year, eg 2001.