MantisBT
[ class tree: MantisBT ] [ index: MantisBT ] [ all elements ]

Class: MantisColumn

Source Location: /core/classes/MantisColumn.class.php

Class Overview


Base class that implements basic column functionality and integration with MantisBT.


Author(s):

Variables

Methods



Class Details

[line 25]
Base class that implements basic column functionality and integration with MantisBT.



Tags:

abstract:  


[ Top ]


Class Variables

$column =  null

[line 35]

Column name, as selected in the manage columns interfaces.



Tags:

access:  public

Type:   mixed


[ Top ]

$sortable =  false

[line 41]

Column is sortable by the user. Setting this to true implies that the column will properly implement the sortquery() method.



Tags:

access:  public

Type:   mixed


[ Top ]

$title =  null

[line 30]

Column title, as displayed to the user.



Tags:

access:  public

Type:   mixed


[ Top ]



Class Methods


method cache [line 58]

void cache( array $p_bugs)

Allow plugin columns to pre-cache data for all issues that will be shown in a given view. This is preferable to the alternative option of querying the database for each issue as the display() method is called.



Tags:

access:  public


Parameters:

array   $p_bugs   Bug objects

[ Top ]

method display [line 65]

void display( object Bug $p_bug, int $p_columns_target)

Function to display column data for a given bug row.



Tags:

abstract:  
access:  public


Parameters:

object Bug   $p_bug   object
int   $p_columns_target   Column display target

[ Top ]

method sortquery [line 49]

array sortquery( string $p_dir)

Build the SQL query elements 'join' and 'order' as used by core/filter_api.php to create the filter sorting query.



Tags:

return:  Keyed-array with query elements; see developer guide
access:  public


Parameters:

string   $p_dir   Sorting order ('ASC' or 'DESC')

[ Top ]


Documentation generated on Sun, 12 Dec 2010 23:50:41 +0900 by phpDocumentor 1.4.3
inserted by FC2 system