<commit_before><?php
/**
 * @version		$Id$
 * @package		phpFrame
 * @subpackage 	database
 * @copyright	Copyright (C) 2009 E-noise.com Limited. All rights reserved.
 * @license		BSD revised. See LICENSE.
 */

defined( '_EXEC' ) or die( 'Restricted access' );

/**
 * Collection Filter Class
 * 
 * The "Row collection filter" class is used to create objects that are then used 
 * when creating "row collections". Collection filter objects are responsible for 
 * encapsulating SQL select filtering conditions (ORDER BY and LIMIT clauses).
 * 
 * This objects are also used by the pagination objects, as they will need to work 
 * with the "limit" properties (limit, limitstart, pages, curreny pages and so on).
 * 
 * Collection filter objects are normally instantated passing them values coming 
 * from the request, so the natural place to instantiate them is in concrete action 
 * controller classes. Action controllers are responsible for brokering request data,
 * so they use this data to create  a list or collection filter that then will be 
 * passed to a model method responsible for creating a "row collection".
 * 
 *  Example:
 *  
 *  <code>
 *  class usersController extends phpFrame_Application_ActionController {
 *  // ...
 *  
 *  	public function get_users() {
 *  		// Get request data
 *  		$orderby = phpFrame::getRequest()->get('orderby', 'u.lastname');
 *  		$orderdir = phpFrame::getRequest()->get('orderdir', 'ASC');
 *  		$limit = phpFrame::getRequest()->get('limit', 25);
 *  		$limitstart = phpFrame::getRequest()->get('limitstart', 0);
 *  		$search = phpFrame::getRequest()->get('search', '');
 *  
 *  		// Create list filter needed for getUsers()
 *  		$list_filter = new phpFrame_Database_CollectionFilter($orderby, $orderdir, $limit, $limitstart, $search);
 *  		
 *  		// Get users using model
 *  		$users = $this->getModel('users')->getUsers($list_filter);<commit_msg>Minor update to Javadoc comments in phpFrame_Database_CollectionFilter class.<commit_after><?php
/**
 * @version		$Id$
 * @package		phpFrame
 * @subpackage 	database
 * @copyright	Copyright (C) 2009 E-noise.com Limited. All rights reserved.
 * @license		BSD revised. See LICENSE.
 */

defined( '_EXEC' ) or die( 'Restricted access' );

/**
 * Collection Filter Class
 * 
 * Collection filter objects are responsible for encapsulating SQL select filtering 
 * conditions (ORDER BY and LIMIT clauses).
 * 
 * "Collection filter" objects are used when creating "row collections".
 * 
 * This objects are also used by the pagination objects, as they will need to work 
 * with the "limit" properties (limit, limitstart, pages, current pages and so on).
 * 
 * Collection filter objects are normally instantiated using values coming 
 * from the request, so the natural place to instantiate them is in concrete "action 
 * controller" classes. Action controllers are responsible for brokering request data.
 * They use this data to create a list or collection filter that will be 
 * passed to a model method responsible for creating a "row collection".
 * 
 *  Example:
 *  
 *  <code>
 *  class usersController extends phpFrame_Application_ActionController {
 *  // ...
 *  
 *  	public function get_users() {
 *  		// Get request data
 *  		$orderby = phpFrame::getRequest()->get('orderby', 'u.lastname');
 *  		$orderdir = phpFrame::getRequest()->get('orderdir', 'ASC');
 *  		$limit = phpFrame::getRequest()->get('limit', 25);
 *  		$limitstart = phpFrame::getRequest()->get('limitstart', 0);
 *  		$search = phpFrame::getRequest()->get('search', '');
 *  
 *  		// Create list filter needed for getUsers()
 *  		$list_filter = new phpFrame_Database_CollectionFilter($orderby, $orderdir, $limit, $limitstart, $search);
 *  		
 *  		// Get users using model
 *  		$users = $this->getModel('users')->getUsers($list_filter);
{'fraction_non_alphanumeric': 0.1185378590078329, 'fraction_numerical': 0.0036553524804177544, 'mean_word_length': 3.905249679897567, 'pattern_counts': {'":': 0, '<': 7, '<?xml version=': 0, '>': 19, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '5099344', 'n_tokens_mistral': 1143, 'n_tokens_neox': 1075, 'n_words': 388}