Documentation

Sesha
in package

This is the base Sesha class.

Copyright 2004-2007 Andrew Coleman mercury@appisolutions.net Copyright 2007-2017 Horde LLC (http://www.horde.org/)

See the enclosed file LICENSE for license information (GPL). If you did not receive this file, see http://www.horde.org/licenses/gpl.

Tags
author

Andrew Coleman mercury@appisolutions.net

Table of Contents

SEARCH_ID  = 1
SEARCH_NAME  = 2
SEARCH_NOTE  = 4
SEARCH_PROPERTY  = 8
SORT_ASCEND  = 0
Sort in ascending order.
SORT_DESCEND  = 1
Sort in descending order.
SORT_NAME  = 101
Sort by stock name.
SORT_NOTE  = 102
Sort by stock note.
SORT_STOCKID  = 100
Sort by stock id.
getStringlistArray()  : array<string|int, mixed>
Returns a Hord_Form_Type_stringlist value split to an array.
isAdmin()  : mixed
listCategories()  : mixed
This function will return the list of available categories.
_rsortByName()  : int
Comparison function for reverse sorting stock by name.
_rsortByNote()  : int
Comparison function for reverse sorting stock by note.
_rsortByProperty()  : int
Comparison function for reverse sorting stock by a property.
_rsortByStockID()  : int
Comparison function for reverse sorting stock by id.
_sortByName()  : int
Comparison function for sorting inventory stock by name.
_sortByNote()  : int
Comparison function for sorting inventory stock by note.
_sortByProperty()  : int
Comparison function for sorting inventory stock by a property.
_sortByStockID()  : int
Comparison function for sorting inventory stock by id.

Constants

SEARCH_ID

public mixed SEARCH_ID = 1

SEARCH_NAME

public mixed SEARCH_NAME = 2

SEARCH_NOTE

public mixed SEARCH_NOTE = 4

SEARCH_PROPERTY

public mixed SEARCH_PROPERTY = 8

SORT_ASCEND

Sort in ascending order.

public mixed SORT_ASCEND = 0

SORT_DESCEND

Sort in descending order.

public mixed SORT_DESCEND = 1

SORT_NAME

Sort by stock name.

public mixed SORT_NAME = 101

SORT_NOTE

Sort by stock note.

public mixed SORT_NOTE = 102

SORT_STOCKID

Sort by stock id.

public mixed SORT_STOCKID = 100

Methods

getStringlistArray()

Returns a Hord_Form_Type_stringlist value split to an array.

public getStringlistArray(string $string) : array<string|int, mixed>
Parameters
$string : string

A comma separated string list.

Return values
array<string|int, mixed>

The string list as an array.

isAdmin()

public static isAdmin([mixed $permLevel = Horde_Perms::DELETE ]) : mixed
Parameters
$permLevel : mixed = Horde_Perms::DELETE
Return values
mixed

listCategories()

This function will return the list of available categories.

public listCategories() : mixed
Return values
mixed

Array of categories on success; PEAR_Error on failure.

_rsortByName()

Comparison function for reverse sorting stock by name.

protected _rsortByName(array<string|int, mixed> $a, array<string|int, mixed> $b) : int
Parameters
$a : array<string|int, mixed>

Item one.

$b : array<string|int, mixed>

Item two.

Return values
int

-1 if item one is greater, 1 if item two is greater; 0 if they are equal.

_rsortByNote()

Comparison function for reverse sorting stock by note.

protected _rsortByNote(array<string|int, mixed> $a, array<string|int, mixed> $b) : int
Parameters
$a : array<string|int, mixed>

Item one.

$b : array<string|int, mixed>

Item two.

Return values
int

-1 if item one is greater, 1 if item two is greater; 0 if they are equal.

_rsortByProperty()

Comparison function for reverse sorting stock by a property.

protected _rsortByProperty(array<string|int, mixed> $a, array<string|int, mixed> $b) : int
Parameters
$a : array<string|int, mixed>

Item one.

$b : array<string|int, mixed>

Item two.

Return values
int

-1 if item one is greater, 1 if item two is greater; 0 if they are equal.

_rsortByStockID()

Comparison function for reverse sorting stock by id.

protected _rsortByStockID(array<string|int, mixed> $a, array<string|int, mixed> $b) : int
Parameters
$a : array<string|int, mixed>

Item one.

$b : array<string|int, mixed>

Item two.

Return values
int

-1 if item one is greater, 1 if item two is greater; 0 if they are equal.

_sortByName()

Comparison function for sorting inventory stock by name.

protected _sortByName(array<string|int, mixed> $a, array<string|int, mixed> $b) : int
Parameters
$a : array<string|int, mixed>

Item one.

$b : array<string|int, mixed>

Item two.

Return values
int

1 if item one is greater, -1 if item two is greater; 0 if they are equal.

_sortByNote()

Comparison function for sorting inventory stock by note.

protected _sortByNote(array<string|int, mixed> $a, array<string|int, mixed> $b) : int
Parameters
$a : array<string|int, mixed>

Item one.

$b : array<string|int, mixed>

Item two.

Return values
int

1 if item one is greater, -1 if item two is greater; 0 if they are equal.

_sortByProperty()

Comparison function for sorting inventory stock by a property.

protected _sortByProperty(array<string|int, mixed> $a, array<string|int, mixed> $b) : int
Parameters
$a : array<string|int, mixed>

Item one.

$b : array<string|int, mixed>

Item two.

Return values
int

1 if item one is greater, -1 if item two is greater; 0 if they are equal.

_sortByStockID()

Comparison function for sorting inventory stock by id.

protected _sortByStockID(array<string|int, mixed> $a, array<string|int, mixed> $b) : int
Parameters
$a : array<string|int, mixed>

Item one.

$b : array<string|int, mixed>

Item two.

Return values
int

1 if item one is greater, -1 if item two is greater; 0 if they are equal.

Search results