com.lokorin.dfcrafters.lib
[ class tree: com.lokorin.dfcrafters.lib ] [ index: com.lokorin.dfcrafters.lib ] [ all elements ]
Packages:
com.lokorin.dfcrafters.lib
com.lokorin.dfcrafters.admin
com.lokorin.dfcrafters.cache
com.lokorin.dfcrafters.includes
com.lokorin.dfcrafters.public
com.lokorin.dfcrafters.public.articles
com.lokorin.dfcrafters.public.contact
com.lokorin.dfcrafters.public.news
com.lokorin.dfcrafters.public.updates


Files:
lib_abbreviations.php
lib_admin.php
lib_admin_panel.php
lib_articles.php
lib_authors.php
lib_calendar.php
lib_counters.php
lib_css.php
lib_db.php
lib_displayer.php
lib_errors.php
lib_events.php
lib_event_digest.php
lib_forms.php
lib_images.php
lib_menu.php
lib_news.php
lib_redirects.php
lib_search.php
lib_tables.php
lib_updates.php
lib_util.php

Classes:
AbbreviationHandler
AbstractTableDisplayer
AddModule
AdminAction
AdminModule
AdminPanel
AliasCalendar
Article
Author
Browse
Button
Calendar
CallbackModule
Checkbox
Comment
Counter
CssHandler
CustomSearch
CustomTableDisplayer
DateField
DB
DeleteModule
DetailsModule
EditModule
EqualSearch
Field
FileNotFoundException
Form
FulltextSearch
GreaterEqualSearch
GreaterSearch
HeadAddable
Header
Hidden
IllegalArgumentException
IOException
LesserEqualSearch
LesserSearch
LikeSearch
MenuItem
News
NoSuchElementException
Page
PasswordField
ReadOnly
ResetButton
SearchField
Select
SizedField
SubmitButton
Table
TableDisplayer
TableEntry
TableField
TableSearcher
TextArea
TextField
TimedEvent
TimeField
Update
UpdateModule
UpdateType
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 133]
Describes a news item.



Tags:

author:  Andreas Launila


[ Top ]

Class Variables

$authorId =

[line 153]

The unique identifier of the author.



Tags:

access:  private

Type:   integer


[ Top ]

$caption =

[line 138]

The caption of the news item.



Tags:

access:  private

Type:   string


[ Top ]

$entry =

[line 148]

The actual processed XHTML entry of the news item.



Tags:

access:  private

Type:   string


[ Top ]

$timestamp =

[line 143]

The UNIX timestamp of when the news was submitted.



Tags:

access:  private

Type:   integer


[ Top ]


Class Methods

constructor __construct [line 159]

News __construct( integer $id)

Constructor for News.



Tags:

access:  public


Overrides TableEntry::__construct() (Constructor for TableEntry.)

Parameters:

integer   $id   The unique identifier of the news entry.

[ Top ]

method getAsHTMLComment [line 218]

string getAsHTMLComment( )

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



Tags:

return:  An XHTML compliant representation.
access:  public


[ Top ]

method getAsHTMLGeneric [line 200]

string getAsHTMLGeneric( )

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



Tags:

return:  An XHTML compliant representation.
access:  public


[ Top ]

method getAsHTMLIndex [line 271]

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 238]

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 getAsRSS [line 296]

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 getAssociatedComments [line 438]

array getAssociatedComments( )

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



Tags:

return:  An array of Comment instances.
access:  public


[ Top ]

method getAuthor [line 464]

Author getAuthor( )

Gets the author of the new item.



Tags:

return:  An instance representing the author.
access:  public


[ Top ]

method getCaption [line 183]

string getCaption( )

Gets the caption of the news entry.



Tags:

return:  A news caption.
access:  public


[ Top ]

method getCommentLink [line 454]

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 430]

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 311]

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 getPermanentUrl [line 422]

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 191]

integer getTimeAdded( )

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



Tags:

return:  A unix timestamp.
access:  public


[ Top ]

method readRow [line 172]

void readRow( mixed $row)



Tags:

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


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

[ Top ]

method updateProcessedEntry [line 322]

void updateProcessedEntry( )

Processes the raw form the 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 Tue, 10 Jan 2006 17:06:34 +0100 by phpDocumentor 1.3.0RC4