YaBB3::Sort - Sort Routines


Name

YaBB3::Sort - Sort Routines


Synopsis

Synopsis


Overview

Not meant to be instanciated and created objects from.


Description

Description


Reference

Use Packages

Exports

  Default   $VERSION
  Optional
  Tags

Package Fields

  $VERSION  The package version number as a float.

Package Subroutines

forumSort

  /@objects    [Opt] The array of object references to sort.
  $sort_below  [Opt] True if the sub-objects will also be sorted.
  Returns
  /@           The now sorted objects array, or undef if no arguments.

Sort and return the given array of objects. Optionally, the boards and categories array fields of each object can be recursively sorted.

ils_sort

  /@data      The array of objects to sort.
  $criteria1  Script to access the first field to compare.
  $criteria2  Script to access the second field to compare.
  $desc       True if the sort should be reversed.
  Returns
  @           A sorted array of the given objects.

!!! Deprecated !!! Do not use. An attempt to optimize the sorting of object arrays by comparing a field from each object. Each criteria argument is a script text that uses the $a and $b scalar object references, as in a sort() comparison subroutine, to access each object field to be compared, as in an eval(). The sort will use a numeric or text comparison operation depending on whether the majority of criteria1 fields are numeric or text.

Object Super Classes

Object Fields

Record Fields

Object Methods


Author

Copyright ©2002, YaBB 3 Development Team. All Rights Reserved.
You may distribute this module under the terms of YaBB 3.
 YaBB3::Sort - Sort Routines