Ejemplos de PHP

Descargar sdk4php

El ejemplo de sdk4php siguiente incluye los métodos más comunes utilizados por los usuarios al integrar sus aplicaciones PHP.

Precaución

OpenKM tiene más de 400 métodos en la API. Los ejemplos siguientes cubren los métodos más comunes utilizados al integrar aplicaciones PHP con OpenKM.

Si tiene problemas al intentar usar métodos no cubiertos en este ejemplo, consúltelos en el foro de la comunidad de OpenKM en https://forum.openkm.com

Professional	Versión de PHP	Estado	Descarga
Versión 7.0.0 y superior	7.x	Activa	sdk4php-3.0.3.zip

Ejemplo de Preview

El ejemplo siguiente describe cómo integrar la funcionalidad de vista previa de OpenKM en su aplicación PHP.

Professional	Versión de PHP	Estado	Descarga
Versión 7.0.0 y superior.	7.x	Activa	okmPreview-3.0.1.zip

Login

En primer lugar, debe crear el objeto del servicio web:

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

A continuación, debe iniciar sesión mediante el método “login”. Puede acceder al método “login” desde el objeto del servicio web “ws”, como se muestra a continuación:

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

Precaución

Una vez que ha iniciado sesión con los servicios web, la sesión se mantiene en el objeto del servicio web. A partir de ese momento puede utilizar el resto de métodos de la API.

En este punto, puede utilizar todos los métodos de Folder de la clase “folder”, como se muestra a continuación:

$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();
?>

Ejemplos de documentos

createDocument

Descripción:

Método	Valores devueltos	Descripción
createDocument($uuid, $name, $content)	Document	Crea un nuevo documento y devuelve un objeto Document con las propiedades del documento creado.

• Parámetros:
  $uuid string type es el uuid de destino de la carpeta o expediente
• $name string type es el nombre del documento.
• $content string type; se recomienda usar file_get_contents, que lee el archivo completo en una cadena.

Ejemplo:

<?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

Descripción:

Método	Valores devueltos	Descripción
deleteDocument($uuid)	void	Elimina un documento.

Nota

Cuando se elimina un documento, se mueve automáticamente a la carpeta /okm:trash/userId.

• Parámetros:
  $uuid string type es el uuid del documento

Ejemplo:

<?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

Descripción:

Método	Valores devueltos	Descripción
getDocumentProperties($uuid)	Document	Devuelve las propiedades del documento.

• Parámetros:
  $uuid string type es el uuid del documento

Ejemplo:

<?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

Descripción:

Método	Valores devueltos	Descripción
getContent($uuid)	string	Recupera el contenido del documento (datos binarios) de la versión actual del documento.

Ejemplo:

<?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

Descripción:

Método	Valores devueltos	Descripción
getDocumentChildren($uuid)	array	Devuelve una lista de todos los documentos cuyo padre es fldId.

• Parámetros:
  $fldId string type es el uuid o la ruta del documento o de un nodo de expediente.

Ejemplo:

<?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

Descripción:

Método	Valores devueltos	Descripción
moveDocument($uuid, $dstId)	void	Mueve un documento a una carpeta o expediente.

• Parámetros:
  $uuid string type es el uuid del documento
• $dstId string type es el uuid de la carpeta o expediente

Ejemplo:

<?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

Descripción:

Método	Valores devueltos	Descripción
copyDocument($uuid, $dstId, $newName)	void	Copia un documento a una carpeta o expediente.

Precaución

Solo se copian al destino los datos binarios y los permisos de seguridad; los metadatos, palabras clave, etc. del documento no se copian.

Consulte el método “extendedCopy” para esta funcionalidad.

• Parámetros:
  $uuid string type es el uuid del documento
• $dstId string type es el uuid de la carpeta o expediente
• $newName string type es el nuevo nombre del documento
• Cuando el valor del parámetro newName es null, el registro conservará el mismo nombre.

Ejemplo:

<?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

Descripción:

Método	Valores devueltos	Descripción
extendedDocumentCopy($uuid, $dstId, $newName, $categories, $keywords, $propertyGroups, $notes, $security)	void	Copia un documento con sus datos asociados a otra carpeta o expediente.

Nota

