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

Source Location: /_includes/lib_sitemap.php

Class Overview

TableEntry
   |
   --Sitemap

Describes a sitemap.


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 197]
Describes a sitemap.



Tags:

author:  Andreas Launila


[ Top ]

Class Variables

$backingTable =

[line 228]

The name of the database table that is backing the sitemap, if any. If no table is backing the sitemap then this variable should be empty. The sitemap should be invalidated if the backing table's contents is changed.



Tags:

access:  private

Type:   string


[ Top ]

$isValid =

[line 220]

Whether or not the XML contents is valid. Contents that is not valid should be regenerated rather than reused. True if the current XML contents is valid, false otherwise.



Tags:

access:  private

Type:   boolean


[ Top ]

$name =

[line 202]

The unqiue name of the sitemap.



Tags:

access:  private

Type:   string


[ Top ]

$timestampUpdated =

[line 208]

A unix timestamp that describes the point in time when the sitemap was last updated.



Tags:

access:  private

Type:   integer


[ Top ]

$xmlContents =

[line 213]

The actual XML document describing the sitemap.



Tags:

access:  private

Type:   string


[ Top ]


Class Methods

constructor __construct [line 237]

Sitemap __construct( string $name)

Constructs the sitemap.



Tags:

access:  public
throws:  IllegalArgumentException If the name is not a valid sitemap name.


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

Parameters:

string   $name   The unique name of the sitemap that should be constructed.

[ Top ]

method getAsElementForIndex [line 391]

string getAsElementForIndex( )

Gets the sitemap reference elemenet that should be used to represent the sitemap in sitemap indices.



Tags:

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


[ Top ]

method getAsXml [line 377]

string getAsXml( )

Gets the contents of the sitemap as an XML document as specified by the google sitemap schema.



Tags:

return:  A complete XML document.
access:  public


[ Top ]

method getFilesBody [line 358]

string getFilesBody( )

Gets the XML body contents for everything in the main menu.



Tags:

return:  A number of well formed XML elements.
access:  private


[ Top ]

method getName [line 411]

string getName( )

Gets the unique name of the sitemap.



Tags:

return:  A name that is unique for the sitemap.
access:  public


[ Top ]

method getNewsBody [line 328]

string getNewsBody( )

Gets the XML body contents for the news sitemap.



Tags:

return:  A number of well formed XML elements.
access:  private


[ Top ]

method getProjectsBody [line 343]

string getProjectsBody( )

Gets the XML body contents for the projects sitemap.



Tags:

return:  A number of well formed XML elements.
access:  private


[ Top ]

method getVirtualLocation [line 403]

string getVirtualLocation( )

Gets the virtual location for the sitemap.



Tags:

return:  A location, relative to the root, for the virtual sitemap.
access:  public


[ Top ]

method invalidate [line 262]

void invalidate( )

Invalidates the sitemape, causing it to be regenerated by the next time it's requested.



Tags:

access:  public


[ Top ]

method readRow [line 250]

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 update [line 277]

void update( )

Updates the sitemap with the latest available contents.



Tags:

access:  private


[ Top ]

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