blogger_entry Class Reference
Public Member Functions | |
| blogger_entry ($parentUser, $timestamp=null) | |
| createFilename () | |
| load () | |
| save () | |
| getGlobalID ($aswhat="view") | |
| getFeedItem () | |
| userCanView ($username) | |
| renderEditor () | |
| renderControls () | |
| renderFull () | |
| renderBlock () | |
| renderTiny () | |
| render ($block=false, $tiny=false) | |
Public Attributes | |
| $username | |
| $timestamp | |
| $filename | |
| $title | |
| $content | |
| $categories | |
| $published | |
| $personal | |
| $viewLevel | |
| $commentLevel | |
| $comments | |
| $parentUser | |
| Reference to the user owning this entry. | |
| $edit = false | |
Detailed Description
Blog entry files structure <?PHP $entry = array(); ?>Blog array structure array( "name" => username, "timestamp" => unix timestamp, "title" => the blog title, "content" => the blog entry (pagedata), "categories" => array("category1", "category2"), "personal" => boolean, defining wether the entry is personal or not, "viewlevel" => integer, describing the viewing allowance level, "commentlevel" => integer, describing the commenting allowance level, "comments" => comment data for comment_handler )
Definition at line 21 of file blogger_entry.php.
Member Function Documentation
| blogger_entry::blogger_entry | ( | $ | parentUser, | |
| $ | timestamp = null | |||
| ) |
Construct a new blogger_entry instance for the user in question If the timestamp is omitted, it means we are creating a new blog entry - just assign the current time
- Parameters:
-
parentUser Reference to the user who owns the entry timestamp Optional. The timestamp for this entry. If none exists, we are creating a new entry.
Definition at line 47 of file blogger_entry.php.
References $parentUser, $timestamp, $userinfo_folder, createFilename(), and load().
| blogger_entry::createFilename | ( | ) |
Definition at line 60 of file blogger_entry.php.
References $userinfo_folder.
Referenced by blogger_entry().
| blogger_entry::load | ( | ) |
Definition at line 67 of file blogger_entry.php.
References commentLevel, title, and viewLevel.
Referenced by blogger_entry(), renderEditor(), and renderFull().
| blogger_entry::save | ( | ) |
Definition at line 82 of file blogger_entry.php.
References array_export(), commentLevel, title, and viewLevel.
Referenced by renderEditor(), and renderFull().
| blogger_entry::getGlobalID | ( | $ | aswhat = "view" |
) |
Definition at line 99 of file blogger_entry.php.
Referenced by getFeedItem(), renderControls(), and renderEditor().
| blogger_entry::getFeedItem | ( | ) |
Definition at line 109 of file blogger_entry.php.
References $title, getGlobalID(), and title.
| blogger_entry::userCanView | ( | $ | username | ) |
Check wether a user is allowed to view this blog entry
- Parameters:
-
username The username of the user who wishes to view the entry
- Returns:
- A boolean describing wether or not the user is allowed
Definition at line 132 of file blogger_entry.php.
| blogger_entry::renderEditor | ( | ) |
Definition at line 140 of file blogger_entry.php.
References $renderedContent, getGlobalID(), globalIDtoURL(), i18n(), load(), lockableClass::lock(), renderWarningBox(), save(), thisPageURL(), title, and lockableClass::unlock().
Referenced by render().
| blogger_entry::renderControls | ( | ) |
Render the controls block for the blog entry
- Returns:
- The rendered controls
Definition at line 188 of file blogger_entry.php.
References $comments, $edit, drawCommand(), getGlobalID(), globalIDtoURL(), and i18n().
Referenced by renderBlock(), and renderTiny().
| blogger_entry::renderFull | ( | ) |
Definition at line 211 of file blogger_entry.php.
References $content, $renderedContent, $title, commentLevel, formatTime(), load(), lockableClass::lock(), parse_page_data(), save(), title, and lockableClass::unlock().
Referenced by render().
| blogger_entry::renderBlock | ( | ) |
Definition at line 236 of file blogger_entry.php.
References $content, $renderedContent, $title, formatTime(), parse_page_data(), renderControls(), and title.
Referenced by render().
| blogger_entry::renderTiny | ( | ) |
Definition at line 255 of file blogger_entry.php.
References $renderedContent, $title, formatTime(), renderControls(), and title.
Referenced by render().
| blogger_entry::render | ( | $ | block = false, |
|
| $ | tiny = false | |||
| ) |
- Parameters:
-
block Render the item in block mode (as opposed to the full entry) tiny Render the block in tiny mode (only title is shown)
- Returns:
- String containing the rendered entry
Definition at line 273 of file blogger_entry.php.
References edit, renderBlock(), renderEditor(), renderFull(), and renderTiny().
Member Data Documentation
| blogger_entry::$username |
| blogger_entry::$timestamp |
| blogger_entry::$filename |
Definition at line 25 of file blogger_entry.php.
| blogger_entry::$title |
Definition at line 27 of file blogger_entry.php.
Referenced by getFeedItem(), renderBlock(), renderFull(), and renderTiny().
| blogger_entry::$content |
| blogger_entry::$categories |
Definition at line 29 of file blogger_entry.php.
| blogger_entry::$published |
Definition at line 30 of file blogger_entry.php.
| blogger_entry::$personal |
Definition at line 32 of file blogger_entry.php.
| blogger_entry::$viewLevel |
Definition at line 33 of file blogger_entry.php.
| blogger_entry::$commentLevel |
Definition at line 34 of file blogger_entry.php.
| blogger_entry::$comments |
| blogger_entry::$parentUser |
Reference to the user owning this entry.
Definition at line 37 of file blogger_entry.php.
Referenced by blogger_entry().
| blogger_entry::$edit = false |
The documentation for this class was generated from the following file:
- setup/modules/blogger/code/blogger_entry.php
