PEAR マニュアル
前のページ次のページ

Structures_DataGrid::setDefaultSort()

Structures_DataGrid::setDefaultSort()  -- デフォルトの並べ替え条件を設定する

概要

require_once 'Structures/DataGrid.php';

mixed Structures_DataGrid::setDefaultSort (array $sortSpec)

説明

並べ替え条件が HTTP リクエストで指定されておらず、かつ sortRecordSet() メソッドもコールされていない場合、setDefaultSort() に渡した設定が用いられます。

これは、ユーザが最初にデータグリッドを見るときに すでに並べ替え済みであってほしい場合に有用です。

このメソッドは、bind() より先にコールする必要があります。

パラメータ

array $sortSpec

array(fieldName => direction, ...) で表した、並べ替えの設定。

返り値

true あるいは PEAR_Error オブジェクトを返します。

例外・エラー

例外はスローされません。

注意

この関数は、スタティックにコールする ことはできません。

前のページホーム次のページ
Structures_DataGrid::setDataSourceOptions()上に戻るStructures_DataGrid::setRenderer()