Skip to content

Declare tentative return types for ext/tidy #6999

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

Closed
wants to merge 1 commit into from
Closed
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
72 changes: 36 additions & 36 deletions ext/tidy/tidy.stub.php
Original file line number Diff line number Diff line change
Expand Up @@ -57,108 +57,108 @@ class tidy
public function __construct(?string $filename = null, array|string|null $config = null, ?string $encoding = null, bool $useIncludePath = false) {}

/**
* @return string|int|bool
* @tentative-return-type
* @alias tidy_getopt
*/
public function getOpt(string $option) {}
public function getOpt(string $option): string|int|bool {}

/**
* @return bool
* @tentative-return-type
* @alias tidy_clean_repair
*/
public function cleanRepair() {}
public function cleanRepair(): bool {}

/** @return bool */
public function parseFile(string $filename, array|string|null $config = null, ?string $encoding = null, bool $useIncludePath = false) {}
/** @tentative-return-type */
public function parseFile(string $filename, array|string|null $config = null, ?string $encoding = null, bool $useIncludePath = false): bool {}

/** @return bool */
public function parseString(string $string, array|string|null $config = null, ?string $encoding = null) {}
/** @tentative-return-type */
public function parseString(string $string, array|string|null $config = null, ?string $encoding = null): bool {}

/**
* @return string|false
* @tentative-return-type
* @alias tidy_repair_string
*/
public static function repairString(string $string, array|string|null $config = null, ?string $encoding = null) {}
public static function repairString(string $string, array|string|null $config = null, ?string $encoding = null): string|false {}

/**
* @return string|false
* @tentative-return-type
* @alias tidy_repair_file
*/
public static function repairFile(string $filename, array|string|null $config = null, ?string $encoding = null, bool $useIncludePath = false) {}
public static function repairFile(string $filename, array|string|null $config = null, ?string $encoding = null, bool $useIncludePath = false): string|false {}

/**
* @return bool
* @tentative-return-type
* @alias tidy_diagnose
*/
public function diagnose() {}
public function diagnose(): bool {}

/**
* @return string
* @tentative-return-type
* @alias tidy_get_release
*/
public function getRelease() {}
public function getRelease(): string {}

/**
* @return array
* @tentative-return-type
* @alias tidy_get_config
*/
public function getConfig() {}
public function getConfig(): array {}

/**
* @return int
* @tentative-return-type
* @alias tidy_get_status
*/
public function getStatus() {}
public function getStatus(): int {}

/**
* @return int
* @tentative-return-type
* @alias tidy_get_html_ver
*/
public function getHtmlVer() {}
public function getHtmlVer(): int {}

#ifdef HAVE_TIDYOPTGETDOC
/**
* @return string|false
* @tentative-return-type
* @alias tidy_get_opt_doc
*/
public function getOptDoc(string $option) {}
public function getOptDoc(string $option): string|false {}
#endif

/**
* @return bool
* @tentative-return-type
* @alias tidy_is_xhtml
*/
public function isXhtml() {}
public function isXhtml(): bool {}

/**
* @return bool
* @tentative-return-type
* @alias tidy_is_xml
*/
public function isXml() {}
public function isXml(): bool {}

/**
* @return tidyNode|null
* @tentative-return-type
* @alias tidy_get_root
*/
public function root() {}
public function root(): ?tidyNode {}

/**
* @return tidyNode|null
* @tentative-return-type
* @alias tidy_get_head
*/
public function head() {}
public function head(): ?tidyNode {}

/**
* @return tidyNode|null
* @tentative-return-type
* @alias tidy_get_html
*/
public function html() {}
public function html(): ?tidyNode {}

/**
* @return tidyNode|null
* @tentative-return-type
* @alias tidy_get_body
*/
public function body() {}
public function body(): ?tidyNode {}
}

final class tidyNode
Expand Down
48 changes: 31 additions & 17 deletions ext/tidy/tidy_arginfo.h
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/* This is a generated file, edit the .stub.php file instead.
* Stub hash: 75995fe0aad02540f1bde99495a188ae4ab7c0ac */
* Stub hash: 4e5f6c0e7c6b8a6939a13276e3e68d2614a73d7e */

ZEND_BEGIN_ARG_WITH_RETURN_OBJ_TYPE_MASK_EX(arginfo_tidy_parse_string, 0, 1, tidy, MAY_BE_FALSE)
ZEND_ARG_TYPE_INFO(0, string, IS_STRING, 0)
Expand Down Expand Up @@ -95,42 +95,54 @@ ZEND_BEGIN_ARG_INFO_EX(arginfo_class_tidy___construct, 0, 0, 0)
ZEND_ARG_TYPE_INFO_WITH_DEFAULT_VALUE(0, useIncludePath, _IS_BOOL, 0, "false")
ZEND_END_ARG_INFO()

ZEND_BEGIN_ARG_INFO_EX(arginfo_class_tidy_getOpt, 0, 0, 1)
ZEND_BEGIN_ARG_WITH_TENTATIVE_RETURN_TYPE_MASK_EX(arginfo_class_tidy_getOpt, 0, 1, MAY_BE_STRING|MAY_BE_LONG|MAY_BE_BOOL)
ZEND_ARG_TYPE_INFO(0, option, IS_STRING, 0)
ZEND_END_ARG_INFO()

ZEND_BEGIN_ARG_INFO_EX(arginfo_class_tidy_cleanRepair, 0, 0, 0)
ZEND_BEGIN_ARG_WITH_TENTATIVE_RETURN_TYPE_INFO_EX(arginfo_class_tidy_cleanRepair, 0, 0, _IS_BOOL, 0)
ZEND_END_ARG_INFO()

ZEND_BEGIN_ARG_INFO_EX(arginfo_class_tidy_parseFile, 0, 0, 1)
ZEND_BEGIN_ARG_WITH_TENTATIVE_RETURN_TYPE_INFO_EX(arginfo_class_tidy_parseFile, 0, 1, _IS_BOOL, 0)
ZEND_ARG_TYPE_INFO(0, filename, IS_STRING, 0)
ZEND_ARG_TYPE_MASK(0, config, MAY_BE_ARRAY|MAY_BE_STRING|MAY_BE_NULL, "null")
ZEND_ARG_TYPE_INFO_WITH_DEFAULT_VALUE(0, encoding, IS_STRING, 1, "null")
ZEND_ARG_TYPE_INFO_WITH_DEFAULT_VALUE(0, useIncludePath, _IS_BOOL, 0, "false")
ZEND_END_ARG_INFO()

ZEND_BEGIN_ARG_INFO_EX(arginfo_class_tidy_parseString, 0, 0, 1)
ZEND_BEGIN_ARG_WITH_TENTATIVE_RETURN_TYPE_INFO_EX(arginfo_class_tidy_parseString, 0, 1, _IS_BOOL, 0)
ZEND_ARG_TYPE_INFO(0, string, IS_STRING, 0)
ZEND_ARG_TYPE_MASK(0, config, MAY_BE_ARRAY|MAY_BE_STRING|MAY_BE_NULL, "null")
ZEND_ARG_TYPE_INFO_WITH_DEFAULT_VALUE(0, encoding, IS_STRING, 1, "null")
ZEND_END_ARG_INFO()

#define arginfo_class_tidy_repairString arginfo_class_tidy_parseString
ZEND_BEGIN_ARG_WITH_TENTATIVE_RETURN_TYPE_MASK_EX(arginfo_class_tidy_repairString, 0, 1, MAY_BE_STRING|MAY_BE_FALSE)
ZEND_ARG_TYPE_INFO(0, string, IS_STRING, 0)
ZEND_ARG_TYPE_MASK(0, config, MAY_BE_ARRAY|MAY_BE_STRING|MAY_BE_NULL, "null")
ZEND_ARG_TYPE_INFO_WITH_DEFAULT_VALUE(0, encoding, IS_STRING, 1, "null")
ZEND_END_ARG_INFO()

