Geeklog
[ class tree: Geeklog ] [ index: Geeklog ] [ all elements ]
Packages:
Geeklog
Calendar
kses
Links
net-geeklog-search
Polls
Spam-X
StaticPages
XMLSitemap
XMLsitemap


Files:
404.php
article.php
association.php
atom.feed.class.php
auth.inc.php
bigdump.php
block.php
calendar.class.php
comment.php
config-install.php
config.class.php
config.php
configinfo.php
configuration.php
configuration_validation.php
configuration_validation.php
configuration_validation.php
configuration_validation.php
configuration_validation.php
configuration_validation.php
configuration_validation.php
consumer.php
database.php
directory.php
downloader.class.php
event.php
facebook.auth.class.php
feedparserbase.class.php
functions.php
functions.php
getimage.php
group.php
help.php
httpclient.php
index.php
index.php
index.php
index.php
index.php
index.php
info.php
install-plugins.php
install_defaults.php
install_updates.php
install_updates.php
install_updates.php
install_updates.php
install_updates.php
install_updates.php
interface.php
LDAP.auth.class.php
lib-admin.php
lib-comment.php
lib-common.php
lib-custom.php
lib-database.php
lib-install.php
lib-mbyte.php
lib-pingback.php
lib-plugins.php
lib-security.php
lib-sessions.php
lib-story.php
lib-syndication.php
lib-trackback.php
lib-upgrade.php
lib-user.php
lib-webservices.php
linkedin.auth.class.php
listfactory.class.php
LiveJournal.auth.class.php
mail.php
migrate.php
moderation.php
mssql.class.php
mssql_1.4.1_to_1.5.0.php
mssql_1.5.0_to_1.5.1.php
mssql_1.5.1_to_1.5.2.php
mssql_1.5.2_to_1.6.0.php
mssql_1.6.0_to_1.6.1.php
mssql_1.6.1_to_1.7.0.php
mssql_1.7.2_to_1.8.0.php
mssql_install.php
mssql_tableanddata.php
mysql.class.php
mysql_1.2.5-1_to_1.3.php
mysql_1.3.1_to_1.3.2.php
mysql_1.3.2-1_to_1.3.3.php
mysql_1.3.3_to_1.3.4.php
mysql_1.3.4_to_1.3.5.php
mysql_1.3.5_to_1.3.6.php
mysql_1.3.7_to_1.3.8.php
mysql_1.3.8_to_1.3.9.php
mysql_1.3.9_to_1.3.10.php
mysql_1.3.10_to_1.3.11.php
mysql_1.3.11_to_1.4.0.php
mysql_1.3_to_1.3.1.php
mysql_1.4.0_to_1.4.1.php
mysql_1.4.1_to_1.5.0.php
mysql_1.5.0_to_1.5.1.php
mysql_1.5.1_to_1.5.2.php
mysql_1.5.2_to_1.6.0.php
mysql_1.6.0_to_1.6.1.php
mysql_1.6.1_to_1.7.0.php
mysql_1.7.2_to_1.8.0.php
mysql_install.php
mysql_tableanddata.php
navbar.class.php
oauthhelper.class.php
oid_parse.php
oid_util.php
openidhelper.class.php
parserfactory.class.php
pgsql.class.php
pgsql_1.7.2_to_1.8.0.php
pgsql_install.php
pgsql_tableanddata.php
pingback.php
plugin.class.php
plugins.php
profiles.php
rdf.feed.class.php
rss.feed.class.php
sanitize.class.php
scripts.class.php
search.php
searchcriteria.class.php
sectest.php
server.php
stats.php
story.class.php
story.php
submit.php
success.php
switchlang.php
syndication.php
template.class.php
timer.class.php
timezoneconfig.class.php
topic.php
trackback.php
trackback.php
trustroot.php
twitter.auth.class.php
unpacker.class.php
upload.class.php
url.class.php
user.php
users.php
usersettings.php
validator.class.php

Interfaces:
ITemplate
Classes:
AbstractConsumerAssociationManager
ActionHandler
Association
Atom03
Atom10
Calendar
CalendarDay
CheckAuthRequired
config
ConsumerAssociation
ConsumerAssociationManager
ConsumerRequest
ConsumerResponse
database
DiffieHellman
DiffieHelmanAssociator
downloader
DumbAssociationManager
ErrorFromServer
facebookConsumer
FeedParserBase
FeedParserFactory
HTTPClient
InvalidLogin
LDAP
linkedinConsumer
ListFactory
LiveJournal
MultiRootTemplate
navbar
OAuthConsumer
OAuthConsumerBaseClass
oidParse
oidUtil
oidUtilPhpBigInt
oidUtilPhpSha1
OpenIDConsumer
OpenIDConsumerHelper
OpenIDServer
ParanoidHTTPClient
Plugin
RDF
Request
RSS0x
RSS20
sanitizer
scripts
SearchCriteria
ServerAssociationStore
ServerResponse
SimpleActionHandler
SimpleConsumer
SimpleHTTPClient
Story
Template
timerobject
TimeZoneConfig
TrustRoot
twitterConsumer
unpacker
upload
url
UserCancelled
UserSetupNeeded
validator
ValidLogin

Class: ListFactory

Source Location: /system/classes/listfactory.class.php

Class Overview




Geeklog List Factory Class




Author(s):


    
          
  • Sami Barakat, s.m.barakat AT gmail DOT com
    • 
      





    

        






Methods
























