registerlocalnamespace.xml Fix typos and amend return type by mmalferov · Pull Request #5490 · php/doc-en

mmalferov · 2026-04-13T15:31:02Z

No description provided.

mmalferov · 2026-04-13T17:58:27Z

Based on the actual behavior and the source code, the method returns Yaf_Loader|false.

<?php

$loader = Yaf_Loader::getInstance();

// Returns Yaf_Loader instance
$result = $loader->registerLocalNamespace("Prefix");
var_dump($result); // object(Yaf_Loader)

// Returns false on invalid input
$result = @$loader->registerLocalNamespace(null);
var_dump($result); // bool(false)

Source code (yaf_loader.c):

PHP_METHOD(yaf_loader, registerLocalNamespace) {
	zval *namespaces;
	zend_string *path = NULL;

	if (zend_parse_parameters(ZEND_NUM_ARGS(), "z|S", &namespaces, &path) == FAILURE) {
		return;
	}

	if (IS_STRING == Z_TYPE_P(namespaces)) {
		if (yaf_loader_register_namespace(Z_YAFLOADEROBJ_P(getThis()), Z_STR_P(namespaces), path)) {
			RETURN_ZVAL(getThis(), 1, 0);
		}
	} else if (IS_ARRAY == Z_TYPE_P(namespaces)) {
		if (yaf_loader_register_namespace_multi(Z_YAFLOADEROBJ_P(getThis()), namespaces)) {
			RETURN_ZVAL(getThis(), 1, 0);
		}
	} else {
		php_error_docref(NULL, E_WARNING, "Invalid parameters provided, must be a string, or an array");
	}

	RETURN_FALSE;
}

And the same: ```php <?php $loader = Yaf_Loader::getInstance(); $result = $loader->registerNamespace("App\Fake", "path"); var_dump($result); // object(Yaf_Loader) $result = @$loader->registerNamespace(null, null); var_dump($result); // bool(false) ```

mmalferov · 2026-04-14T00:52:12Z

And the same:

<?php

$loader = Yaf_Loader::getInstance();

$result = $loader->registerNamespace(namespace: "App\Fake", path: "path"); // Not 'namespaces' that lead to the fatal error
var_dump($result); // object(Yaf_Loader)

$result = @$loader->registerNamespace(null, null);
var_dump($result); // bool(false)

lacatoire · 2026-04-22T17:14:26Z

  <methodsynopsis>
-   <modifier>public</modifier> <type>void</type><methodname>Yaf_Loader::registerLocalNamespace</methodname>
+   <modifier>public</modifier> <type class="union"><type>Yaf_Loader</type><type>false</type></type><methodname>Yaf_Loader::registerLocalNamespace</methodname>
   <methodparam><type>mixed</type><parameter>prefix</parameter></methodparam>


Suggested change

<methodparam><type>mixed</type><parameter>prefix</parameter></methodparam>

<methodparam><type class="union"><type>string</type><type>array</type><

/type><parameter>prefix</parameter></methodparam>

The function only accepts string or array at runtime. Other types trigger an E_WARNING and the function returns false. See here Aligns with the sibling registernamespace.xml which already uses string|array.

lacatoire · 2026-04-22T17:16:30Z

   <note>
    <para>
-      Yaf still think underline as folder separator.
+      Yaf still think underscore as folder separator.


Suggested change

Yaf still think underscore as folder separator.

Yaf still thinks underscore as folder separator.

lacatoire · 2026-04-22T17:16:45Z

    <listitem>
     <para>
-      a string of path, it is better to use abosolute path here for performance
+      A &string; of path, it is better to use abosolute path here for performance.


Suggested change

A &string; of path, it is better to use abosolute path here for performance.

A &string; of path, it is better to use absolute path here for performance.

lacatoire · 2026-04-22T17:18:21Z

-   <modifier>public</modifier> <type>void</type><methodname>Yaf_Loader::registerLocalNamespace</methodname>
+   <modifier>public</modifier> <type class="union"><type>Yaf_Loader</type><type>false</type></type><methodname>Yaf_Loader::registerLocalNamespace</methodname>
   <methodparam><type>mixed</type><parameter>prefix</parameter></methodparam>
  </methodsynopsis>


Suggested change

</methodsynopsis>

<methodparam choice="opt"><type>string</type><parameter>path</parameter></methodparam>

</methodsynopsis>

The function accepts a second optional $path parameter that isn't documented on this page. Per the zpp call "z|S" the function takes one required zval and one optional string, and the proto comment right above the method confirms:
proto public Yaf_Loader::registerLocalNamespace(mixed $namespace, string $path = NULL) Here

The sibling registernamespace.xml already documents $path, which makes sense since both methods are the same C function (PHP_MALIAS).

lacatoire · 2026-04-22T17:24:18Z

+      All class prefix with these prefix will be loaded in local library path.
     </para>
    </listitem>
   </varlistentry>


Suggested change

</varlistentry>

</varlistentry>

<varlistentry>

<term><parameter>path</parameter></term>

<listitem>

<simpara>A &string; of path, it is better to use absolute path here for performance.</simpara>

</listitem>

</varlistentry>

lacatoire · 2026-04-22T17:24:29Z

-      all class prefix with these prefix will be loaded in local library path.
+      A &string; or an &array; of class name prefix.
+      All class prefix with these prefix will be loaded in local library path.
     </para>


Suggested change

</para>

</simpara>

lacatoire · 2026-04-22T17:24:36Z

@@ -49,8 +50,8 @@
    <term><parameter>prefix</parameter></term>
    <listitem>
     <para>


Suggested change

<para>

<simpara>

lacatoire · 2026-04-22T17:24:45Z

@@ -60,7 +61,7 @@
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>


Suggested change

<para>

<simpara>

lacatoire · 2026-04-22T17:24:53Z

  <para>
-   bool
+   Returns the <classname>Yaf_Loader</classname> instance on success,&return.falseforfailure;.
  </para>


Suggested change

</para>

</simpara>

mmalferov added 2 commits April 13, 2026 18:30

registerlocalnamespace.xml Fix typo

2e60096

registerlocalnamespace.xml Amend return type

b88761b

mmalferov changed the title ~~registerlocalnamespace.xml Fix typo~~ registerlocalnamespace.xml Fix typo and amend return type Apr 13, 2026

mmalferov added 9 commits April 14, 2026 02:44

registerlocalnamespace.xml Fix typo

c566582

registerlocalnamespace.xml Fix typo

14e57a5

registerlocalnamespace.xml To variable

ab2f653

registerlocalnamespace.xml Add space

9bf4b84

registernamespace.xml Amend the directive name

7a5fce7

registernamespace.xml ; to .

191fba8

registernamespace.xml Fix typo. underline → underscore

d627fa9

registernamespace.xml Fix parameter name

24c9751

construct.xml Fix typo, amend examples

55074ce

mmalferov changed the title ~~registerlocalnamespace.xml Fix typo and amend return type~~ registerlocalnamespace.xml Fix typos and amend return type Apr 14, 2026

lacatoire reviewed Apr 22, 2026

View reviewed changes

	<methodparam><type>mixed</type><parameter>prefix</parameter></methodparam>
	<methodparam><type class="union"><type>string</type><type>array</type><
	/type><parameter>prefix</parameter></methodparam>

	Yaf still think underscore as folder separator.
	Yaf still thinks underscore as folder separator.

	A &string; of path, it is better to use abosolute path here for performance.
	A &string; of path, it is better to use absolute path here for performance.

	</methodsynopsis>
	<methodparam choice="opt"><type>string</type><parameter>path</parameter></methodparam>
	</methodsynopsis>

Conversation

mmalferov commented Apr 13, 2026

Uh oh!

mmalferov commented Apr 13, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mmalferov commented Apr 14, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

mmalferov commented Apr 13, 2026 •

edited

Loading