#define arginfo_class_tidy_repairFile arginfo_class_tidy_parseFile
ZEND_BEGIN_ARG_WITH_TENTATIVE_RETURN_TYPE_MASK_EX(arginfo_class_tidy_repairFile, 0, 1, MAY_BE_STRING|MAY_BE_FALSE)
ZEND_ARG_TYPE_INFO(0, filename, IS_STRING, 0)
ZEND_ARG_TYPE_MASK(0, config, MAY_BE_ARRAY|MAY_BE_STRING|MAY_BE_NULL, "null")
ZEND_ARG_TYPE_INFO_WITH_DEFAULT_VALUE(0, encoding, IS_STRING, 1, "null")
ZEND_ARG_TYPE_INFO_WITH_DEFAULT_VALUE(0, useIncludePath, _IS_BOOL, 0, "false")
ZEND_END_ARG_INFO()

#define arginfo_class_tidy_diagnose arginfo_class_tidy_cleanRepair

#define arginfo_class_tidy_getRelease arginfo_class_tidy_cleanRepair
ZEND_BEGIN_ARG_WITH_TENTATIVE_RETURN_TYPE_INFO_EX(arginfo_class_tidy_getRelease, 0, 0, IS_STRING, 0)
ZEND_END_ARG_INFO()

#define arginfo_class_tidy_getConfig arginfo_class_tidy_cleanRepair
ZEND_BEGIN_ARG_WITH_TENTATIVE_RETURN_TYPE_INFO_EX(arginfo_class_tidy_getConfig, 0, 0, IS_ARRAY, 0)
ZEND_END_ARG_INFO()

#define arginfo_class_tidy_getStatus arginfo_class_tidy_cleanRepair
ZEND_BEGIN_ARG_WITH_TENTATIVE_RETURN_TYPE_INFO_EX(arginfo_class_tidy_getStatus, 0, 0, IS_LONG, 0)
ZEND_END_ARG_INFO()

#define arginfo_class_tidy_getHtmlVer arginfo_class_tidy_cleanRepair
#define arginfo_class_tidy_getHtmlVer arginfo_class_tidy_getStatus

#if defined(HAVE_TIDYOPTGETDOC)
ZEND_BEGIN_ARG_INFO_EX(arginfo_class_tidy_getOptDoc, 0, 0, 1)
ZEND_BEGIN_ARG_WITH_TENTATIVE_RETURN_TYPE_MASK_EX(arginfo_class_tidy_getOptDoc, 0, 1, MAY_BE_STRING|MAY_BE_FALSE)
ZEND_ARG_TYPE_INFO(0, option, IS_STRING, 0)
ZEND_END_ARG_INFO()
#endif
Expand All @@ -139,15 +151,17 @@ ZEND_END_ARG_INFO()

#define arginfo_class_tidy_isXml arginfo_class_tidy_cleanRepair

#define arginfo_class_tidy_root arginfo_class_tidy_cleanRepair
ZEND_BEGIN_ARG_WITH_TENTATIVE_RETURN_OBJ_INFO_EX(arginfo_class_tidy_root, 0, 0, tidyNode, 1)
ZEND_END_ARG_INFO()

#define arginfo_class_tidy_head arginfo_class_tidy_cleanRepair
#define arginfo_class_tidy_head arginfo_class_tidy_root

#define arginfo_class_tidy_html arginfo_class_tidy_cleanRepair
#define arginfo_class_tidy_html arginfo_class_tidy_root

#define arginfo_class_tidy_body arginfo_class_tidy_cleanRepair
#define arginfo_class_tidy_body arginfo_class_tidy_root

#define arginfo_class_tidyNode___construct arginfo_class_tidy_cleanRepair
ZEND_BEGIN_ARG_INFO_EX(arginfo_class_tidyNode___construct, 0, 0, 0)
ZEND_END_ARG_INFO()

ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_class_tidyNode_hasChildren, 0, 0, _IS_BOOL, 0)
ZEND_END_ARG_INFO()
Expand Down