PHP Samples

Download sdk4php

The sdk4php sample below includes the most common methods used by users when integrating their PHP applications.

OpenKM has more than 400 methods in the API. The samples below cover the most common methods used when integrating PHP applications with OpenKM.

If you have issues trying to use methods not covered in this sample, ask for them in the OpenKM community forum at https://forum.openkm.com

Professional	PHP version	Status	Download
Version 7.0.0 and above	7.x	Active	sdk4php-3.0.3.zip

Preview sample

The sample below describes how to integrate the OpenKM preview feature in your PHP application.

Professional	PHP version	Status	Download
Version 7.0.0 and above.	7.x	Active	okmPreview-3.0.1.zip

First, you must create the web service object:

$this->ws = OKMWebServicesFactory::build(self::HOST);

Then you should log in using the method "login". You can access the "login" method from the web service object "ws" as shown below:

$this->ws->login(self::USER, self::PASSWORD);

Once you are logged in with the web services, the session is kept in the web service object. Then you can use the other API methods.

At this point, you can use all the Folder methods from "folder" class as shown below:

$folder = $this->ws->folder->getFolderProperties("4a3b1c1b-c880-45a3-a6ff-2c8b7c5adfa5");

<?php
include '../src/openkm/OpenKM.php';

use openkm\OKMWebServicesFactory;
use openkm\OpenKM;

class Test {

    const HOST = "http://localhost:8080/openkm/";
    const USER = "okmAdmin";
    const PASSWORD = "admin";

    private $ws;

    public function __construct() {
        $this->ws = OKMWebServicesFactory::build(self::HOST);
    }

    public function test() {
        echo '<pre>';
        try {
            $this->ws->login(self::USER, self::PASSWORD);
            $folder = $this->ws->folder->getFolderProperties("4a3b1c1b-c880-45a3-a6ff-2c8b7c5adfa5");
            var_dump($folder);
        } catch (Exception $e) {
            var_dump($e);
        }
    }

}

$openkm = new OpenKM(); //autoload
$test = new Test();
$$test->test();
?>

Document samples

createDocument

Description:

Method	Return values	Description
createDocument($uuid, $name, $content)	Document	Creates a new document and returns a Document object with the properties of the created document.
Parameters: $uuid string type is the destination uuid of the Folder or Record $name string type is the document name. $content string type; it is recommended to use file_get_contents ? reads the entire file into a string.

Method

Return values

Description

createDocument($uuid, $name, $content)

Document

Creates a new document and returns a Document object with the properties of the created document.

Parameters:
$uuid string type is the destination uuid of the Folder or Record

$name string type is the document name.

$content string type; it is recommended to use file_get_contents ? reads the entire file into a string.

Example:

<?php

include '../src/openkm/OpenKM.php';

use openkm\OKMWebServicesFactory;
use openkm\OpenKM;

class Test {

    const HOST = "http://localhost:8080/openkm/";
    const USER = "okmAdmin";
    const PASSWORD = "admin";

    private $ws;

    public function __construct() {
        $this->ws = OKMWebServicesFactory::build(self::HOST);
    }

    public function test() {
        echo '<pre>';
        try {
            $this->ws->login(self::USER, self::PASSWORD);
            $fileName = dirname(__FILE__) . '/files/test.pdf';
            $document = $this->ws->document->createDocument('f93ac8df-e83b-487f-9a14-0af9e910a818', 'test.pdf', file_get_contents($fileName));
            var_dump($document);
        } catch (Exception $e) {
            var_dump($e);
        }
    }

}

$openkm = new OpenKM(); //autoload
$test = new Test();
$test->test();
?>

deleteDocument

Description:

Method	Return values	Description
deleteDocument($uuid)	void	Deletes a document.
Parameters: $uuid string type is the uuid of the Document When a document is deleted, it is automatically moved to /okm:trash/userId folder.

Example:

<?php

include '../src/openkm/OpenKM.php';

use openkm\OKMWebServicesFactory;
use openkm\OpenKM;

class Test {

    const HOST = "http://localhost:8080/openkm/";
    const USER = "okmAdmin";
    const PASSWORD = "admin";

    private $ws;

    public function __construct() {
        $this->ws = OKMWebServicesFactory::build(self::HOST);
    }

    public function test() {
        echo '<pre>';
        try {
            $this->ws->login(self::USER, self::PASSWORD);
            $this->ws->document->deleteDocument('5b37c508-b2be-4429-ba5e-acc96089c6a9');
            echo 'deleted';
        } catch (Exception $e) {
            var_dump($e);
        }
    }

}

$openkm = new OpenKM(); //autoload
$test = new Test();
$test->test();
?>

getDocumentProperties

Description:

Method	Return values	Description
getDocumentProperties($uuid)	Document	Returns the document properties.
Parameters: $uuid string type is the uuid of the Document

Example:

<?php

include '../src/openkm/OpenKM.php';

use openkm\OKMWebServicesFactory;
use openkm\OpenKM;

class Test {

    const HOST = "http://localhost:8080/openkm/";
    const USER = "okmAdmin";
    const PASSWORD = "admin";

    private $ws;

    public function __construct() {
        $this->ws = OKMWebServicesFactory::build(self::HOST);
    }

    public function test() {
        echo '<pre>';
        try {
            $this->ws->login(self::USER, self::PASSWORD);
            $document = $this->ws->document->getDocumentProperties('7e12a9ff-95b2-4945-bf5f-1bb709d89c14');
            var_dump($document);
        } catch (Exception $e) {
            var_dump($e);
        }
    }

}

$openkm = new OpenKM(); //autoload
$test = new Test();
$test->test();
?>

getContent

Description:

Method	Return values	Description
getContent($uuid)	string	Retrieves the document content - binary data - of the actual document version.
Parameters: $uuid string type is the uuid of the Document

Example:

<?php

include '../src/openkm/OpenKM.php';

use openkm\OKMWebServicesFactory;
use openkm\OpenKM;

class Test {

    const HOST = "http://localhost:8080/openkm/";
    const USER = "okmAdmin";
    const PASSWORD = "admin";

    private $ws;

    public function __construct() {
        $this->ws = OKMWebServicesFactory::build(self::HOST);
    }

    public function test() {
        $method = 1;
        $this->ws->login(self::USER, self::PASSWORD);
        $content = $this->ws->document->getContent('b02877cc-bc71-4be9-9bfb-2e50b1732fd3');
        switch ($method) {
            case 1:
                $file = fopen(dirname(__FILE__) . '/files/logo_download.png', 'w+');
                fwrite($file, $content);
                fclose($file);
                echo 'download correct';
                break;
            case 2:
                ob_clean();
                $document = $this->ws->document->getDocumentProperties('b02877cc-bc71-4be9-9bfb-2e50b1732fd3');
                $name = PathUtils::getName($document->getPath());
                header("Cache-Control:  maxage=1");
                header("Pragma: public");
                header("Content-Type: " . $document->getMimeType());
                header('Content-Disposition: attachment; filename="' . $name . '"');
                header("Content-Length: " . strlen($content));
                echo $content;
                break;
        }
    }

}

$openkm = new OpenKM(); //autoload
$test = new Test();
$test->test();
?>

getDocumentChildren

Description:

Method	Return values	Description
getDocumentChildren($uuid)	array	Returns a list of all documents whose parent is fldId.
Parameters: $fldId string type is the uuid or path of the Document or a record node.

Example:

<?php

include '../src/openkm/OpenKM.php';

use openkm\OKMWebServicesFactory;
use openkm\OpenKM;

class Test {

    const HOST = "http://localhost:8080/openkm/";
    const USER = "okmAdmin";
    const PASSWORD = "admin";

    private $ws;

    public function __construct() {
        $this->ws = OKMWebServicesFactory::build(self::HOST);
    }

    public function test() {
        echo '<pre>';
        try {
            $this->ws->login(self::USER, self::PASSWORD);
            $documents = $this->ws->document->getDocumentChildren('f93ac8df-e83b-487f-9a14-0af9e910a818');
            foreach ($documents as $document) {
                var_dump($document);
            }
        } catch (Exception $e) {
            var_dump($e);
        }
    }

}

$openkm = new OpenKM(); //autoload
$test = new Test();
$test->test();
?>

moveDocument

Description:

Method	Return values	Description
moveDocument($uuid, $dstId)	void	Move a document into a folder or record.
Parameters: $uuid string type is the uuid of the Document $dstId string type is the uuid of the Folder or Record

Method

Return values

Description

moveDocument($uuid, $dstId)

void

Move a document into a folder or record.

Parameters:
$uuid string type is the uuid of the Document

$dstId string type is the uuid of the Folder or Record

