ZenMagick 0.9.10

Frames No frames
Summary: Field | Method | Constr Detail: Field | Method | Constr
org.zenmagick.mvc.resultlist.options\ZMSortOption
mvc\resultlist\options\ZMSortOption.php at line 33

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
Fields inherited from org.zenmagick.core\ZMObject
properties_
Method Summary
void

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

Create a new sort option.
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
__construct, attachMethod, get, getAttachedMethods, getProperties, getPropertyNames, set, singleton

Method Detail

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

__construct

public void __construct(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.
mvc\resultlist\options\ZMSortOption.php at line 70

getId

public string getId()

Get the option id.

Returns:
The option id.
mvc\resultlist\options\ZMSortOption.php at line 84

getName

public string getName()

Get the option name.

Returns:
The option name.
mvc\resultlist\options\ZMSortOption.php at line 77

getReverseId

public string getReverseId()

Get the reverse option id.

Returns:
The reverse option id.
mvc\resultlist\options\ZMSortOption.php at line 91

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 99

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.10

Frames No frames
Summary: Field | Method | Constr Detail: Field | Method | Constr