Folder samples

Basics

On almost methods you'll see parameter named "fldId". The value of this parameter can be some valid folder UUID or path.

Example of fldId:

Using UUID -> "6e86cc0b-bc9a-4c51-8296-e9d4e749e449";
Using path -> "/okm:root/SDK4PHP/test"

Methods

createFolder

Description:

Method Return values Description

Method	Return values	Description
createFolder(Folder $fld)	Folder	Creates a new folder and returns a result an object Folder.
The variable path into the parameter $fld, must be initializated. It indicates the folder path into OpenKM. `Folder fld = new Folder(); fld.setPath("/okm:root/SDK4PHP/test");` The other variables of a Folder ( fld ) will not take any effect on folder creation. We suggest using the method below to create a FolderSimple rather this one.

createFolder(Folder $fld)

Folder

Creates a new folder and returns a result an object Folder.

The variable path into the parameter $fld, must be initializated. It indicates the folder path into OpenKM.

Folder fld = new Folder();
fld.setPath("/okm:root/SDK4PHP/test");

The other variables of a Folder ( fld ) will not take any effect on folder creation.

We suggest using the method below to create a FolderSimple rather this one.

Example:

<?php

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

use openkm\OKMWebservices;
use openkm\OKMWebServicesFactory;
use openkm\OpenKM;
use openkm\bean\Folder;

class ExampleFolder {

    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 testCreateFolder() {
        try {
            $fld = new Folder();
            $fld->setPath("/okm:root/SDK4PHP/test");
            $folder = $this->ws->createFolder($fld);
            var_dump($folder);
        } catch (Exception $e) {
            var_dump($e);
        }
    }   
}

$openkm = new OpenKM(); //autoload
$exampleFolder = new ExampleFolder();
$exampleFolder->testCreateFolder();
?>

createFolderSimple

Description:

Method	Return values	Description
createFolderSimple($fldPath)	Folder	Creates a new folder and return it as a result of an object Folder.
Parameters: $fldPath string type is the Path of the Folder

Example:

<?php

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

use openkm\OKMWebservices;
use openkm\OKMWebServicesFactory;
use openkm\OpenKM;
use openkm\bean\Folder;

class ExampleFolder {

    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 testCreateFolderSimple() {
        try {
            $folder = $this->ws->createFolderSimple("/okm:root/SDK4PHP/test");
            var_dump($folder);
        } catch (Exception $e) {
            var_dump($e);
        }
    }
}

$openkm = new OpenKM(); //autoload
$exampleFolder = new ExampleFolder();
$exampleFolder->testCreateFolderSimple();

?>

getFolderProperties

Description:

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

Example:

<?php

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

use openkm\OKMWebservices;
use openkm\OKMWebServicesFactory;
use openkm\OpenKM;
use openkm\bean\Folder;

class ExampleFolder {

    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 testGetFolderProperties() {
        try {
            $folder = $this->ws->getFolderProperties("/okm:root/SDK4PHP/test");
            var_dump($folder);
        } catch (Exception $e) {
            var_dump($e);
        }
    }

}

$openkm = new OpenKM(); //autoload
$exampleFolder = new ExampleFolder();
$exampleFolder->testGetFolderProperties();

?>

deleteFolder

Description:

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

Example:

<?php

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

use openkm\OKMWebservices;
use openkm\OKMWebServicesFactory;
use openkm\OpenKM;

class ExampleFolder {

    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 testDeleteFolder() {
        try {
            $this->ws->deleteFolder("/okm:root/SDK4PHP/test"); 
            echo 'delete folder';           
        } catch (Exception $e) {
            var_dump($e);
        }
    }

}

$openkm = new OpenKM(); //autoload
$exampleFolder = new ExampleFolder();
$exampleFolder->testDeleteFolder();

?>

renameFolder

Description:

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

Method

Return values

Description

renameFolder($fldId, $newName)

void

Renames a folder.

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

$newName string type is the new name for the Folder

Example:

<?php

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

use openkm\OKMWebservices;
use openkm\OKMWebServicesFactory;
use openkm\OpenKM;

class ExampleFolder {

    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 testRenameFolder() {
        try {
            // Exists folder /okm:root/SDK4PHP/test
            $this->ws->renameFolder("/okm:root/SDK4PHP/test","renamedFolder");
            // Folder has renamed to /okm:root/SDK4PHP/renamedFolder
            echo 'rename Folder';
        } catch (Exception $e) {
            var_dump($e);
        }
    }

}

$openkm = new OpenKM(); //autoload
$exampleFolder = new ExampleFolder();
$exampleFolder->testRenameFolder();
?>