Example:

<?php

include '../src/openkm/OpenKM.php';

use openkm\OKMWebServicesFactory;
use openkm\OpenKM;

class Test {

    const HOST = "http://localhost:8080/openkm/";
    const USER = "okmAdmin";
    const PASSWORD = "admin";

    private $ws;

    public function __construct() {
        $this->ws = OKMWebServicesFactory::build(self::HOST);
    }

    public function test() {
        echo '<pre>';
        try {
            $this->ws->login(self::USER, self::PASSWORD);
            $this->ws->document->moveDocument('b02877cc-bc71-4be9-9bfb-2e50b1732fd3', '55102c84-e4f5-4cbc-a3d1-cf1896367752');
            echo 'moveDocument';
        } catch (Exception $e) {
            var_dump($e);
        }
    }

}

$openkm = new OpenKM(); //autoload
$test = new Test();
$test->test();
?>

copyDocument

Description:

Method	Return values	Description
copyDocument($uuid, $dstId, $newName)	void	Copies a document to a folder or record.
Parameters: $uuid string type is the uuid of the Document $dstId string type is the uuid of the Folder or Record $newName string type is the new name for the Document When the parameter newName value is null, the document will preserve the same name. Only the binary data and the security grants are copied to destination; the metadata, keywords, etc. of the document are not copied. See "extendedDocumentCopy" method for this feature.

Method

Return values

Description

copyDocument($uuid, $dstId, $newName)

void

Copies a document to a folder or record.

Parameters:
$uuid string type is the uuid of the Document

$dstId string type is the uuid of the Folder or Record

$newName string type is the new name for the Document

When the parameter newName value is null, the document will preserve the same name.

Only the binary data and the security grants are copied to destination; the metadata, keywords, etc. of the document are not copied.

See "extendedDocumentCopy" method for this feature.

Example:

<?php

include '../src/openkm/OpenKM.php';

use openkm\OKMWebServicesFactory;
use openkm\OpenKM;

class Test {

    const HOST = "http://localhost:8080/openkm/";
    const USER = "okmAdmin";
    const PASSWORD = "admin";

    private $ws;

    public function __construct() {
        $this->ws = OKMWebServicesFactory::build(self::HOST);
    }

    public function test() {
        echo '<pre>';
        try {
            $this->ws->login(self::USER, self::PASSWORD);
            $document = $this->ws->document->copyDocument('b02877cc-bc71-4be9-9bfb-2e50b1732fd3', '55102c84-e4f5-4cbc-a3d1-cf1896367752', 'new_logo.png');
            var_dump($document);
            echo 'copyDocument';
        } catch (Exception $e) {
            var_dump($e);
        }
    }

}

$openkm = new OpenKM(); //autoload
$test = new Test();
$test->test();
?>

extendedDocumentCopy

Description:

Method	Return values	Description
extendedDocumentCopy($uuid, $dstId, $newName, $categories, $keywords, $propertyGroups, $notes, $security)	void	Copies a document with associated data into another folder or record.
Parameters: $uuid string type is the uuid of the Folder $dstId string type is the uuid of the Folder or Record $newName string type is the newName $categories boolean type $keywords boolean type $propertyGroups boolean type $notes boolean type $security boolean type By default, only the binary data and the security grants are copied; the metadata, keywords, etc., of the folder are not copied. Additionally: When the categories parameter is true, the original values of the categories will be copied. When the keywords parameter is true, the original values of the keywords will be copied. When the propertyGroups parameter is true, the original values of the metadata groups will be copied. When the notes parameter is true, the original values of the notes will be copied. When the security parameter is true, the original values of the security will be copied.

Method

Return values

Description

extendedDocumentCopy($uuid, $dstId, $newName, $categories, $keywords, $propertyGroups, $notes, $security)

void

Copies a document with associated data into another folder or record.

Parameters:
$uuid string type is the uuid of the Folder

$dstId string type is the uuid of the Folder or Record

$newName string type is the newName

$categories boolean type

$keywords boolean type

$propertyGroups boolean type

$notes boolean type

$security boolean type

By default, only the binary data and the security grants are copied; the metadata, keywords, etc., of the folder are not copied.

Additionally:

When the categories parameter is true, the original values of the categories will be copied.
When the keywords parameter is true, the original values of the keywords will be copied.
When the propertyGroups parameter is true, the original values of the metadata groups will be copied.
When the notes parameter is true, the original values of the notes will be copied.
When the security parameter is true, the original values of the security will be copied.

Example:

<?php

include '../src/openkm/OpenKM.php';

use openkm\OKMWebServicesFactory;
use openkm\OpenKM;

class Test {

    const HOST = "http://localhost:8080/openkm/";
    const USER = "okmAdmin";
    const PASSWORD = "admin";

    private $ws;

    public function __construct() {
        $this->ws = OKMWebServicesFactory::build(self::HOST);
    }

    public function test() {
        echo '<pre>';
        try {
            $this->ws->login(self::USER, self::PASSWORD);
            $document = $this->ws->document->extendedDocumentCopy('4ee59dea-4641-4336-a2c4-af384d9040ad', 'd81ac5f3-0cb3-4cd7-997b-3b1b9f4403f8', 'copy.pdf', true, true, true, true, true);
            var_dump($document);
            echo 'extendedDocumentCopy';
        } catch (Exception $e) {
            var_dump($e);
        }
    }

}

$openkm = new OpenKM(); //autoload
$test = new Test();
$test->test();
?>

checkout

Description:

Method	Return values	Description
checkout($uuid)	void	Marks the document for editing.
Parameters: $uuid string type is the uuid or path of the Document Only one user can modify a document at the same time. Before starting editing, you must perform a checkout action that locks the editing process for other users and allows it only to the user who executed the action.

Method

Return values

Description

checkout($uuid)

void

Marks the document for editing.

Parameters:
$uuid string type is the uuid or path of the Document

Only one user can modify a document at the same time.

Before starting editing, you must perform a checkout action that locks the editing process for other users and allows it only to the user who executed the action.

Example:

<?php

include '../src/openkm/OpenKM.php';

use openkm\OKMWebServicesFactory;
use openkm\OpenKM;

class Test {

    const HOST = "http://localhost:8080/openkm/";
    const USER = "okmAdmin";
    const PASSWORD = "admin";

    private $ws;

    public function __construct() {
        $this->ws = OKMWebServicesFactory::build(self::HOST);
    }

    public function test() {
        echo '<pre>';
        try {
            $this->ws->login(self::USER, self::PASSWORD);
            $this->ws->document->checkout('eb0e6511-3415-47ca-bcde-393d97944c85');
            // At this point the document is locked for other users except for the user who executed the action
            echo 'correct';
        } catch (Exception $e) {
            var_dump($e);
        }
    }

}

$openkm = new OpenKM(); //autoload
$test = new Test();
$test->test();
?>

cancelCheckout

Description:

Method	Return values	Description
cancelCheckout($docId)	void	Cancels document editing.
Parameters: $docId string type is the uuid or path of the Document This action can only be done by the user who previously executed the checkout action.

Example:

<?php

include '../src/openkm/OpenKM.php';

use openkm\OKMWebServicesFactory;
use openkm\OpenKM;

class Test {

    const HOST = "http://localhost:8080/openkm/";
    const USER = "okmAdmin";
    const PASSWORD = "admin";

    private $ws;

    public function __construct() {
        $this->ws = OKMWebServicesFactory::build(self::HOST);
    }

    public function test() {
        echo '<pre>';
        try {
            $this->ws->login(self::USER, self::PASSWORD);
            // At this point the document is locked for other users except for the user who executed the action
            $this->ws->document->cancelCheckout('eb0e6511-3415-47ca-bcde-393d97944c85');
            // At this point other users are allowed to execute a checkout and modify the document
            echo 'correct';
        } catch (Exception $e) {
            var_dump($e);
        }
    }

}

$openkm = new OpenKM(); //autoload
$test = new Test();
$test->test();
?>

forceCancelCheckout

Description:

Method	Return values	Description
forceCancelCheckout($uuid)	void	Cancels document editing.
Parameters: $uuid string type is the uuid or path of the Document This method allows you to cancel editing on any document. It is not mandatory that this action is executed by the same user who previously executed the checkout action. This action can only be done by a super user (user with ROLE_ADMIN).

Method

Return values

Description

forceCancelCheckout($uuid)

void

Cancels document editing.

Parameters:
$uuid string type is the uuid or path of the Document

This method allows you to cancel editing on any document.

It is not mandatory that this action is executed by the same user who previously executed the checkout action.

This action can only be done by a super user (user with ROLE_ADMIN).

Example:

<?php

