search
HomeBackend DevelopmentPHP TutorialDetailed explanation of the usage of PHP custom function return value

Detailed explanation of the usage of PHP custom function return value

Jun 27, 2017 am 09:15 AM
phpfunctionusagecustomizeDetailed explanationreturn

Return value

User spaceFunctionUse the return keyword to return information to its calling space, which is the same as the syntax of C language.

For example:

function sample_long() {  
  return 42;  
}  
$bar = sample_long();

When sample_long() is called, 42 is returned and set to the $bar variable. The equivalent code in C language is as follows:

int sample_long(void) {  
  return 42;  
}  
void main(void) {  
  int bar = sample_long();  
}

Of course, In C language you always know what the function being called is, and it returns based on the function prototype, so accordingly you have to define the variable where the return result is stored. When processed in PHP user space, the variable type is dynamic and relies on The type of zval introduced in Chapter 2 "Ins and Outs of Variables".

return_value variable

You may think that your internal function should directly return a zval , or allocate a zval's memory space and return zval as follows *.

PHP_FUNCTION(sample_long_wrong)  
{  
    zval *retval;  
      
    MAKE_STD_ZVAL(retval);  
    ZVAL_LONG(retval, 42);  
      
    return retval;  
}

Unfortunately, this is incorrect. It is not mandatory for every function implementation to allocate zval and return it. But the Zend engine Pre-allocate this space before the function call. Then initialize the type of zval to IS_NULL and pass the value as the parameter name return_value. The following is the correct approach:

PHP_FUNCTION(sample_long)  
{  
    ZVAL_LONG(return_value, 42);  
    return;  
}

It should be noted that the PHP_FUNCTION() implementation does not Any value will be returned directly. Instead, the appropriate data will be popped directly into the return_value parameter, and the Zend engine will process it after the internal function is executed.

Friendly reminder: ZVAL_LONG() macro is for multiple assignments A wrapper for the operation:

Z_TYPE_P(return_value) = IS_LONG;  
Z_LVAL_P(return_value) = 42;

Or more directly:

return_value->type = IS_LONG;  
return_value->value.lval = 42;

The is_ref and refcount attributes of return_value should not be modified directly by internal functions. These values ​​​​are handled by the Zend engine in Initialized and processed when your function is called.

Now let's take a look at this special function and add it to the sample extension created in Chapter 5, "Your First Extension". Just add it in Add this function below the sample_hello_world() function, and add sample_long() to the php_sample_functions structure:

static function_entry php_sample_functions[] = {  
    PHP_FE(sample_hello_world, NULL)  
    PHP_FE(sample_long, NULL)  
    { NULL, NULL, NULL }  
};

Now we can execute make to rebuild the extension.

If everything is OK, you can run php and test the new function:

$ php -r 'var_dump(sample_long());

Wrap more compact macros

In the code In terms of readability and maintainability, there are repeated parts in the ZVAL_*() macro: return_value variable. In this case, by replacing ZVAL of the macro with RETVAL, we can omit return_value when calling.

In the previous example, the implementation code of sample_long() can be reduced to the following:

PHP_FUNCTION(sample_long)  
{  
    RETVAL_LONG(42);  
    return;  
}

The above is the detailed content of Detailed explanation of the usage of PHP custom function return value. For more information, please follow other related articles on the PHP Chinese website!

Statement
The content of this article is voluntarily contributed by netizens, and the copyright belongs to the original author. This site does not assume corresponding legal responsibility. If you find any content suspected of plagiarism or infringement, please contact admin@php.cn
What are some common problems that can cause PHP sessions to fail?What are some common problems that can cause PHP sessions to fail?Apr 25, 2025 am 12:16 AM

Reasons for PHPSession failure include configuration errors, cookie issues, and session expiration. 1. Configuration error: Check and set the correct session.save_path. 2.Cookie problem: Make sure the cookie is set correctly. 3.Session expires: Adjust session.gc_maxlifetime value to extend session time.

How do you debug session-related issues in PHP?How do you debug session-related issues in PHP?Apr 25, 2025 am 12:12 AM

