SDK for PHP 1.0

If you want to collaborate extending features or add newer contact with us at contact website form indicating this URL.

OpenKM SDK for php is a set of software developement tools that allows for the creation of applications for OpenKM. The OpenKM SDK for php include a webservices library. This webservices library is a complete API layer to access OpenKM through webservices and provides complete compatibility between OpenKM webservices versions without change code.

Available zip file

• File:Sdk4php-1.0.zip

Advantage of use

We recommend to use SDK for php because it implements an extra layer between webservices and logic -factory- which allow transparently change between webservices versions without major effors. Simply instance other webservices version from factory in your source code.

Available functions and classes

Classes

• AppVersion
• CheckBox
• Document
• Entry
• Folder
• FormElement
• FormElementComplex
• GrantedRole
• GrantedUser
• Input
• KeywordMap
• LockInfo
• Node
• Note
• Option
• Permission
• PropertyGroup
• ProposedQueryReceived
• ProposedQuerySent
• QueryParams
• QueryResult
• ResultSet
• Select
• Separator
• SuggestBox
• SimplePropertyGroup
• Text
• TextArea
• Validator
• Version

Auth

    public function getGrantedRoles($nodeId);
    public function getGrantedUsers($nodeId);
    public function getMail($user);
    public function getName($user);
    public function getRoles();
    public function getRolesByUser($user);
    public function getUsers();
    public function getUsersByRole($role);
    public function revokeRole($nodeId, $role, $permissions, $recursive);
    public function revokeUser($nodeId, $user, $permissions, $recursive);
    public function grantRole($nodeId, $role, $permissions, $recursive);
    public function grantUser($nodeId, $user, $permissions, $recursive);

Repository

    public function getRootFolder();
    public function getTrashFolder();
    public function getTemplatesFolder();
    public function getPersonalFolder();
    public function getMailFolder();
    public function getThesaurusFolder();
    public function getCategoriesFolder();
    public function purgeTrash();
    public function getUpdateMessage();
    public function getRepositoryUuid();
    public function hasNode($nodeId);
    public function getNodePath($uuid);
    public function getNodeUuid($nodePath);
    public function getAppVersion();

Document

    public function createDocument(Document $okmDocument, $is);
    public function createDocumentSimple($docPath, $is);
    public function deleteDocument($docId);
    public function getDocumentProperties($docId);
    public function getContent($docId);
    public function getContentByVersion($docId, $versionId);
    public function getDocumentChildren($fldId);
    public function renameDocument($docId, $newName);
    public function setProperties(Document $okmDocument);
    public function setLanguage($docId, $lang);
    public function setTitle($docId, $title);
    public function checkout($docId);
    public function cancelCheckout($docId);
    public function forceCancelCheckout($docId);
    public function isCheckedOut($docId);
    public function checkin($docId, $is, $comment);
    public function getVersionHistory($docId);
    public function lock($docId);
    public function unlock($docId);
    public function forceUnlock($docId);
    public function isLocked($docId);
    public function getLockInfo($docId);
    public function purgeDocument($docId);
    public function moveDocument($docId, $dstId);
    public function copyDocument($docId, $dstId);
    public function restoreVersion($docId, $versionId);
    public function purgeVersionHistory($docId);
    public function getVersionHistorySize($docId);
    public function isValidDocument($docId);
    public function getDocumentPath($uuid);

Folder

    public function createFolder(Folder $okmFolder);
    public function createFolderSimple($fldPath);
    public function getFolderProperties($fldId);
    public function deleteFolder($fldId);
    public function renameFolder($fldId, $newName);
    public function moveFolder($fldId, $dstId);
    public function getFolderChildren($fldId);
    public function isValidFolder($fldId);
    public function getFolderPath($uuid);

Note

    public function addNote($nodeId, $text);
    public function getNote($noteId);
    public function deleteNote($noteId);
    public function setNote($noteId, $text);
    public function listNotes($nodeId);

PropertyGroup

    public function addGroup($nodeId, $grpName);
    public function removeGroup($nodeId, $grpName);
    public function getGroups($nodeId);
    public function getAllGroups();
    public function getPropertyGroupProperties($nodeId, $grpName);
    public function setPropetyGroupProperties($nodeId, $grpName, $formElementList = array());
    public function setPropertyGroupPropertiesSimple($nodeId, $grpName, $properties = array());
    public function hasGroup($nodeId, $grpName);

Property

    public function addCategory($nodeId, $catId);
    public function removeCategory($nodeId, $catId);
    public function addKeyword($nodeId, $keyword);
    public function removeKeyword($nodeId, $keyword);
    public function setEncryption($nodeId, $cipherName);
    public function unsetEncryption($nodeId);
    public function setSigned($nodeId, $signed);

Search

    public function findByContent($content);
    public function findByName($name);
    public function findByKeywords($keywords = array());
    public function find(QueryParams $queryParams);
    public function findPaginated(QueryParams $queryParams, $offset, $limit);
    public function findSimpleQueryPaginated($statement, $offset, $limit);
    public function findMoreLikeThis($uuid, $max);
    public function getKeywordMap($filter = array());
    public function getCategorizedDocuments($categoryId);
    public function saveSearch(QueryParams $params);
    public function updateSearch(QueryParams $params);
    public function getSearch($qpId);
    public function getAllSearchs();
    public function deleteSearch($qpId);

Unders contruction