include '../src/openkm/OpenKM.php';

use openkm\OKMWebServicesFactory;
use openkm\OpenKM;

class Test {

    const HOST = "http://localhost:8080/openkm/";
    const USER = "okmAdmin";
    const PASSWORD = "admin";

    private $ws;

    public function __construct() {
        $this->ws = OKMWebServicesFactory::build(self::HOST);
    }

    public function test() {
        echo '<pre>';
        try {
            $this->ws->login(self::USER, self::PASSWORD);
            // At this point the document is locked for other users except for the user who executed the action
            $this->ws->document->forceCancelCheckout('eb0e6511-3415-47ca-bcde-393d97944c85');
            // At this point other users are allowed to execute a checkout and modify the document
            echo 'correct';
        } catch (Exception $e) {
            var_dump($e);
        }
    }

}

$openkm = new OpenKM(); //autoload
$test = new Test();
$test->test();
?>

isCheckedOut

Description:

Method	Return values	Description
isCheckedOut($uuid)	bool	Returns a boolean that indicates whether the document is being edited or not.
Parameters: $uuid string type is the uuid or path of the Document

Example:

<?php

include '../src/openkm/OpenKM.php';

use openkm\OKMWebServicesFactory;
use openkm\OpenKM;

class Test {

    const HOST = "http://localhost:8080/openkm/";
    const USER = "okmAdmin";
    const PASSWORD = "admin";

    private $ws;

    public function __construct() {
        $this->ws = OKMWebServicesFactory::build(self::HOST);
    }

    public function test() {
        echo '<pre>';
        try {
            $this->ws->login(self::USER, self::PASSWORD);
            var_dump($this->ws->document->isCheckedOut('eb0e6511-3415-47ca-bcde-393d97944c85'));
        } catch (Exception $e) {
            var_dump($e);
        }
    }

}

$openkm = new OpenKM(); //autoload
$test = new Test();
$test->test();
?>

checkin

Description:

Method	Return values	Description
checkin($uuid, $content, $comment,$increment)	Version	Updates a document with a new version and returns an object with new Version values.
Parameters: $uuid string type is the uuid or path of the Document $content string type; it is recommended to use file_get_contents ? reads the entire file into a string. $comment string type is the comment for the new version of the document $increment int type The value of the increment variable must be 1 or greater. The valid values of the increment variable depend on the VersionNumberAdapter you have enabled. Only the user who started the editing (checkout) is allowed to update the document.

Method

Return values

Description

checkin($uuid, $content, $comment,$increment)

Version

Updates a document with a new version and returns an object with new Version values.

Parameters:
$uuid string type is the uuid or path of the Document

$content string type; it is recommended to use file_get_contents ? reads the entire file into a string.

$comment string type is the comment for the new version of the document

$increment int type

The value of the increment variable must be 1 or greater.

The valid values of the increment variable depend on the VersionNumberAdapter you have enabled.

Only the user who started the editing (checkout) is allowed to update the document.

Example:

<?php

include '../src/openkm/OpenKM.php';

use openkm\OKMWebServicesFactory;
use openkm\OpenKM;

class Test {

    const HOST = "http://localhost:8080/openkm/";
    const USER = "okmAdmin";
    const PASSWORD = "admin";

    private $ws;

    public function __construct() {
        $this->ws = OKMWebServicesFactory::build(self::HOST);
    }

    public function test() {
        echo '<pre>';
        try {
            $this->ws->login(self::USER, self::PASSWORD);
            $this->ws->document->checkout('eb0e6511-3415-47ca-bcde-393d97944c85');
            if ($this->ws->document->isCheckedOut('eb0e6511-3415-47ca-bcde-393d97944c85')) {
                $fileName = dirname(__FILE__) . '/files/logo.png';
                $version = $this->ws->document->checkin('eb0e6511-3415-47ca-bcde-393d97944c85', file_get_contents($fileName), "optional some comment", 1);
                var_dump($version);
            }
        } catch (Exception $e) {
            var_dump($e);
        }
    }

}

$openkm = new OpenKM(); //autoload
$test = new Test();
$test->test();
?>

getVersionHistory

Folder sample

createFolder

Description:

Method	Return values	Description
createFolder($uuid, $name)	Folder	Creates a new folder and returns a Folder object as a result.
Parameters: $uuid string type is the destination uuid of the Folder or Record

Example:

<?php

include '../src/openkm/OpenKM.php';

use openkm\OKMWebServicesFactory;
use openkm\OpenKM;

class Test {

    const HOST = "http://localhost:8080/openkm/";
    const USER = "okmAdmin";
    const PASSWORD = "admin";

    private $ws;

    public function __construct() {
        $this->ws = OKMWebServicesFactory::build(self::HOST);
    }

    public function test() {
        echo '<pre>';
        try {
            $this->ws->login(self::USER, self::PASSWORD);
            $folder = $this->ws->folder->createFolder('f93ac8df-e83b-487f-9a14-0af9e910a818', 'test');
            var_dump($folder);
        } catch (Exception $e) {
            var_dump($e);
        }
    }

}

$openkm = new OpenKM(); //autoload
$test = new Test();
$test->test();
?>

getFolderProperties

Description:

Method	Return values	Description
getFolderProperties($uuid)	Folder	Returns the folder properties.
Parameters: $uuid string type is the uuid of the Folder

Example:

<?php

include '../src/openkm/OpenKM.php';

use openkm\OKMWebServicesFactory;
use openkm\OpenKM;

class Test {

    // const HOST = "http://localhost:8080/openkm/";
    const HOST = "http://192.168.1.11:8888/openkm/";
    const USER = "okmAdmin";
    const PASSWORD = "admin";

    private $ws;

    public function __construct() {
        $this->ws = OKMWebServicesFactory::build(self::HOST);
    }

    public function test() {
        echo '<pre>';
        try {
            $this->ws->login(self::USER, self::PASSWORD);
            $folder = $this->ws->folder->getFolderProperties("4a3b1c1b-c880-45a3-a6ff-2c8b7c5adfa5");
            var_dump($folder);
        } catch (Exception $e) {
            var_dump($e);
        }
    }

}

$openkm = new OpenKM(); //autoload
$test = new Test();
$test->test();
?>

deleteFolder

Description:

Method	Return values	Description
deleteFolder($uuid)	void	Deletes a folder.
Parameters: $uuid string type is the uuid of the Folder

Example:

<?php

include '../src/openkm/OpenKM.php';

use openkm\OKMWebServicesFactory;
use openkm\OpenKM;

class Test {

    // const HOST = "http://localhost:8080/openkm/";
    const HOST = "http://192.168.1.11:8888/openkm/";
    const USER = "okmAdmin";
    const PASSWORD = "admin";

    private $ws;

    public function __construct() {
        $this->ws = OKMWebServicesFactory::build(self::HOST);
    }

    public function test() {
        echo '<pre>';
        try {
            $this->ws->login(self::USER, self::PASSWORD);
            $this->ws->folder->deleteFolder("56c4d33b-daad-4389-bfdc-ee8dd5273899");
            echo 'delete folder';
        } catch (Exception $e) {
            var_dump($e);
        }
    }

}

$openkm = new OpenKM(); //autoload
$test = new Test();
$test->test();
?>

renameFolder

Description:

Method	Return values	Description
renameFolder($uuid, $newName)	void	Renames a folder.
Parameters: $uuid string type is the uuid of the Folder $newName string type is the new name for the Folder

Method

Return values

Description

renameFolder($uuid, $newName)

void

Renames a folder.

Parameters:
$uuid string type is the uuid of the Folder

$newName string type is the new name for the Folder

Example:

<?php

include '../src/openkm/OpenKM.php';

use openkm\OKMWebServicesFactory;
use openkm\OpenKM;

class Test {

    const HOST = "http://localhost:8080/openkm/";
    const USER = "okmAdmin";
    const PASSWORD = "admin";

    private $ws;

    public function __construct() {
        $this->ws = OKMWebServicesFactory::build(self::HOST);
    }

    public function test() {
        echo '<pre>';
        try {
            $this->ws->login(self::USER, self::PASSWORD);
            // Exists folder /okm:root/sdk/test
            $folder = $this->ws->folder->renameFolder("0b89e4ca-0019-4837-82a4-05bc05d83353", "renamedFolder");
            // Folder has renamed to /okm:root/sdk/renamedFolder
            echo 'rename Folder';
            var_dump($folder);
        } catch (Exception $e) {
            var_dump($e);
        }
    }

}

$openkm = new OpenKM(); //autoload
$test = new Test();
$test->test();
?>

moveFolder

Description:

