array ( 0 => 'index.php', 1 => 'PHP Manual', ), 'head' => array ( 0 => 'UTF-8', 1 => 'uk', ), 'this' => array ( 0 => 'rararchive.getcomment.php', 1 => 'RarArchive::getComment', 2 => 'Get comment text from the RAR archive', ), 'up' => array ( 0 => 'class.rararchive.php', 1 => 'RarArchive', ), 'prev' => array ( 0 => 'rararchive.close.php', 1 => 'RarArchive::close', ), 'next' => array ( 0 => 'rararchive.getentries.php', 1 => 'RarArchive::getEntries', ), 'alternatives' => array ( ), 'source' => array ( 'lang' => 'en', 'path' => 'reference/rar/rararchive/getcomment.xml', ), 'history' => array ( ), ); $setup["toc"] = $TOC; $setup["toc_deprecated"] = $TOC_DEPRECATED; $setup["parents"] = $PARENTS; manual_setup($setup); contributors($setup); ?>

RarArchive::getComment

rar_comment_get

(PECL rar >= 2.0.0)

RarArchive::getComment -- rar_comment_get — Get comment text from the RAR archive

Опис

Об'єктно-орієнтований стиль (method):

public RarArchive::getComment(): string

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

rar_comment_get(RarArchive $rarfile): string

Get the (global) comment stored in the RAR archive. It may be up to 64 KiB long.

Зауваження:

This extension does not support comments at the entry level.

Параметри

rarfile

A RarArchive object, opened with rar_open().

Значення, що повертаються

Returns the comment or null if there is none.

Зауваження:

RAR has currently no support for unicode comments. The encoding of the result of this function is not specified, but it will probably be 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);
?>