PHP Класс BaseList

This class has been auto-generated by the Doctrine ORM Framework
Автор: Pierre Boitel, Bastien Libersa, Paul Périé
Наследование: extends sfDoctrineRecord
Показать файл Открыть проект Примеры использования класса

Защищенные свойства (Protected)

Свойство Тип Описание
$admin string
$beforeRender boolean
$clickable boolean
$colVis boolean
$cols array
$defaultSorting string
$defaultSortingDir string
$filters array
$hidden array
$id string
$ignoredCols array
$inUseColumn integer
$items array
$model mixed
$notSortable array
$order boolean
$renderTable boolean
$search boolean
$searchCols array
$web string

Открытые методы

Метод Описание
FormatFileSize ( integer $size ) : string Get human readable filesize
__construct ( )
addSDom ( string $id ) : void Add sDom element
beforeRender ( ) : void Renders list id
doApprove ( array $ids ) : boolean Handle approve
doData ( ) : array Data provider
doDelete ( array $ids ) : boolean Handle delete
doDisapprove ( array $ids ) : boolean Handle disapprove
getContextSDom ( ) : string Get Context Box sDom property.
getCount ( string $from = NULL ) : integer Get db rows count
getId ( ) : string Get list id
getSDom ( ) : string Get sDom property.
getSorting ( ) : string Get default sorting
processItem ( mixed $item ) : mixed Process item
processRow ( array $row ) : array Process db row
render ( ) : ArticleList Render table.
setClickable ( boolean $clickable = TRUE ) : BaseList Set links clickable
setColVis ( boolean $colVis = FALSE ) : ArticleList Set ColVis.
setHidden ( integer | string $key ) : ArticleList Set column to be hidden.
setItems ( array $items ) : ArticleList Set items.
setOrder ( boolean $order = FALSE ) : ArticleList Set order.
setSearch ( boolean $search = FALSE ) : ArticleList Set search.

Защищенные методы

Метод Описание
getArgs ( ) : array Get function arguments
getPath ( string $filename ) : string | null Get path for file - try in subclass folder, fallback in baseclass folder

Описание методов

FormatFileSize() публичный статический Метод

Get human readable filesize
public static FormatFileSize ( integer $size ) : string
$size integer
Результат string

__construct() публичный Метод

public __construct ( )

addSDom() публичный Метод

Add sDom element
public addSDom ( string $id ) : void
$id string
Результат void

beforeRender() публичный Метод

Renders list id
public beforeRender ( ) : void
Результат void

doApprove() публичный Метод

Handle approve
public doApprove ( array $ids ) : boolean
$ids array
Результат boolean

doData() публичный Метод

Data provider
public doData ( ) : array
Результат array

doDelete() публичный Метод

Handle delete
public doDelete ( array $ids ) : boolean
$ids array
Результат boolean

doDisapprove() публичный Метод

Handle disapprove
public doDisapprove ( array $ids ) : boolean
$ids array
Результат boolean

getArgs() закрытый защищенный Метод

Get function arguments
final protected getArgs ( ) : array
Результат array

getContextSDom() публичный Метод

Get Context Box sDom property.
public getContextSDom ( ) : string
Результат string

getCount() публичный Метод

Get db rows count
public getCount ( string $from = NULL ) : integer
$from string
Результат integer

getId() публичный Метод

Get list id
public getId ( ) : string
Результат string

getPath() закрытый защищенный Метод

Get path for file - try in subclass folder, fallback in baseclass folder
final protected getPath ( string $filename ) : string | null
$filename string
Результат string | null

getSDom() публичный Метод

Get sDom property.
public getSDom ( ) : string
Результат string

getSorting() публичный Метод

Get default sorting
public getSorting ( ) : string
Результат string

processItem() публичный Метод

Process item
public processItem ( mixed $item ) : mixed
$item mixed
Результат mixed

processRow() публичный Метод

Process db row
public processRow ( array $row ) : array
$row array
Результат array

render() публичный Метод

Render table.
public render ( ) : ArticleList
Результат ArticleList

setClickable() публичный Метод

Set links clickable
public setClickable ( boolean $clickable = TRUE ) : BaseList
$clickable boolean
Результат BaseList

setColVis() публичный Метод

Set ColVis.
public setColVis ( boolean $colVis = FALSE ) : ArticleList
$colVis boolean
Результат ArticleList

setHidden() публичный Метод

Set column to be hidden.
public setHidden ( integer | string $key ) : ArticleList
$key integer | string
Результат ArticleList

setItems() публичный Метод

Set items.
public setItems ( array $items ) : ArticleList
$items array
Результат ArticleList

setOrder() публичный Метод

Set order.
public setOrder ( boolean $order = FALSE ) : ArticleList
$order boolean
Результат ArticleList

setSearch() публичный Метод

Set search.
public setSearch ( boolean $search = FALSE ) : ArticleList
$search boolean
Результат ArticleList

Описание свойств

$admin защищенное свойство

protected string $admin
Результат string

$beforeRender защищенное свойство

protected bool $beforeRender
Результат boolean

$clickable защищенное свойство

protected bool $clickable
Результат boolean

$colVis защищенное свойство

protected bool $colVis
Результат boolean

$cols защищенное свойство

protected array $cols
Результат array

$defaultSorting защищенное свойство

protected string $defaultSorting
Результат string

$defaultSortingDir защищенное свойство

protected string $defaultSortingDir
Результат string

$filters защищенное свойство

protected array $filters
Результат array

$hidden защищенное свойство

protected array $hidden
Результат array

$id защищенное свойство

protected string $id
Результат string

$ignoredCols защищенное свойство

protected array $ignoredCols
Результат array

$inUseColumn защищенное свойство

protected int $inUseColumn
Результат integer

$items защищенное свойство

protected array $items
Результат array

$model защищенное свойство

protected mixed $model
Результат mixed

$notSortable защищенное свойство

protected array $notSortable
Результат array

$order защищенное свойство

protected bool $order
Результат boolean

$renderTable защищенное статическое свойство

protected static bool $renderTable
Результат boolean

$searchCols защищенное свойство

protected array $searchCols
Результат array

$web защищенное свойство

protected string $web
Результат string