Method	Return values	Description
moveFolder($uuid, $dstId)	void	Moves a folder into another folder or record.
Parameters: $uuid string type is the uuid of the Folder $dstId string type is the uuid of the Folder or record

Method

Return values

Description

moveFolder($uuid, $dstId)

void

Moves a folder into another folder or record.

Parameters:
$uuid string type is the uuid of the Folder

$dstId string type is the uuid of the Folder or record

Example:

<?php

include '../src/openkm/OpenKM.php';

use openkm\OKMWebServicesFactory;
use openkm\OpenKM;

class Test {

    const HOST = "http://localhost:8080/openkm/";
    const USER = "okmAdmin";
    const PASSWORD = "admin";

    private $ws;

    public function __construct() {
        $this->ws = OKMWebServicesFactory::build(self::HOST);
    }

    public function test() {
        echo '<pre>';
        try {
            $this->ws->login(self::USER, self::PASSWORD);
            // Exists folder /okm:root/sdk/test
            $this->ws->folder->moveFolder("0b89e4ca-0019-4837-82a4-05bc05d83353", "55102c84-e4f5-4cbc-a3d1-cf1896367752");
            // Folder has moved to /okm:root/move/test
            echo 'move Folder';
        } catch (Exception $e) {
            var_dump($e);
        }
    }

}

$openkm = new OpenKM(); //autoload
$test = new Test();
$test->test();
?>

getFolderChildren

Description:

Method	Return values	Description
getFolderChildren($uuid)	array	Returns an array of all folders whose parent is fldId.
Parameters: $uuid string type is the uuid of the Folder or Record node

Example:

<?php

include '../src/openkm/OpenKM.php';

use openkm\OKMWebServicesFactory;
use openkm\OpenKM;

class Test {

    const HOST = "http://localhost:8080/openkm/";
    const USER = "okmAdmin";
    const PASSWORD = "admin";

    private $ws;

    public function __construct() {
        $this->ws = OKMWebServicesFactory::build(self::HOST);
    }

    public function test() {
        echo '<pre>';
        try {
            $this->ws->login(self::USER, self::PASSWORD);
            $folders = $this->ws->folder->getFolderChildren('f93ac8df-e83b-487f-9a14-0af9e910a818');
            foreach ($folders as $folder) {
                var_dump($folder);
            }
        } catch (Exception $e) {
            var_dump($e);
        }
    }

}

$openkm = new OpenKM(); //autoload
$test = new Test();
$test->test();
?>

copyFolder

Description:

Method	Return values	Description
copyFolder($uuid, $dstId, $newName)	void	Copy a folder into another folder or record.
Parameters: $uuid string type is the uuid of the Folder $dstId string type is the uuid of the Folder or Record $newName string type is the new name for the Folder. Value is null, folder will preserve the same name. Only the security grants are copied to the destination; the metadata, keywords, etc. of the folder are not copied. See "extendedFolderCopy" method for this feature.

Method

Return values

Description

copyFolder($uuid, $dstId, $newName)

void

Copy a folder into another folder or record.

Parameters:
$uuid string type is the uuid of the Folder

$dstId string type is the uuid of the Folder or Record

$newName string type is the new name for the Folder. Value is null, folder will preserve the same name.

Only the security grants are copied to the destination; the metadata, keywords, etc. of the folder are not copied.

See "extendedFolderCopy" method for this feature.

Example:

<?php

include '../src/openkm/OpenKM.php';

use openkm\OKMWebServicesFactory;
use openkm\OpenKM;

class Test {

    const HOST = "http://localhost:8080/openkm/";
    const USER = "okmAdmin";
    const PASSWORD = "admin";

    private $ws;

    public function __construct() {
        $this->ws = OKMWebServicesFactory::build(self::HOST);
    }

    public function test() {
        echo '<pre>';
        try {
            $this->ws->login(self::USER, self::PASSWORD);
            $this->ws->folder->copyFolder('4a3b1c1b-c880-45a3-a6ff-2c8b7c5adfa5', '55102c84-e4f5-4cbc-a3d1-cf1896367752', "new_name");
        } catch (Exception $e) {
            var_dump($e);
        }
    }

}

$openkm = new OpenKM(); //autoload
$test = new Test();
$test->test();
?>

extendedFolderCopy

Description:

Method	Return values	Description
extendedFolderCopy($uuid, $dstId, $categories, $keywords, $propertyGroups, $notes, $security)	void	Copies a folder with associated data into another folder or record.
Parameters: $uuid string type is the uuid of the Folder $dstId string type is the uuid of the Folder or Record $categories boolean type $keywords boolean type $propertyGroups boolean type $notes boolean type $security boolean type By default, only the binary data and the security grants, the metadata, keywords, etc., of the folder are not copied. Additionally: When category parameter is true the original values of the categories will be copied. When keywords parameter is true the original values of the keywords will be copied. When propertyGroups parameter is true the original values of the metadata groups will be copied. When notes parameter is true the original values of the notes will be copied. When security parameter is true the original values of the security will be copied.

Method

Return values

Description

extendedFolderCopy($uuid, $dstId, $categories, $keywords, $propertyGroups, $notes, $security)

void

Copies a folder with associated data into another folder or record.

Parameters:
$uuid string type is the uuid of the Folder

$dstId string type is the uuid of the Folder or Record

$categories boolean type

$keywords boolean type

$propertyGroups boolean type

$notes boolean type

$security boolean type

By default, only the binary data and the security grants, the metadata, keywords, etc., of the folder are not copied.

Additionally:

When category parameter is true the original values of the categories will be copied.
When keywords parameter is true the original values of the keywords will be copied.
When propertyGroups parameter is true the original values of the metadata groups will be copied.
When notes parameter is true the original values of the notes will be copied.
When security parameter is true the original values of the security will be copied.

Example:

<?php

include '../src/openkm/OpenKM.php';

use openkm\OKMWebServicesFactory;
use openkm\OpenKM;

class Test {

    const HOST = "http://localhost:8080/openkm/";
    const USER = "okmAdmin";
    const PASSWORD = "admin";

    private $ws;

    public function __construct() {
        $this->ws = OKMWebServicesFactory::build(self::HOST);
    }

    public function test() {
        echo '<pre>';
        try {
            $this->ws->login(self::USER, self::PASSWORD);
            $folder = $this->ws->folder->extendedFolderCopy('4a3b1c1b-c880-45a3-a6ff-2c8b7c5adfa5', '55102c84-e4f5-4cbc-a3d1-cf1896367752', 'new name extend copy', true, true, true, true, true);
            var_dump($folder);
        } catch (Exception $e) {
            var_dump($e);
        }
    }

}

$openkm = new OpenKM(); //autoload
$test = new Test();
$test->test();
?>

getContentInfo

Description:

Method	Return values	Description
getContentInfo($uuid)	ContentInfo	Returns a ContentInfo object with information about the folder.
Parameters: $uuid string type is the uuid or path of the Folder. The ContentInfo object retrieves information about: The number of folders in it. The number of documents in it. The number of records in it. The number of emails in it. The size in bytes of all objects in the folder.

Method

Return values

Description

getContentInfo($uuid)

ContentInfo

Returns a ContentInfo object with information about the folder.

Parameters:
$uuid string type is the uuid or path of the Folder.

The ContentInfo object retrieves information about:

The number of folders in it.
The number of documents in it.
The number of records in it.
The number of emails in it.
The size in bytes of all objects in the folder.

Example:

<?php

include '../src/openkm/OpenKM.php';

use openkm\OKMWebServicesFactory;
use openkm\OpenKM;

class Test {

    const HOST = "http://localhost:8080/openkm/";
    const USER = "okmAdmin";
    const PASSWORD = "admin";

    private $ws;

    public function __construct() {
        $this->ws = OKMWebServicesFactory::build(self::HOST);
    }

    public function test() {
        echo '<pre>';
        try {
            $this->ws->login(self::USER, self::PASSWORD);
            var_dump($this->ws->folder->getContentInfo('4a3b1c1b-c880-45a3-a6ff-2c8b7c5adfa5'));
        } catch (Exception $e) {
            var_dump($e);
        }
    }

}

$openkm = new OpenKM(); //autoload
$test = new Test();
$test->test();
?>

purgeFolder

Description:

Method	Return values	Description
purgeFolder($uuid)	void	The folder is permanently removed from the repository.
Parameters: $uuid string type is the uuid or path of the Folder. Usually, you will purge folders to /okm:trash/userId - the personal trash user location - but it is possible to directly purge any folder from the whole repository. When a folder is purged, it will only be able to be restored from a previously created repository backup. The purge action permanently removes the folder from the repository.

Method

Return values

Description

purgeFolder($uuid)

void

The folder is permanently removed from the repository.

