ZenMagick 0.9.8


org.zenmagick.mvc.resultlist.options.ZMSortOption
\mvc\resultlist\options\ZMSortOption.php at line 34

Class ZMSortOption

ZMObject
└─ZMSortOption

public class ZMSortOption
extends ZMObject

A single sort option.

The returned id will automatically reflect the current status, the id the sort order.

Author:
DerManoMann
Version:
$Id: ZMSortOption.php 2610 2009-11-20 02:45:25Z dermanomann $

Fields inherited from org.zenmagick.core.ZMObject
properties_
Constructor Summary

ZMSortOption(string name, int id, boolean active, boolean decending)

Create a new sort option.

Method Summary
string

getId()

Get the option id.

string

getName()

Get the option name.

string

getReverseId()

Get the reverse option id.

boolean

isActive()

Check if this option is active.

boolean

isDecending()

Check if the sorting is ascending or decending.

Methods inherited from org.zenmagick.core.ZMObject
attachMethod, get, getAttachedMethods, getPropertyNames, set, singleton

Constructor Detail

\mvc\resultlist\options\ZMSortOption.php at line 49

ZMSortOption

public ZMSortOption(string name, int id, boolean active, boolean decending)

Create a new sort option.

Parameters:
name - The option name.
id - The option id.
active - Optional active flag if this option is currently active.
decending - Ascending/decending flag (default is ascending.

Method Detail

\mvc\resultlist\options\ZMSortOption.php at line 71

getId

public string getId()

Get the option id.

Returns:
The option id.

\mvc\resultlist\options\ZMSortOption.php at line 85

getName

public string getName()

Get the option name.

Returns:
The option name.

\mvc\resultlist\options\ZMSortOption.php at line 78

getReverseId

public string getReverseId()

Get the reverse option id.

Returns:
The reverse option id.

\mvc\resultlist\options\ZMSortOption.php at line 92

isActive

public boolean isActive()

Check if this option is active.

Returns:
true if this option is active, false, if not.

\mvc\resultlist\options\ZMSortOption.php at line 100

isDecending

public boolean isDecending()

Check if the sorting is ascending or decending.

Returns:
true if sorting is decending, false if sorting is ascending.

ZenMagick 0.9.8