Skip to content

Commit aab1445

Browse files
cmb69cmb69
committed
Don't specify method return values in stubs
We also fix the @return annotation of `::open()` and `::XML()`, which return an `XMLReader` instance when called statically.
1 parent daac578 commit aab1445

File tree

2 files changed

+56
-45
lines changed

2 files changed

+56
-45
lines changed

‎ext/xmlreader/xmlreader.stub.php

+41-20
Original file line numberDiff line numberDiff line change
@@ -2,56 +2,77 @@
22

33
class XMLReader
44
{
5-
function close(): bool {}
5+
/** @return bool */
6+
function close() {}
67

78
/** @return string|null|false */
89
function getAttribute(string $name) {}
910

10-
function getAttributeNo(int $index): ?string {}
11+
/** @return ?string */
12+
function getAttributeNo(int $index) {}
1113

1214
/** @return string|null|false */
1315
function getAttributeNs(string $name, string $namespaceURI) {}
1416

15-
function getParserProperty(int $property): bool {}
17+
/** @return bool */
18+
function getParserProperty(int $property) {}
1619

17-
function isValid(): bool {}
20+
/** @return bool */
21+
function isValid() {}
1822

1923
/** @return string|null|false */
2024
function lookupNamespace(string $prefix) {}
2125

22-
function moveToAttribute(string $name): bool {}
26+
/** @return bool */
27+
function moveToAttribute(string $name) {}
2328

24-
function moveToAttributeNo(int $index): bool {}
29+
/** @return bool */
30+
function moveToAttributeNo(int $index) {}
2531

26-
function moveToAttributeNs(string $name, string $namespaceURI): bool {}
32+
/** @return bool */
33+
function moveToAttributeNs(string $name, string $namespaceURI) {}
2734

28-
function moveToElement(): bool {}
35+
/** @return bool */
36+
function moveToElement() {}
2937

30-
function moveToFirstAttribute(): bool {}
38+
/** @return bool */
39+
function moveToFirstAttribute() {}
3140

32-
function moveToNextAttribute(): bool {}
41+
/** @return bool */
42+
function moveToNextAttribute() {}
3343

34-
function read(): bool {}
44+
/** @return bool */
45+
function read() {}
3546

36-
function next(string $localname = UNKNOWN): bool {}
47+
/** @return bool */
48+
function next(string $localname = UNKNOWN) {}
3749

38-
function open(string $URI, ?string $encoding = null, int $options = 0): bool {}
50+
/** @return bool|XMLReader */
51+
function open(string $URI, ?string $encoding = null, int $options = 0) {}
3952

40-
function readInnerXml(): string {}
53+
/** @return string */
54+
function readInnerXml() {}
4155

42-
function readOuterXml(): string {}
56+
/** @return string */
57+
function readOuterXml() {}
4358

44-
function readString(): string {}
59+
/** @return string */
60+
function readString() {}
4561

62+
/** @return bool */
4663
function setSchema(?string $filename) {}
4764

48-
function setParserProperty(int $property, bool $value): bool {}
65+
/** @return bool */
66+
function setParserProperty(int $property, bool $value) {}
4967

50-
function setRelaxNGSchema(?string $filename): bool {}
68+
/** @return bool */
69+
function setRelaxNGSchema(?string $filename) {}
5170

52-
function setRelaxNGSchemaSource(?string $source): bool {}
71+
/** @return bool */
72+
function setRelaxNGSchemaSource(?string $source) {}
5373

54-
function XML(string $source, ?string $encoding = null, int $options = 0): bool {}
74+
/** @return bool|XMLReader */
75+
function XML(string $source, ?string $encoding = null, int $options = 0) {}
5576

5677
/** @return DOMNode|bool */
5778
function expand(?DOMNode $basenode = null) {}

‎ext/xmlreader/xmlreader_arginfo.h

+15-25
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
/* This is a generated file, edit the .stub.php file instead. */
22

3-
ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_class_XMLReader_close, 0, 0, _IS_BOOL, 0)
3+
ZEND_BEGIN_ARG_INFO_EX(arginfo_class_XMLReader_close, 0, 0, 0)
44
ZEND_END_ARG_INFO()
55

66
ZEND_BEGIN_ARG_INFO_EX(arginfo_class_XMLReader_getAttribute, 0, 0, 1)
77
ZEND_ARG_TYPE_INFO(0, name, IS_STRING, 0)
88
ZEND_END_ARG_INFO()
99

10-
ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_class_XMLReader_getAttributeNo, 0, 1, IS_STRING, 1)
10+
ZEND_BEGIN_ARG_INFO_EX(arginfo_class_XMLReader_getAttributeNo, 0, 0, 1)
1111
ZEND_ARG_TYPE_INFO(0, index, IS_LONG, 0)
1212
ZEND_END_ARG_INFO()
1313

@@ -16,7 +16,7 @@ ZEND_BEGIN_ARG_INFO_EX(arginfo_class_XMLReader_getAttributeNs, 0, 0, 2)
1616
ZEND_ARG_TYPE_INFO(0, namespaceURI, IS_STRING, 0)
1717
ZEND_END_ARG_INFO()
1818

19-
ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_class_XMLReader_getParserProperty, 0, 1, _IS_BOOL, 0)
19+
ZEND_BEGIN_ARG_INFO_EX(arginfo_class_XMLReader_getParserProperty, 0, 0, 1)
2020
ZEND_ARG_TYPE_INFO(0, property, IS_LONG, 0)
2121
ZEND_END_ARG_INFO()
2222