Parameters:
$uuid string type is the uuid or path of the Folder.

Usually, you will purge folders to /okm:trash/userId - the personal trash user location - but it is possible to directly purge any folder from the whole repository.

When a folder is purged, it will only be able to be restored from a previously created repository backup. The purge action permanently removes the folder from the repository.

Example:

<?php

include '../src/openkm/OpenKM.php';

use openkm\OKMWebServicesFactory;
use openkm\OpenKM;

class Test {

    const HOST = "http://localhost:8080/openkm/";
    const USER = "okmAdmin";
    const PASSWORD = "admin";

    private $ws;

    public function __construct() {
        $this->ws = OKMWebServicesFactory::build(self::HOST);
    }

    public function test() {
        echo '<pre>';
        try {
            $this->ws->login(self::USER, self::PASSWORD);
            $this->ws->folder->purgeFolder('d1faccb3-9e64-4d2d-865f-1c057e3a279b');
            echo 'purge folder';
        } catch (Exception $e) {
            var_dump($e);
        }
    }

}

$openkm = new OpenKM(); //autoload
$test = new Test();
$test->test();
?>

createMissingFolders

Description:

Method	Return values	Description
createMissingFolders($fldPath)	void	Creates missing folders.
Parameters: $fldPath string type is the path of the Folder.

Example:

<?php

include '../src/openkm/OpenKM.php';

use openkm\OKMWebServicesFactory;
use openkm\OpenKM;

class Test {

    const HOST = "http://localhost:8080/openkm/";
    const USER = "okmAdmin";
    const PASSWORD = "admin";

    private $ws;

    public function __construct() {
        $this->ws = OKMWebServicesFactory::build(self::HOST);
    }

    public function test() {
        echo '<pre>';
        try {
            $this->ws->login(self::USER, self::PASSWORD);
            $this->ws->folder->createMissingFolders("/okm:root/sdk/missingfld2/missingfld3");
            var_dump('create missing folders');
        } catch (Exception $e) {
            var_dump($e);
        }
    }

}

$openkm = new OpenKM(); //autoload
$test = new Test();
$test->test();
?>

createFolderFromTemplate

Description:

Method	Return values	Description
createFolderFromTemplate($uuid, $dstPath, $language, $categories, $keywords, $propertyGroups, $notes, $properties)	Folder	Creates a new folder from a template and returns a Folder object.
The $uuid parameter is the UUID value of the template file. The $dstPath value is the folder destination path. The $language parameter is optional. When the template uses metadata groups to fill in fields, then these values are mandatory and must be set in the properties parameter. Additionally: When the categories parameter is true, the original values of the categories will be copied. When the keywords parameter is true, the original values of the keywords will be copied. When the propertyGroups parameter is true, the original values of the metadata groups will be copied. When the notes parameter is true, the original values of the notes will be copied.

Method

Return values

Description

createFolderFromTemplate($uuid, $dstPath, $language, $categories,
$keywords, $propertyGroups, $notes, $properties)

Folder

Creates a new folder from a template and returns a Folder object.

The $uuid parameter is the UUID value of the template file.

The $dstPath value is the folder destination path.

The $language parameter is optional.

When the template uses metadata groups to fill in fields, then these values are mandatory and must be set in the properties parameter.

Additionally:

When the categories parameter is true, the original values of the categories will be copied.
When the keywords parameter is true, the original values of the keywords will be copied.
When the propertyGroups parameter is true, the original values of the metadata groups will be copied.
When the notes parameter is true, the original values of the notes will be copied.

Example:

<?php

include '../src/openkm/OpenKM.php';

use openkm\OKMWebServicesFactory;
use openkm\OpenKM;

class Test {

    // const HOST = "http://localhost:8080/openkm/";
    const HOST = "http://192.168.1.11:8888/openkm/";
    const USER = "okmAdmin";
    const PASSWORD = "admin";

    private $ws;

    public function __construct() {
        $this->ws = OKMWebServicesFactory::build(self::HOST);
    }

    public function test() {
        echo '<pre>';
        try {
            $this->ws->login(self::USER, self::PASSWORD);

            $properties = [];
            $properties["okp:consulting.name"] = "update value";
            $properties["okp:consulting.important"] = "false";

            $folder = $this->ws->folder->createFolderFromTemplate('47c70047-2924-483c-bc42-23d0cbef6b17', '/okm:root/sdk/foldertemplate', 'es', true, true, true, true, $properties);
            var_dump($folder);
        } catch (Exception $e) {
            var_dump($e);
        }
    }

}

$openkm = new OpenKM(); //autoload
$test = new Test();
$test->test();
?>

PropertyGroup samples

addPropertyGroup

Description:

Method	Return values	Description
addPropertyGroup($uuid, $grpName, $properties)	void	Adds an empty metadata group to a node.
Parameters: $uuid string type is the uuid of the document, folder, mail, or record. $grpName string type; grpName should be a valid metadata group name.

Method

Return values

Description

addPropertyGroup($uuid, $grpName, $properties)

void

Adds an empty metadata group to a node.

Parameters:

$uuid string type is the uuid of the document, folder, mail, or record.

$grpName string type; grpName should be a valid metadata group name.

Example:

<?php

include '../src/openkm/OpenKM.php';

use openkm\OKMWebServicesFactory;
use openkm\OpenKM;

class Test {

    const HOST = "http://localhost:8080/openkm/";
    const USER = "okmAdmin";
    const PASSWORD = "admin";

    private $ws;

    public function __construct() {
        $this->ws = OKMWebServicesFactory::build(self::HOST);
    }

    public function test() {
        echo '<pre>';
        try {
            $this->ws->login(self::USER, self::PASSWORD);
            $properties = [];
            $properties["okp:consulting.name"] = "new value";
            $properties["okp:consulting.important"] = "true";
            $this->ws->propertyGroup->addPropertyGroup('7e12a9ff-95b2-4945-bf5f-1bb709d89c14', 'okg:consulting', $properties);
            echo 'Add Group';
        } catch (Exception $e) {
            var_dump($e);
        }
    }

}

$openkm = new OpenKM(); //autoload
$test = new Test();
$test->test();
?>

removePropertyGroup

Description:

Method	Return values	Description
removePropertyGroup($uuid, $grpName)	void	Removes a metadata group from a node.
Parameters: $uuid string type is the uuid of the document, folder, mail or record. $grpName string type; grpName should be a valid metadata group name.

Method

Return values

Description

removePropertyGroup($uuid, $grpName)

void

Removes a metadata group from a node.

Parameters:

$uuid string type is the uuid of the document, folder, mail or record.

$grpName string type; grpName should be a valid metadata group name.

Example:

<?php

include '../src/openkm/OpenKM.php';

use openkm\OKMWebServicesFactory;
use openkm\OpenKM;

class Test {

    const HOST = "http://localhost:8080/openkm/";
    const USER = "okmAdmin";
    const PASSWORD = "admin";

    private $ws;

    public function __construct() {
        $this->ws = OKMWebServicesFactory::build(self::HOST);
    }

    public function test() {
        echo '<pre>';
        try {
            $this->ws->login(self::USER, self::PASSWORD);
            $this->ws->propertyGroup->removePropertyGroup('7e12a9ff-95b2-4945-bf5f-1bb709d89c14', 'okg:consulting');
            echo 'Remove Group';
        } catch (Exception $e) {
            var_dump($e);
        }
    }

}

$openkm = new OpenKM(); //autoload
$test = new Test();
$test->test();
?>

getPropertyGroups

Description:

Method	Return values	Description
getPropertyGroups($uuid)	array	Retrieves a list of metadata groups assigned to a node.
Parameters: $uuid string type is the uuid of the document, folder, mail, or record.

Method

Return values

Description

getPropertyGroups($uuid)

array

Retrieves a list of metadata groups assigned to a node.

Parameters:

$uuid string type is the uuid of the document, folder, mail, or record.

Example:

<?php

include '../src/openkm/OpenKM.php';

use openkm\OKMWebServicesFactory;
use openkm\OpenKM;

class Test {

    const HOST = "http://localhost:8080/openkm/";
    const USER = "okmAdmin";
    const PASSWORD = "admin";

    private $ws;

    public function __construct() {
        $this->ws = OKMWebServicesFactory::build(self::HOST);
    }

    public function test() {
        echo '<pre>';
        try {
            $this->ws->login(self::USER, self::PASSWORD);
            $propertyGroups = $this->ws->propertyGroup->getPropertyGroups('7e12a9ff-95b2-4945-bf5f-1bb709d89c14');
            foreach ($propertyGroups as $propertyGroup) {
                var_dump($propertyGroup);
                echo '<br>';
            }
        } catch (Exception $e) {
            var_dump($e);
        }
    }

}

