-
diff --git a/assets/en_develop_source-module.md.9402ba24.js b/assets/en_develop_source-module.md.faae4360.js
similarity index 72%
rename from assets/en_develop_source-module.md.9402ba24.js
rename to assets/en_develop_source-module.md.faae4360.js
index 9b5e2595..90dd8e85 100644
--- a/assets/en_develop_source-module.md.9402ba24.js
+++ b/assets/en_develop_source-module.md.faae4360.js
@@ -1,4 +1,4 @@
-import{_ as o,c as e,o as s,U as a}from"./chunks/framework.a73c7ff7.js";const F=JSON.parse('{"title":"Source module","description":"","frontmatter":{},"headers":[],"relativePath":"en/develop/source-module.md","filePath":"en/develop/source-module.md"}'),n={name:"en/develop/source-module.md"},l=a(`
The download source module of static-php-cli is a major module. It includes dependent libraries, external extensions, PHP source code download methods and file decompression methods. The download configuration file mainly involves the source.json file, which records the download method of all downloadable resources.
The main commands involved in the download function are bin/spc download and bin/spc extract. The download command is a downloader that downloads resources according to the configuration file, and the extract command is an extractor that extract sources from downloaded files.
Generally speaking, downloading resources may be slow because these resources come from various official websites, GitHub, and other different locations. At the same time, they also occupy a large space, so you can download the resources once and reuse them.
The configuration file of the downloader is source.json, which contains the download methods of all resources. You can add the resource download methods you need, or modify the existing resource download methods.
The download configuration structure of each resource is as follows. The following is the resource download configuration corresponding to the libevent extension:
json
{
+import{_ as o,c as e,o as s,U as a}from"./chunks/framework.a73c7ff7.js";const F=JSON.parse('{"title":"Source module","description":"","frontmatter":{},"headers":[],"relativePath":"en/develop/source-module.md","filePath":"en/develop/source-module.md"}'),n={name:"en/develop/source-module.md"},l=a(`
The download source module of static-php-cli is a major module. It includes dependent libraries, external extensions, PHP source code download methods and file decompression methods. The download configuration file mainly involves the source.json file, which records the download method of all downloadable sources.
The main commands involved in the download function are bin/spc download and bin/spc extract. The download command is a downloader that downloads sources according to the configuration file, and the extract command is an extractor that extract sources from downloaded files.
Generally speaking, downloading sources may be slow because these sources come from various official websites, GitHub, and other different locations. At the same time, they also occupy a large space, so you can download the sources once and reuse them.
The configuration file of the downloader is source.json, which contains the download methods of all sources. You can add the source download methods you need, or modify the existing source download methods.
The download configuration structure of each source is as follows. The following is the source download configuration corresponding to the libevent extension:
json
{"libevent":{"type":"ghrel","repo":"libevent/libevent",
@@ -8,4 +8,4 @@ import{_ as o,c as e,o as s,U as a}from"./chunks/framework.a73c7ff7.js";const F=
"path":"LICENSE"}}
-}
The most important field here is type. Currently, the types it supports are:
url: Directly use URL to download, for example: https://download.libsodium.org/libsodium/releases/libsodium-1.0.18.tar.gz.
ghrel: Use the GitHub Release API to download, download the artifacts uploaded from the latest version released by maintainers.
ghtar: Use the GitHub Release API to download. Different from ghrel, ghtar is downloaded from the source code (tar.gz) in the latest Release of the project.
ghtagtar: Use GitHub Release API to download. Compared with ghtar, ghtagtar can find the latest one from the tags list and download the source code in tar.gz format (because some projects only use tag release version).
bitbuckettag: Download using BitBucket API, basically the same as ghtagtar, except this one applies to BitBucket.
git: Clone the project directly from a Git address to download resources, applicable to any public Git repository.
filelist: Use a crawler to crawl the Web download site that provides file index, and get the latest version of the file name and download it.
custom: If none of the above download methods are satisfactory, you can write custom, create a new class under src/SPC/store/source/, inherit CustomSourceBase, and write the download script yourself.
(TODO)
`,10),t=[l];function c(p,r,d,i,u,D){return s(),e("div",null,t)}const h=o(n,[["render",c]]);export{F as __pageData,h as default};
+}
The most important field here is type. Currently, the types it supports are:
url: Directly use URL to download, for example: https://download.libsodium.org/libsodium/releases/libsodium-1.0.18.tar.gz.
ghrel: Use the GitHub Release API to download, download the artifacts uploaded from the latest version released by maintainers.
ghtar: Use the GitHub Release API to download. Different from ghrel, ghtar is downloaded from the source code (tar.gz) in the latest Release of the project.
ghtagtar: Use GitHub Release API to download. Compared with ghtar, ghtagtar can find the latest one from the tags list and download the source code in tar.gz format (because some projects only use tag release version).
bitbuckettag: Download using BitBucket API, basically the same as ghtagtar, except this one applies to BitBucket.
git: Clone the project directly from a Git address to download sources, applicable to any public Git repository.
filelist: Use a crawler to crawl the Web download site that provides file index, and get the latest version of the file name and download it.
custom: If none of the above download methods are satisfactory, you can write custom, create a new class under src/SPC/store/source/, inherit CustomSourceBase, and write the download script yourself.
(TODO)
`,10),t=[l];function c(p,r,d,i,u,D){return s(),e("div",null,t)}const h=o(n,[["render",c]]);export{F as __pageData,h as default};
diff --git a/assets/en_develop_source-module.md.9402ba24.lean.js b/assets/en_develop_source-module.md.faae4360.lean.js
similarity index 100%
rename from assets/en_develop_source-module.md.9402ba24.lean.js
rename to assets/en_develop_source-module.md.faae4360.lean.js
diff --git a/assets/en_develop_structure.md.1a717dd0.js b/assets/en_develop_structure.md.1a717dd0.js
new file mode 100644
index 00000000..ebc4004e
--- /dev/null
+++ b/assets/en_develop_structure.md.1a717dd0.js
@@ -0,0 +1 @@
+import{_ as e,c as o,o as t,U as c}from"./chunks/framework.a73c7ff7.js";const b=JSON.parse('{"title":"Introduction to project structure","description":"","frontmatter":{},"headers":[],"relativePath":"en/develop/structure.md","filePath":"en/develop/structure.md"}'),d={name:"en/develop/structure.md"},n=c('
static-php-cli mainly contains three logical components: sources, dependent libraries, and extensions. These three components also correspond to three configuration files: source.json, lib.json, and ext.json.
A complete process for building standalone static PHP is:
Use the source download module Downloader to download specified or all source codes. These sources include PHP source code, dependent library source code, and extension source code.
Use the source decompression module SourceExtractor to decompress the downloaded sources to the compilation directory.
Use the dependency tool to calculate the dependent extensions and dependent libraries of the currently added extension, and then compile each library that needs to be compiled in the order of dependencies.
After building each dependent library using Builder under the corresponding operating system, install it to the buildroot directory.
If external extensions are included (the source code does not contain extensions within PHP), copy the external extensions to the source/php-src/ext/ directory.
Use Builder to build the PHP source code and build target to the buildroot directory.
The project is mainly divided into several folders:
bin/: used to store program entry files, including bin/spc, bin/spc-alpine-docker, bin/setup-runtime.
config/: Contains all the extensions and dependent libraries supported by the project, as well as the download link and download methods of these sources. It is divided into three files: lib.json, ext.json, source.json .
src/: The core code of the project, including the entire framework and commands for compiling various extensions and libraries.
vendor/: The directory that Composer depends on, you do not need to make any modifications to it.
The operating principle is to start a ConsoleApplication of symfony/console, and then parse the commands entered by the user in the terminal.
bin/spc is an entry file, including the Unix common #!/usr/bin/env php, which is used to allow the system to automatically execute with the PHP interpreter installed on the system. After the project executes new ConsoleApplication(), the framework will automatically register them as commands.
The project does not directly use the Command registration method and command execution method recommended by Symfony. Here are small changes:
Each command uses the #[AsCommand()] Attribute to register the name and description.
Abstract execute() so that all commands are based on BaseCommand (which is based on Symfony\\Component\\Console\\Command\\Command), and the execution code of each command itself is written in the handle() method .
Added variable $no_motd to BaseCommand, which is used to display the Figlet greeting when the command is executed.
BaseCommand saves InputInterface and OutputInterface as member variables. You can use $this->input and $this->output within the command class.
The source code of the project is located in the src/SPC directory, supports automatic loading of the PSR-4 standard, and contains the following subdirectories and classes:
src/SPC/builder/: The core compilation command code used to build libraries, PHP and related extensions under different operating systems, and also includes some compilation system tool methods.
src/SPC/command/: All commands of the project are here.
src/SPC/doctor/: Doctor module, which is a relatively independent module used to check the system environment. It can be entered using the command bin/spc doctor.
src/SPC/exception/: exception class.
src/SPC/store/: Classes related to storage, files and sources are all here.
src/SPC/util/: Some reusable tool methods are here.
src/SPC/ConsoleApplication.php: command line program entry file.
If you have read the source code, you may find that there is also a src/globals/ directory, which is used to store some global variables, global methods, and non-PSR-4 standard PHP source code that is relied upon during the build process, such as extension sanity check code etc.
',15),s=[n];function i(r,a,l,u,h,m){return t(),o("div",null,s)}const f=e(d,[["render",i]]);export{b as __pageData,f as default};
diff --git a/assets/en_develop_structure.md.39368a84.lean.js b/assets/en_develop_structure.md.1a717dd0.lean.js
similarity index 100%
rename from assets/en_develop_structure.md.39368a84.lean.js
rename to assets/en_develop_structure.md.1a717dd0.lean.js
diff --git a/assets/en_develop_structure.md.39368a84.js b/assets/en_develop_structure.md.39368a84.js
deleted file mode 100644
index 79784d4b..00000000
--- a/assets/en_develop_structure.md.39368a84.js
+++ /dev/null
@@ -1 +0,0 @@
-import{_ as e,c as o,o as t,U as c}from"./chunks/framework.a73c7ff7.js";const b=JSON.parse('{"title":"Introduction to project structure","description":"","frontmatter":{},"headers":[],"relativePath":"en/develop/structure.md","filePath":"en/develop/structure.md"}'),d={name:"en/develop/structure.md"},n=c('
static-php-cli mainly contains three logical components: sources, dependent libraries, and extensions. These three components also correspond to three configuration files: source.json, lib.json, and ext.json.
A complete process for building standalone static PHP is:
Use the source download module Downloader to download specified or all source codes. These resources include PHP source code, dependent library source code, and extension source code.
Use the resource decompression module SourceExtractor to decompress the downloaded resources to the compilation directory.
Use the dependency tool to calculate the dependent extensions and dependent libraries of the currently added extension, and then compile each library that needs to be compiled in the order of dependencies.
After building each dependent library using Builder under the corresponding operating system, install it to the buildroot directory.
If external extensions are included (the source code does not contain extensions within PHP), copy the external extensions to the source/php-src/ext/ directory.
Use Builder to build the PHP source code and build target to the buildroot directory.
The project is mainly divided into several folders:
bin/: used to store program entry files, including bin/spc, bin/spc-alpine-docker, bin/setup-runtime.
config/: Contains all the extensions and dependent libraries supported by the project, as well as the download link and download methods of these sources. It is divided into three files: lib.json, ext.json, source.json .
src/: The core code of the project, including the entire framework and commands for compiling various extensions and libraries.
vendor/: The directory that Composer depends on, you do not need to make any modifications to it.
The operating principle is to start a ConsoleApplication of symfony/console, and then parse the commands entered by the user in the terminal.
bin/spc is an entry file, including the Unix common #!/usr/bin/env php, which is used to allow the system to automatically execute with the PHP interpreter installed on the system. After the project executes new ConsoleApplication(), the framework will automatically register them as commands.
The project does not directly use the Command registration method and command execution method recommended by Symfony. Here are small changes:
Each command uses the #[AsCommand()] Attribute to register the name and description.
Abstract execute() so that all commands are based on BaseCommand (which is based on Symfony\\Component\\Console\\Command\\Command), and the execution code of each command itself is written in the handle() method .
Added variable $no_motd to BaseCommand, which is used to display the Figlet greeting when the command is executed.
BaseCommand saves InputInterface and OutputInterface as member variables. You can use $this->input and $this->output within the command class.
The source code of the project is located in the src/SPC directory, supports automatic loading of the PSR-4 standard, and contains the following subdirectories and classes:
src/SPC/builder/: The core compilation command code used to build libraries, PHP and related extensions under different operating systems, and also includes some compilation system tool methods.
src/SPC/command/: All commands of the project are here.
src/SPC/doctor/: Doctor module, which is a relatively independent module used to check the system environment. It can be entered using the command bin/spc doctor.
src/SPC/exception/: exception class.
src/SPC/store/: Classes related to storage, files and resources are all here.
src/SPC/util/: Some reusable tool methods are here.
src/SPC/ConsoleApplication.php: command line program entry file.
If you have read the source code, you may find that there is also a src/globals/ directory, which is used to store some global variables, global methods, and non-PSR-4 standard PHP source code that is relied upon during the build process, such as extension sanity check code etc.
',15),s=[n];function i(r,a,l,u,h,m){return t(),o("div",null,s)}const f=e(d,[["render",i]]);export{b as __pageData,f as default};
diff --git a/assets/en_guide_manual-build.md.99d1a681.js b/assets/en_guide_manual-build.md.fc78940a.js
similarity index 94%
rename from assets/en_guide_manual-build.md.99d1a681.js
rename to assets/en_guide_manual-build.md.fc78940a.js
index 4cdeef07..b0b2a8ab 100644
--- a/assets/en_guide_manual-build.md.99d1a681.js
+++ b/assets/en_guide_manual-build.md.fc78940a.js
@@ -33,7 +33,7 @@ import{_ as s,c as a,o as e,U as o}from"./chunks/framework.a73c7ff7.js";const m=
bin/spcdoctor# Quickly check and fix when it can be automatically repaired (use package management to install dependent packages, only support the above-mentioned operating systems and distributions)
-bin/spcdoctor--auto-fix
Use the build command to start building the static php binary. Before executing the bin/spc build command, be sure to use the download command to download resources. It is recommended to use doctor to check the environment.
You need to go to Extension List or Command Generator to select the extension you want to add, and then use the command bin/spc build to compile. You need to specify a compilation target, choose from the following parameters:
--build-cli: Build a cli sapi (command line interface, which can execute PHP code on the command line)
--build-fpm: Build a fpm sapi (php-fpm, used in conjunction with other traditional fpm architecture software such as nginx)
--build-micro: Build a micro sapi (used to build a standalone executable binary containing PHP code)
--build-embed: Build an embed sapi (used to embed into other C language programs)
--build-all: build all above sapi
bash
# Compile PHP with bcmath,curl,openssl,ftp,posix,pcntl extensions, the compilation target is cli
+bin/spcdoctor--auto-fix
Use the build command to start building the static php binary. Before executing the bin/spc build command, be sure to use the download command to download sources. It is recommended to use doctor to check the environment.
You need to go to Extension List or Command Generator to select the extension you want to add, and then use the command bin/spc build to compile. You need to specify a compilation target, choose from the following parameters:
--build-cli: Build a cli sapi (command line interface, which can execute PHP code on the command line)
--build-fpm: Build a fpm sapi (php-fpm, used in conjunction with other traditional fpm architecture software such as nginx)
--build-micro: Build a micro sapi (used to build a standalone executable binary containing PHP code)
--build-embed: Build an embed sapi (used to embed into other C language programs)
--build-all: build all above sapi
bash
# Compile PHP with bcmath,curl,openssl,ftp,posix,pcntl extensions, the compilation target is clibin/spcbuildbcmath,curl,openssl,ftp,posix,pcntl--build-cli# Compile PHP with phar,curl,posix,pcntl,tokenizer extensions, compile target is micro
@@ -54,7 +54,7 @@ import{_ as s,c as a,o as e,U as o}from"./chunks/framework.a73c7ff7.js";const m=
# Use ini file specification (-N is shorthand for --with-ini-file)bin/spcmicro:combinea.php-N/path/to/your/custom.ini
WARNING
Note, please do not directly use the PHP source code or the php.ini file in the system-installed PHP, it is best to manually write an ini configuration file that you need, for example:
The ini injection of this command is achieved by appending a special structure after micro.sfx, which is different from the function of inserting hard-coded INI during compilation.
Use the command bin/spc extract to unpack and copy the source code required for compilation, including php-src and the source code of various dependent libraries (you need to specify the name of the library to be unpacked).
For example, after we have downloaded resources, we want to distribute and execute the build process, manually unpack and copy the package to a specified location, and we can use commands.
bash
# Unzip the downloaded compressed package of php-src and libxml2, and store the decompressed source code in the source directory
+memory_limit=1G
The ini injection of this command is achieved by appending a special structure after micro.sfx, which is different from the function of inserting hard-coded INI during compilation.
Use the command bin/spc extract to unpack and copy the source code required for compilation, including php-src and the source code of various dependent libraries (you need to specify the name of the library to be unpacked).
For example, after we have downloaded sources, we want to distribute and execute the build process, manually unpack and copy the package to a specified location, and we can use commands.
bash
# Unzip the downloaded compressed package of php-src and libxml2, and store the decompressed source code in the source directorybin/spcextractphp-src,libxml2
Debug commands refer to a collection of commands that can assist in outputting some information when you use static-php-cli to build PHP or modify and enhance the static-php-cli project itself.
dev:extensions: output all currently supported extension names, or output the specified extension information
dev:php-version: output the currently compiled PHP version (by reading php_version.h)
dev:sort-config: Sort the list of configuration files in the config/ directory in alphabetical order
bash
# output all extensions informationbin/spcdev:extensions
diff --git a/assets/en_guide_manual-build.md.99d1a681.lean.js b/assets/en_guide_manual-build.md.fc78940a.lean.js
similarity index 100%
rename from assets/en_guide_manual-build.md.99d1a681.lean.js
rename to assets/en_guide_manual-build.md.fc78940a.lean.js
diff --git a/en/contributing/index.html b/en/contributing/index.html
index e355f3ba..0c6c845d 100644
--- a/en/contributing/index.html
+++ b/en/contributing/index.html
@@ -16,7 +16,7 @@
If you have code or documentation to contribute, here's what you need to know first.
What type of code are you contributing? (new extensions, bug fixes, security issues, project framework optimizations, documentation)
If you contribute new files or new snippets, is your code checked by php-cs-fixer and phpstan?
Have you fully read the Developer Guide before contributing code?
If you can answer the above questions and have made changes to the code, you can initiate a Pull Request in the project GitHub repository in time. After the code review is completed, the code can be modified according to the suggestion, or directly merged into the main branch.
The main purpose of this project is to compile statically linked PHP binaries, and the command line processing function is written based on symfony/console. Before development, if you are not familiar with it, Check out the symfony/console documentation first.
Because this project is basically a PHP project running locally, generally speaking, there will be no remote attacks. But if you find such a problem, please **DO NOT submit a PR or Issue in the GitHub repository, You need to contact the project maintainer (crazywhalecc) via mail.
Fixing bugs generally does not involve modification of the project structure and framework, so if you can locate the wrong code and fix it directly, please submit a PR directly.
For adding a new extension, you need to understand some basic structure of the project and how to add a new extension according to the existing logic. It will be covered in detail in the next section on this page. In general, you will need:
Evaluate whether the extension can be compiled inline into PHP.
Evaluate whether the extension's dependent libraries (if any) can be compiled statically.
Write library compile commands on different platforms.
Verify that the extension and its dependencies are compatible with existing extensions and dependencies.
Verify that the extension works normally in cli, micro, fpm SAPIs.
If you are already familiar with the working principle of symfony/console, and at the same time want to make some modifications or optimizations to the framework of the project, please understand the following things first:
Adding extensions does not belong to project framework optimization, but if you find that you have to optimize the framework when adding new extensions, you need to modify the framework itself before adding extensions.
For some large-scale logical modifications (such as those involving LibraryBase, Extension objects, etc.), it is recommended to submit an Issue or Draft PR for discussion first.
In the early stage of the project, it was a pure private development project, and there were some Chinese comments in the code. After internationalizing your project you can submit a PR to translate these comments into English.
Please do not submit more useless code fragments in the code, such as a large number of unused variables, methods, classes, and code that has been rewritten many times.
#[AsFixItem()] first parameter is the name of the fix item, and this method must return True or False. When False is returned, the automatic repair failed and manual handling is required.
In the code here, shell()->exec() is the method of executing commands of the project, which is used to replace exec() and system(), and also provides debugging, obtaining execution status, entering directories, etc. characteristic.