b2evolution

Multilingual multiuser multiblog engine

b2evolution Technical Documentation (Version 1.8) [ class tree: evocore ] [ index: evocore ] [ all elements ]

Procedural File: _resultsel.class.php

Source Location: /blogs/inc/_misc/_resultsel.class.php

Page Details

This file implements the ResultSel class.

This file is part of the evoCore framework - http://evocore.net/ See also http://sourceforge.net/projects/evocms/.

Author:  fsaya: Fabrice SAYA-GASNIER / PROGIDISTRI
Author:  fplanque: Francois PLANQUE
Version:  $Id: _resultsel.class.php,v 1.4.2.2 2006/06/16 21:20:09 fplanque Exp $
Copyright:  

(c)2003-2006 by Francois PLANQUE - http://fplanque.net/ Parts of this file are copyright (c)2005-2006 by PROGIDISTRI - http://progidistri.com/.

Filesource:  Source Code for this file
Classes
Class Description
ResultSel ResultSel class: displays Results and provides Selection capabilities
Includes
require_once (dirname(__FILE__).'/_results.class.php') [line 40]

Includes:

[ Top ]


Functions
cols_check  [line 224]

void cols_check( the $selection_ID, the $sel_table, the $sel_table_item, the $sel_table_selection  )

Sets the cols_check global variable to verify if checkboxes have to be checked in the result set

Parameters:
the   $selection_ID:  selection ID
the   $sel_table:  name of the attachment table (which links the items and the selections
the   $sel_table_item:  item id field
the   $sel_table_selection:  selection id field


[ Top ]
handle_selection_actions  [line 365]

void handle_selection_actions( integer $selection_ID, string $prefix, string $prefix_sel  )

Handle selection action

Determine if we need to perform an action to the current selection and do it in this case.

Parameters:
integer   $selection_ID:  the current selection id
string   $prefix:  prefix (cont_, etab_, firm_, ..)
string   $prefix_sel:  selection prefix (cocs_, etes_, fifs_, ..)


[ Top ]
selection_action  [line 398]

void selection_action( string $action, integer $selection_ID, string $selection_name, string $prefix, string $prefix_sel  )

Manages the various database changes to make on selections

Parameters:
string   $action:  the action currently effectuated
integer   $selection_ID:  the current selection id
string   $selection_name:  the current selection name
string   $prefix:  prefix (cont_, etab_, firm_, ..)
string   $prefix_sel:  selection prefix (cocs_, etes_, fifs_, ..)


[ Top ]
selection_checkbox  [line 252]

string selection_checkbox( integer $item_ID, string $param_prefix  )

Display a checkbox allowing to add the item to a selection

Only one checkbox will be displayed for each ID. IDs which are already in the selection will be pre-checked.

Parameters:
integer   $item_ID:  item ID
string   $param_prefix:  item name / prefix for form values

API Tags:
Return:  the correct input tag
Deprecated:  should go into ResultSel class


[ Top ]
selection_select_tag  [line 303]

void selection_select_tag( string $category_prefix, string $selections_table, string $selections_table_name, string $selections_table_ID, integer $selection_ID  )

Creates the select tag in the search menu and fills it with the appropriate option tags

Parameters:
string   $category_prefix:  the selection category prefix(the one used during the construction of the result object)
string   $selections_table:  the name of the table containing the selections
string   $selections_table_name:  the name field in the selection table
string   $selections_table_ID:  the id field in the selection table
integer   $selection_ID:  the current selection id


[ Top ]


Documentation generated on Tue, 18 Dec 2007 23:22:05 +0100 by phpDocumentor 1.4.0