README

MarkLogic的PHP API

MLPHP是MarkLogic的PHP API，它使得在运行PHP（版本5.4或更高版本）的Web服务器上存储文档、管理文档元数据和创建复杂的搜索查询变得容易。PHP类通过MarkLogic REST API与MarkLogic通信。

安装MLPHP（见下文）后，您只需几行PHP代码即可将文档加载到MarkLogic中

use MarkLogic\MLPHP;

$document = new MLPHP\Document($client);
$document->setContentFile('myfile.xml')->write('/myfile.xml');

搜索同样简单

use MarkLogic\MLPHP;

$search = new MLPHP\Search($client);
$results = $search->retrieve('cat');

更多详细信息请参阅下文中的示例。

依赖关系

• MarkLogic 7或更高版本。下载服务器，启动它，并在端口号8001上的Admin UI中请求免费的开发者或Express许可。
• 启用PHP 5.4或更高版本的PHP网络服务器（例如，运行PHP的Apache），以下扩展库（通常默认可用）
  • DOM
  • cURL
  • XSL
• MLPHP
• Composer.

安装

要将MLPHP添加到项目中，只需在composer.json中将MLPHP添加为Composer依赖项

{
    "require": {
        "marklogic/mlphp" : "dev-master"
    }
}

然后，根据您如何安装Composer，运行

% composer install

或

% php composer.phar install

API文档

API文档可在线上找到。复制也提供在MLPHP仓库的api/docs下。

许可

MLPHP在Apache License，Version 2.0下授权（见LICENSE.txt）。

状态

MLPHP处于早期开发阶段，但已准备好使用。API可能会更改。

示例

MLPHP示例正在修订。

开发

构建

% git clone git@github.com:marklogic/mlphp mlphp
% cd mlphp
% composer install

要从源生成一组干净的新的API文档

1. 更新master分支

    % cd $PATH_TO_MLPHP/mlphp/api/docs
    % git rm -rf *
    % cd $PATH_TO_MLPHP/mlphp/
    % vendor/bin/phpdoc mlphp.ini
    % cd $PATH_TO_MLPHP/mlphp/api/docs
    % git add .
    % git commit -a -m "New docs"
    % git push origin master
   

2. 更新gh-pages副本（技术借鉴自https://gist.github.com/825950）

    % cd $PATH_TO_MLPHP/mlphp/api
   

   如果是第一次，

    % git clone -b gh-pages \
        --single-branch git@github.com:marklogic/mlphp docs-ghpages
   

   那么...

    % cd $PATH_TO_MLPHP/mlphp/api/docs-ghpages
    % git rm -rf [a-z]*
    % cd $PATH_TO_MLPHP/mlphp
    % vendor/bin/phpdoc mlphp-ghpages.ini
    % cd PATH_TO_MLPHP/mlphp/api/docs-ghpages
    % git add .
    % git commit -a -m "New docs"
    % git push origin gh-pages
   

单元测试

单元测试可以在tests下找到。要运行，

1. 编辑phpunit-config.php并设置特定于您的MarkLogic设置的配置变量。

2. 运行测试

    % vendor/bin/phpunit tests
   

MLPHP 使用 PHPUnit 进行测试。有关测试信息，请参阅 README.md。

贡献

您可以通过向项目的 [GitHub Issue Tracker]（https://github.com/marklogic/mlphp/issues）提交问题来请求新功能。

请将 pull requests 提交到 develop 分支。

版权

版权所有 2002-2015 MarkLogic Corporation。保留所有权利。