...

...

@@ -1,15 +1,15 @@

1

1

<?xml version="1.0" encoding="utf-8"?>

2

2

<!-- $Revision$ -->

3

-

<refentry xmlns="http://docbook.org/ns/docbook" xml:id="phar.count">

3

+

<refentry xml:id="phar.count" xmlns="http://docbook.org/ns/docbook">

4

4

<refnamediv>

5

5

<refname>Phar::count</refname>

6

6

<refpurpose>Returns the number of entries (files) in the Phar archive</refpurpose>

7

7

</refnamediv>

8

8

<refsect1 role="description">

9

9

&reftitle.description;

10

-

<methodsynopsis>

10

+

<methodsynopsis role="Phar">

11

11

<modifier>public</modifier> <type>int</type><methodname>Phar::count</methodname>

12

-

<void/>

12

+

<methodparam choice="opt"><type>int</type><parameter>mode</parameter><initializer><constant>COUNT_NORMAL</constant></initializer></methodparam>

13

13

</methodsynopsis>

14

14

15

15

<para>

...

...

@@ -18,8 +18,20 @@

18

18

</refsect1>

19

19

<refsect1 role="parameters">

20

20

&reftitle.parameters;

21

-

<para>

22

-

</para>

21

+

<variablelist>

22

+

<varlistentry>

23

+

<term><parameter>mode</parameter></term>

24

+

<listitem>

25

+

<para>

26

+

<parameter>mode</parameter> is an integer value specifying the counting mode to be used.

27

+

By default, it is set to <constant>COUNT_NORMAL</constant>,

28

+

which counts only the number of items in the archive that have not been deleted or hidden.

29

+

When set to <constant>COUNT_RECURSIVE</constant>, it counts all items in the archive,

30

+

including those that have been deleted or hidden.

31

+

</para>

32

+

</listitem>

33

+

</varlistentry>

34

+

</variablelist>

23

35

</refsect1>

24

36

<refsect1 role="returnvalues">

25

37

&reftitle.returnvalues;

...

...

@@ -64,7 +76,6 @@ The new phar has 1 entries

64

76

</refsect1>

65

77

66

78

</refentry>

67

-

68

79

<!-- Keep this comment at the end of the file

69

80

Local variables:

70

81

mode: sgml

71

82