com.lokorin.dfcrafters.lib
[ class tree: com.lokorin.dfcrafters.lib ] [ index: com.lokorin.dfcrafters.lib ] [ all elements ]

Class: Update

Source Location: /_includes/lib_updates.php

Class Overview

TableEntry
   |
   --Update

Describes an update. An update is a manifestation of a change to the site that viewers of the site should be aware of. An update belongs to an UpdateType.


Author(s):

  • Andreas Launila

Variables

Methods


Inherited Variables

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 286]
Describes an update. An update is a manifestation of a change to the site that viewers of the site should be aware of. An update belongs to an UpdateType.



Tags:

author:  Andreas Launila


[ Top ]


Class Variables

$displayText =

[line 309]

The text describing the specific update. This value will generally differ from each update instance.



Tags:

access:  private

Type:   string


[ Top ]

$linkId =

[line 303]

This is an identifier that is used when constructing links to the updated item. It is used in cojunction with the updater type's link format.



Tags:

access:  private

Type:   mixed


[ Top ]

$timestamp =

[line 296]

The unix timestamp of when the update was generated.



Tags:

access:  private

Type:   integer


[ Top ]

$updateType =

[line 291]

The unique identifier for the update type that the update belongs to.



Tags:

access:  private

Type:   integer


[ Top ]



Class Methods


constructor __construct [line 316]

Update __construct( integer $id)

Constructor for UpdateType.



Tags:

access:  public


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

Parameters:

integer   $id   The unique identifier for the update type that should be constructed.

[ Top ]

method getLink [line 351]

string getLink( )

Gets the XHTML link representing the update.



Tags:

return:  An XHTML compliant link.
access:  public


[ Top ]

method getTimestamp [line 335]

int getTimestamp( )

Gets the unix timestamp of when the update was generated.



Tags:

return:  A unix timestamp.
access:  public


[ Top ]

method getType [line 343]

UpdateType getType( )

Gets the update type connected with the update.



Tags:

return:  An type of update.
access:  public


[ Top ]

method readRow [line 324]

void readRow( mixed $row)



Tags:

access:  public
see:  com.lokorin.dfcrafters.includes.TableEntry($row)


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

[ Top ]


Documentation generated on Tue, 10 Jan 2006 17:06:38 +0100 by phpDocumentor 1.3.0RC4