apidoc
[ class tree: apidoc ] [ index: apidoc ] [ all elements ]
Packages:
Pager


Classes:
Pager
   Pager_HtmlWidgets

Class: Pager_HtmlWidgets

Source Location: /Pager-2.4.4/HtmlWidgets.php

Class Overview




Two constants used to guess the path- and file-name of the page














Variables






Methods
















Inherited Variables





Inherited Methods














Class Details



[line 43]

Two constants used to guess the path- and file-name of the page
when the user doesn't set any other value




[ Top ]







Class Variables



	
	

	
$pager =  null

	
[line 45]

  
  

	

  

    

      Type:  
      mixed
    

      

	



	
[ Top ]










Method Detail



	
	
Pager_HtmlWidgets (Constructor)   [line 49]

	

    

    

		Pager_HtmlWidgets Pager_HtmlWidgets(

&$pager)
    

    


	
		



        
Parameters:

    

    

          

          
        &$pager  
        —
          
      

        

    


        
[ Top ]

  

  
  
	
	
getPageSelectBox   [line 167]

	

    

    

		string getPageSelectBox(
[array
$params = array()], [string
$extraAttributes = ''])
    

    


	
		Returns a string with a XHTML SELECT menu with the page numbers,  useful as an alternative to the links


    

  • Return: xhtml select box
    • 

  • Access: public
    • 








        
Parameters:

    

    

          

        string  
        $extraAttributes  
        —
          (html attributes) Tag attributes or                   HTML attributes (id="foo" pairs), will be inserted in the                   <select> tag
      

          

        array  
        $params  
        —
          - 'optionText': text to show in each option.                   Use '%d' where you want to see the number of pages selected. 
  • 'autoSubmit': if TRUE, add some js code to submit the
                  form on the onChange event

      

        

    


        
[ Top ]

  

  
  
	
	
getPerPageSelectBox   [line 79]

	

    

    

		string getPerPageSelectBox(
[integer
$start = 5], [integer
$end = 30], [integer
$step = 5], [boolean
$showAllData = false], [array
$extraParams = array()])
    

    


	
		Returns a string with a XHTML SELECT menu,
useful for letting the user choose how many items per page should be  displayed. If parameter useSessions is TRUE, this value is stored in  a session var. The string isn't echoed right now so you can use it  with template engines.


    

  • Return: xhtml select box
    • 

  • Access: public
    • 








        
Parameters:

    

    

          

        integer  
        $start  
        —
          
      

          

        integer  
        $end  
        —
          
      

          

        integer  
        $step  
        —
          
      

          

        boolean  
        $showAllData  
        —
          If true, perPage is set equal to totalItems.
      

          

        array  
        $extraParams  
        —
          (or string $optionText for BC reasons) 
  • 'optionText': text to show in each option.
                  Use '%d' where you want to see the number of pages selected.
  • 'attributes': (html attributes) Tag attributes or
                  HTML attributes (id="foo" pairs), will be inserted in the
                  <select> tag
  • 'checkMaxLimit': if true, Pager checks if $end is bigger
                  than $totalItems, and doesn't show the extra select options

      

        

    


        
[ Top ]

  

  
  



        

		    

		    Documentation generated on Sun, 29 Jul 2007 10:30:08 -0400 by phpDocumentor 1.4.0. PEAR Logo Copyright ©  PHP Group 2004.