Por defecto solo se copian los datos binarios y los permisos de seguridad; los metadatos, las palabras clave, etc. de la carpeta no se copian.

Además:

• Cuando el parámetro category es true, se copiarán los valores originales de las categorías.
• Cuando el parámetro keywords es true, se copiarán los valores originales de las palabras clave.
• Cuando el parámetro propertyGroups es true, se copiarán los valores originales de los grupos de metadatos.
• Cuando el parámetro notes es true, se copiarán los valores originales de las notas.
• Cuando el parámetro wiki es true, se copiarán los valores originales de la wiki.

• Parámetros:
  $uuid string type es el uuid de la carpeta
• $dstId string type es el uuid de la carpeta o expediente
• $newName string type es el nuevo nombre
• $categories boolean type
• $keywords boolean type
• $propertyGroups boolean type
• $notes boolean type
• $security boolean type

Ejemplo:

<?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

Descripción:

Método	Valores devueltos	Descripción
checkout($uuid)	void	Marca el documento para su edición.

• Parámetros:
  $uuid string type es el uuid o la ruta del documento
• Solo un usuario puede modificar un documento al mismo tiempo.
• Antes de comenzar la edición debe realizar una acción de checkout, que bloquea el proceso de edición para otros usuarios y permite la edición únicamente al usuario que ha ejecutado la acción.

Ejemplo:

<?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

Descripción:

Método	Valores devueltos	Descripción
cancelCheckout($docId)	void	Cancela la edición del documento.

Precaución

Esta acción solo puede realizarla el usuario que ejecutó previamente la acción de checkout.

Ejemplo:

<?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

Descripción:

Método	Valores devueltos	Descripción
forceCancelCheckout($uuid)	void	Cancela la edición del documento.

Precaución

Esta acción solo puede realizarla un superusuario (usuario con ROLE_ADMIN).

• Parámetros:
  $uuid string type es el uuid o la ruta del documento
• Este método permite cancelar la edición de cualquier documento.
• No es obligatorio que esta acción la ejecute el mismo usuario que ejecutó previamente la acción de checkout.

Ejemplo:

<?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

Descripción:

Método	Valores devueltos	Descripción
isCheckedOut($uuid)	bool	Devuelve un booleano que indica si el documento está siendo editado o no.

• Parámetros:
  $uuid string type es el uuid o la ruta del documento

Ejemplo:

<?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

Descripción:

Método	Valores devueltos	Descripción
checkin($uuid, $content, $comment,$increment)	Version	Actualiza un documento con una nueva versión y devuelve un objeto con los nuevos valores de Version.

Nota

El valor de la variable increment debe ser 1 o superior.

Los valores válidos de la variable increment dependen del VersionNumberAdapter que tenga habilitado.

Precaución

Solo el usuario que inició la edición (checkout) puede actualizar el documento.

• Parámetros:
  $uuid string type es el uuid o la ruta del documento
• $content string type; se recomienda usar file_get_contents, que lee el archivo completo en una cadena.
• $comment string type es el comentario para la nueva versión del documento
• $increment int type

Ejemplo:

<?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

Ejemplo de Folder

createFolder

Descripción:

Método	Valores devueltos	Descripción
createFolder($uuid, $name)	Folder	Crea una nueva carpeta y devuelve como resultado un objeto Folder.

• Parámetros:
  $uuid string type es el uuid de destino de la carpeta o expediente

Ejemplo:

<?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

Descripción:

Método	Valores devueltos	Descripción
getFolderProperties($uuid)	Folder	Devuelve las propiedades de la carpeta.

• Parámetros:
  $uuid string type es el uuid de la carpeta

Ejemplo:

<?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

Descripción:

Método	Valores devueltos	Descripción
deleteFolder($uuid)	void	Elimina una carpeta.

• Parámetros:
  $uuid string type es el uuid de la carpeta

Ejemplo:

<?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

Descripción:

Método	Valores devueltos	Descripción
renameFolder($uuid, $newName)	void	Renombra una carpeta.

• Parámetros:
  $uuid string type es el uuid de la carpeta
• $newName string type es el nuevo nombre de la carpeta

Ejemplo:

<?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

Descripción:

Método	Valores devueltos	Descripción
moveFolder($uuid, $dstId)	void	Mueve una carpeta a otra carpeta o expediente.

• Parámetros:
  $uuid string type es el uuid de la carpeta
• $dstId string type es el uuid de la carpeta o expediente

Ejemplo:

<?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

Descripción:

Método	Valores devueltos	Descripción
getFolderChildren($uuid)	array	Devuelve un array con todas las carpetas cuyo padre es fldId.

• Parámetros:
  $uuid string type es el uuid del nodo de carpeta o expediente

Ejemplo:

<?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

Descripción:

Método	Valores devueltos	Descripción
copyFolder($uuid, $dstId, $newName)	void	Copia una carpeta dentro de otra carpeta o expediente.

Precaución

Solo se copian al destino los permisos de seguridad; los metadatos, las palabras clave, etc. de la carpeta no se copian.

Consulte el método “extendedCopy” para esta funcionalidad.

• Parámetros:
  $uuid string type es el uuid de la carpeta
• $dstId string type es el uuid de la carpeta o expediente
• $newName string type es el nuevo nombre de la carpeta. Si el valor es null, la carpeta conservará el mismo nombre.

Ejemplo:

<?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

Descripción:

Método	Valores devueltos	Descripción
extendedFolderCopy($uuid, $dstId, $categories, $keywords, $propertyGroups, $notes, $security)	void	Copia una carpeta con sus datos asociados a otra carpeta o expediente.

Nota

Por defecto solo se copian los datos binarios y los permisos de seguridad; los metadatos, las palabras clave, etc. de la carpeta no se copian.

Además:

• Cuando el parámetro category es true, se copiarán los valores originales de las categorías.
• Cuando el parámetro keywords es true, se copiarán los valores originales de las palabras clave.
• Cuando el parámetro propertyGroups es true, se copiarán los valores originales de los grupos de metadatos.
• Cuando el parámetro notes es true, se copiarán los valores originales de las notas.
• Cuando el parámetro wiki es true, se copiarán los valores originales de la wiki.

• Parámetros:
  $uuid string type es el uuid de la carpeta
• $dstId string type es el uuid de la carpeta o expediente
• $categories boolean type
• $keywords boolean type
• $propertyGroups boolean type
• $notes boolean type
• $security boolean type

Ejemplo:

<?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

Descripción:

Método	Valores devueltos	Descripción
getContentInfo($uuid)	ContentInfo	Devuelve un objeto ContentInfo con información sobre la carpeta.

• Parámetros:
  $uuid string type es el uuid o la ruta de la carpeta.
• El objeto ContentInfo recupera información sobre:

Ejemplo:

<?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

Descripción:

Método	Valores devueltos	Descripción
purgeFolder($uuid)	void	La carpeta se elimina permanentemente del repositorio.

Precaución

Cuando se purga una carpeta, solo se podrá restaurar desde una copia de seguridad previa del repositorio. La acción de purga elimina la carpeta definitivamente del repositorio.

• Parámetros:
  $uuid string type es el uuid o la ruta de la carpeta.
• Normalmente purgará carpetas de /okm:trash/userId (las ubicaciones de la papelera personal del usuario), pero es posible purgar directamente cualquier carpeta de todo el repositorio.

Ejemplo:

<?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

Descripción:

Método	Valores devueltos	Descripción
createMissingFolders($fldPath)	void	Crea las carpetas que faltan.

• Parámetros:
  $fldPath string type es la ruta de la carpeta.

Ejemplo:

<?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

Descripción:

Método	Valores devueltos	Descripción
createFolderFromTemplate($uuid, $dstPath, $language, $categories, $keywords, $propertyGroups, $notes, $properties)	Folder	Crea una nueva carpeta a partir de una plantilla y devuelve un objeto Folder.

Nota

Además:

• Cuando el parámetro category es true, se copiarán los valores originales de las categorías.
• Cuando el parámetro keywords es true, se copiarán los valores originales de las palabras clave.
• Cuando el parámetro propertyGroups es true, se copiarán los valores originales de los grupos de metadatos.
• Cuando el parámetro notes es true, se copiarán los valores originales de las notas.

• El parámetro $uuid es el valor UUID del archivo de plantilla.
• El valor $dstPath es la ruta de la carpeta de destino.
• El parámetro $language es opcional.
• Cuando la plantilla utiliza grupos de metadatos para rellenar campos, estos valores son obligatorios y deben establecerse en el parámetro properties.

Ejemplo:

<?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();
?>

Ejemplos de PropertyGroup

addPropertyGroup

Descripción:

Método	Valores devueltos	Descripción
addPropertyGroup($uuid, $grpName, $properties)	void	Añade un grupo de metadatos vacío a un nodo.

• Parámetros:
• $uuid string type es el uuid del documento, carpeta, correo o expediente.
• $grpName string type; grpName debe ser un nombre de grupo de metadatos válido.

Ejemplo:

<?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

Descripción:

Método	Valores devueltos	Descripción
removePropertyGroup($uuid, $grpName)	void	Elimina un grupo de metadatos de un nodo.

• Parámetros:
• $uuid string type es el uuid del documento, carpeta, correo o expediente.
• $grpName string type; grpName debe ser un nombre de grupo de metadatos válido.

Ejemplo:

<?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

Descripción:

Método	Valores devueltos	Descripción
getPropertyGroups($uuid)	array	Recupera una lista de los grupos de metadatos asignados a un nodo.

• Parámetros:
• $uuid string type es el uuid del documento, carpeta, correo o expediente.

Ejemplo:

<?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

Descripción:

Método	Valores devueltos	Descripción
getAllPropertyGroups()	array	Recupera una lista de todos los grupos de metadatos definidos en la aplicación.

Ejemplo:

<?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

Descripción:

Método	Valores devueltos	Descripción
getPropertyGroupForm($grpName)	array	Recupera una lista de las definiciones de todos los elementos de un grupo de metadatos.

Nota

El método se utiliza normalmente para mostrar elementos de formulario vacíos para crear nuevos valores de metadatos.

• Parámetros:
• $grpName string type. El grpName debe ser un nombre de grupo de metadatos válido.

Ejemplo:

<?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

Descripción:

Método	Valores devueltos	Descripción
getPropertyGroupFormByNode($uuid, $grpName)	array	Recupera una lista de todos los elementos del grupo de metadatos definidos para un nodo.

Nota

El método se utiliza normalmente para mostrar elementos de formulario vacíos para crear nuevos valores de metadatos.

• Parámetros:
• $uuid string type es el uuid del documento, carpeta, correo o expediente.
• $grpName string type. El grpName debe ser un nombre de grupo de metadatos válido.

Ejemplo:

<?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

Descripción:

Método	Valores devueltos	Descripción
setPropertyGroupProperties($uuid, $grpName, $properties)	void	Cambia los valores del grupo de metadatos de un nodo.

Precaución

Antes de cambiar los metadatos, debe tener el grupo añadido al nodo (consulte el método addGroup); de lo contrario, se producirá un error.

Nota

No es obligatorio establecer todos los valores de los campos en el parámetro properties; basta con especificar los campos cuyos valores desea cambiar.

Nota

El ejemplo siguiente se basa en esta definición de grupo de metadatos:

<?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>

• Parámetros:
• $uuid string type es el uuid o la ruta del documento, carpeta, correo o expediente.
• $grpName string type. El grpName debe ser un nombre de grupo de metadatos válido.
• $properties array type. Un array de propiedades.

Ejemplo:

<?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

Descripción:

Método	Valores devueltos	Descripción
hasPropertyGroup($uuid, $grpName)	bool	Devuelve un booleano que indica si el nodo tiene un grupo de metadatos.

• Parámetros:
• $uuid string type es el uuid del documento, carpeta, correo o expediente.
• $grpName string type es el grpName, que debe ser un nombre de grupo de metadatos válido.

Ejemplo:

<?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

Descripción:

Método	Valores devueltos	Descripción
getRegisteredPropertyGroupDefinition()	string	Devuelve la definición XML de los grupos de metadatos.

Precaución

El método solo puede ser ejecutado por superusuarios con pertenencia a ROLE_ADMIN.

Ejemplo:

<?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

Descripción:

Método	Valores devueltos	Descripción
getPropertyGroupSuggestions($uuid, $grpName, $propName)	array	Recupera una lista de valores sugeridos para un campo de metadatos.

Precaución

El parámetro propName debe ser de tipo campo Select de metadatos.

Nota

Más información en Crear su propio analizador de sugerencias y Campo Select de metadatos.

Nota

El ejemplo siguiente se basa en esta definición de grupo de metadatos:

<?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>

• Parámetros:
• $uuid string type es el uuid del documento, carpeta, correo o expediente.
• $grpName string type es el grpName, que debe ser un nombre de grupo de metadatos válido.
• $propName string type. El parámetro propName debe ser un campo de tipo Metadata Select field type.

Ejemplo:

<?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

Descripción:

Método	Valores devueltos	Descripción
registerPropertyGroupDefinition($content, $name)	void	Establece en el repositorio la definición XML de los grupos de metadatos.

Precaución

El método solo puede ser ejecutado por superusuarios con pertenencia a ROLE_ADMIN.

• Parámetros:
• $content string type. Se recomienda usar file_get_contents, que lee el archivo completo en una cadena.
• $name string type. El nombre del grupo de propiedades.

Ejemplo:

<?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

Descripción:

Método	Valores devueltos	Descripción
getPropertyGroupProperties($uuid, $grpName)	array	Recupera una lista de todos los elementos del grupo de metadatos y sus valores para un nodo.

Nota

El método se utiliza normalmente para mostrar elementos de formulario con sus valores, para que el usuario los vea o los cambie.

• Parámetros:
• $uuid string type es el uuid del documento, carpeta, correo o expediente.
• $grpName string type. El grpName debe ser un nombre de grupo de metadatos válido.

Ejemplo:

<?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

Descripción:

Método	Valores devueltos	Descripción
getPropertyGroupPropertiesByVersion($uuid, $grpName, $versionName)	array	Recupera una lista de todos los elementos del grupo de metadatos y sus valores para un nodo.

Nota

El método se utiliza normalmente para mostrar elementos de formulario con sus valores, para que el usuario los vea o los cambie.

• Parámetros:
• $uuid string type es el uuid del documento, carpeta, correo o expediente.
• $grpName string type. El grpName debe ser un nombre de grupo de metadatos válido.
• $versionName string type. La versión del documento, carpeta, correo o expediente.

Ejemplo:

<?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();
?>

Ejemplos de búsqueda

find

Descripción:

Método	Valores devueltos	Descripción
find(QueryParams $queryParams, $propertiesPlugin)	array	Devuelve una lista de QueryResults filtrados por los valores del parámetro queryParams.

Nota

Recuperar objetos completos (Document, Folder, Record, Mail) desde REST puede llevar mucho tiempo (proceso de marshalling y unmarshalling) si solo le interesa utilizar unas pocas variables de los objetos. Si es su caso, puede utilizar clases NodeProperties para recuperar las variables del objeto que realmente necesita.

• Parámetros:
  $queryParams QueryParams type
• $propertiesPlugin string type, debe ser el nombre canónico de la clase que implementa la interfaz NodeProperties.

Ejemplo:

<?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

Descripción:

Método	Valores devueltos	Descripción
findPaginated(QueryParams $queryParams, $offset, $limit, $propertiesPlugin)	ResultSet	Devuelve una lista de resultados paginados filtrados por los valores del parámetro queryParams.

Consejo

Los parámetros “limit” y “offset” le permiten recuperar solo una parte de los resultados de una consulta.

• El parámetro “limit” se utiliza para limitar el número de resultados devueltos.
• El parámetro “offset” se utiliza para omitir ese número de resultados antes de empezar a devolverlos.

Nota

Por ejemplo, si su consulta tiene 1000 resultados pero solo desea devolver los 10 primeros, debe utilizar estos valores:

• limit=10
• offset=0

Ahora suponga que desea mostrar los resultados del 11 al 20; debe utilizar estos valores:

• limit=10
• offset=10

Recuperar objetos completos (Document, Folder, Record, Mail) desde REST puede llevar mucho tiempo (proceso de marshalling y unmarshalling) si solo le interesa utilizar unas pocas variables de los objetos. Si es su caso, puede utilizar clases NodeProperties para recuperar las variables del objeto que realmente necesita.

• Parámetros:
  $queryParams QueryParams type
• $offset int type
• $limit int type
• $propertiesPlugin string type, debe ser el nombre canónico de la clase que implementa la interfaz NodeProperties.

Ejemplo:

<?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();
?>