Управление комментариями презентации в PHP

В PowerPoint комментарий отображается как заметка или аннотация на слайде. При щелчке по комментарию его содержимое или сообщения раскрываются.

Зачем добавлять комментарии в презентации?

Вы можете использовать комментарии для предоставления обратной связи или общения с коллегами при просмотре презентаций.

Чтобы вы могли использовать комментарии в презентациях PowerPoint, Aspose.Slides for PHP via Java предоставляет

Класс Presentation, содержащий коллекцию авторов (из класса CommentAuthorCollection). Авторы добавляют комментарии к слайдам.
Класс CommentCollection, содержащий коллекцию комментариев для отдельных авторов.
Класс Comment, содержащий информацию об авторах и их комментариях: кто добавил комментарий, время его добавления, позицию комментария и т.д.
Класс CommentAuthor , содержащий информацию об отдельных авторах: имя автора, его инициалы, комментарии, связанные с именем автора, и т.д.

Добавление комментариев к слайдам

Этот PHP‑код показывает, как добавить комментарий к слайду в презентации PowerPoint:

  # Создаёт экземпляр класса Presentation
  $pres = new Presentation();
  $Array = new java_class("java.lang.reflect.Array");
  try {
    # Добавляет пустой слайд
    $pres->getSlides()->addEmptySlide($pres->getLayoutSlides()->get_Item(0));
    # Добавляет автора
    $author = $pres->getCommentAuthors()->addAuthor("Jawad", "MF");
    # Устанавливает позицию для комментариев
    $point = new Point2DFloat(0.2, 0.2);
    # Добавляет комментарий к слайду для автора на слайде 1
    $author->getComments()->addComment("Hello Jawad, this is slide comment", $pres->getSlides()->get_Item(0), $point, new Java("java.util.Date"));
    # Добавляет комментарий к слайду для автора на слайде 2
    $author->getComments()->addComment("Hello Jawad, this is second slide comment", $pres->getSlides()->get_Item(1), $point, new Java("java.util.Date"));
    # Доступ к ISlide 1
    $slide = $pres->getSlides()->get_Item(0);
    # Когда в качестве аргумента передаётся null, комментарии всех авторов извлекаются для выбранного слайда
    $Comments = $slide->getSlideComments($author);
    # Доступ к комментариям с индексом 0 для слайда 1
    $str = $Comments[0]->getText();
    $pres->save("Comments_out.pptx", SaveFormat::Pptx);
    if (java_values($Array->getLength($Comments)) > 0) {
      # Выбирает коллекцию комментариев автора с индексом 0
      $commentCollection = $Comments[0]->getAuthor()->getComments();
      $Comment = $commentCollection->get_Item(0)->getText();
    }
  } finally {
    if (!java_is_null($pres)) {
      $pres->dispose();
    }
  }

Доступ к комментариям слайда

Этот PHP‑код показывает, как получить существующий комментарий на слайде в презентации PowerPoint:

  # Создаёт экземпляр класса Presentation
  $pres = new Presentation("Comments1.pptx");
  try {
    foreach($pres->getCommentAuthors() as $commentAuthor) {
      $author = $commentAuthor;
      foreach($author->getComments() as $comment1) {
        $comment = $comment1;
        echo("ISlide :" . $comment->getSlide()->getSlideNumber() . " has comment: " . $comment->getText() . " with Author: " . $comment->getAuthor()->getName() . " posted on time :" . $comment->getCreatedTime() . "\n");
      }
    }
  } finally {
    if (!java_is_null($pres)) {
      $pres->dispose();
    }
  }

Ответы на комментарии

Родительский комментарий — это основной или оригинальный комментарий в иерархии комментариев или ответов. С помощью методов getParentComment или setParentComment (из класса Comment) можно получить или задать родительский комментарий.

Этот PHP‑код показывает, как добавлять комментарии и получать ответы на них:

  $pres = new Presentation();
  $Array = new java_class("java.lang.reflect.Array");
  try {
    # Добавляет комментарий
    $author1 = $pres->getCommentAuthors()->addAuthor("Author_1", "A.A.");
    $comment1 = $author1->getComments()->addComment("comment1", $pres->getSlides()->get_Item(0), new Point2DFloat(10, 10), new Java("java.util.Date"));
    # Добавляет ответ к comment1
    $author2 = $pres->getCommentAuthors()->addAuthor("Autror_2", "B.B.");
    $reply1 = $author2->getComments()->addComment("reply 1 for comment 1", $pres->getSlides()->get_Item(0), new Point2DFloat(10, 10), new Java("java.util.Date"));
    $reply1->setParentComment($comment1);
    # Добавляет ещё один ответ к comment1
    $reply2 = $author2->getComments()->addComment("reply 2 for comment 1", $pres->getSlides()->get_Item(0), new Point2DFloat(10, 10), new Java("java.util.Date"));
    $reply2->setParentComment($comment1);
    # Добавляет ответ к существующему ответу
    $subReply = $author1->getComments()->addComment("subreply 3 for reply 2", $pres->getSlides()->get_Item(0), new Point2DFloat(10, 10), new Java("java.util.Date"));
    $subReply->setParentComment($reply2);
    $comment2 = $author2->getComments()->addComment("comment 2", $pres->getSlides()->get_Item(0), new Point2DFloat(10, 10), new Java("java.util.Date"));
    $comment3 = $author2->getComments()->addComment("comment 3", $pres->getSlides()->get_Item(0), new Point2DFloat(10, 10), new Java("java.util.Date"));
    $reply3 = $author1->getComments()->addComment("reply 4 for comment 3", $pres->getSlides()->get_Item(0), new Point2DFloat(10, 10), new Java("java.util.Date"));
    $reply3->setParentComment($comment3);
    # Отображает иерархию комментариев в консоли
    $slide = $pres->getSlides()->get_Item(0);
    $comments = $slide->getSlideComments(null);
    for($i = 0; $i < java_values($Array->getLength($comments)) ; $i++) {
      $comment = $comments[$i];
      while (!java_is_null($comment->getParentComment())) {
        System->out->print("\t");
        $comment = $comment->getParentComment();
      } 
      echo($comments[$i]->getAuthor()->getName() . " : " . $comments[$i]->getText());
      echo();
    }
    $pres->save("parent_comment.pptx", SaveFormat::Pptx);
    # Удаляет comment1 и все ответы к нему
    $comment1->remove();
    $pres->save("remove_comment.pptx", SaveFormat::Pptx);
  } finally {
    if (!java_is_null($pres)) {
      $pres->dispose();
    }
  }

