doc-en icon indicating copy to clipboard operation
doc-en copied to clipboard

Document missing functions/methods

Open kocsismate opened this issue 3 years ago • 6 comments

Currently, the following internal functions/methods are not yet documented:

  • [x] SensitiveParameterValue::__construct()
  • [x] SensitiveParameterValue::getValue()
  • [x] SensitiveParameterValue::__debugInfo()
  • [ ] Exception::__wakeup()
  • [ ] Error::__wakeup()
  • [ ] DateTimeInterface::__serialize()
  • [ ] DateTimeInterface::__unserialize()
  • [ ] DateTime::__serialize()
  • [ ] DateTime::__unserialize()
  • [ ] DateTimeImmutable::__serialize()
  • [ ] DateTimeImmutable::__unserialize()
  • [ ] DateTimeZone::__serialize()
  • [ ] DateTimeZone::__unserialize()
  • [ ] DateTimeZone::__wakeup()
  • [ ] DateTimeZone::__set_state()
  • [ ] DateInterval::__serialize()
  • [ ] DateInterval::__unserialize()
  • [ ] DateInterval::__wakeup()
  • [ ] DateInterval::__set_state()
  • [ ] DatePeriod::__serialize()
  • [ ] DatePeriod::__unserialize()
  • [ ] DatePeriod::__wakeup()
  • [ ] DatePeriod::__set_state()
  • [ ] DatePeriod::getIterator()
  • [ ] DOMNode::lookupNamespaceURI()
  • [x] DOMImplementation::getFeature() (See #820)
  • [ ] DOMDocumentFragment::append()
  • [ ] DOMDocumentFragment::prepend()
  • [ ] DOMNodeList::getIterator()
  • [ ] DOMCharacterData::replaceWith()
  • [ ] DOMCharacterData::remove()
  • [ ] DOMCharacterData::before()
  • [ ] DOMCharacterData::after()
  • [ ] DOMElement::remove()
  • [ ] DOMElement::before()
  • [ ] DOMElement::after()
  • [ ] DOMElement::replaceWith()
  • [ ] DOMElement::append()
  • [ ] DOMElement::prepend()
  • [ ] DOMDocument::adoptNode()
  • [ ] DOMDocument::append()
  • [ ] DOMDocument::prepend()
  • [ ] DOMNamedNodeMap::getIterator()
  • [x] _()
  • [x] imap_is_open() (#2583)
  • [ ] IntlBreakIterator::getIterator()
  • [ ] IntlPartsIterator::getRuleStatus()
  • [ ] intlgregcal_create_instance()
  • [ ] intlgregcal_set_gregorian_change()
  • [ ] intlgregcal_get_gregorian_change()
  • [ ] intlgregcal_is_leap_year()
  • [ ] locale_canonicalize()
  • [ ] ResourceBundle::getIterator()
  • [ ] Spoofchecker::setRestrictionLevel()
  • [ ] json_validate()
  • [x] mysqli::escape_string()
  • [x] mysqli::set_opt()
  • [ ] oci_lob_save()
  • [ ] oci_lob_import()
  • [ ] oci_lob_load()
  • [ ] oci_lob_read()
  • [ ] oci_lob_eof()
  • [ ] oci_lob_tell()
  • [ ] oci_lob_rewind()
  • [ ] oci_lob_seek()
  • [ ] oci_lob_size()
  • [ ] oci_lob_write()
  • [ ] oci_lob_append()
  • [ ] oci_lob_truncate()
  • [ ] oci_lob_erase()
  • [ ] oci_lob_flush()
  • [ ] ocisetbufferinglob()
  • [ ] ocigetbufferinglob()
  • [ ] oci_lob_export()
  • [ ] ocifetchinto()
  • [ ] oci_free_cursor()
  • [ ] ocipasswordchange()
  • [ ] oci_free_collection()
  • [ ] oci_collection_append()
  • [ ] oci_collection_element_get()
  • [ ] oci_collection_assign()
  • [ ] oci_collection_element_assign()
  • [ ] oci_collection_size()
  • [ ] oci_collection_max()
  • [ ] oci_collection_trim()
  • [ ] pcntl_wifcontinued()
  • [ ] pcntl_forkx()
  • [ ] pg_errormessage()
  • [ ] pg_exec()
  • [ ] pg_numrows()
  • [ ] pg_numfields()
  • [ ] pg_cmdtuples()
  • [ ] pg_fieldname()
  • [ ] pg_fieldsize()
  • [ ] pg_fieldtype()
  • [ ] pg_fieldnum()
  • [ ] pg_result()
  • [ ] pg_fieldprtlen()
  • [ ] pg_fieldisnull()
  • [ ] pg_freeresult()
  • [ ] pg_getlastoid()
  • [ ] pg_locreate()
  • [ ] pg_lounlink()
  • [ ] pg_loopen()
  • [ ] pg_loclose()
  • [ ] pg_loread()
  • [ ] pg_lowrite()
  • [ ] pg_loreadall()
  • [ ] pg_loimport()
  • [ ] pg_loexport()
  • [ ] pg_setclientencoding()
  • [ ] pg_clientencoding()
  • [ ] PharData::count()
  • [ ] PharData::getAlias()
  • [ ] PharData::getPath()
  • [ ] PharData::getMetadata()
  • [ ] PharData::getModified()
  • [ ] PharData::getSignature()
  • [ ] PharData::getStub()
  • [ ] PharData::getVersion()
  • [ ] PharData::hasMetadata()
  • [ ] PharData::isBuffering()
  • [ ] PharData::isCompressed()
  • [ ] PharData::isFileFormat()
  • [ ] PharData::offsetExists()
  • [ ] PharData::offsetGet()
  • [ ] PharData::startBuffering()
  • [ ] PharData::stopBuffering()
  • [ ] PharData::apiVersion()
  • [ ] PharData::canCompress()
  • [ ] PharData::canWrite()
  • [ ] PharData::createDefaultStub()
  • [ ] PharData::getSupportedCompression()
  • [ ] PharData::getSupportedSignatures()
  • [ ] PharData::interceptFileFuncs()
  • [ ] PharData::isValidPharFilename()
  • [ ] PharData::loadPhar()
  • [ ] PharData::mapPhar()
  • [ ] PharData::running()
  • [ ] PharData::mount()
  • [ ] PharData::mungServer()
  • [ ] PharData::unlinkArchive()
  • [ ] PharData::webPhar()
  • [ ] posix_sysconf()
  • [ ] Random\Randomizer::nextFloat()
  • [ ] Random\Randomizer::getFloat()
  • [ ] Random\Randomizer::getBytesFromString()
  • [x] ReflectionFunctionAbstract::getClosureCalledClass() (#4043)
  • [ ] ReflectionClass::__clone()
  • [ ] ReflectionClassConstant::__clone()
  • [x] ReflectionParameter::isPromoted() (#4049)
  • [ ] ReflectionType::__clone()
  • [ ] ReflectionReference::__clone()
  • [ ] ReflectionAttribute::__toString()
  • [ ] ReflectionAttribute::__clone()
  • [ ] socket_atmark()
  • [ ] ArrayObject::__serialize()
  • [ ] ArrayObject::__unserialize()
  • [ ] ArrayObject::__debugInfo()
  • [ ] ArrayIterator::__serialize()
  • [ ] ArrayIterator::__unserialize()
  • [ ] ArrayIterator::__debugInfo()
  • [ ] SplFileInfo::__debugInfo()
  • [ ] SplFileInfo::_bad_state_ex()
  • [ ] SplDoublyLinkedList::__debugInfo()
  • [ ] SplDoublyLinkedList::__serialize()
  • [ ] SplDoublyLinkedList::__unserialize()
  • [ ] SplFixedArray::__serialize()
  • [ ] SplFixedArray::__unserialize()
  • [ ] SplFixedArray::getIterator()
  • [ ] SplFixedArray::jsonSerialize()
  • [ ] SplPriorityQueue::__debugInfo()
  • [ ] SplHeap::__debugInfo()
  • [ ] RecursiveRegexIterator::accept()
  • [ ] SplObjectStorage::__serialize()
  • [ ] SplObjectStorage::__unserialize()
  • [ ] SplObjectStorage::__debugInfo()
  • [ ] MultipleIterator::__debugInfo()
  • [ ] SQLite3::lastExtendedErrorCode()
  • [ ] SQLite3::enableExtendedResultCodes()
  • [ ] config_get_hash()
  • [ ] litespeed_request_headers()
  • [ ] litespeed_response_headers()
  • [ ] litespeed_finish_request()

kocsismate avatar Jan 10 '23 07:01 kocsismate

Assign imap_is_open() to myself, as I was hoping I would get around it prior to 8.2.1 release.

Girgias avatar Jan 10 '23 14:01 Girgias

I'm currently looking at adding docs for all the reflection methods mentioned here, though I do have a question about ReflectionFunctionAbstract::getClosureCalledClass(), I'm unsure of exactly how it differs from getClosureScopeClass().

ollieread avatar Jan 23 '23 16:01 ollieread

The mysqli methods are documented. https://www.php.net/manual/en/function.mysqli-escape-string.php and https://www.php.net/manual/en/function.mysqli-set-opt.php Is there anything missing? What should be added?

kamil-tekiela avatar Dec 11 '23 21:12 kamil-tekiela

The mysqli methods are documented. https://www.php.net/manual/en/function.mysqli-escape-string.php and https://www.php.net/manual/en/function.mysqli-set-opt.php Is there anything missing? What should be added?

Thanks for double checking these. They showed up as undocumented because gen_stub.php can't handle the two aliases to the same function due to this regex: https://github.com/php/php-src/blob/02bca09bc1691fb4b3c62fee8402191cce7aee06/build/gen_stub.php#L5301

Apart from fixing this discrepancy, the only missing symbols from the manual are a few global constants which are not present in the predefined constants page:

Warning: Missing predefined constant for MYSQLI_OPT_LOAD_DATA_LOCAL_DIR
Warning: Missing predefined constant for MYSQLI_CLIENT_FOUND_ROWS
Warning: Missing predefined constant for MYSQLI_CLIENT_SSL_VERIFY_SERVER_CERT
Warning: Missing predefined constant for MYSQLI_CLIENT_CAN_HANDLE_EXPIRED_PASSWORDS
Warning: Missing predefined constant for MYSQLI_OPT_CAN_HANDLE_EXPIRED_PASSWORDS
Warning: Missing predefined constant for MYSQLI_ASYNC
Warning: Missing predefined constant for MYSQLI_STORE_RESULT_COPY_DATA
Warning: Missing predefined constant for MYSQLI_NO_DEFAULT_VALUE_FLAG
Warning: Missing predefined constant for MYSQLI_ON_UPDATE_NOW_FLAG
Warning: Missing predefined constant for MYSQLI_SET_CHARSET_DIR
Warning: Missing predefined constant for MYSQLI_SERVER_QUERY_WAS_SLOW
Warning: Missing predefined constant for MYSQLI_SERVER_PS_OUT_PARAMS
Warning: Missing predefined constant for MYSQLI_REFRESH_BACKUP_LOG
Warning: Missing predefined constant for MYSQLI_TRANS_START_WITH_CONSISTENT_SNAPSHOT

(They may be documented on other pages though)

kocsismate avatar Dec 13 '23 21:12 kocsismate