MDB2_TableBrowser
[ class tree: MDB2_TableBrowser ] [ index: MDB2_TableBrowser ] [ all elements ]
Packages:
MDB2_TableBrowser


Classes:
MDB2_TableBrowser
MDB2_TableBrowser_ColumnManager
MDB2_TableBrowser_DBException
MDB2_TableBrowser_FilterManager
MDB2_TableBrowser_GroupByManager
MDB2_TableBrowser_MultipleFilterManager
MDB2_TableBrowser_OrderByManager
MDB2_TableBrowser_ParameterException
MDB2_TableBrowser_Single
MDB2_TableBrowser_TableValidator
Files:
ColumnManager.php
DBException.php
example.php
FilterManager.php
GroupByManager.php
Interfaces.php
MultipleFliterManager.php
OrderByManager.php
ParameterException.php
Single.php
TableBrowser.php
TableValidator.php

Class: MDB2_TableBrowser_InterfaceSelectClauseGenerator

Source Location: /MDB2_TableBrowser-0.1.3/MDB2/TableBrowser/Interfaces.php

Class Overview

MDB2_TableBrowser_InterfaceSQLGenerator
   |
   --MDB2_TableBrowser_InterfaceSelectClauseGenerator

This interface defines a behaviour that includes generating all or part of the 'select' clause in an sql statement


Author(s):

Version:

  • Release: <package_version>

Copyright:

  • 2007-2012 Isaac Tewolde

Methods

Inherited Variables

Inherited Methods

Class: MDB2_TableBrowser_InterfaceSQLGenerator

MDB2_TableBrowser_InterfaceSQLGenerator::generateSQL()
Producers part or all of an sql statement

Class Details

[line 170]
This interface defines a behaviour that includes generating all or part of the 'select' clause in an sql statement


[ Top ]

Method Detail

addCustomColumn   [line 238]

void addCustomColumn( string $colName, [string $alias = null])

Adds a custom column to the table_browser. Used for columns that are a function and not a tableColumn
  • Access: public

Parameters:

string   $colName   —  The column (case sensitive)
string   $alias   —  An alias for the column(optional)

[ Top ]

getColumnAlias   [line 218]

string getColumnAlias( string $colName)

Gets a column alias
  • Return: The column alias
  • Access: public

Parameters:

string   $colName   —  The column Name

[ Top ]

getRealColumnName   [line 228]

string getRealColumnName( string $alias)

Returns the actual column name given an alias. It will simply return the columnName if it is being passed the columnName instead of an alias.
  • Return: The real column name
  • Access: public

Parameters:

string   $alias   —  The column alias

[ Top ]

removeColumnAlias   [line 210]

void removeColumnAlias( string $colName)

Removes a column alias
  • Access: public

Parameters:

string   $colName   —  The column Name

[ Top ]

removeCustomColumn   [line 246]

void removeCustomColumn( string $colName)

Removes a custom column
  • Access: public

Parameters:

string   $colName   —  The column (case sensitive)

[ Top ]

resetColumAliases   [line 202]

void resetColumAliases( )

Removes all column aliases
  • Access: public

[ Top ]

resetSelectColumns   [line 186]

void resetSelectColumns( )

Resets the column selections
  • Access: public

[ Top ]

selectColumns   [line 180]

void selectColumns( array $colNames)

Selects the columns that will be included in the select clause
  • Throws: MDB2_TableBrowser_ParameterException if column is invalid
  • Access: public

Parameters:

array   $colNames   —  The columns to be included in the select clause

[ Top ]

setColumnAlias   [line 196]

void setColumnAlias( string $colName, string $alias)

Sets an alias for the sepecified column
  • Throws: MDB2_TableBrowser_ParameterException if column is invalid
  • Access: public

Parameters:

string   $colName   —  The column name
string   $alias   —  The column alias

[ Top ]
Documentation generated on Mon, 11 Mar 2019 15:48:25 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.