Permalink
Switch branches/tags
Nothing to show
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
355 lines (282 sloc) 6.32 KB

Goodreads PHP

Actions

Get id of user who authorized OAuth

$provider->getUserId();

Paginate an author's books

$provider->getBooksByAuthorId($authorId);

Get info about an author by id

$provider->getAuthorById($authorId);

Follow an author

$provider->followAuthorById($authorId);

Unfollow an author

$provider->unfollowAuthorByFollowingId($authorFollowingId);

Show author following information

$provider->getAuthorFollowingInfoById($authorFollowingId);

Get Goodreads book IDs given ISBNs

$provider->getBookIdByIsbn($isbn);

Get Goodreads work IDs given Goodreads book IDs

$provider->getWorkIdByBookId($bookId);

Get review statistics given a list of ISBNs

$provider->getReviewStatisticsByIsbn($isbn);

Get the reviews for a book given a Goodreads book id

$provider->getBookReviewsById($bookId);

Get the reviews for a book given an ISBN

$provider->getBookReviewsByIsbn($isbn);

Get the reviews for a book given a title string

$provider->getBookReviewsByTitle($title);

Create a comment

$provider->addComment($resourceType, $resourceId, $comment);

List comments on a subject

$provider->getCommentsByType($type, $id);

Events in your area

$provider->getEvents();

Follow a user

$provider->followUserById($userId);

Unfollow a user

$provider->unfollowUserById($userId);

Confirm or decline a friend recommendation

$provider->confirmFriendRecommendation($recommendationId);

Confirm or decline a friend request

$provider->confirmFriendRequest($requestId);

Get friend requests

$provider->getFriendRequests();

Add a friend

$provider->addFriendById($userId);

Join a group

$provider->joinGroupById($groupId);

List groups for a given user

$provider->getGroupsByUserId($userId);

Return members of a particular group

$provider->getGroupMembersByGroupId($groupId);

Find a group

$provider->getGroupByQuery($query);

Get info about a group by id

$provider->getGroupById($groupId);

See the current user's notifications

$provider->getUserNotifications();

Add to books owned

$provider->addOwnedBookById($bookId, $conditionCode, $conditionDescription, $purchaseDate, $purchaseLocation, $uniqueCode);

List books owned by a user

$provider->getOwnedBooks();

Show an owned book

$provider->getOwnedBookById($ownedBookId);

Update an owned book

$provider->updateOwnedBook($ownedBookId, $bookId);

Delete an owned book

$provider->deleteOwnedBook($ownedBookId);

Add a quote

$provider->addQuote($quote, $authorName);

Like a resource

$provider->likeResourceById($resourceId, $resourceType);

Unlike a resource

$provider->unlikeResourceById($resourceId);

Get a user's read status

$provider->getReadStatusById($statusId);

Get a recommendation from a user to another user

$provider->getRecommendationById($recommendationId);

Add review

$provider->addBookReview($bookId);

Edit a review

$provider->editBookReview($reviewId);

Delete a book review

$provider->deleteBookReview($reviewId);

Get the books on a members shelf

$provider->getShelfBooksByUserId($userId);

Recent reviews from all members

$provider->getAllRecentReviews();

Get a review

$provider->getReviewById($reviewId);

Get a user's review for a given book

$provider->getReviewByUserIdAndBookId($userId, $bookId);

Find an author by name

$provider->getAuthorByName($authorName);

Find books by title, author, or ISBN

$provider->getBookByQuery($query);

See a series

$provider->getSeriesById($seriesId);

See all series by an author

$provider->getSeriesByAuthorId($authorId);

See all series a work is in

$provider->getSeriesByWorkId($workId);

Add a book to a shelf

$provider->addBookToShelf($bookId, $shelfName);

Remove a book from a shelf

$provider->removeBookFromShelf($bookId, $shelfName);

Add books to many shelves

$provider->addBooksToShelves($bookIds, $shelfNames);

Get a user's shelves

$provider->getShelvesByUserId($userId);

Create a new topic

$provider->addTopic($subjectType, $subjectId, $title, $description);

Get list of topics in a group's folder

$provider->getTopicsByGroupFolderId($folderId, $groupId);

Get info about a topic by id

$provider->getTopicById($topicId);

Get a list of topics with unread comments

$provider->getTopicUnreadCommentsByGroupId($groupId);

Get your friend updates

$provider->getFriendUpdates();

Add book shelf

$provider->addBookShelf($shelfName);

Edit book shelf

$provider->editBookShelfById($shelfId, $shelfName);

Get info about a member by id or username

$provider->getUserById($userId);

Compare books with another member

$provider->getBookComparisonByUserId($userId);

Get a user's followers

$provider->getFollowersByUserId($userId);

Get people a user is following

$provider->getFollowingByUserId($userId);

Get a user's friends

$provider->getFriendsByUserId($userId);

Add user status update

$provider->addStatusUpdate();

Delete user status update

$provider->removeStatusUpdateById($statusId);

Get a user status

$provider->getStatusUpdateById($statusId);

View user statuses

$provider->getRecentStatusUpdates();

See all editions by work

$provider->getEditionsByWorkId($workId);