$openkm = new OpenKM(); //autoload
$test = new Test();
$test->test();
?>

getAllPropertyGroups

Description:

Method	Return values	Description
getAllPropertyGroups()	array	Retrieves a list of all metadata groups set in the application.

Example:

<?php

include '../src/openkm/OpenKM.php';

use openkm\OKMWebServicesFactory;
use openkm\OpenKM;

class Test {

    const HOST = "http://localhost:8080/openkm/";
    const USER = "okmAdmin";
    const PASSWORD = "admin";

    private $ws;

    public function __construct() {
        $this->ws = OKMWebServicesFactory::build(self::HOST);
    }

    public function test() {
        echo '<pre>';
        try {
            $this->ws->login(self::USER, self::PASSWORD);
            $propertyGroups = $this->ws->propertyGroup->getAllPropertyGroups();
            foreach ($propertyGroups as $propertyGroup) {
                var_dump($propertyGroup);
                echo '<br>';
            }
        } catch (Exception $e) {
            var_dump($e);
        }
    }

}

$openkm = new OpenKM(); //autoload
$test = new Test();
$test->test();
?>

getPropertyGroupForm

Description:

Method	Return values	Description
getPropertyGroupForm($grpName)	array	Retrieves a list of all metadata group element definitions.
Parameters: $grpName string type. The grpName should be a valid metadata group name. The method is usually used to display empty form elements for creating new metadata values.

Method

Return values

Description

getPropertyGroupForm($grpName)

array

Retrieves a list of all metadata group element definitions.

Parameters:

$grpName string type. The grpName should be a valid metadata group name.

The method is usually used to display empty form elements for creating new metadata values.

Example:

<?php

include '../src/openkm/OpenKM.php';

use openkm\OKMWebServicesFactory;
use openkm\OpenKM;

class ExamplePropertyGroup {

    const HOST = "http://localhost:8080/OpenKM/";
    const USER = "okmAdmin";
    const PASSWORD = "admin";

    private $ws;

    public function __construct() {
        $this->ws = OKMWebServicesFactory::build(self::HOST, self::USER, self::PASSWORD);
    }

    public function testGetPropertyGroupForm() {
        try {
            $formElements = $this->ws->getPropertyGroupForm('okg:consulting');
            foreach ($formElements as $formElement) {
               var_dump($formElement);
            }
        } catch (Exception $e) {
            var_dump($e);
        }
    }
}

$openkm = new OpenKM(); //autoload
$examplePropertyGroup = new ExamplePropertyGroup();
$examplePropertyGroup->testGetPropertyGroupPropertiesSimple();
?>

getPropertyGroupFormByNode

Description:

Method	Return values	Description
getPropertyGroupFormByNode($uuid, $grpName)	array	Retrieves a list of all metadata group elements defined for a node.
Parameters: $uuid string type is the uuid of the document, folder, mail, or record. $grpName string type. The grpName should be a valid metadata group name. The method is usually used to display empty form elements for creating new metadata values.

Method

Return values

Description

getPropertyGroupFormByNode($uuid, $grpName)

array

Retrieves a list of all metadata group elements defined for a node.

Parameters:

$uuid string type is the uuid of the document, folder, mail, or record.

$grpName string type. The grpName should be a valid metadata group name.

The method is usually used to display empty form elements for creating new metadata values.

Example:

<?php

include '../src/openkm/OpenKM.php';

use openkm\OKMWebServicesFactory;
use openkm\OpenKM;

class Test {

    const HOST = "http://localhost:8080/openkm/";
    const USER = "okmAdmin";
    const PASSWORD = "admin";

    private $ws;

    public function __construct() {
        $this->ws = OKMWebServicesFactory::build(self::HOST);
    }

    public function test() {
        echo '<pre>';
        try {
            $this->ws->login(self::USER, self::PASSWORD);
            $formElements = $this->ws->propertyGroup->getPropertyGroupFormByNode('7e12a9ff-95b2-4945-bf5f-1bb709d89c14', 'okg:consulting');
            foreach ($formElements as $formElement) {
                var_dump($formElement);
            }
        } catch (Exception $e) {
            var_dump($e);
        }
    }

}

$openkm = new OpenKM(); //autoload
$test = new Test();
$test->test();
?>

setPropertyGroupProperties

Description:

Method Return values Description

Method	Return values	Description
setPropertyGroupProperties($uuid, $grpName, $properties)	void	Changes the metadata group values of a node.
Parameters: $uuid string type is the uuid or path of the document, folder, mail, or record. $grpName string type. The grpName should be a valid metadata group name. $properties array type. An array of properties. Before changing metadata, you should have the group added to the node (see addGroup method); otherwise an error will be raised. It is not mandatory to set all field values in the properties parameter; it is enough to specify the fields whose values you wish to change. The sample below is based on this Metadata group definition: <?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE property-groups PUBLIC "-//OpenKM//DTD Property Groups 2.0//EN" "http://www.openkm.com/dtd/property-groups-2.0.dtd"> <property-groups> <property-group label="Consulting" name="okg:consulting"> <input label="Name" type="text" name="okp:consulting.name"/> <input label="Date" type="date" name="okp:consulting.date" /> <checkbox label="Important" name="okp:consulting.important"/> <textarea label="Comment" name="okp:consulting.comment"/> </property-group> </property-groups>

setPropertyGroupProperties($uuid, $grpName, $properties)

void

Changes the metadata group values of a node.

Parameters:

$uuid string type is the uuid or path of the document, folder, mail, or record.

$grpName string type. The grpName should be a valid metadata group name.

$properties array type. An array of properties.

Before changing metadata, you should have the group added to the node (see addGroup method); otherwise an error will be raised.

It is not mandatory to set all field values in the properties parameter; it is enough to specify the fields whose values you wish to change.

The sample below is based on this Metadata group definition:

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE property-groups PUBLIC "-//OpenKM//DTD Property Groups 2.0//EN"
                                 "http://www.openkm.com/dtd/property-groups-2.0.dtd">
<property-groups>
  <property-group label="Consulting" name="okg:consulting">
    <input label="Name" type="text" name="okp:consulting.name"/>
    <input label="Date" type="date" name="okp:consulting.date" />
    <checkbox label="Important" name="okp:consulting.important"/>
    <textarea label="Comment" name="okp:consulting.comment"/>
  </property-group>
</property-groups>

Example:

<?php

include '../src/openkm/OpenKM.php';

use openkm\OKMWebServicesFactory;
use openkm\OpenKM;

class Test {

    const HOST = "http://localhost:8080/openkm/";
    const USER = "okmAdmin";
    const PASSWORD = "admin";

    private $ws;

    public function __construct() {
        $this->ws = OKMWebServicesFactory::build(self::HOST);
    }

    public function test() {
        echo '<pre>';
        try {
            $properties = [];
            $properties["okp:consulting.name"] = "update value";
            $properties["okp:consulting.important"] = "false";

            $this->ws->login(self::USER, self::PASSWORD);
            $this->ws->propertyGroup->setPropertyGroupProperties('7e12a9ff-95b2-4945-bf5f-1bb709d89c14', 'okg:consulting', $properties);
            echo 'updated';
        } catch (Exception $e) {
            var_dump($e);
        }
    }

}

$openkm = new OpenKM(); //autoload
$test = new Test();
$test->test();
?>

hasPropertyGroup

Description:

Method	Return values	Description
hasPropertyGroup($uuid, $grpName)	bool	Returns a boolean that indicates if the node has a metadata group.
Parameters: $uuid string type is the uuid of the document, folder, mail, or record. $grpName string type is the grpName should be a valid Metadata group name.

Method

Return values

Description

hasPropertyGroup($uuid, $grpName)

bool

Returns a boolean that indicates if the node has a metadata group.

Parameters:

$uuid string type is the uuid of the document, folder, mail, or record.

$grpName string type is the grpName should be a valid Metadata group name.

Example:

<?php

include '../src/openkm/OpenKM.php';

use openkm\OKMWebServicesFactory;
use openkm\OpenKM;

class Test {

    const HOST = "http://localhost:8080/openkm/";
    const USER = "okmAdmin";
    const PASSWORD = "admin";

    private $ws;

    public function __construct() {
        $this->ws = OKMWebServicesFactory::build(self::HOST);
    }

    public function test() {
        try {
            $this->ws->login(self::USER, self::PASSWORD);
            echo 'Have metadata group: ' . $this->ws->propertyGroup->hasPropertyGroup('7e12a9ff-95b2-4945-bf5f-1bb709d89c14', 'okg:consulting');
        } catch (Exception $e) {
            var_dump($e);
        }
    }

}