Attention

При использовании метода remove (из класса Comment) для удаления комментария также удаляются ответы на этот комментарий.
Если настройка setParentComment приводит к кольцевой ссылке, будет выброшено исключение PptxEditException.

Добавление современных комментариев

В 2021 году Microsoft внедрила современные комментарии в PowerPoint. Функция современных комментариев значительно улучшает совместную работу в PowerPoint. С её помощью пользователи PowerPoint могут отмечать комментарии как решённые, привязывать их к объектам и тексту и гораздо проще взаимодействовать.

Aspose Slides поддерживает современные комментарии с помощью класса ModernComment. Методы addModernComment и insertModernComment были добавлены в класс CommentCollection.

Этот PHP‑код показывает, как добавить современный комментарий к слайду в презентации PowerPoint:

  $pres = new Presentation();
  try {
    $newAuthor = $pres->getCommentAuthors()->addAuthor("Some Author", "SA");
    $modernComment = $newAuthor->getComments()->addModernComment("This is a modern comment", $pres->getSlides()->get_Item(0), null, new Point2DFloat(100, 100), new Java("java.util.Date"));
    $pres->save("pres.pptx", SaveFormat::Pptx);
  } finally {
    if (!java_is_null($pres)) {
      $pres->dispose();
    }
  }

Удаление комментариев

Удалить все комментарии и авторов

Этот PHP‑код показывает, как удалить все комментарии и авторов в презентации:

  $presentation = new Presentation("example.pptx");
  try {
    # Удаляет все комментарии из презентации
    foreach($presentation->getCommentAuthors() as $author) {
      $author->getComments()->clear();
    }
    # Удаляет всех авторов
    $presentation->getCommentAuthors()->clear();
    $presentation->save("example_out.pptx", SaveFormat::Pptx);
  } finally {
    if (!java_is_null($presentation)) {
      $presentation->dispose();
    }
  }

Удалить отдельные комментарии

Этот PHP‑код показывает, как удалить конкретные комментарии на слайде:

  $presentation = new Presentation();
  try {
    $slide = $presentation->getSlides()->get_Item(0);
    # добавляем комментарии...
    $author = $presentation->getCommentAuthors()->addAuthor("Author", "A");
    $author->getComments()->addComment("comment 1", $slide, new Point2DFloat(0.2, 0.2), new Java("java.util.Date"));
    $author->getComments()->addComment("comment 2", $slide, new Point2DFloat(0.3, 0.2), new Java("java.util.Date"));
    # удаляем все комментарии, содержащие текст "comment 1"
    foreach($presentation->getCommentAuthors() as $commentAuthor) {
      $toRemove = new Java("java.util.ArrayList");
      foreach($slide->getSlideComments($commentAuthor) as $comment) {
        if ($comment->getText()->equals("comment 1")) {
          $toRemove->add($comment);
        }
      }
      foreach($toRemove as $comment) {
        $commentAuthor->getComments()->remove($comment);
      }
    }
    $presentation->save("pres.pptx", SaveFormat::Pptx);
  } finally {
    if (!java_is_null($presentation)) {
      $presentation->dispose();
    }
  }

FAQ

Поддерживает ли Aspose.Slides статус «решён» для современных комментариев?

Да. Modern comments предоставляют метод setStatus; вы можете задать состояние комментария (например, пометить его как решённое), и это состояние сохраняется в файле и распознаётся PowerPoint.

Поддерживаются ли обсуждения в виде цепочек ответов и есть ли ограничение вложенности?

Да. Каждый комментарий может ссылаться на свой parent comment, позволяя создавать произвольные цепочки ответов. API не объявляет конкретного ограничения глубины вложенности.

В какой системе координат определяется позиция маркера комментария на слайде?

Позиция хранится как точка с плавающей запятой в системе координат слайда. Это даёт возможность точно разместить маркер комментария там, где это необходимо.

Получение и обновление свойств представления презентации в PHP Управление заметками презентации в PHP