Skip to content

Add docs for memory_reset_peak_usage() #1809

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Sep 26, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions reference/info/functions/memory-get-peak-usage.xml
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,7 @@
<para>
<simplelist>
<member><function>memory_get_usage</function></member>
<member><function>memory_reset_peak_usage</function></member>
<member><link linkend="ini.memory-limit">memory_limit</link></member>
</simplelist>
</para>
Expand Down
97 changes: 97 additions & 0 deletions reference/info/functions/memory-reset-peak-usage.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,97 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.memory-reset-peak-usage" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>memory_reset_peak_usage</refname>
<refpurpose>Reset the peak memory usage</refpurpose>
</refnamediv>

<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>void</type><methodname>memory_reset_peak_usage</methodname>
<void/>
</methodsynopsis>
<para>
Resets the peak memory usage returned by the
<function>memory_get_peak_usage</function> function.
</para>
</refsect1>

<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>

<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.void;
</para>
</refsect1>

<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>memory_reset_peak_usage</function> example</title>
<programlisting role="php">
<![CDATA[
<?php

var_dump(memory_get_peak_usage());

$a = str_repeat("Hello", 424242);
var_dump(memory_get_peak_usage());

unset($a);
memory_reset_peak_usage();

$a = str_repeat("Hello", 2424);
var_dump(memory_get_peak_usage());

?>
]]>
</programlisting>
&example.outputs.similar;
<screen>
<![CDATA[
int(422440)
int(2508672)
int(399208)
]]>
</screen>
</example>
</para>
</refsect1>

<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>memory_get_peak_usage</function></member>
</simplelist>
</para>
</refsect1>

</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
1 change: 1 addition & 0 deletions reference/info/versions.xml
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@
<function name="ini_get_all" from="PHP 4 &gt;= 4.2.0, PHP 5, PHP 7, PHP 8"/>
<function name="ini_restore" from="PHP 4, PHP 5, PHP 7, PHP 8"/>
<function name="ini_set" from="PHP 4, PHP 5, PHP 7, PHP 8"/>
<function name="memory_reset_peak_usage" from="PHP 8 &gt;= 8.2.0"/>
<function name="memory_get_peak_usage" from="PHP 5 &gt;= 5.2.0, PHP 7, PHP 8"/>
<function name="memory_get_usage" from="PHP 4 &gt;= 4.3.2, PHP 5, PHP 7, PHP 8"/>
<function name="php_ini_loaded_file" from="PHP 5 &gt;= 5.2.4, PHP 7, PHP 8"/>
Expand Down