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

Class: Category

Source Location: /_includes/lib_mplf_archive.php

Class Overview

TableEntry
   |
   --Category

Describes a link category.


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 358]
Describes a link category.



Tags:

author:  Andreas Launila


[ Top ]


Class Variables

$children =

[line 373]

The Category instances that are direct children to this instance.



Tags:

access:  private

Type:   array


[ Top ]

$description =

[line 368]

The description of the category.



Tags:

access:  private

Type:   string


[ Top ]

$name =

[line 363]

The name of the category.



Tags:

access:  private

Type:   string


[ Top ]



Class Methods


constructor __construct [line 379]

Category __construct( integer $id)

Constructor for Category.



Tags:

access:  public


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

Parameters:

integer   $id   The unique identifier to be used.

[ Top ]

method addChild [line 418]

void addChild( Category $childToAdd)

Adds a child (Category instance).



Tags:

access:  public


Parameters:

string   $childToAdd   The Category instance that should be added as child element.

[ Top ]

method getAssociatedFilters [line 435]

array getAssociatedFilters( )

Gets all filters associated with the category, e.g. all filters that have the category as their category.



Tags:

return:  Key is irrelevant, Value is Filter instance.
access:  public


[ Top ]

method getChildren [line 426]

array getChildren( )

Gets all the direct children instances.



Tags:

return:  Key is irrelevant, value is a Category instance.
access:  public


[ Top ]

method getDescription [line 409]

sring getDescription( )

Gets the description of the category.



Tags:

return:  A category description.
access:  public


[ Top ]

method getName [line 401]

string getName( )

Gets the name for the specific instance (not including parents).



Tags:

return:  A single category name.
access:  public


[ Top ]

method readRow [line 392]

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 ]


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