content
Packages
Interfaces
Classes
Files

Class: Note

Source Location: /content/note.class.php [line 37]

Class Overview



This class provides you an easy way to manage notation.

		

	    
Author(s):

	    
	




		





    

    
    

        
Methods

        
    

    		











Class Details


This class provides you an easy way to manage notation.
    
Tags:

    

        
    




[ Top ] - [ Class Details ] - [ Methods ] - [ Variables ]



	

	
Class Methods

	
  

    
    
constructor Note [line 50]

    

    

    

        Note Note(
string
$script, int
$idprov, string
$script_path, int
$notation_scale, [string
$module_folder = ''], [int
$options = 0])
    

    

    
        
Create an new object Note.

    
        
Parameters:

    

    

          

        string  
        $script  
        The module name in which the pagination is used. <strong>Warning</strong>The sql table name has to be the same name, otherwise you has to specify the sql table name in $script and module name in $module_folder argument
      

          

        int  
        $idprov  
        The id of the item in the module.
      

          

        string  
        $script_path  
        The script path. Example : url('file.php?id=' . $idart, 'file-' . $idart . '.php')
      

          

        int  
        $notation_scale  
        The notation scale
      

          

        string  
        $module_folder  
        (optional) The folder where the module is located. It allow you to specify a different module location
      

          

        int  
        $options  
        
      

        

    

        
[ Top ] - [ Class Details ] - [ Methods ] - [ Variables ]
    

  

  

  

    
    
method add [line 63]

    

    

    

        Return add(
int
$note)
    

    

    
        
Add a note on the item. It has to be into the notation scale.
    
Tags:

    

        
  • return: a string used in the ajax file, to update the notation. If an error occur, return an error code.

    


    
        
Parameters:

    

    

          

        int  
        $note  
        The note given by the user.
      

        

    

        
[ Top ] - [ Class Details ] - [ Methods ] - [ Variables ]
    

  

  

  

    
    
method display_form [line 94]

    

    

    

        string display_form(
[object
$template = false])
    

    

    
        
Display the ajax notation form.
    
Tags:

    

        
  • return: the parsed template.

    


    
        
Parameters:

    

    

          

        object  
        $template  
        Template object to use another template file.
      

        

    

        
[ Top ] - [ Class Details ] - [ Methods ] - [ Variables ]
    

  

  

  

    
    
method get_attribute [line 231]

    

    

    

        unknown_type get_attribute(
string
$varname)
    

    

    
        
Accessor

    
        
Parameters:

    

    

          

        string  
        $varname  
        
      

        

    

        
[ Top ] - [ Class Details ] - [ Methods ] - [ Variables ]
    

  

  



  

	
	
static method display_img [line 192]

	

    

    

		static string display_img(
int
$note, int
$notation_scale, [int
$num_stars_display = 0])
    

    

	
		
Static method which display the notation with images, you can restrain the number of images displayed with the argument $num_stars_display
    
Tags:

    

        
  • return: The notation with images.

    


	
        
Parameters:

    

    

          

        int  
        $note  
        The note of the item.
      

          

        int  
        $notation_scale  
        Notation scale
      

          

        int  
        $num_stars_display  
        Number of image to display.
      

        

    

        
[ Top ] - [ Class Details ] - [ Methods ] - [ Variables ]
    

  

  



    

    
Class Variables

    
                                            

                            
                [line 277]  
                mixed 
                $idprov 
                                 =  0                

                                

                                    

                    

        
[ Top ] - [ Class Details ] - [ Methods ] - [ Variables ]
                

                            
                [line 280]  
                mixed 
                $module_folder 
                                 =  ''                

                                

                                    

                    

        
[ Top ] - [ Class Details ] - [ Methods ] - [ Variables ]
                

                            
                [line 283]  
                mixed 
                $notation_scale 
                                 =  ''                

                                

                                    

                    

        
[ Top ] - [ Class Details ] - [ Methods ] - [ Variables ]
                

                            
                [line 281]  
                mixed 
                $options 
                                 =  ''                

                                

                                    

                    

        
[ Top ] - [ Class Details ] - [ Methods ] - [ Variables ]
                

                            
                [line 278]  
                mixed 
                $path 
                                 =  ''                

                                

                                    

                    

        
[ Top ] - [ Class Details ] - [ Methods ] - [ Variables ]
                

                            
                [line 276]  
                mixed 
                $script 
                                 =  ''                

                                

                                    

                    

        
[ Top ] - [ Class Details ] - [ Methods ] - [ Variables ]
                

                            
                [line 279]  
                mixed 
                $script_path 
                                 =  ''                

                                

                                    

                    

        
[ Top ] - [ Class Details ] - [ Methods ] - [ Variables ]
                

                            
                [line 282]  
                mixed 
                $sql_table 
                                 =  ''                

                                

                                    

                    

        
[ Top ] - [ Class Details ] - [ Methods ] - [ Variables ]
    



            		
        

            

    
    
         
    

    
Documentation generated on Tue, 28 Jul 2009 22:43:41 +0200 by phpDocumentor 1.4.1



			

			
	        

				

 

 

Annonces