CLICK HERE TO BUY IT TODAY! OR GET IT FREE VIA TRIALPAY  

PHP Demo Application - Source Code

/Framework/Model/DataObjects/Interfaces/GridData.php

<?php
/**
* Script Contents: Apeel_Framework_Model_DataObjects_Interfaces_GridData Interface
* @package Apeel_Framework_Model_DataObjects
*/

/**
* Interface which must be implemented by Data Objects that represent grid data

* The methods defined by this interface tells the grid object how to handle
* and present the data to the user.  

* More detailed explanations of what is expected from these methods can be 
* found in the Grid Sample in the Application/Model/DataObjects/Sample folder.
*  
* @package      Apeel_Framework_Model_DataObjects 
* @version      1.1.0
* @author       John W. King (email: contact@apeelframework.net)
* @copyright    City Business Logic Limited 2001-2011
* @license      Dual MIT / GNU Lesser General Public License Version 3
*/
interface Apeel_Framework_Model_DataObjects_Interfaces_GridData {
    
    
/**
    * Tells the grid which columns(s) identify a unique row, which is useful
    * to allow editing and deletion of records.  
    * 
    * @return string | array
    */
    
public function getPrimarykey();
    
    
/**
    * Returns an array of column definitions that specify formatting 
    * information such as whether the column should be sortable and how it 
    * should be aligned for example.  
    * 
    * @return array
    */
    
public function getGridColumns();
    
    
/**
    * Returns an array of column editor definitions - used primarily when 
    * selecting a column to filter grid data by - this array tells it 
    * whether to allow the user to enter data via a text box, dropdown list,
    * autocomplete, etc.  Includes specifics for each type.  
    * 
    * When $index is supplied, it returns the definitions for that column.  
    * 
    * @param mixed $index
    * @return array
    */
    
public function getEditors($index NULL);
    
    
/**
    * Returns an array containing zero or more fields to sort the data by,
    * including whether the column should be sorted ascending/descending.  
    * 
    * @return array
    */
    
public function getDefaultSortColumns();
    
    
/**
    * Returns a heading for the grid, typically describing the data that the
    * Data Object displays.  
    * 
    * @return string
    */
    
public function getTitle();

}


PHP Demo Source Code Index