PHP - Lua::include() Function

---

---

The PHP Lua::include() function allows Lua script files to be included and run inside a PHP program. This function lets you run Lua code directly in PHP, which improves the process of integrating Lua with PHP.

This is helpful if you need to include Lua's characteristics, like its fast performance and easy syntax, into a PHP project. The include() function loads and runs the Lua script, then returns the result. It simplifies the use of Lua scripts in a PHP environment.

Syntax

Below is the syntax of the PHP Lua::include() function −

public mixed Lua::include( string $file )

Parameters

This function accepts $file parameter which is a string. The location of the Lua file you want to run or include is displayed. The file should include the Lua code that the function loads and runs.

Return Value

The include() function returns the result of included code, NULL for wrong arguments, or FALSE on failure.

PHP Version

The include() function is available from version 0.9.0 of the PECL lua extension onwards.

Example 1

This basic example shows how to include a Lua script named as 'simple.lua' using the PHP Lua::include() function. It runs the Lua code and prints the result. This is a simple case where the Lua script just outputs a value.

<?php
   // Lua script and prints the result
   $result = Lua::include('simple.lua');
   echo $result;
?> 

Output

This will generate the below output −

This is a simple Lua script!

Example 2

This example makes use of the variables in the Lua function include(). Lua works with variables, giving them values. The result is shown on the screen after being sent back to PHP.

<?php
   $result = Lua::include('variables.lua');
   echo "Result: " . $result;
?>

The Lua file variables.lua contains some Lua code as follows −

-- variables.lua
my_variable = "Hello from Tutorialspoint!"
return my_variable

Output

Here is the outcome of the following code −

Result: Hello from Tutorialspoint!

Example 3

This example checks whether the Lua script has an error. If Lua::include() returns false, it indicates an issue with the Lua script. The application just handles the error by displaying a notification.

<?php
   $result = Lua::include('error.lua');
   if ($result === false) {
      echo "An error occurred in the Lua script.";
   } else {
      echo "Lua script result: " . $result;
   }
?> 

Output

If there is an error in the Lua script, the output will be −

An error occurred in the Lua script.

If the Lua script runs without errors, the output will be something like −

Lua script result: This Lua script ran without errors.