RarArchive::getComment

rar_comment_get

(PECL rar >= 2.0.0)

RarArchive::getComment -- rar_comment_get — Получить текст комментария из архива RAR

Объектно-ориентированный стиль (method):

public RarArchive::getComment ( ) : string

Процедурный стиль:

rar_comment_get ( RarArchive $rarfile ) : string

Возвращает (глобальный) комментарий, сохраненный в архиве RAR. Он может быть длиной вплоть до 64 KiB.

Замечание:
Модуль не поддерживает комментарии на уровне записей.

Возвращает комментарий или null, если его нет.

Замечание:
RAR в текущий момент не поддерживает комментарии в unicode. Кодировка результата не определена, но, возможно, она будет Windows-1252.

Пример #1 Объектно-ориентированный стиль


<?php
$rar_arch = RarArchive::open('commented.rar'); 
echo $rar_arch->getComment();
?>

Результатом выполнения данного примера будет что-то подобное:

This is the comment of the file commented.rar.

Пример #2 Процедурный стиль


<?php
$rar_arch = rar_open('commented.rar'); 
echo rar_comment_get($rar_arch);
?>