Bitrix-D7  20.5.0
Класс Archive
Граф наследования:Archive:
HttpResponse Response

Открытые члены

 __construct ($name)
 Archive constructor. Подробнее...
 
 addEntry ($archiveEntry)
 Add one entry. Подробнее...
 
 isEmpty ()
 Returns true if the archive does not have entries. Подробнее...
 
 send ()
 Sends content to output stream and sets necessary headers. Подробнее...
 
- Открытые члены унаследованные от HttpResponse
 __construct ()
 
 flush ($text='')
 Flushes the content to the output buffer. Подробнее...
 
 addHeader ($name, $value='')
 Adds a HTTP header field to the response. Подробнее...
 
 setHeaders (Web\HttpHeaders $headers)
 Sets a collection of HTTP headers. Подробнее...
 
 addCookie (Web\Cookie $cookie, $replace=true, $checkExpires=true)
 Adds a cookie to the response. Подробнее...
 
 allowPersistentCookies ($mode)
 Remembers user's choice about storing persistent cookies. Подробнее...
 
 getCookies ()
 
 getHeaders ()
 
 writeHeaders ()
 Flushes all headers and cookies. Подробнее...
 
 setStatus ($status)
 Sets the HTTP status of the response. Подробнее...
 
 getStatus ()
 Returns the HTTP status of the response. Подробнее...
 
 setLastModified (Type\DateTime $time)
 Sets the latest time for the Last-Modified header field. Подробнее...
 
 redirectTo ($url)
 
 copyHeadersTo (HttpResponse $response)
 
- Открытые члены унаследованные от Response
 clear ()
 
 setContent ($content)
 Sets content. Подробнее...
 
 appendContent ($content)
 Appends content. Подробнее...
 
 getContent ()
 Returns content of response. Подробнее...
 

Защищенные члены

 getFileList ()
 Return entries as string. Подробнее...
 
 setContentDispositionHeader ()
 
- Защищенные члены унаследованные от HttpResponse
 initializeHeaders ()
 
 flushHeader ($header)
 
 setCookie (Web\Cookie $cookie)
 
 getServerProtocol ()
 
- Защищенные члены унаследованные от Response
 checkContent ($content)
 
 writeBody ($text)
 

Защищенные данные

 $name
 
 $entries = []
 
- Защищенные данные унаследованные от HttpResponse
 $cookies = array()
 
 $headers
 
 $lastModified
 
- Защищенные данные унаследованные от Response
 $content
 

Дополнительные унаследованные члены

- Поля данных унаследованные от HttpResponse
const STORE_COOKIE_NAME = "STORE_COOKIES"
 

Подробное описание

См. определение в файле main/lib/engine/response/zip/archive.php строка 6

Конструктор(ы)

◆ __construct()

__construct (   $name)

Archive constructor.

Аргументы
string$nameArchive name.

См. определение в файле main/lib/engine/response/zip/archive.php строка 24

25  {
27  $this->name = $name;
28 
29  $this->addHeader('X-Archive-Files', 'zip');
30  }
addHeader($name, $value='')
Adds a HTTP header field to the response.
__construct(Base $connector)
Constructor.
Definition: resultview.php:40

Методы

◆ addEntry()

addEntry (   $archiveEntry)

Add one entry.

in current archive.

Аргументы
ArchiveEntry$archiveEntryEntry for archive.

См. определение в файле main/lib/engine/response/zip/archive.php строка 36

37  {
38  if ($archiveEntry instanceof ArchiveEntry)
39  {
40  $this->entries[] = $archiveEntry;
41  }
42  }

◆ getFileList()

getFileList ( )
protected

Return entries as string.

Возвращает
string

См. определение в файле main/lib/engine/response/zip/archive.php строка 57

58  {
59  $list = [];
60  foreach ($this->entries as $entry)
61  {
62  $list[] = (string)$entry;
63  }
64 
65  return implode("\n", $list);
66  }

◆ isEmpty()

isEmpty ( )

Returns true if the archive does not have entries.

Возвращает
bool

См. определение в файле main/lib/engine/response/zip/archive.php строка 48

49  {
50  return empty($this->entries);
51  }

◆ send()

send ( )

Sends content to output stream and sets necessary headers.

Возвращает
void

Переопределяет метод предка Response.

См. определение в файле main/lib/engine/response/zip/archive.php строка 86

87  {
88  if (!$this->isEmpty())
89  {
91  $this->setContent(
92  $this->getFileList()
93  );
94  }
95 
96  parent::send();
97  }
isEmpty()
Returns true if the archive does not have entries.
setContent($content)
Sets content.

◆ setContentDispositionHeader()

setContentDispositionHeader ( )
protected

См. определение в файле main/lib/engine/response/zip/archive.php строка 68

69  {
70  $utfName = \CHTTP::urnEncode($this->name, 'UTF-8');
71  $translitName = \CUtil::translit($this->name, LANGUAGE_ID, [
72  'max_len' => 1024,
73  'safe_chars' => '.',
74  'replace_space' => '-',
75  ]);
76  $this->addHeader(
77  'Content-Disposition',
78  "attachment; filename=\"{$translitName}\"; filename*=utf-8''{$utfName}"
79  );
80  }

Поля

◆ $entries

$entries = []
protected

См. определение в файле main/lib/engine/response/zip/archive.php строка 18

◆ $name

$name
protected

См. определение в файле main/lib/engine/response/zip/archive.php строка 12


Объявления и описания членов класса находятся в файле: