Verified Commit 9813a1cc authored by Dave Long's avatar Dave Long
Browse files

Issue #2985165 by Liam Morland, ayushmishra206, nbaosullivan, AkashKumar07,...

Issue #2985165 by Liam Morland, ayushmishra206, nbaosullivan, AkashKumar07, valthebald, mathieso, Sutharsan: Improve documentation for BookManagerInterface::saveBookLink()

(cherry picked from commit 090e8981)
parent 2318ad9c
Loading
Loading
Loading
Loading
+12 −4
Original line number Diff line number Diff line
@@ -183,15 +183,23 @@ public function getAllBooks();
  public function updateOutline(NodeInterface $node);

  /**
   * Saves a single book entry.
   * Saves a link for a single book entry to the book.
   *
   * @param array $link
   *   The link data to save.
   *   The link data to save. $link['nid'] must be set. Other keys in this array
   *   get default values from
   *   \Drupal\book\BookManagerInterface::getLinkDefaults(). The array keys
   *   available to be set are documented in
   *   \Drupal\book\BookOutlineStorageInterface::loadMultiple().
   * @param bool $new
   *   Is this a new book.
   *   Whether this is a link to a new book entry.
   *
   * @return array
   *   The book data of that node.
   *   The book entry link information. This is $link with values added or
   *   updated.
   *
   * @see \Drupal\book\BookManagerInterface::getLinkDefaults()
   * @see \Drupal\book\BookOutlineStorageInterface::loadMultiple()
   */
  public function saveBookLink(array $link, $new);