From b48d650bb598610e71a63dbf4093e77ee485f14a Mon Sep 17 00:00:00 2001 From: yuduan chen Date: Mon, 15 Sep 2014 01:23:36 +0000 Subject: [PATCH] Document the initialization git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@334865 c90b9560-bf6c-de11-be94-00142212c4b1 --- reference/phdfs/book.xml | 41 +++++++++ reference/phdfs/configure.xml | 33 ++++++++ reference/phdfs/constants.xml | 62 ++++++++++++++ reference/phdfs/phdfs.xml | 99 ++++++++++++++++++++++ reference/phdfs/phdfs/connect.xml | 58 +++++++++++++ reference/phdfs/phdfs/construct.xml | 76 +++++++++++++++++ reference/phdfs/phdfs/copy.xml | 76 +++++++++++++++++ reference/phdfs/phdfs/create-directory.xml | 67 +++++++++++++++ reference/phdfs/phdfs/delete.xml | 67 +++++++++++++++ reference/phdfs/phdfs/destruct.xml | 58 +++++++++++++ reference/phdfs/phdfs/disconnect.xml | 58 +++++++++++++ reference/phdfs/phdfs/exists.xml | 67 +++++++++++++++ reference/phdfs/phdfs/file-info.xml | 67 +++++++++++++++ reference/phdfs/phdfs/list-directory.xml | 67 +++++++++++++++ reference/phdfs/phdfs/read.xml | 76 +++++++++++++++++ reference/phdfs/phdfs/rename.xml | 76 +++++++++++++++++ reference/phdfs/phdfs/tell.xml | 67 +++++++++++++++ reference/phdfs/phdfs/write.xml | 85 +++++++++++++++++++ reference/phdfs/reference.xml | 30 +++++++ reference/phdfs/setup.xml | 64 ++++++++++++++ reference/phdfs/versions.xml | 46 ++++++++++ 21 files changed, 1340 insertions(+) create mode 100755 reference/phdfs/book.xml create mode 100755 reference/phdfs/configure.xml create mode 100755 reference/phdfs/constants.xml create mode 100755 reference/phdfs/phdfs.xml create mode 100755 reference/phdfs/phdfs/connect.xml create mode 100755 reference/phdfs/phdfs/construct.xml create mode 100755 reference/phdfs/phdfs/copy.xml create mode 100755 reference/phdfs/phdfs/create-directory.xml create mode 100755 reference/phdfs/phdfs/delete.xml create mode 100755 reference/phdfs/phdfs/destruct.xml create mode 100755 reference/phdfs/phdfs/disconnect.xml create mode 100755 reference/phdfs/phdfs/exists.xml create mode 100755 reference/phdfs/phdfs/file-info.xml create mode 100755 reference/phdfs/phdfs/list-directory.xml create mode 100755 reference/phdfs/phdfs/read.xml create mode 100755 reference/phdfs/phdfs/rename.xml create mode 100755 reference/phdfs/phdfs/tell.xml create mode 100755 reference/phdfs/phdfs/write.xml create mode 100755 reference/phdfs/reference.xml create mode 100755 reference/phdfs/setup.xml create mode 100755 reference/phdfs/versions.xml diff --git a/reference/phdfs/book.xml b/reference/phdfs/book.xml new file mode 100755 index 0000000000..a439873303 --- /dev/null +++ b/reference/phdfs/book.xml @@ -0,0 +1,41 @@ + + + + + Phdfs + Phdfs + +The phdfs extensions is using PHP to manipulate Hadoop HDFS +phdfs requires PHP 5.3 or greater. Earlier versions may not work. +For a quick start guide, please refer to the Tutorials section. + + + + + &reference.phdfs.setup; + &reference.phdfs.constants; + &reference.phdfs.examples; + &reference.phdfs.reference; + + + + diff --git a/reference/phdfs/configure.xml b/reference/phdfs/configure.xml new file mode 100755 index 0000000000..aa01b12fc8 --- /dev/null +++ b/reference/phdfs/configure.xml @@ -0,0 +1,33 @@ + + + +
+ &reftitle.install; + + + Use when compiling PHP. + + +
+ + + diff --git a/reference/phdfs/constants.xml b/reference/phdfs/constants.xml new file mode 100755 index 0000000000..473e17c17e --- /dev/null +++ b/reference/phdfs/constants.xml @@ -0,0 +1,62 @@ + + + + + &reftitle.constants; + &extension.constants; + + + + + O_WRONLY + (integer) + + + + + + + + + O_CREAT + (integer) + + + + + + + + + O_APPEND + (integer) + + + + + + + + + + + diff --git a/reference/phdfs/phdfs.xml b/reference/phdfs/phdfs.xml new file mode 100755 index 0000000000..887fefe6f4 --- /dev/null +++ b/reference/phdfs/phdfs.xml @@ -0,0 +1,99 @@ + + + + + + The phdfs class + phdfs + + + + +
+ &reftitle.intro; + + + +
+ + +
+ &reftitle.classsynopsis; + + + + phdfs + + + + + phdfs + + + + &Properties; + + static + host + + + static + port + + + + &Methods; + + + + +
+ + + +
+ &reftitle.properties; + + + host + + + + + + port + + + + + +
+ + + + + + &reference.phdfs.entities.phdfs; + + + + diff --git a/reference/phdfs/phdfs/connect.xml b/reference/phdfs/phdfs/connect.xml new file mode 100755 index 0000000000..08328d6458 --- /dev/null +++ b/reference/phdfs/phdfs/connect.xml @@ -0,0 +1,58 @@ + + + + + + phdfs::connect + Description + + + + &reftitle.description; + + public ReturnTypephdfs::connect + + + + + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + + + + + + + + diff --git a/reference/phdfs/phdfs/construct.xml b/reference/phdfs/phdfs/construct.xml new file mode 100755 index 0000000000..4940a5afe3 --- /dev/null +++ b/reference/phdfs/phdfs/construct.xml @@ -0,0 +1,76 @@ + + + + + + phdfs::__construct + Description + + + + &reftitle.description; + + public phdfs::__construct + stringip + stringport + + + + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + + + ip + + + + + + + + port + + + + + + + + + + + &reftitle.returnvalues; + + + + + + + + + diff --git a/reference/phdfs/phdfs/copy.xml b/reference/phdfs/phdfs/copy.xml new file mode 100755 index 0000000000..9834798574 --- /dev/null +++ b/reference/phdfs/phdfs/copy.xml @@ -0,0 +1,76 @@ + + + + + + phdfs::copy + Description + + + + &reftitle.description; + + public ReturnTypephdfs::copy + stringsource_file + stringdestination_file + + + + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + + + source_file + + + + + + + + destination_file + + + + + + + + + + + &reftitle.returnvalues; + + + + + + + + + diff --git a/reference/phdfs/phdfs/create-directory.xml b/reference/phdfs/phdfs/create-directory.xml new file mode 100755 index 0000000000..3ab4e7f69b --- /dev/null +++ b/reference/phdfs/phdfs/create-directory.xml @@ -0,0 +1,67 @@ + + + + + + phdfs::create_directory + Description + + + + &reftitle.description; + + public ReturnTypephdfs::create_directory + stringpath + + + + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + + + path + + + + + + + + + + + &reftitle.returnvalues; + + + + + + + + + diff --git a/reference/phdfs/phdfs/delete.xml b/reference/phdfs/phdfs/delete.xml new file mode 100755 index 0000000000..9b1cddc8f9 --- /dev/null +++ b/reference/phdfs/phdfs/delete.xml @@ -0,0 +1,67 @@ + + + + + + phdfs::delete + Description + + + + &reftitle.description; + + public ReturnTypephdfs::delete + stringpath + + + + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + + + path + + + + + + + + + + + &reftitle.returnvalues; + + + + + + + + + diff --git a/reference/phdfs/phdfs/destruct.xml b/reference/phdfs/phdfs/destruct.xml new file mode 100755 index 0000000000..9117185d29 --- /dev/null +++ b/reference/phdfs/phdfs/destruct.xml @@ -0,0 +1,58 @@ + + + + + + phdfs::__destruct + Description + + + + &reftitle.description; + + public ReturnTypephdfs::__destruct + + + + + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + + + + + + + + diff --git a/reference/phdfs/phdfs/disconnect.xml b/reference/phdfs/phdfs/disconnect.xml new file mode 100755 index 0000000000..cc452ecab3 --- /dev/null +++ b/reference/phdfs/phdfs/disconnect.xml @@ -0,0 +1,58 @@ + + + + + + phdfs::disconnect + Description + + + + &reftitle.description; + + public ReturnTypephdfs::disconnect + + + + + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + + + + + + + + diff --git a/reference/phdfs/phdfs/exists.xml b/reference/phdfs/phdfs/exists.xml new file mode 100755 index 0000000000..d3c2b7984a --- /dev/null +++ b/reference/phdfs/phdfs/exists.xml @@ -0,0 +1,67 @@ + + + + + + phdfs::exists + Description + + + + &reftitle.description; + + public ReturnTypephdfs::exists + stringpath + + + + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + + + path + + + + + + + + + + + &reftitle.returnvalues; + + + + + + + + + diff --git a/reference/phdfs/phdfs/file-info.xml b/reference/phdfs/phdfs/file-info.xml new file mode 100755 index 0000000000..f5bc5f6685 --- /dev/null +++ b/reference/phdfs/phdfs/file-info.xml @@ -0,0 +1,67 @@ + + + + + + phdfs::file_info + Description + + + + &reftitle.description; + + public ReturnTypephdfs::file_info + stringpath + + + + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + + + path + + + + + + + + + + + &reftitle.returnvalues; + + + + + + + + + diff --git a/reference/phdfs/phdfs/list-directory.xml b/reference/phdfs/phdfs/list-directory.xml new file mode 100755 index 0000000000..06e9691ea0 --- /dev/null +++ b/reference/phdfs/phdfs/list-directory.xml @@ -0,0 +1,67 @@ + + + + + + phdfs::list_directory + Description + + + + &reftitle.description; + + public ReturnTypephdfs::list_directory + stringpath + + + + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + + + path + + + + + + + + + + + &reftitle.returnvalues; + + + + + + + + + diff --git a/reference/phdfs/phdfs/read.xml b/reference/phdfs/phdfs/read.xml new file mode 100755 index 0000000000..a0bc3217fe --- /dev/null +++ b/reference/phdfs/phdfs/read.xml @@ -0,0 +1,76 @@ + + + + + + phdfs::read + Description + + + + &reftitle.description; + + public ReturnTypephdfs::read + stringpath + stringlength + + + + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + + + path + + + + + + + + length + + + + + + + + + + + &reftitle.returnvalues; + + + + + + + + + diff --git a/reference/phdfs/phdfs/rename.xml b/reference/phdfs/phdfs/rename.xml new file mode 100755 index 0000000000..c3847202bc --- /dev/null +++ b/reference/phdfs/phdfs/rename.xml @@ -0,0 +1,76 @@ + + + + + + phdfs::rename + Description + + + + &reftitle.description; + + public ReturnTypephdfs::rename + stringold_path + stringnew_path + + + + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + + + old_path + + + + + + + + new_path + + + + + + + + + + + &reftitle.returnvalues; + + + + + + + + + diff --git a/reference/phdfs/phdfs/tell.xml b/reference/phdfs/phdfs/tell.xml new file mode 100755 index 0000000000..ec7fc9f4eb --- /dev/null +++ b/reference/phdfs/phdfs/tell.xml @@ -0,0 +1,67 @@ + + + + + + phdfs::tell + Description + + + + &reftitle.description; + + public ReturnTypephdfs::tell + stringpath + + + + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + + + path + + + + + + + + + + + &reftitle.returnvalues; + + + + + + + + + diff --git a/reference/phdfs/phdfs/write.xml b/reference/phdfs/phdfs/write.xml new file mode 100755 index 0000000000..83b1c9bf30 --- /dev/null +++ b/reference/phdfs/phdfs/write.xml @@ -0,0 +1,85 @@ + + + + + + phdfs::write + Description + + + + &reftitle.description; + + public ReturnTypephdfs::write + stringpath + stringbuffer + stringmode + + + + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + + + path + + + + + + + + buffer + + + + + + + + mode + + + + + + + + + + + &reftitle.returnvalues; + + + + + + + + + diff --git a/reference/phdfs/reference.xml b/reference/phdfs/reference.xml new file mode 100755 index 0000000000..f21e9d76e5 --- /dev/null +++ b/reference/phdfs/reference.xml @@ -0,0 +1,30 @@ + + + + + Phdfs &Functions; + + &reference.phdfs.entities.functions; + + + + diff --git a/reference/phdfs/setup.xml b/reference/phdfs/setup.xml new file mode 100755 index 0000000000..f9aac25045 --- /dev/null +++ b/reference/phdfs/setup.xml @@ -0,0 +1,64 @@ + + + + + &reftitle.setup; + +
+ &reftitle.required; + + PHP Version: PHP 5.3+ + + + ZTS Enabled ( Thread Safety ) + + + need to install hadoop + +
+ +
+ &reftitle.install; + + &pecl.moved; + + + &pecl.info; + &url.pecl.package;phdfs. + +
+ +
+ this extension has no configuration directives defined in php.ini. +
+ +
+ &reftitle.resources; + &no.resource; + + + +
+ + + + diff --git a/reference/phdfs/versions.xml b/reference/phdfs/versions.xml new file mode 100755 index 0000000000..c77f2d532d --- /dev/null +++ b/reference/phdfs/versions.xml @@ -0,0 +1,46 @@ + + + + + + + + + + + + + + + + + + + + + + + + +