php / php/doc-en

Add note for WeakMap::offsetExists behavoir for NULL values

Open
#4,727 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
XML
Stars
596
Forks
890
Avg merge
1d 15h
Merged PRs (30d)
55

Description

From manual page: https://php.net/weakmap.offsetexists


Hi,
I just came across the following behavior of the WeakMap. A hint in the documentation would have helped me. Hence this entry.

When assigning NULL to an offset of a WeakMap, a call to WeakMap::offsetExists returns false, even when the actual offset exists.
According to https://github.com/php/php-src/issues/8437, this is currently intended.
Therefore, I suggest adding a note like "NULL values return false, even if the offset was previously set."

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the WeakMap::offsetExists manual page at https://php.net/weakmap.offsetexists and review the surrounding documentation. Add a note explaining that NULL values return false even when the offset was previously set, then verify that the wording accurately reflects the intended behavior described in PHP issue 8437.

Written by the indexing model from the issue text.

Assessment

Tech stack
php
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.