Methods to debug session problems in PHP include: 1. Check whether the session is started correctly; 2. Verify the delivery of the session ID; 3. Check the storage and reading of session data; 4. Check the server configuration. By outputting session ID and data, viewing session file content, etc., you can effectively diagnose and solve session-related problems.

What happens if session_start() is called multiple times?What happens if session_start() is called multiple times?Apr 25, 2025 am 12:06 AM

Multiple calls to session_start() will result in warning messages and possible data overwrites. 1) PHP will issue a warning, prompting that the session has been started. 2) It may cause unexpected overwriting of session data. 3) Use session_status() to check the session status to avoid repeated calls.

How do you configure the session lifetime in PHP?How do you configure the session lifetime in PHP?Apr 25, 2025 am 12:05 AM

Configuring the session lifecycle in PHP can be achieved by setting session.gc_maxlifetime and session.cookie_lifetime. 1) session.gc_maxlifetime controls the survival time of server-side session data, 2) session.cookie_lifetime controls the life cycle of client cookies. When set to 0, the cookie expires when the browser is closed.

What are the advantages of using a database to store sessions?What are the advantages of using a database to store sessions?Apr 24, 2025 am 12:16 AM

The main advantages of using database storage sessions include persistence, scalability, and security. 1. Persistence: Even if the server restarts, the session data can remain unchanged. 2. Scalability: Applicable to distributed systems, ensuring that session data is synchronized between multiple servers. 3. Security: The database provides encrypted storage to protect sensitive information.

How do you implement custom session handling in PHP?How do you implement custom session handling in PHP?Apr 24, 2025 am 12:16 AM

Implementing custom session processing in PHP can be done by implementing the SessionHandlerInterface interface. The specific steps include: 1) Creating a class that implements SessionHandlerInterface, such as CustomSessionHandler; 2) Rewriting methods in the interface (such as open, close, read, write, destroy, gc) to define the life cycle and storage method of session data; 3) Register a custom session processor in a PHP script and start the session. This allows data to be stored in media such as MySQL and Redis to improve performance, security and scalability.

What is a session ID?What is a session ID?Apr 24, 2025 am 12:13 AM

SessionID is a mechanism used in web applications to track user session status. 1. It is a randomly generated string used to maintain user's identity information during multiple interactions between the user and the server. 2. The server generates and sends it to the client through cookies or URL parameters to help identify and associate these requests in multiple requests of the user. 3. Generation usually uses random algorithms to ensure uniqueness and unpredictability. 4. In actual development, in-memory databases such as Redis can be used to store session data to improve performance and security.

How do you handle sessions in a stateless environment (e.g., API)?How do you handle sessions in a stateless environment (e.g., API)?Apr 24, 2025 am 12:12 AM

Managing sessions in stateless environments such as APIs can be achieved by using JWT or cookies. 1. JWT is suitable for statelessness and scalability, but it is large in size when it comes to big data. 2.Cookies are more traditional and easy to implement, but they need to be configured with caution to ensure security.

See all articles

Hot AI Tools

Undresser.AI Undress

Undresser.AI Undress

AI-powered app for creating realistic nude photos

AI Clothes Remover

AI Clothes Remover

Online AI tool for removing clothes from photos.

Undress AI Tool

Undress AI Tool

Undress images for free

Clothoff.io

Clothoff.io

AI clothes remover

Video Face Swap

Video Face Swap

Swap faces in any video effortlessly with our completely free AI face swap tool!

Hot Tools

SublimeText3 English version

SublimeText3 English version

Recommended: Win version, supports code prompts!

ZendStudio 13.5.1 Mac

ZendStudio 13.5.1 Mac

Powerful PHP integrated development environment

MinGW - Minimalist GNU for Windows

MinGW - Minimalist GNU for Windows

This project is in the process of being migrated to osdn.net/projects/mingw, you can continue to follow us there. MinGW: A native Windows port of the GNU Compiler Collection (GCC), freely distributable import libraries and header files for building native Windows applications; includes extensions to the MSVC runtime to support C99 functionality. All MinGW software can run on 64-bit Windows platforms.

SAP NetWeaver Server Adapter for Eclipse

SAP NetWeaver Server Adapter for Eclipse

Integrate Eclipse with SAP NetWeaver application server.

Atom editor mac version download

Atom editor mac version download

The most popular open source editor