Wattmon Documentation Wiki

User Tools

Site Tools

You are here: start » uphp » functions » include
Trace: • mb_scan_percent • process_list • log • mb_num_devices
uphp:functions:include

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision 		Previous revision
uphp:functions:include [2017/05/08 14:28]
jeff 		uphp:functions:include [2021/09/13 05:57] (current)
Line 7: Line 7:
 ====Description==== ====Description====
  
-<well size="sm"> +<well size="sm"><html>
-<html>+
 <span style="font-size:125%">include ( <span style="font-size:125%">include (
 <span style="color:green">string <span style="color:green">string
 <span style="color:blue">$filename <span style="color:blue">$filename
 <span style="color:black">) <span style="color:black">)
-</html> +</html></well>
-</well>+
  
 This function includes and evaluates the specified file. When a file is included, the code it contains inherits the variable scope of the line on which the include occurs. Any variables available at that line in the calling file will be available within the called file, from that point forward. If the include occurs inside a function within the calling file, then all of the code contained in the called file will behave as though it had been defined inside that function. So, it will follow the variable scope of that function. This function includes and evaluates the specified file. When a file is included, the code it contains inherits the variable scope of the line on which the include occurs. Any variables available at that line in the calling file will be available within the called file, from that point forward. If the include occurs inside a function within the calling file, then all of the code contained in the called file will behave as though it had been defined inside that function. So, it will follow the variable scope of that function.
Line 22: Line 20:
 <html><b><span style="color:blue">$filename<span style="color:black"></b>:  <b><span style="color:green">String<span style="color:black"></b> containing the path and filename of the script to include and evaluate</html> <html><b><span style="color:blue">$filename<span style="color:black"></b>:  <b><span style="color:green">String<span style="color:black"></b> containing the path and filename of the script to include and evaluate</html>
  
-====Return Value====+====Return Values====
  
 None None
  
-====See Also====+====Notes==== 
 + 
 +This function is very useful for including frequently repeated code in multiple scripts. It is also useful for including different code depending upon configuration or provided files (varying "[[hardware:modules]]" or "packages"). 
 + 
 +The code contained in the included file is compiled into the script the first time the script is run. If changes are made to the contents of an included file without modifying the script that contains [[include]] then recompilation must be forced (by deleting the .cgc file). See [[uphp:uphp_compiler|The uPHP Compiler]] for more information (forced recompilation is discussed there in section [[uphp:uphp_compiler#Notes]]). 
 + 
 +The included file is interpreted as HTML unless it contains the opening and closing uPHP Tags ''<?'' and ''?>''. See [[uphp:uphp_language_basics|uPHP Language Basics]] for more information. 
 + 
 +====Also See====
  
 [[call_user_func()]] - Call a user defined function with optional parameters [[call_user_func()]] - Call a user defined function with optional parameters
uphp/functions/include.1494253704.txt.gz · Last modified: 2021/09/13 05:56 (external edit)

Page Tools

Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki