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: Project

Source Location: /_includes/lib_projects.php

Class Overview

TableEntry
   |
   --Project

Describes a project.


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 138]
Describes a project.



Tags:

author:  Andreas Launila


[ Top ]

Class Variables

$description =

[line 206]

A processed description in XHTML of what the project is about, it's goals and so on.



Tags:

access:  private

Type:   string


[ Top ]

$doDisplayInMenu =

[line 184]

Whether or not the project should be shown in the site's menu. True if the project should be shown, false otherwise.



Tags:

access:  private

Type:   boolean


[ Top ]

$hasDownloads =

[line 166]

Whether or not the project has any projects associated with it. True if the project has downloads, false otherwise.



Tags:

access:  private

Type:   boolean


[ Top ]

$hasSource =

[line 173]

Whether or not the project's source is available for download. True if the project has source available for download, false otherwise. If it is false then it's assumed that the source can be gotten through contact.



Tags:

access:  private

Type:   boolean


[ Top ]

$iconName =

[line 178]

The name of the icon image used to represent the project.



Tags:

access:  private

Type:   string


[ Top ]

$langId =

[line 149]

The unique identifier of the programming language that represents the project.



Tags:

access:  private

Type:   integer


[ Top ]

$langVersion =

[line 154]

The language version that the project usues.



Tags:

access:  private

Type:   string


[ Top ]

$license =

[line 200]

The license if any that the project is released under. The license information should be in the form of XHTML code.



Tags:

access:  private

Type:   string


[ Top ]

$name =

[line 143]

The name of the project.



Tags:

access:  private

Type:   string


[ Top ]

$pageDescription =

[line 217]

The description that the project pages should have.



Tags:

access:  private

Type:   string


[ Top ]

$path =

[line 160]

The path from the root to the projects directory. Alternativly an absolute url starting with 'http://' can be specified.



Tags:

access:  private

Type:   string


[ Top ]

$stageId =

[line 189]

The unique identifier for the stage that the project is currently at.



Tags:

access:  private

Type:   integer


[ Top ]

$timeProcessed =

[line 212]

The timestamp describing the point in time when the description was last processed.



Tags:

access:  private

Type:   integer


[ Top ]

$timestamp =

[line 194]

The unix timestamp that represents when the project was added.



Tags:

access:  private

Type:   integer


[ Top ]


Class Methods

constructor __construct [line 223]

Project __construct( integer $id)

Constructor for Project.



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

Parameters:

integer   $id   The unique identifier for the project.

[ Top ]

method getAsSitemapEntries [line 617]

string getAsSitemapEntries( )

Gets the project, and all its subpages, as a sitemap entries.



Tags:

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


[ Top ]

method getDescriptionAsHtml [line 578]

string getDescriptionAsHtml( )

Gets the project's description as valid XHTML code.



Tags:

return:  XHTML compliant code.
access:  private


[ Top ]

method getDownloadsGroupedByCategory [line 479]

array getDownloadsGroupedByCategory( )

Gets all download items that are connected to the project. The items are grouped by their respective category. The categories should if possible be displayed in the order that they are given.



Tags:

return:  An array where the key is a DownloadCategory instance and the corresponding value is an array of DownloadItem instances, where each such instance represents a downloadable item in the category.
access:  public


[ Top ]

method getImages [line 494]

array getImages( )

Gets all images, and their descriptions, that are connected to the project.



Tags:

return:  The name of the image as key and the description that is connected to the image as value.
access:  public


[ Top ]

method getInfo [line 358]

string getInfo( )

Gets a summary of all information available on the project.



Tags:

return:  XHTML compliant code representing all information on the project.
access:  public


[ Top ]

method getLicense [line 570]

string getLicense( )

Gets information about the license under which the project is released.



Tags:

return:  The license information as valid XHTML code.
access:  public


[ Top ]

method getLink [line 275]

string getLink( )

Gets the link representation for the project. If the project has an icon then it is used to represent the project, otherwise a text link is used.



Tags:

return:  An XHTML compliant link representation.
access:  public


[ Top ]

method getMenu [line 410]

string getMenu( )

Gets the submenu connected with the project, i.e. a menu for all pages in the project.



Tags:

return:  XHTML compliant code representing the menu.
access:  public


[ Top ]

method getName [line 349]

string getName( )

Gets the name of the project.



Tags:

return:  A name.
access:  public


[ Top ]

method getNews [line 512]

array getNews( )

Gets all news entries that are connected to the project.



Tags:

return:  Each entry represents a news item. The items are ordered so that the news item with the timestamp is first.
access:  public


[ Top ]

method getNewsSqlSelector [line 521]

string getNewsSqlSelector( )

Gets an sql selector that selects all news that are connected to the project from the news table.



Tags:

return:  An sql selector.
access:  public


[ Top ]

method getPageDescription [line 638]

string getPageDescription( )

Gets the page description that should be used when displaying a page that is related to this project.



Tags:

return:  A brief description.
access:  public


[ Top ]

method getPath [line 466]

string getPath( )

Gets the path from the site's root to the home directory of the project.



Tags:

return:  A path relative to the root.
access:  public


[ Top ]

method getProgrammingLanguage [line 304]

ProgrammingLanguage getProgrammingLanguage( )

Gets the programming language used in the project.



Tags:

return:  The ProgrammingLanguage instance that represents the used language.
access:  public


[ Top ]

method getRssHeaderLink [line 534]

string getRssHeaderLink( )

Gets the header link to the RSS page for the project's news.



Tags:

return:  XHTML compliant code that describes a header link (which should only be placed in the header portion of the page).
access:  public


[ Top ]

method getRssPath [line 544]

string getRssPath( )

Gets the path to the RSS feed for the project's news.



Tags:

return:  A path, relative to the site's root, to the project's news RSS feed.
access:  public


[ Top ]

method getStage [line 313]

Stage getStage( )

Gets the stage that the project is currently at.



Tags:

return:  The Stage instance that represents the current Stage.
access:  public


[ Top ]

method getSubmenu [line 552]

ProjectMenu getSubmenu( )

Gets the submenu of the project.



Tags:

return:  A project submenu.
access:  public


[ Top ]

method getSynopsis [line 325]

string getSynopsis( )

Gets a short synopsis of the project. The synopsis consists of the name and link to the project along with a list with the following information: language (and version), when it was started, current stage and a short description.



Tags:

return:  XHTML compliant code representing a short synopsis of the project.
access:  public


[ Top ]

method hasMenu [line 455]

boolean hasMenu( )

Whether or not the project has a menu.



Tags:

return:  True if the project has a menu, false otherwise.
access:  public


[ Top ]

method isMenuDisplayable [line 562]

boolean isMenuDisplayable( )

Checks if the project should be displayed in the menu.



Tags:

return:  True if the project should be displayed in the navigational menu, false otherwise.
access:  public


[ Top ]

method readRow [line 246]

void readRow( mixed $row)



Tags:

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


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

[ Top ]

method updateProcessedDescription [line 590]

void updateProcessedDescription( )

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



Tags:

access:  public


[ Top ]

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