@@ -26,18 +26,11 @@ ZEND_BEGIN_ARG_INFO_EX(arginfo_class_XMLReader_lookupNamespace, 0, 0, 1)
2626
ZEND_ARG_TYPE_INFO(0, prefix, IS_STRING, 0)
2727
ZEND_END_ARG_INFO()
2828

29-
ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_class_XMLReader_moveToAttribute, 0, 1, _IS_BOOL, 0)
30-
ZEND_ARG_TYPE_INFO(0, name, IS_STRING, 0)
31-
ZEND_END_ARG_INFO()
29+
#define arginfo_class_XMLReader_moveToAttribute arginfo_class_XMLReader_getAttribute
3230

33-
ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_class_XMLReader_moveToAttributeNo, 0, 1, _IS_BOOL, 0)
34-
ZEND_ARG_TYPE_INFO(0, index, IS_LONG, 0)
35-
ZEND_END_ARG_INFO()
31+
#define arginfo_class_XMLReader_moveToAttributeNo arginfo_class_XMLReader_getAttributeNo
3632

37-
ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_class_XMLReader_moveToAttributeNs, 0, 2, _IS_BOOL, 0)
38-
ZEND_ARG_TYPE_INFO(0, name, IS_STRING, 0)
39-
ZEND_ARG_TYPE_INFO(0, namespaceURI, IS_STRING, 0)
40-
ZEND_END_ARG_INFO()
33+
#define arginfo_class_XMLReader_moveToAttributeNs arginfo_class_XMLReader_getAttributeNs
4134

4235
#define arginfo_class_XMLReader_moveToElement arginfo_class_XMLReader_close
4336

@@ -47,41 +40,38 @@ ZEND_END_ARG_INFO()
4740

4841
#define arginfo_class_XMLReader_read arginfo_class_XMLReader_close
4942

50-
ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_class_XMLReader_next, 0, 0, _IS_BOOL, 0)
43+
ZEND_BEGIN_ARG_INFO_EX(arginfo_class_XMLReader_next, 0, 0, 0)
5144
ZEND_ARG_TYPE_INFO(0, localname, IS_STRING, 0)
5245
ZEND_END_ARG_INFO()
5346

54-
ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_class_XMLReader_open, 0, 1, _IS_BOOL, 0)
47+
ZEND_BEGIN_ARG_INFO_EX(arginfo_class_XMLReader_open, 0, 0, 1)
5548
ZEND_ARG_TYPE_INFO(0, URI, IS_STRING, 0)
5649
ZEND_ARG_TYPE_INFO(0, encoding, IS_STRING, 1)
5750
ZEND_ARG_TYPE_INFO(0, options, IS_LONG, 0)
5851
ZEND_END_ARG_INFO()
5952

60-
ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_class_XMLReader_readInnerXml, 0, 0, IS_STRING, 0)
61-
ZEND_END_ARG_INFO()
53+
#define arginfo_class_XMLReader_readInnerXml arginfo_class_XMLReader_close
6254

63-
#define arginfo_class_XMLReader_readOuterXml arginfo_class_XMLReader_readInnerXml
55+
#define arginfo_class_XMLReader_readOuterXml arginfo_class_XMLReader_close
6456

65-
#define arginfo_class_XMLReader_readString arginfo_class_XMLReader_readInnerXml
57+
#define arginfo_class_XMLReader_readString arginfo_class_XMLReader_close
6658

6759
ZEND_BEGIN_ARG_INFO_EX(arginfo_class_XMLReader_setSchema, 0, 0, 1)
6860
ZEND_ARG_TYPE_INFO(0, filename, IS_STRING, 1)
6961
ZEND_END_ARG_INFO()
7062

71-
ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_class_XMLReader_setParserProperty, 0, 2, _IS_BOOL, 0)
63+
ZEND_BEGIN_ARG_INFO_EX(arginfo_class_XMLReader_setParserProperty, 0, 0, 2)
7264
ZEND_ARG_TYPE_INFO(0, property, IS_LONG, 0)
7365
ZEND_ARG_TYPE_INFO(0, value, _IS_BOOL, 0)
7466
ZEND_END_ARG_INFO()
7567

76-
ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_class_XMLReader_setRelaxNGSchema, 0, 1, _IS_BOOL, 0)
77-
ZEND_ARG_TYPE_INFO(0, filename, IS_STRING, 1)
78-
ZEND_END_ARG_INFO()
68+
#define arginfo_class_XMLReader_setRelaxNGSchema arginfo_class_XMLReader_setSchema
7969

80-
ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_class_XMLReader_setRelaxNGSchemaSource, 0, 1, _IS_BOOL, 0)
70+
ZEND_BEGIN_ARG_INFO_EX(arginfo_class_XMLReader_setRelaxNGSchemaSource, 0, 0, 1)
8171
ZEND_ARG_TYPE_INFO(0, source, IS_STRING, 1)
8272
ZEND_END_ARG_INFO()
8373

84-
ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_class_XMLReader_XML, 0, 1, _IS_BOOL, 0)
74+
ZEND_BEGIN_ARG_INFO_EX(arginfo_class_XMLReader_XML, 0, 0, 1)
8575
ZEND_ARG_TYPE_INFO(0, source, IS_STRING, 0)
8676
ZEND_ARG_TYPE_INFO(0, encoding, IS_STRING, 1)
8777
ZEND_ARG_TYPE_INFO(0, options, IS_LONG, 0)

0 commit comments

Comments
 (0)