README

一个通用的非官方REST API客户端，用于PHP连接到OpenKM服务器。

http://github.com/ruvart/openkm-client
Ruvart contacto@ruvart.com

我创建这个客户端/库是因为我找不到官方的版本。我尝试跟随OpenKM文档中关于PHP库的所有链接，都抛出了错误、缺失文件或类似的问题。

由于我匆忙制作了这个客户端，并且只实现了我项目需要的API端点，因此并非OpenKM创建的所有API端点都已在客户端中实现。然而，我希望这个库对你仍然有所帮助。

有关任何问题：http://github.com/ruvart/openkm-client/issues

说实话，我只有在有时间的时候才会处理这些问题。希望你能理解。

*注意：文件名必须包含完整的路由加上文件名，或者只包含OpenKM生成的文件ID。

安装

PHP 8.0或更高版本。

$ composer require ruvart/openkm-client

基本用法

$okmClient = new OpenKMClient($url,$user,$password, true);

//This funtion gets the route to the users folder (OpenKM User), it's the equivalent to C:\Users\user-name
//You can user any valid route if you don't wanna use the user's folder
$root = $okmClient->getRoot();

//Is a valid file
if ( $okmClient->documentIsValid($root . $file_name) ) {
    echo "It's a valid file";
}
else {
    echo "It's not a valid file";
}


//Filezise
$properties = $okmClient->documentGetProperties($root . $file_name);
if ( !empty($properties) && !empty($properties['actualVersion']) && !empty($properties['actualVersion']['size']) ) {
    echo $properties['actualVersion']['size'];
}


//Mime info
$properties = $okmClient->documentGetProperties($root . $file_name);
if ( !empty($properties) && !empty($properties['mimeType']) ) {
    echo $properties['mimeType'];
}


//Uploads a file
$okmClient->documentCreateSimple($root . $file_name, $route_to_local_file);


//rename a file
$okmClient->documentRename($root . $file_name, $only_new_name);


//copy a file
$okmClient->documentCopy($root . $file_name, $destiny_route);


//Stream a file
$okmClient->documentGetContent($root . $file_name, 'PHP:output');


//Deletes a file
$okmClient->documentDelete($root . $file_name);


//Make folder / dir
$okmClient->folderCreateSimple($root . $folder_name);