PHP Class BaseList

This class has been auto-generated by the Doctrine ORM Framework
Author: Pierre Boitel, Bastien Libersa, Paul Périé
Inheritance: extends sfDoctrineRecord
Show file Open project: sourcefabric/newscoop Class Usage Examples

Protected Properties

Property Type Description
$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

Public Methods

Method Description
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.

Protected Methods

Method Description
getArgs ( ) : array Get function arguments
getPath ( string $filename ) : string | null Get path for file - try in subclass folder, fallback in baseclass folder

Method Details

FormatFileSize() public static method

Get human readable filesize
public static FormatFileSize ( integer $size ) : string
$size integer
return string

__construct() public method

public __construct ( )

addSDom() public method

Add sDom element
public addSDom ( string $id ) : void
$id string
return void

beforeRender() public method

Renders list id
public beforeRender ( ) : void
return void

doApprove() public method

Handle approve
public doApprove ( array $ids ) : boolean
$ids array
return boolean

doData() public method

Data provider
public doData ( ) : array
return array

doDelete() public method

Handle delete
public doDelete ( array $ids ) : boolean
$ids array
return boolean

doDisapprove() public method

Handle disapprove
public doDisapprove ( array $ids ) : boolean
$ids array
return boolean

getArgs() final protected method

Get function arguments
final protected getArgs ( ) : array
return array

getContextSDom() public method

Get Context Box sDom property.
public getContextSDom ( ) : string
return string

getCount() public method

Get db rows count
public getCount ( string $from = NULL ) : integer
$from string
return integer

getId() public method

Get list id
public getId ( ) : string
return string

getPath() final protected method

Get path for file - try in subclass folder, fallback in baseclass folder
final protected getPath ( string $filename ) : string | null
$filename string
return string | null

getSDom() public method

Get sDom property.
public getSDom ( ) : string
return string

getSorting() public method

Get default sorting
public getSorting ( ) : string
return string

processItem() public method

Process item
public processItem ( mixed $item ) : mixed
$item mixed
return mixed

processRow() public method

Process db row
public processRow ( array $row ) : array
$row array
return array

render() public method

Render table.
public render ( ) : ArticleList
return ArticleList

setClickable() public method

Set links clickable
public setClickable ( boolean $clickable = TRUE ) : BaseList
$clickable boolean
return BaseList

setColVis() public method

Set ColVis.
public setColVis ( boolean $colVis = FALSE ) : ArticleList
$colVis boolean
return ArticleList

setHidden() public method

Set column to be hidden.
public setHidden ( integer | string $key ) : ArticleList
$key integer | string
return ArticleList

setItems() public method

Set items.
public setItems ( array $items ) : ArticleList
$items array
return ArticleList

setOrder() public method

Set order.
public setOrder ( boolean $order = FALSE ) : ArticleList
$order boolean
return ArticleList

setSearch() public method

Set search.
public setSearch ( boolean $search = FALSE ) : ArticleList
$search boolean
return ArticleList

Property Details

$admin protected property

protected string $admin
return string

$beforeRender protected property

protected bool $beforeRender
return boolean

$clickable protected property

protected bool $clickable
return boolean

$colVis protected property

protected bool $colVis
return boolean

$cols protected property

protected array $cols
return array

$defaultSorting protected property

protected string $defaultSorting
return string

$defaultSortingDir protected property

protected string $defaultSortingDir
return string

$filters protected property

protected array $filters
return array

$hidden protected property

protected array $hidden
return array

$id protected property

protected string $id
return string

$ignoredCols protected property

protected array $ignoredCols
return array

$inUseColumn protected property

protected int $inUseColumn
return integer

$items protected property

protected array $items
return array

$model protected property

protected mixed $model
return mixed

$notSortable protected property

protected array $notSortable
return array

$order protected property

protected bool $order
return boolean

$renderTable protected static property

protected static bool $renderTable
return boolean

$searchCols protected property

protected array $searchCols
return array

$web protected property

protected string $web
return string