POT
POT
POT
Main menu

Download

Forum

SVN

Class: OTS_Bans_List

Source Location: /classes/OTS_Bans_List.php

Class OTS_Bans_List

Class Overview

List of all bans.

List of all bans.

Located in /classes/OTS_Bans_List.php [line 19]

OTS_Base_List
   |
   --OTS_Bans_List
Author(s):
Information Tags:
Version:  0.1.5
Since:  0.1.5

Methods

[ Top ]
Descendants
Child Class Description
OTS_IPBans_List List of IP bans.
OTS_PlayerBans_List List of player bans.
OTS_AccountBans_List List of account bans.

[ Top ]
Inherited Properties, Constants, and Methods
Inherited Properties Inherited Methods Inherited Constants

Inherited From OTS_Base_List

OTS_Base_List::$class
OTS_Base_List::$db
OTS_Base_List::$rows
OTS_Base_List::$table

Inherited From OTS_Base_List

OTS_Base_List::__construct()
Sets database connection handler.
OTS_Base_List::count()
Returns number of rows on list in current criterium.
OTS_Base_List::current()
Returns current row.
OTS_Base_List::getSQL()
Returns SQL query for SELECT.
OTS_Base_List::init()
Sets list parameters.
OTS_Base_List::key()
Current cursor position.
OTS_Base_List::next()
Moves to next row.
OTS_Base_List::orderBy()
Appends sorting rule.
OTS_Base_List::prepareSQL()
Returns generic SQL query that can be adaptated by child classes.
OTS_Base_List::resetOrder()
Clears ORDER BY clause.
OTS_Base_List::rewind()
Select rows from database.
OTS_Base_List::setFilter()
Sets filter on list.
OTS_Base_List::setLimit()
Sets LIMIT clause.
OTS_Base_List::setOffset()
Sets OFFSET clause.
OTS_Base_List::valid()
Checks if there are any rows left.
OTS_Base_List::__set()
Magic PHP5 method.
OTS_Base_List::__set_state()
Magic PHP5 method.
OTS_Base_List::__sleep()
Magic PHP5 method.
OTS_Base_List::__wakeup()
Magic PHP5 method.

[ Top ]
Method Summary
OTS_Ban   current()   Returns current row.
string   getSQL()   Returns SQL query for SELECT.
void   init()   Sets list parameters.
void   rewind()   Overwrites generic query.

[ Top ]
Methods
current  [line 85]

  OTS_Ban current( )

Returns current row.

Returns current row. Returns object of class which handle single row representation. Object is initialised with ID of current position in result cursor.


API Tags:
Return:  Current row.
Access:  public

Information Tags:
Version:  0.1.5
Since:  0.1.5

Redefinition of:
OTS_Base_List::current()
Returns current row.

[ Top ]
getSQL  [line 56]

  string getSQL( [bool $count = false]  )

Returns SQL query for SELECT.

Returns SQL query for SELECT.

Parameters:
bool   $count:  Shows if the SQL should be generated for COUNT() variant.

API Tags:
Return:  SQL query part.
Access:  protected

Information Tags:
Version:  0.1.5
Since:  0.1.5

Redefinition of:
OTS_Base_List::getSQL()
Returns SQL query for SELECT.

[ Top ]
init  [line 31]

  void init( )

Sets list parameters.

Sets list parameters. This method is called at object creation.


API Tags:
Access:  public

Information Tags:
Version:  0.1.5
Since:  0.1.5

Redefinition of:
OTS_Base_List::init()
Sets list parameters.

[ Top ]
rewind  [line 43]

  void rewind( )

Overwrites generic query.

Overwrites generic query.


API Tags:
Access:  public

Information Tags:
Version:  0.1.5
Throws:  PDOException On PDO operation error.
Since:  0.1.5

Redefinition of:
OTS_Base_List::rewind()
Select rows from database.

[ Top ]