$openkm = new OpenKM(); //autoload
$test = new Test();
$test->test();
?>

getRegisteredPropertyGroupDefinition

Description:

Method	Return values	Description
getRegisteredPropertyGroupDefinition()	string	Returns the XML metadata groups definition.
The method can only be executed by superusers with ROLE_ADMIN membership.

Example:

<?php

include '../src/openkm/OpenKM.php';

use openkm\OKMWebServicesFactory;
use openkm\OpenKM;

class Test {

    const HOST = "http://localhost:8080/openkm/";
    const USER = "okmAdmin";
    const PASSWORD = "admin";

    private $ws;

    public function __construct() {
        $this->ws = OKMWebServicesFactory::build(self::HOST);
    }

    public function test() {
        echo '<pre>';
        try {
            $this->ws->login(self::USER, self::PASSWORD);
            var_dump($this->ws->propertyGroup->getRegisteredPropertyGroupDefinition());
        } catch (Exception $e) {
            var_dump($e);
        }
    }

}

$openkm = new OpenKM(); //autoload
$test = new Test();
$test->test();
?>

getPropertyGroupSuggestions

Description:

Method Return values Description

Method	Return values	Description
getPropertyGroupSuggestions($uuid, $grpName, $propName)	array	Retrieves a list of suggested metadata field values.
Parameters: $uuid string type is the uuid of the document, folder, mail, or record. $grpName string type is the grpName should be a valid Metadata group name. $propName string type. The propName parameter should be a Metadata Select field type. The propName parameter should be a Metadata Select field type. More information at Creating your own Suggestion Analyzer and Metadata Select field. The sample below is based on this Metadata group definition: <?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE property-groups PUBLIC "-//OpenKM//DTD Property Groups 2.0//EN" "http://www.openkm.com/dtd/property-groups-2.0.dtd"> <property-groups> <property-group label="Technology" name="okg:technology"> <select label="Type" name="okp:technology.type" type="multiple"> <option label="Alfa" value="t1"/> <option label="Beta" value="t2" /> <option label="Omega" value="t3" /> </select> <select label="Language" name="okp:technology.language" type="simple"> <option label="Java" value="java"/> <option label="Python" value="python"/> <option label="PHP" value="php" /> </select> <input label="Comment" name="okp:technology.comment"/> <textarea label="Description" name="okp:technology.description"/> <input label="Link" type="link" name="okp:technology.link"/> </property-group> </property-groups>

getPropertyGroupSuggestions($uuid, $grpName, $propName)

array

Retrieves a list of suggested metadata field values.

Parameters:

$uuid string type is the uuid of the document, folder, mail, or record.

$grpName string type is the grpName should be a valid Metadata group name.

$propName string type. The propName parameter should be a Metadata Select field type.

The propName parameter should be a Metadata Select field type.

More information at Creating your own Suggestion Analyzer and Metadata Select field.

The sample below is based on this Metadata group definition:

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE property-groups PUBLIC "-//OpenKM//DTD Property Groups 2.0//EN"
                                 "http://www.openkm.com/dtd/property-groups-2.0.dtd">
<property-groups>
  <property-group label="Technology" name="okg:technology">
    <select label="Type" name="okp:technology.type" type="multiple">
      <option label="Alfa" value="t1"/>
      <option label="Beta" value="t2" />
      <option label="Omega" value="t3" />
    </select>
    <select label="Language" name="okp:technology.language" type="simple">
      <option label="Java" value="java"/>
      <option label="Python" value="python"/>
      <option label="PHP" value="php" />
    </select>
    <input label="Comment" name="okp:technology.comment"/>
    <textarea label="Description" name="okp:technology.description"/>
    <input label="Link" type="link" name="okp:technology.link"/>
  </property-group>
</property-groups>

Example:

<?php

include '../src/openkm/OpenKM.php';

use openkm\OKMWebServicesFactory;
use openkm\OpenKM;

class Test {

    const HOST = "http://localhost:8080/openkm/";
    const USER = "okmAdmin";
    const PASSWORD = "admin";

    private $ws;

    public function __construct() {
        $this->ws = OKMWebServicesFactory::build(self::HOST);
    }

    public function test() {
        echo '<pre>';
        try {
            $this->ws->login(self::USER, self::PASSWORD);
            $suggestions = $this->ws->propertyGroup->getPropertyGroupSuggestions('055b5206-35d0-4351-ba92-c304bbba7ddf', 'okg:technology', 'okp:technology.priority');
            foreach ($suggestions as $suggestion) {
                var_dump($suggestion);
            }
        } catch (Exception $e) {
            var_dump($e);
        }
    }

}

$openkm = new OpenKM(); //autoload
$test = new Test();
$test->test();
?>

registerPropertyGroupDefinition

Description:

Method	Return values	Description
registerPropertyGroupDefinition($content, $name)	void	Sets the XML Metadata groups definition into the repository.
Parameters: $content string type. It is recommended to use file_get_contents ? reads the entire file into a string. $name string type. The name of the property group. The method can only be executed by superusers with ROLE_ADMIN membership.

Method

Return values

Description

registerPropertyGroupDefinition($content, $name)

void

Sets the XML Metadata groups definition into the repository.

Parameters:

$content string type. It is recommended to use file_get_contents ? reads the entire file into a string.

$name string type. The name of the property group.

The method can only be executed by superusers with ROLE_ADMIN membership.

Example:

<?php

include '../src/openkm/OpenKM.php';

use openkm\OKMWebServicesFactory;
use openkm\OpenKM;

class Test {

    const HOST = "http://localhost:8080/openkm/";
    const USER = "okmAdmin";
    const PASSWORD = "admin";

    private $ws;

    public function __construct() {
        $this->ws = OKMWebServicesFactory::build(self::HOST);
    }

    public function test() {
        echo '<pre>';
        try {
            $this->ws->login(self::USER, self::PASSWORD);
            $fileName = dirname(__FILE__) . '/propertygroup/propertyGroups.xml';
            $this->ws->propertyGroup->registerPropertyGroupDefinition(file_get_contents($fileName), 'sdk4php');
            var_dump('Register Definition correct');
        } catch (Exception $e) {
            var_dump($e);
        }
    }

}

$openkm = new OpenKM(); //autoload
$test = new Test();
$test->test();
?>

getPropertyGroupProperties

Description:

Method	Return values	Description
getPropertyGroupProperties($uuid, $grpName)	array	Retrieves a list of all metadata group elements and their values for a node.
Parameters: $uuid string type is the uuid of the document, folder, mail, or record. $grpName string type. The grpName should be a valid metadata group name. The method is usually used to display form elements with their values to be shown or changed by the user.

Method

Return values

Description

getPropertyGroupProperties($uuid, $grpName)

array

Retrieves a list of all metadata group elements and their values for a node.

Parameters:

$uuid string type is the uuid of the document, folder, mail, or record.

$grpName string type. The grpName should be a valid metadata group name.

The method is usually used to display form elements with their values to be shown or changed by the user.

Example:

<?php

include '../src/openkm/OpenKM.php';

use openkm\OKMWebServicesFactory;
use openkm\OpenKM;

class Test {

    const HOST = "http://localhost:8080/openkm/";
    const USER = "okmAdmin";
    const PASSWORD = "admin";

    private $ws;

    public function __construct() {
        $this->ws = OKMWebServicesFactory::build(self::HOST);
    }

    public function test() {
        echo '<pre>';
        try {
            $this->ws->login(self::USER, self::PASSWORD);
            $properties = $this->ws->propertyGroup->getPropertyGroupProperties('7e12a9ff-95b2-4945-bf5f-1bb709d89c14', 'okg:consulting');
            foreach ($properties as $key => $value) {
                echo 'key: ' . $key . ' value: ' . $value;
                echo '<br>';
            }
        } catch (Exception $e) {
            var_dump($e);
        }
    }

}

$openkm = new OpenKM(); //autoload
$test = new Test();
$test->test();
?>

getPropertyGroupPropertiesByVersion

Description:

Method	Return values	Description
getPropertyGroupPropertiesByVersion($uuid, $grpName, $versionName)	array	Retrieves a list of all metadata group elements and their values for a node.
Parameters: $uuid string type is the uuid of the document, folder, mail, or record. $grpName string type. The grpName should be a valid metadata group name. $versionName string type. The version of the document, folder, mail, or record. The method is usually used to display form elements with their values to be shown or changed by the user.

Method

Return values

Description

getPropertyGroupPropertiesByVersion($uuid, $grpName, $versionName)

array

Retrieves a list of all metadata group elements and their values for a node.

Parameters:

$uuid string type is the uuid of the document, folder, mail, or record.

$grpName string type. The grpName should be a valid metadata group name.

$versionName string type. The version of the document, folder, mail, or record.

The method is usually used to display form elements with their values to be shown or changed by the user.

Example:

<?php

include '../src/openkm/OpenKM.php';

use openkm\OKMWebServicesFactory;
use openkm\OpenKM;

class Test {

    const HOST = "http://localhost:8080/openkm/";
    const USER = "okmAdmin";
    const PASSWORD = "admin";

    private $ws;

    public function __construct() {
        $this->ws = OKMWebServicesFactory::build(self::HOST);
    }

    public function test() {
        try {
            $this->ws->login(self::USER, self::PASSWORD);
            $properties = $this->ws->propertyGroup->getPropertyGroupPropertiesByVersion('7e12a9ff-95b2-4945-bf5f-1bb709d89c14', 'okg:consulting', '1.3');
            foreach ($properties as $key => $value) {
                echo 'key: ' . $key . ' value: ' . $value;
                echo '<br>';
            }
        } catch (Exception $e) {
            var_dump($e);
        }
    }

}

$openkm = new OpenKM(); //autoload
$test = new Test();
$test->test();
?>

Search samples

find

Description:

Method	Return values	Description
find(QueryParams $queryParams, $propertiesPlugin)	array	Returns a list of QueryResults filtered by the values of the queryParams parameter.
Parameters: $queryParams QueryParams type $propertiesPlugin string type, must be the canonical class name of the class that implements the NodeProperties interface. Retrieving entire Objects ( Document, Folder, Record, Mail ) from REST can take a lot of time - the marshalling and unmarshalling process - while you are only interested in using a few Object variables. If this is your case, you can use NodeProperties classes to retrieve the Object variables that you really need.

Method

Return values

Description

find(QueryParams $queryParams, $propertiesPlugin)

array

Returns a list of QueryResults filtered by the values of the queryParams parameter.

Parameters:
$queryParams QueryParams type

$propertiesPlugin string type, must be the canonical class name of the class that implements the NodeProperties interface.

Retrieving entire Objects ( Document, Folder, Record, Mail ) from REST can take a lot of time - the marshalling and unmarshalling process - while you are only interested in using a few Object variables. If this is your case, you can use NodeProperties classes to retrieve the Object variables that you really need.

Example:

<?php

include '../src/openkm/OpenKM.php';

use openkm\OKMWebServicesFactory;
use openkm\OpenKM;

class Test {

    const HOST = "http://localhost:8080/openkm/";
    const USER = "okmAdmin";
    const PASSWORD = "admin";

    private $ws;

    public function __construct() {
        $this->ws = OKMWebServicesFactory::build(self::HOST);
    }

    public function test() {
        echo '<pre>';
        try {
            $this->ws->login(self::USER, self::PASSWORD);
            $queryParams = new QueryParams();
            $queryParams->setDomain(QueryParams::DOCUMENT + QueryParams::FOLDER);
            $queryParams->setFolder("f93ac8df-e83b-487f-9a14-0af9e910a818");
            $queryParams->setFolderRecursive(true);
            $queryParams->setLastModifiedFrom(20150628000000);
            $queryParams->setLastModifiedTo(date('Ymdhis'));
            $queryResults = $this->ws->search->find($queryParams, null);
            foreach ($queryResults as $queryResult) {
                var_dump($queryResult);
            }
        } catch (Exception $e) {
            var_dump($e);
        }
    }

}

$openkm = new OpenKM(); //autoload
$test = new Test();
$test->test();
?>

findPaginated

Description:

Method	Return values	Description
findPaginated(QueryParams $queryParams, $offset, $limit, $propertiesPlugin)	ResultSet	Returns a list of paginated results filtered by the values of the queryParams parameter.
Parameters: $queryParams QueryParams type $offset int type $limit int type $propertiesPlugin string type, must be the canonical class name of the class that implements the NodeProperties interface. The parameters "limit" and "offset" allow you to retrieve just a portion of the results of a query. The parameter "limit" is used to limit the number of results returned. The parameter "offset" indicates how many results to skip before starting to return results. For example, if your query has 1000 results, but you only want to return the first 10, you should use these values: limit=10 offset=0 Now, suppose you want to show the results from 11-20, you should use these values: limit=10 offset=10 Retrieving entire Objects ( Document, Folder, Record, Mail ) from REST can take a lot of time - the marshalling and unmarshalling process - while you are only interested in using a few Object variables. If this is your case, you can use NodeProperties classes to retrieve the Object variables that you really need.

Method

Return values

Description

findPaginated(QueryParams $queryParams, $offset, $limit, $propertiesPlugin)

ResultSet

Returns a list of paginated results filtered by the values of the queryParams parameter.

Parameters:
$queryParams QueryParams type

$offset int type

$limit int type

$propertiesPlugin string type, must be the canonical class name of the class that implements the NodeProperties interface.

The parameters "limit" and "offset" allow you to retrieve just a portion of the results of a query.

The parameter "limit" is used to limit the number of results returned.
The parameter "offset" indicates how many results to skip before starting to return results.

For example, if your query has 1000 results, but you only want to return the first 10, you should use these values:

limit=10
offset=0

Now, suppose you want to show the results from 11-20, you should use these values:

limit=10
offset=10

Example:

<?php

include '../src/openkm/OpenKM.php';

use openkm\OKMWebServicesFactory;
use openkm\OpenKM;

class Test {

    const HOST = "http://localhost:8080/openkm/";
    const USER = "okmAdmin";
    const PASSWORD = "admin";

    private $ws;

    public function __construct() {
        $this->ws = OKMWebServicesFactory::build(self::HOST);
    }

    public function test() {
        echo '<pre>';
        try {
            $this->ws->login(self::USER, self::PASSWORD);
            $queryParams = new QueryParams();
            $queryParams->setDomain(QueryParams::DOCUMENT + QueryParams::FOLDER);
            $queryParams->setFolder("f93ac8df-e83b-487f-9a14-0af9e910a818");
            $queryParams->setFolderRecursive(true);
            $queryParams->setLastModifiedFrom(20150628000000);
            $queryParams->setLastModifiedTo(date('Ymdhis'));
            $resultSet = $this->ws->search->findPaginated($queryParams, 0, 10, null);
            echo "Total results:" . $resultSet->getTotal();
            foreach ($resultSet->getResults() as $queryResult) {
                var_dump($queryResult);
            }
        } catch (Exception $e) {
            var_dump($e);
        }
    }

}

$openkm = new OpenKM(); //autoload
$test = new Test();
$test->test();
?>

Table of contents [ Hide Show ]

Download sdk4php
Preview sample
Login
Document samples

createDocument
deleteDocument
getDocumentProperties
getContent
getDocumentChildren
moveDocument
copyDocument
extendedDocumentCopy
checkout
cancelCheckout
forceCancelCheckout
isCheckedOut
checkin
getVersionHistory

Folder sample

createFolder
getFolderProperties
deleteFolder
renameFolder
moveFolder
getFolderChildren
copyFolder
extendedFolderCopy
getContentInfo
purgeFolder
createMissingFolders
createFolderFromTemplate

PropertyGroup samples

addPropertyGroup
removePropertyGroup
getPropertyGroups
getAllPropertyGroups
getPropertyGroupForm
getPropertyGroupFormByNode
setPropertyGroupProperties
hasPropertyGroup
getRegisteredPropertyGroupDefinition
getPropertyGroupSuggestions
registerPropertyGroupDefinition
getPropertyGroupProperties
getPropertyGroupPropertiesByVersion

Search samples

find
findPaginated

OpenKM 7.0 CE

PHP Samples

Download sdk4php

Preview sample

Login

Document samples

createDocument

deleteDocument

getDocumentProperties

getContent

getDocumentChildren

moveDocument

copyDocument

extendedDocumentCopy

checkout

cancelCheckout

forceCancelCheckout

isCheckedOut

checkin

getVersionHistory

Folder sample

createFolder

getFolderProperties

deleteFolder

renameFolder

moveFolder

getFolderChildren

copyFolder

extendedFolderCopy

getContentInfo

purgeFolder

createMissingFolders

createFolderFromTemplate

PropertyGroup samples

addPropertyGroup

removePropertyGroup

getPropertyGroups

getAllPropertyGroups

getPropertyGroupForm

getPropertyGroupFormByNode

setPropertyGroupProperties

hasPropertyGroup

getRegisteredPropertyGroupDefinition

getPropertyGroupSuggestions

registerPropertyGroupDefinition

getPropertyGroupProperties

getPropertyGroupPropertiesByVersion

Search samples

find

findPaginated