Skip to content
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.

Sign up for GitHub

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

docs: fix spelling in stubs.rst #18220

Merged
merged 1 commit into from
Apr 1, 2025
Merged

docs: fix spelling in stubs.rst #18220

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
26 changes: 13 additions & 13 deletions docs/source/miscellaneous/stubs.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,11 @@ code, but instead contain empty function and method bodies. A very basic stub lo
/** @var float */
const WEIGHT = 6.8;

class Atmopshere {
class Atmosphere {
public function calculateBar(): float {}
}

function fahrenheitToCelcius(float $fahrenheitToCelcius): float {}
function fahrenheitToCelsius(float $fahrenheitToCelsius): float {}

Any kind of symbol can be declared via stubs. Every type can be used, with the exception of
disjunctive normal form (DNF) types. Additional meta information can be added via PHPDoc blocks or
Expand All @@ -33,17 +33,17 @@ using namespace blocks:
/** @var float */
const WEIGHT_TON = 6.8;

class Atmopshere {
class Atmosphere {
public function calculateBar(): float {}
}
}

namespace Algorithms {
function fahrenheitToCelcius(float $fahrenheit): float {}
function fahrenheitToCelsius(float $fahrenheit): float {}
}

The above example declares the global constants ``ANIMAL`` and ``WEIGHT_TON``, and the class
``Atmopshere`` in the top-level namespace. The ``fahrenheitToCelcius()`` function is declared to be
``Atmosphere`` in the top-level namespace. The ``fahrenheitToCelsius()`` function is declared to be
in the ``Algorithms`` namespace.

********************
Expand Down Expand Up @@ -77,11 +77,11 @@ The arginfo file matching our first example looks like:
/* This is a generated file, edit the .stub.php file instead.
* Stub hash: e4ed788d54a20272a92a3f6618b73d48ec848f97 */

ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_fahrenheitToCelcius, 0, 1, IS_DOUBLE, 0)
ZEND_ARG_TYPE_INFO(0, fahrenheitToCelcius, IS_DOUBLE, 0)
ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_fahrenheitToCelsius, 0, 1, IS_DOUBLE, 0)
ZEND_ARG_TYPE_INFO(0, fahrenheitToCelsius, IS_DOUBLE, 0)
ZEND_END_ARG_INFO()

ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_class_Atmopshere_calculateBar, 0, 0, IS_DOUBLE, 0)
ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_class_Atmosphere_calculateBar, 0, 0, IS_DOUBLE, 0)
ZEND_END_ARG_INFO()

The hash that is included in the file makes sure that stub files are not reprocessed unless the stub
Expand Down Expand Up @@ -186,24 +186,24 @@ In order to generate these, add the file-level ``@generate-function-entries`` PH
public function calculateBar(): float {}
}

function fahrenheitToCelcius(float $fahrenheit): float {}
function fahrenheitToCelsius(float $fahrenheit): float {}

Now, the following C code is generated:

.. code:: c

ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_fahrenheitToCelcius, 0, 1, IS_DOUBLE, 0)
ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_fahrenheitToCelsius, 0, 1, IS_DOUBLE, 0)
ZEND_ARG_TYPE_INFO(0, fahrenheit, IS_DOUBLE, 0)
ZEND_END_ARG_INFO()

ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_class_Atmosphere_calculateBar, 0, 0, IS_DOUBLE, 0)
ZEND_END_ARG_INFO()

ZEND_FUNCTION(fahrenheitToCelcius);
ZEND_FUNCTION(fahrenheitToCelsius);
ZEND_METHOD(Atmosphere, calculateBar);

static const zend_function_entry ext_functions[] = {
ZEND_FE(fahrenheitToCelcius, arginfo_fahrenheitToCelcius)
ZEND_FE(fahrenheitToCelsius, arginfo_fahrenheitToCelsius)
ZEND_FE_END
};

Expand Down Expand Up @@ -762,7 +762,7 @@ Running it with the stub examples that are used in this guide, the following war
Warning: Missing class synopsis for Number
Warning: Missing class synopsis for Elephant
Warning: Missing class synopsis for Atmosphere
Warning: Missing method synopsis for fahrenheitToCelcius()
Warning: Missing method synopsis for fahrenheitToCelsius()
Warning: Missing method synopsis for Atmosphere::calculateBar()

**********************
Expand Down