Class Details



[line 131]

Geeklog List Factory Class





Tags:





  

    author:  Sami Barakat, s.m.barakat AT gmail DOT com
  










[ Top ]








Class Methods




  

	
	
constructor ListFactory [line 159]

	

    

    

		ListFactory ListFactory(
string
$url, [array
$limits = '10,15,20,25,30,35'], [int
$per_page = 20])
    

    


	
		Constructor

Sets up private url variable and defines the  LF_SOURCE_TITLE, LF_SOURCE_NAME and LF_ROW_NUMBER constants.





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        string  
        $url  
        The URL of the page the table appears on
      

          

        array  
        $limits  
        The avaliable page limits
      

          

        int  
        $per_page  
        The default number or rows per page
      

        

    


        
[ Top ]

  

  

	
	
method addResult [line 303]

	

    

    

		void addResult(
array
$result)
    

    


	
		Appends a single result to the list





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        array  
        $result  
        A single result that will be appended to the rest
      

        

    


        
[ Top ]

  

  

	
	
method addResultArray [line 315]

	

    

    

		void addResultArray(

$arr, array
$result)
    

    


	
		Appends several results to the list





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        array  
        $result  
        An array of result that will be appended to the rest
      

          

          
        $arr  
        
      

        

    


        
[ Top ]

  

  

	
	
method ExecuteQueries [line 447]

	

    

    

		array ExecuteQueries(
)
    

    


	
		Executes pre set queries





Tags:





  

    return:  The results found
  

  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getFormattedOutput [line 580]

	

    

    

		string getFormattedOutput(
array
$rows_arr, string
$title, [string
$list_top = ''], [string
$list_bottom = ''], [boolean
$show_sort = true], [boolean
$show_limit = true])
    

    


	
		Generates the HTML code based on the preset style





Tags:





  

    return:  HTML output
  

  

    access:  public
  









	
        
Parameters:

    

    

          

        array  
        $rows_arr  
        The rows to display in the list
      

          

        string  
        $title  
        The title of the list
      

          

        string  
        $list_top  
        HTML that will appear before the list is printed
      

          

        string  
        $list_bottom  
        HTML that will appear after the list is printed
      

          

        boolean  
        $show_sort  
        True to enable column sorting, false to disable
      

          

        boolean  
        $show_limit  
        True to show page limits, false to hide
      

        

    


        
[ Top ]

  

  

	
	
method setCallback [line 257]

	

    

    

		void setCallback(
string
$title, string
$name, 
$callback, int
$rank, int
$total, string
$function)
    

    


	
		Sets a callback function that provides another source for results.

The function will be passed two parameters, $offset and $limit,  which will determine how many results are requested. The callback  function should then return a multidimensional array containing  the results. This provides an alternative to the setQuery()  function as results can be sourced from anywhere.





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        string  
        $title  
        The text that's displayed to the user
      

          

        string  
        $name  
        The local name given to the query
      

          

        string  
        $function  
        Any callable function, method or lambda
      

          

        int  
        $rank  
        The rating that determins how many results will be returned
      

          

        int  
        $total  
        The total number of results that are avaliable
      

          

          
        $callback  
        
      

        

    


        
[ Top ]

  

  

	
	
method setDefaultSort [line 291]

	

    

    

		void setDefaultSort(
string
$field, [string
$direction = 'desc'])
    

    


	
		Sets the default sort field





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        string  
        $field  
        The field name to sort
      

          

        string  
        $direction  
        'asc' for ascending order and 'desc' for descending order
      

        

    


        
[ Top ]

  

  

	
	
method setField [line 204]

	

    

    

		void setField(
string
$title, string
$name, [boolean
$display = true], [boolean
$sort = true], [string
$format = '%s'])
    

    


	
		Sets a field in the list.

Note: LF_ROW_NUMBER cannot be sorted





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        string  
        $title  
        The title of the field which is displayed to the user
      

          

        string  
        $name  
        The local name given to the field
      

          

        boolean  
        $display  
        True if the field is to be displayed to the user otherwise false
      

          

        boolean  
        $sort  
        True if the field can be sorted otherwise false
      

          

        string  
        $format  
        The format string with one type specifier
      

        

    


        
[ Top ]

  

  

	
	
method setQuery [line 228]

	

    

    

		void setQuery(
string
$title, string
$name, string
$sql, int
$rank)
    

    


	
		Sets the SQL query that will generate rows





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        string  
        $title  
        The text that's displayed to the user
      

          

        string  
        $name  
        The local name given to the query
      

          

        string  
        $sql  
        The SQL string without the ORDER BY or LIMIT clauses
      

          

        int  
        $rank  
        The rating that determins how many results will be returned
      

        

    


        
[ Top ]

  

  

	
	
method setRowFunction [line 278]

	

    

    

		void setRowFunction(

$callback, callback
$function)
    

    


	
		Sets the callback function thats called on every row for styling  or formatting.





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        callback  
        $function  
        Any callable function, method or lambda
      

          

          
        $callback  
        
      

        

    


        
[ Top ]

  

  

	
	
method setStyle [line 186]

	

    

    

		void setStyle(
string
$style)
    

    


	
		Determins which set of templates to load when formatting the output





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        string  
        $style  
        Either 'table' or 'inline'
      

        

    


        
[ Top ]

  






        

		    

		    Documentation generated on Sat, 11 Feb 2012 02:08:35 -0500 by phpDocumentor 1.4.3