PHPackages                             ruvart/openkm-client - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [HTTP & Networking](/categories/http)
4. /
5. ruvart/openkm-client

ActiveLibrary[HTTP & Networking](/categories/http)

ruvart/openkm-client
====================

A generic unofficial REST API client for PHP for connecting with an OpenKM Server.

0.3(2y ago)026MITPHPPHP >=8.0

Since Jan 6Pushed 2y ago1 watchersCompare

[ Source](https://github.com/ruvart/openkm-client)[ Packagist](https://packagist.org/packages/ruvart/openkm-client)[ Docs](http://github.com/ruvart/openkm-client)[ RSS](/packages/ruvart-openkm-client/feed)WikiDiscussions main Synced 1mo ago

READMEChangelog (3)DependenciesVersions (4)Used By (0)

openkm-client
=============

[](#openkm-client)

A generic unofficial REST API client for PHP for connecting with an OpenKM Server.

Ruvart

I created this client/library because I couldn't find the official one. Every single link I tried to follow in the OpenKM documentation for the PHP library threw an error, a missing file, or something similar.

Not all the API endpoints that OpenKM creates have been implemented in this client because I made it in a hurry and only implemented the ones that I needed for my project. However, I hope this library can still be helpful to you.

For any issues:

To be honest, I will only attend to them when I have time. I hope you can understand.

`*Note:` The file name must contain the full route plus the file name or only the file's ID that OpenKM generates.

Installation
------------

[](#installation)

PHP 8.0 or above.

```
$ composer require ruvart/openkm-client
```

Basic Usage
-----------

[](#basic-usage)

```
$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);
```

###  Health Score

20

—

LowBetter than 14% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity6

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity39

Early-stage or recently created project

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~0 days

Total

3

Last Release

861d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/59ed2f64985af9fa6bd0d97153eb385f3a223c216c387b66d6abaab0263a711b?d=identicon)[ruvart](/maintainers/ruvart)

---

Top Contributors

[![ruvart](https://avatars.githubusercontent.com/u/1543011?v=4)](https://github.com/ruvart "ruvart (10 commits)")

---

Tags

jsonapiclientrestxmlcurlOpenKM

### Embed Badge

![Health badge](/badges/ruvart-openkm-client/health.svg)

```
[![Health](https://phpackages.com/badges/ruvart-openkm-client/health.svg)](https://phpackages.com/packages/ruvart-openkm-client)
```

###  Alternatives

[tcdent/php-restclient

A generic REST API client for PHP

3542.9M29](/packages/tcdent-php-restclient)[serpapi/google-search-results-php

Get Google, Bing, Baidu, Ebay, Yahoo, Yandex, Home depot, Naver, Apple, Duckduckgo, Youtube search results via SerpApi.com

69114.3k](/packages/serpapi-google-search-results-php)[vinelab/http

An http library developed for the laravel framework. aliases itself as HttpClient

59300.2k11](/packages/vinelab-http)[ismaeltoe/osms

PHP library wrapper of the Orange SMS API.

4540.0k](/packages/ismaeltoe-osms)[jsor/hal-client

A lightweight client for consuming and manipulating Hypertext Application Language (HAL) resources.

2425.9k1](/packages/jsor-hal-client)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)