com.lokorin.lokorin.lib
[ class tree: com.lokorin.lokorin.lib ] [ index: com.lokorin.lokorin.lib ] [ all elements ]
Packages:
com.lokorin.lokorin.lib
com.lokorin.lokorin.admin
com.lokorin.lokorin.cache
com.lokorin.lokorin.includes
com.lokorin.lokorin.js
com.lokorin.lokorin.modules
com.lokorin.lokorin.public


Files:
lib_abbreviations.php
lib_admin.php
lib_admin_panel.php
lib_cache.php
lib_calendar.php
lib_counters.php
lib_css.php
lib_db.php
lib_displayer.php
lib_dkpbank.php
lib_downloads.php
lib_errors.php
lib_events.php
lib_event_digest.php
lib_forms.php
lib_graphs.php
lib_images.php
lib_languages.php
lib_links.php
lib_markup.php
lib_menu.php
lib_mplf_archive.php
lib_news.php
lib_performance.php
lib_projects.php
lib_readme.php
lib_redirects.php
lib_search.php
lib_sitemap.php
lib_tables.php
lib_util.php

Classes:
AbbreviationHandler
AbstractTableDisplayer
AddModule
AdminAction
AdminModule
AdminPanel
AliasCalendar
Axis
Browse
Button
Calendar
CallbackModule
Category
Chapter
Checkbox
Comment
Counter
CssHandler
CustomSearch
CustomTableDisplayer
DataBase
DateField
DeleteModule
DetailsModule
DownloadCategory
DownloadItem
Edit
EditModule
EqualSearch
Field
FileNotFoundException
Filter
FilterArchive
Form
FulltextSearch
Graph
GraphFunction
GreaterEqualSearch
GreaterSearch
HeadAddable
HeadData
Header
Hidden
IllegalArgumentException
IllegalStateException
IOException
LesserEqualSearch
LesserSearch
LikeSearch
Link
MenuItem
Moderator
News
NoSuchElementException
Page
PasswordField
PerformanceData
ProgrammingLanguage
Project
ProjectMenu
Readme
ReadOnly
ResetButton
SearchField
Select
Sitemap
SitemapIndex
SizedField
Stage
SubmitButton
Table
TableDisplayer
TableEntry
TableField
TableSearcher
TextArea
TextField
TimedEvent
TimeField
UpdateModule
UrlNotFoundException
Validatable

Class: News

Source Location: /_includes/lib_news.php

Class Overview

TableEntry
   |
   --News

Describes a news item.


Author(s):

  • Andreas Launila

Variables

Methods

Inherited Variables

Class: TableEntry

TableEntry::$id

Inherited Methods

Class: TableEntry

TableEntry::__construct()
Constructor for TableEntry.
TableEntry::getId()
Gets the unique identifier for the table entry.
TableEntry::readRow()
Processes the contents of a retrieved row that describes the entry.

Class Details

[line 131]
Describes a news item.



Tags:

author:  Andreas Launila


[ Top ]

Class Variables

$caption =

[line 136]

The caption of the news item.



Tags:

access:  private

Type:   string


[ Top ]

$entry =

[line 151]

The actual processed XHTML entry of the news item.



Tags:

access:  private

Type:   string


[ Top ]

$lastGenerated =

[line 146]

The unix timestamp of when the contents of the news was last generated.



Tags:

access:  private

Type:   integer


[ Top ]

$projectIds =

[line 157]

The unique identifiers of the projects that the news item is connected to.



Tags:

access:  private

Type:   array


[ Top ]

$timestamp =

[line 141]

The unix timestamp of when the news was submitted.



Tags:

access:  private

Type:   integer


[ Top ]


Class Methods

constructor News [line 163]

News News( integer $id)

Constructor for News.



Tags:

access:  public


Parameters:

integer   $id   The unique identifier of the news entry.

[ Top ]

method getAsHTMLArchive [line 245]

string getAsHTMLArchive( )

Gets the (X)HTML representing the news entry as it should be displayed in an archive (it includes the project references, but not a comment link).



Tags:

return:  An XHTML compliant representation.
access:  public


[ Top ]

method getAsHTMLComment [line 291]

string getAsHTMLComment( )

Gets the (X)HTML representing the news entry as it should be displayed in a comment enviorment. It doesn't include comment links nor an individual header.



Tags:

return:  An XHTML compliant representation.
access:  public


[ Top ]

method getAsHTMLGeneric [line 217]

string getAsHTMLGeneric( )

Gets the (X)HTML representing the news entry as it should be displayed in a generic enviorment (it includes the project references etc).



Tags:

return:  An XHTML compliant representation.
access:  public


[ Top ]

method getAsHTMLIndex [line 360]

string getAsHTMLIndex( mixed $maxCharacters, integer $maxCharacter)

Gets the (X)HTML representating the news entry in a search engine friendly form.



Tags:

return:  An XHTML compliant representation.
access:  public


Parameters:

integer   $maxCharacter   The maximum number of characters that should remain in the preview version.

[ Top ]

method getAsHTMLPreview [line 319]

string getAsHTMLPreview( mixed $maxCharacters, integer $maxCharacter)

Gets the (X)HTML representating the news entry as it should be displayed when displayed as a preview.



Tags:

return:  An XHTML compliant representation.
access:  public


Parameters:

integer   $maxCharacter   The maximum number of characters that should remain in the preview version.

[ Top ]

method getAsHTMLProject [line 273]

string getAsHTMLProject( )

Gets the (X)HTML representing the news entry as it should be displayed in a project specific enviorment (it doesn't include the project references etc).



Tags:

return:  An XHTML compliant representation.
access:  public


[ Top ]

method getAsRSS [line 387]

string getAsRSS( )

Gets the news entry as it should displayed in an RSS feed.



Tags:

return:  An RSS compliant item element.
access:  public


[ Top ]

method getAsSitemapEntry [line 499]

string getAsSitemapEntry( )

Gets the news entry as a sitemap entry.



Tags:

return:  A well-formed XML url entry as specified by the google sitemap schema.
access:  public


[ Top ]

method getAssociatedComments [line 472]

array getAssociatedComments( )

Gets all comment instance that are related to the news entry.



Tags:

return:  An array of Comment instances.
access:  public


[ Top ]

method getCaption [line 200]

string getCaption( )

Gets the caption of the news entry.



Tags:

return:  A news caption.
access:  public


[ Top ]

method getCommentLink [line 488]

An getCommentLink( )

Gets a link to the news iterm's comment page.



Tags:

return:  XHTML compliant version of the link.
access:  private


[ Top ]

method getCommentUrl [line 464]

string getCommentUrl( )

Gets the url to the news' comments page.



Tags:

return:  An url path from the http host.
access:  private


[ Top ]

method getEntryAsHTML [line 402]

string getEntryAsHTML( )

Gets the news' entry with markup code in it (e.g. [img]...[/img]) to the XHTML equivelant.



Tags:

return:  An XHTML representation.
access:  private


[ Top ]

method getPermanentRelativeUrl [line 447]

string getPermanentRelativeUrl( )

Gets the permanent url to the news item relative to the site root.



Tags:

return:  An url path relative to the site root.
access:  private


[ Top ]

method getPermanentUrl [line 439]

string getPermanentUrl( )

Gets the premanent url to the news item.



Tags:

return:  An url path from the http host.
access:  private


[ Top ]

method getTimeAdded [line 208]

integer getTimeAdded( )

Gets the timestamp that represents when the news entry was added.



Tags:

return:  A unix timestamp.
access:  public


[ Top ]

method getTitleRelativeUrl [line 455]

string getTitleRelativeUrl( )

Gets the title url to the news item relative to the site root.



Tags:

return:  An url path relative to the site root.
access:  private


[ Top ]

method readRow [line 179]

void readRow( mixed $row)



Tags:

access:  protected
see:  com.lokorin.lokorin.TableEntry.readRow($row)


Overrides TableEntry::readRow() (Processes the contents of a retrieved row that describes the entry.)

[ Top ]

method updateProcessedEntry [line 413]

void updateProcessedEntry( )

Processes the raw form of the news entry and updates the processed form with the new version. This should be done whenever the entry changes.



Tags:

access:  public


[ Top ]

Documentation generated on Sun, 16 Apr 2006 21:03:44 +0200 by phpDocumentor 1.3.0RC4