Add simple example hello. (#76)

Author: jmjoy

Cargo.toml

@@ -19,6 +19,7 @@ members = [
 
     # internal
     "examples/complex",
+    "examples/hello",
     "examples/http-client",
     "examples/http-server",
     "examples/logging",

examples/hello/Cargo.toml

@@ -0,0 +1,24 @@
+# Copyright (c) 2022 PHPER Framework Team
+# PHPER is licensed under Mulan PSL v2.
+# You can use this software according to the terms and conditions of the Mulan
+# PSL v2. You may obtain a copy of Mulan PSL v2 at:
+#          http://license.coscl.org.cn/MulanPSL2
+# THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY
+# KIND, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO
+# NON-INFRINGEMENT, MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE.
+# See the Mulan PSL v2 for more details.
+
+[package]
+name = "hello"
+version = "0.0.0"
+publish = false
+authors = { workspace = true }
+edition = { workspace = true }
+rust-version = { workspace = true }
+license = { workspace = true }
+
+[lib]
+crate-type = ["lib", "cdylib"]
+
+[dependencies]
+phper = { version = "0.6.0", path = "../../phper" }

examples/hello/README.md

@@ -0,0 +1,26 @@
+# hello
+
+Hello world example.
+
+## Environment
+
+```bash
+# Optional, specify if php isn't installed globally.
+export PHP_CONFIG=<Your path of php-config>
+```
+
+## Build
+
+```bash
+cargo build --release
+```
+
+## Run
+
+```bash
+php -d "extension=target/release/libhello.so" -r "say_hello('Bob');"
+```
+
+## License
+
+[MulanPSL-2.0](https://github.com/phper-framework/phper/blob/master/LICENSE).

examples/hello/build.rs

@@ -0,0 +1,17 @@
+// Copyright (c) 2022 PHPER Framework Team
+// PHPER is licensed under Mulan PSL v2.
+// You can use this software according to the terms and conditions of the Mulan
+// PSL v2. You may obtain a copy of Mulan PSL v2 at:
+//          http://license.coscl.org.cn/MulanPSL2
+// THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY
+// KIND, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO
+// NON-INFRINGEMENT, MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE.
+// See the Mulan PSL v2 for more details.
+
+fn main() {
+    #[cfg(target_os = "macos")]
+    {
+        println!("cargo:rustc-link-arg=-undefined");
+        println!("cargo:rustc-link-arg=dynamic_lookup");
+    }
+}

examples/hello/src/lib.rs

@@ -0,0 +1,40 @@
+// Copyright (c) 2022 PHPER Framework Team
+// PHPER is licensed under Mulan PSL v2.
+// You can use this software according to the terms and conditions of the Mulan
+// PSL v2. You may obtain a copy of Mulan PSL v2 at:
+//          http://license.coscl.org.cn/MulanPSL2
+// THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY
+// KIND, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO
+// NON-INFRINGEMENT, MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE.
+// See the Mulan PSL v2 for more details.
+
+use phper::{echo, functions::Argument, modules::Module, php_get_module, values::ZVal};
+
+/// The php function, receive arguments with type `ZVal`.
+fn say_hello(arguments: &mut [ZVal]) -> phper::Result<()> {
+    // Get the first argument, expect the type `ZStr`, and convert to Rust utf-8
+    // str.
+    let name = arguments[0].expect_z_str()?.to_str()?;
+
+    // Macro which do php internal `echo`.
+    echo!("Hello, {}!\n", name);
+
+    Ok(())
+}
+
+/// This is the entry of php extension, the attribute macro `php_get_module`
+/// will generate the `extern "C" fn`.
+#[php_get_module]
+pub fn get_module() -> Module {
+    // New `Module` with extension info.
+    let mut module = Module::new(
+        env!("CARGO_CRATE_NAME"),
+        env!("CARGO_PKG_VERSION"),
+        env!("CARGO_PKG_AUTHORS"),
+    );
+
+    // Register function `say_hello`, with one argument `name`.
+    module.add_function("say_hello", say_hello, vec![Argument::by_val("name")]);
+
+    module
+}