moveFolder

Description:

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

Method

Return values

Description

moveFolder($fldId, $dstId)

void

Moves a folder into other folder or record.

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

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

Example:

<?php

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

use openkm\OKMWebservices;
use openkm\OKMWebServicesFactory;
use openkm\OpenKM;
use openkm\bean\Folder;

class ExampleFolder {

    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 testMoveFolder(){
        try {
            // Exists folder /okm:root/SDK4PHP/test
            $this->ws->moveFolder("/okm:root/SDK4PHP/test","/okm:root/SDK4PHP/tmp");
            // Folder has moved to /okm:root/SDK4PHP/tmp/test
            echo 'move Folder';
        } catch (Exception $e) {
            var_dump($e);
        }
    }
}

$openkm = new OpenKM(); //autoload
$exampleFolder = new ExampleFolder();
$exampleFolder->testMoveFolder();

?>

getFolderChildren

Description:

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

Example:

<?php

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

use openkm\OKMWebservices;
use openkm\OKMWebServicesFactory;
use openkm\OpenKM;
use openkm\bean\Folder;

class ExampleFolder {

    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 testGetFolderChildren(){
        try {            
            $folders = $this->ws->getFolderChildren("/okm:root/SDK4PHP");            
            foreach ($folders as $folder) {
                var_dump($folder);
            }
        } catch (Exception $e) {
            var_dump($e);
        }
    }
}

$openkm = new OpenKM(); //autoload
$exampleFolder = new ExampleFolder();
$exampleFolder->testGetFolderChildren();

?>

isValidFolder

Description:

Method	Return values	Description
isValidFolder($fldId)	Boolean	Returns a boolean that indicates if the node is a folder or not.
Parameters: $fldId string type is the uuid or path of the Folder

Example:

<?php

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

use openkm\OKMWebservices;
use openkm\OKMWebServicesFactory;
use openkm\OpenKM;

class ExampleFolder {

    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 testIsValidFolder(){
        try {            
            // Return false
            var_dump($this->ws->isValidFolder("/okm:root/SDK4PHP/logo.png"));
            // Return true
            var_dump($this->ws->isValidFolder("/okm:root/SDK4PHP"));
        } catch (Exception $e) {
            var_dump($e);
        }
    }
}

$openkm = new OpenKM(); //autoload
$exampleFolder = new ExampleFolder();
$exampleFolder->testIsValidFolder();

?>

getFolderPath

Description:

Method	Return values	Description
getFolderPath($uuid)	String	Convert folder UUID to folder path.
Parameters: $uuid string type is the uuid of the Folder

Example:

<?php

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

use openkm\OKMWebservices;
use openkm\OKMWebServicesFactory;
use openkm\OpenKM;
use openkm\bean\Folder;

class ExampleFolder {

    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 testGetFolderPath(){
        try {                        
            var_dump($this->ws->getFolderPath("6e86cc0b-bc9a-4c51-8296-e9d4e749e449"));                        
        } catch (Exception $e) {
            var_dump($e);
        }
    }
}

$openkm = new OpenKM(); //autoload
$exampleFolder = new ExampleFolder();
$exampleFolder->testGetFolderPath();

?>

copyFolder

Description:

Method	Return values	Description
copyFolder($fldId, $dstId, $newName)	void	Copies a folder into other folder or record.
Parameters: $fldId string type is the uuid or path of the Folder $dstId string type is the uuid or path of the Folder or Record $newName string type is the new name for the Folder. Value is null, folder will preservates 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($fldId, $dstId, $newName)

void

Copies a folder into other folder or record.

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

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

$newName string type is the new name for the Folder. Value is null, folder will preservates 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\OKMWebservices;
use openkm\OKMWebServicesFactory;
use openkm\OpenKM;
use openkm\bean\Folder;

class ExampleFolder {

    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 testCopyFolder(){
        try {                        
            $this->ws->copyFolder("/okm:root/SDK4PHP/test","/okm:root/SDK4PHP/tmp","new_name");                        
        } catch (Exception $e) {
            var_dump($e);
        }
    }
}

$openkm = new OpenKM(); //autoload
$exampleFolder = new ExampleFolder();
$exampleFolder->testCopyFolder();

?>

extendedFolderCopy

Description:

Method	Return values	Description
extendedFolderCopy($fldId, $dstId, $categories, $keywords, $propertyGroups, $notes, $wiki)	void	Copies a folder with associated data into other folder or record.
Parameters: $fldId string type is the uuid or path of the Folder $dstId string type is the uuid or path of the Folder or Record $categories boolean type $keywords boolean type $propertyGroups boolean type $notes boolean type $wiki 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 wiki parameter is true the original values of the wiki will be copied.

Method

Return values

Description

extendedFolderCopy($fldId, $dstId, $categories, $keywords, $propertyGroups, $notes, $wiki)

void

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

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

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

$categories boolean type

$keywords boolean type

$propertyGroups boolean type

$notes boolean type

$wiki 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 wiki parameter is true the original values of the wiki will be copied.

Example:

<?php

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

use openkm\OKMWebservices;
use openkm\OKMWebServicesFactory;
use openkm\OpenKM;
use openkm\bean\Folder;

class ExampleFolder {

    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 testExtentedFolderCopy() {
        try {
            $this->ws->extendedFolderCopy("/okm:root/SDK4PHP/test", "/okm:root/SDK4PHP/tmp", true, true, true, true, true);
        } catch (Exception $e) {
            var_dump($e);
        }
    }

}

$openkm = new OpenKM(); //autoload
$exampleFolder = new ExampleFolder();
$exampleFolder->testExtentedFolderCopy();
?>

getContentInfo

Description:

Method	Return values	Description
getContentInfo($fldId)	ContentInfo	Return and object ContentInfo with information about folder.
Parameters: $fldId string type is the uuid or path of the Folder. The ContentInfo object retrives information about: The number of folders into. The number of documents into. The number of records into. The number of mails into. The size in bytes of all objects into the folder.

Method

Return values

Description

getContentInfo($fldId)

ContentInfo

Return and object ContentInfo with information about folder.

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

The ContentInfo object retrives information about:

The number of folders into.
The number of documents into.
The number of records into.
The number of mails into.
The size in bytes of all objects into the folder.

Example:

<?php

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

use openkm\OKMWebservices;
use openkm\OKMWebServicesFactory;
use openkm\OpenKM;
use openkm\bean\Folder;

class ExampleFolder {

    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 testGetContentInfo(){
        try {
            var_dump($this->ws->getContentInfo("/okm:root/SDK4PHP"));
        } catch (Exception $e) {
            var_dump($e);
        }
    }
}

$openkm = new OpenKM(); //autoload
$exampleFolder = new ExampleFolder();
$exampleFolder->testGetContentInfo();
?>

purgeFolder

Description:

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

Method

Return values

Description

purgeFolder($fldId)

void

Folder is definitely removed from repository.

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

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

When a folder is purged only will be able to be restored from a previously repository backup. The purge action remove the folder definitely from the repository.

Example:

<?php

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

use openkm\OKMWebservices;
use openkm\OKMWebServicesFactory;
use openkm\OpenKM;
use openkm\bean\Folder;

class ExampleFolder {

    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 testPurgeFolder(){
       try {
            $this->ws->purgeFolder("/okm:root/SDK4PHP/test");
        } catch (Exception $e) {
            var_dump($e);
        }         
    }
}

$openkm = new OpenKM(); //autoload
$exampleFolder = new ExampleFolder();
$exampleFolder->testPurgeFolder();
?>

setStyle

Description:

Method	Return values	Description
setStyle($fldId, $styleId)	void	Set the folder style.
Parameters: $fldId string type is the uuid or path of the Folder. $styleId long type is the id of the style. More information at: Folder style.

Method

Return values

Description

setStyle($fldId, $styleId)

void

Set the folder style.

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

$styleId long type is the id of the style.

More information at: Folder style.

Example:

<?php

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

use openkm\OKMWebservices;
use openkm\OKMWebServicesFactory;
use openkm\OpenKM;
use openkm\bean\Folder;

class ExampleFolder {

    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 testSetStyle() {
        try {
            $this->ws->setStyle("/okm:root/SDK4PHP/test",1);
        } catch (Exception $e) {
            var_dump($e);
        }
    }

}

$openkm = new OpenKM(); //autoload
$exampleFolder = new ExampleFolder();
$exampleFolder->testSetStyle();
?>

Table of contents [ Hide Show ]

Basics
Methods

createFolder
createFolderSimple
getFolderProperties
deleteFolder
renameFolder
moveFolder
getFolderChildren
isValidFolder
getFolderPath
copyFolder
extendedFolderCopy
getContentInfo
purgeFolder
setStyle

SDK for PHP 2.4.0

Folder samples

Basics

Methods

createFolder

createFolderSimple

getFolderProperties

deleteFolder

renameFolder

moveFolder

getFolderChildren

isValidFolder

getFolderPath

copyFolder

extendedFolderCopy

getContentInfo

purgeFolder

setStyle