Главная » Языки программирования

Php return array include

Содержание
  1. PHP: Returning a variable from an include file.
  2. included_file.php
  3. main.php
  4. get_included_files
  5. Parameters
  6. Return Values
  7. Examples
  8. See Also
  9. User Contributed Notes 7 notes
  10. Return from include file
  11. 5 Answers 5

PHP: Returning a variable from an include file.

This is a quick tutorial on how to “return” variables from an included PHP file. This design can be used whenever you want to assign the return value of an included file to a variable in your main script (the main script in this case is the script that “called” your included file). In this example, I will be using two files: main.php and included_file.php

Take a look at the following code snippet:

included_file.php

This is the file that we will be including:

Note that in the example above, I am returning a string variable. To return a variable from an included file, you MUST use the return statement.

main.php

This is our main script. This is the file that “calls” our included file:

Above, we include the file included_file.php and assign its return value to a variable called $stringVariable.

If you run the code above, you’ll see that the include statement returned the string variable that we created in included_file.php

In the past, I have seen type of design being used to store and retrieve configuration values. For example: In the MVC framework Laravel, there is a config folder that contains files such as mail.php, session.php and database.php. If you open any of these files, you’ll see that each file is returning an associative array that contains configuration values.

Here is a basic example of an include file returning configuration values:

 'localhost', 'db_user' => 'root', 'db_pass' => '', 'db_name' => 'test' );

Then, if we want to retrieve the configuration values above:

If you run the code above, you will see that $databaseConfig contains the associative array that we created in database.php

Источник

get_included_files

Gets the names of all files that have been included using include , include_once , require or require_once .

Parameters

This function has no parameters.

Return Values

Returns an array of the names of all files.

The script originally called is considered an «included file,» so it will be listed together with the files referenced by include and family.

Files that are included or required multiple times only show up once in the returned array.

Examples

Example #1 get_included_files() example

include ‘test1.php’ ;
include_once ‘test2.php’ ;
require ‘test3.php’ ;
require_once ‘test4.php’ ;

foreach ( $included_files as $filename ) echo » $filename \n» ;
>

The above example will output:

/path/to/abc.php /path/to/test1.php /path/to/test2.php /path/to/test3.php /path/to/test4.php

See Also

  • include — include
  • include_once — include_once
  • require — require
  • require_once — require_once
  • get_required_files() — Alias of get_included_files

User Contributed Notes 7 notes

As of PHP5, this function seems to return an array with the first index being the script all subsequent scripts are included to.
If index.php includes b.php and c.php and calls get_included_files(), the returned array looks as follows:

If you want to know which is the script that is including current script you can use $_SERVER[‘SCRIPT_FILENAME’] or any other similar server global.

If you also want to ensure current script is being included and not run independently you should evaluate following expression:

If this expression returns TRUE, current script is being included or required.

If you have a MAIN php script which you don’t want to be included by other scripts, you could use this function. For example:

main.php:
function blockit ()
$buf = get_included_files ();
return $buf [ 0 ] != __FILE__ ;
>

blockit () and exit( «You can not include a MAIN file as a part of your script.» );

print «OK» ;
?>

So other script couldn’t include main.php to modify its internal global vars.

It’s perhaps not clear from the existing docs that the returned list contains nested include files as well.

That is, if A.php includes B.php, and B.php includes C.php, the result returned when calling get_included_files() from inside A.php WILL contain ‘C.php’.

As is often the case, YMMV. I tried the __FILE__ and SCRIPT_FILENAME comparison and found this:

SCRIPT_FILENAME: /var/www/cgi-bin/php441
__FILE__: /raid/home/natpresch/natpresch/RAY_included.php

Gives one when the script is standalone and always more than one when the script is included.

This function aims to perform filtering of files that have been included :

function setIncludeFiles ( $arrayInc = array()) <
$incFiles = get_included_files ();
if(( count ( $arrayInc )> 0 )&&( count ( $incFiles )> 0 )) <
$aInt = array_intersect ( $arrayInc , $incFiles );
if( count ( $aInt )> 0 ) <
return false ;
>elseif( count ( $aInt ) < 1 ) <
foreach( $arrayInc as $inc ) <
if( is_file ( $inc ))
include( $inc );
else <
return false ;
>
>
>
>else <
return false ;
>
>
?>

Usage :

$toBeInclude = array( ‘/data/your_include_files_1.php’ ,
‘/data/your_include_files_2.php’ ,
‘/data/your_include_files_3.php’ ,
);
setIncludeFiles ( $toBeInclude );
?>

Return false if something goes wrong.

This is a great way to emulate Python’s ‘__name__ = «__main__»‘

if( get_included_files ()[ 0 ] === __FILE__ ) doStuff ();
?>

Something that’s not noted in the docs, if a file is included remotely and you do a get_included_files() in the include itself it will *not* return the document that included it.

?>

test3.php (server 192.168.1.11):

Array ( [0] => /var/www/localhost/htdocs/test/test3.php )

Which means you can use get_included_files() to help intercept and prevent XSS-style attacks against your code.

Оцените статью
© 2024 Программирование