Class Artwork

Description
Description | Vars (details) | Methods (details)

The Artwork object represents the artwork for an album.

Located in /artwork.php (line 14) 


	
			





	
	

		
Variable Summary

		

			Description |
						Vars (details)
							| 
									Methods (details)
							
					

		

			

								

					string
					$album_name
				

								

					string
					$big_path
				

								

					string
					$path
				

							

		

	


	
	

		
Method Summary

		

			Description |
															Vars (details)
				 
				|
						Methods (details)
		

		
			
			

								
				

											Artwork
										Artwork
											(string $artist_key, [string $album_key = NULL])
									

								
				

											bool
										has_artwork
										()
									

								
				

											bool
										has_big_artwork
										()
									

								
				

											string
										path
											([bool $big = FALSE])
									

							

		

	
		

	
	

		
Variables

		

			Description |
										Vars (details)
						
			
							| 
									Methods (details)
							
					

		

			



	

		
			string
			$album_name
						(line 29)
		
	


	

The name of the album.

	
	
		
		







	

		
			string
			$big_path
						(line 24)
		
	


	

The path to the full-size artwork file.

	
	
		
		







	

		
			string
			$path
						(line 19)
		
	


	

The path to the 150-pixel artwork file.

	
	
		
		



						
		

	

	
	
	

		
Methods

		

			Description |
															Vars (details)
														Methods (details)
						
		

		

			



	
	

		Constructor Artwork (line 40)
	
 
	
	

Creates an artwork object for an artist and album.


If the album key is not specified, uses the first album for the artist.

	
    
				
  • return: the artwork object
    • 
			

	
	

		Artwork
		
			Artwork
		
					(string $artist_key, [string $album_key = NULL])
			

	
			
    
					
  • 
				string
				$artist_key: the key for the artist			
    • 
					
  • 
				string
				$album_key: the key for the album			
    • 
				

		
		
	




	
	

		has_artwork (line 77)
	
 
	
	

Checks whether an artwork file is present for the album and artist.

	
    
				
  • return: whether artwork is available.
    • 
			

	
	

		bool
		
			has_artwork
		
				()
			

	
		
		
	




	
	

		has_big_artwork (line 86)
	
 
	
	

Checks whether a full-size artwork file is present for the album and artist.

	
    
				
  • return: whether full-size artwork is available.
    • 
			

	
	

		bool
		
			has_big_artwork
		
				()
			

	
		
		
	




	
	

		path (line 68)
	
 
	
	

The path for the artwork.

	
    
				
  • return: the parth to the artwork file
    • 
			

	
	

		string
		
			path
		
					([bool $big = FALSE])
			

	
			
    
					
  • 
				bool
				$big: whether the full-size artwork should be used			
    • 
				

		
		
	

						
		

	

	
	

		Documentation generated on Sun, 12 Feb 2006 19:27:50 +0100 by phpDocumentor 1.2.3