Class BookmarkOperations

Description
Description | Methods (details)

Class for doing bookmark related functions. Maybe of the Bookmark object functions are just wrappers around these.

  • version: $Revision$
  • license: GPL

Located in /class.bookmarkoperations.inc.php (line 41) 


	
			







	
	

		
Method Summary

		

			Description |
												Methods (details)
		

		
			
			

																																												
												

											mixed
										DeleteBookmarkByID
											(mixed $id)
									

																

											mixed
										InsertBookmark
											(mixed $bookmark)
									

																

											mixed
										LoadBookmarkByID
											(mixed $id)
									

																

											array
										LoadBookmarks
											( $user_id)
									

																

											mixed
										UpdateBookmark
											(mixed $bookmark)
									

								

		

	
		

	
	
	

		
Methods

		

			Description |
																Methods (details)
						
		

		

			




	
	

		DeleteBookmarkByID (line 197)
	
 
	
	

Deletes an existing bookmark from the database.

	
    
				
  • return: If successful, true.  If it fails, false.
    • 
			

	
	

		mixed
		
			DeleteBookmarkByID
		
					(mixed $id)
			

	
			
    
					
  • 
				mixed
				$id: Id of the bookmark to delete			
    • 
				

		
			
	




	
	

		InsertBookmark (line 150)
	
 
	
	

Saves a new bookmark to the database.

	
    
				
  • return: The new bookmark_id.  If it fails, it returns -1.
    • 
			

	
	

		mixed
		
			InsertBookmark
		
					(mixed $bookmark)
			

	
			
    
					
  • 
				mixed
				$bookmark: Bookmark object to save			
    • 
				

		
			
	




	
	

		LoadBookmarkByID (line 122)
	
 
	
	

Loads a bookmark by bookmark_id.

	
    
				
  • return: If successful, the filled Bookmark object.  If it fails, it returns false.
    • 
				
  • since: 0.6.1
    • 
			

	
	

		mixed
		
			LoadBookmarkByID
		
					(mixed $id)
			

	
			
    
					
  • 
				mixed
				$id: bookmark_id to load			
    • 
				

		
			
	




	
	

		LoadBookmarks (line 92)
	
 
	
	

Gets a list of all bookmarks for a given user

	
    
				
  • return: An array of Bookmark objects
    • 
			

	
	

		array
		
			LoadBookmarks
		
					( $user_id)
			

	
			
    
					
  • 
				
				$user_id			
    • 
				

		
			
	




	
	

		UpdateBookmark (line 174)
	
 
	
	

Updates an existing bookmark in the database.

	
    
				
  • return: If successful, true.  If it fails, false.
    • 
			

	
	

		mixed
		
			UpdateBookmark
		
					(mixed $bookmark)
			

	
			
    
					
  • 
				mixed
				$bookmark: Bookmark object to save			
    • 
				

		
			
	

						
		

	



	

		Documentation generated on Sun, 12 Aug 2012 08:38:21 -0600 by phpDocumentor 1.3.2