https://www.openkm.com/wiki/index.php?title=SDK_for_PHP_2.0.2&feed=atom&action=history
SDK for PHP 2.0.2 - Revision history
2024-03-29T10:38:06Z
Revision history for this page on the wiki
MediaWiki 1.27.3
https://www.openkm.com/wiki/index.php?title=SDK_for_PHP_2.0.2&diff=11830&oldid=prev
Jllort: /* PropertyGroup */
2014-09-05T06:33:19Z
<p><span dir="auto"><span class="autocomment">PropertyGroup</span></span></p>
<table class="diff diff-contentalign-left" data-mw="interface">
<col class='diff-marker' />
<col class='diff-content' />
<col class='diff-marker' />
<col class='diff-content' />
<tr style='vertical-align: top;' lang='en'>
<td colspan='2' style="background-color: white; color:black; text-align: center;">← Older revision</td>
<td colspan='2' style="background-color: white; color:black; text-align: center;">Revision as of 06:33, 5 September 2014</td>
</tr><tr><td colspan="2" class="diff-lineno" id="mw-diff-left-l434" >Line 434:</td>
<td colspan="2" class="diff-lineno">Line 434:</td></tr>
<tr><td class='diff-marker'> </td><td style="background-color: #f9f9f9; color: #333333; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #e6e6e6; vertical-align: top; white-space: pre-wrap;"></td><td class='diff-marker'> </td><td style="background-color: #f9f9f9; color: #333333; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #e6e6e6; vertical-align: top; white-space: pre-wrap;"></td></tr>
<tr><td class='diff-marker'> </td><td style="background-color: #f9f9f9; color: #333333; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #e6e6e6; vertical-align: top; white-space: pre-wrap;"><div>=== PropertyGroup ===</div></td><td class='diff-marker'> </td><td style="background-color: #f9f9f9; color: #333333; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #e6e6e6; vertical-align: top; white-space: pre-wrap;"><div>=== PropertyGroup ===</div></td></tr>
<tr><td colspan="2"> </td><td class='diff-marker'>+</td><td style="color:black; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #a3d3ff; vertical-align: top; white-space: pre-wrap;"><div><ins style="font-weight: bold; text-decoration: none;">{{Note|when you want to set values into select multiple using setPropertyGroupPropertiesSimple must declare each value into string separated by character ";". For example if want to select values 1,2 should build a string like this "1;2"}}</ins></div></td></tr>
<tr><td colspan="2"> </td><td class='diff-marker'>+</td><td style="color:black; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #a3d3ff; vertical-align: top; white-space: pre-wrap;"><div><ins style="font-weight: bold; text-decoration: none;"></ins></div></td></tr>
<tr><td class='diff-marker'> </td><td style="background-color: #f9f9f9; color: #333333; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #e6e6e6; vertical-align: top; white-space: pre-wrap;"><div><source lang="php"></div></td><td class='diff-marker'> </td><td style="background-color: #f9f9f9; color: #333333; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #e6e6e6; vertical-align: top; white-space: pre-wrap;"><div><source lang="php"></div></td></tr>
<tr><td class='diff-marker'> </td><td style="background-color: #f9f9f9; color: #333333; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #e6e6e6; vertical-align: top; white-space: pre-wrap;"><div>     public function addGroup($nodeId, $grpName);</div></td><td class='diff-marker'> </td><td style="background-color: #f9f9f9; color: #333333; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #e6e6e6; vertical-align: top; white-space: pre-wrap;"><div>     public function addGroup($nodeId, $grpName);</div></td></tr>
</table>
Jllort
https://www.openkm.com/wiki/index.php?title=SDK_for_PHP_2.0.2&diff=11738&oldid=prev
Jllort at 07:18, 2 July 2014
2014-07-02T07:18:18Z
<p></p>
<table class="diff diff-contentalign-left" data-mw="interface">
<col class='diff-marker' />
<col class='diff-content' />
<col class='diff-marker' />
<col class='diff-content' />
<tr style='vertical-align: top;' lang='en'>
<td colspan='2' style="background-color: white; color:black; text-align: center;">← Older revision</td>
<td colspan='2' style="background-color: white; color:black; text-align: center;">Revision as of 07:18, 2 July 2014</td>
</tr><tr><td colspan="2" class="diff-lineno" id="mw-diff-left-l117" >Line 117:</td>
<td colspan="2" class="diff-lineno">Line 117:</td></tr>
<tr><td class='diff-marker'> </td><td style="background-color: #f9f9f9; color: #333333; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #e6e6e6; vertical-align: top; white-space: pre-wrap;"><div></source></div></td><td class='diff-marker'> </td><td style="background-color: #f9f9f9; color: #333333; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #e6e6e6; vertical-align: top; white-space: pre-wrap;"><div></source></div></td></tr>
<tr><td class='diff-marker'> </td><td style="background-color: #f9f9f9; color: #333333; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #e6e6e6; vertical-align: top; white-space: pre-wrap;"></td><td class='diff-marker'> </td><td style="background-color: #f9f9f9; color: #333333; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #e6e6e6; vertical-align: top; white-space: pre-wrap;"></td></tr>
<tr><td class='diff-marker'>−</td><td style="color:black; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #ffe49c; vertical-align: top; white-space: pre-wrap;"><div>An example of searching with the sdk and how to know if <del class="diffchange diffchange-inline">a </del>document or folder.   </div></td><td class='diff-marker'>+</td><td style="color:black; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #a3d3ff; vertical-align: top; white-space: pre-wrap;"><div>An example of searching with the sdk and how to know if <ins class="diffchange diffchange-inline">the result node is </ins>document or folder.   </div></td></tr>
<tr><td class='diff-marker'> </td><td style="background-color: #f9f9f9; color: #333333; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #e6e6e6; vertical-align: top; white-space: pre-wrap;"></td><td class='diff-marker'> </td><td style="background-color: #f9f9f9; color: #333333; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #e6e6e6; vertical-align: top; white-space: pre-wrap;"></td></tr>
<tr><td class='diff-marker'> </td><td style="background-color: #f9f9f9; color: #333333; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #e6e6e6; vertical-align: top; white-space: pre-wrap;"><div><source lang="php"></div></td><td class='diff-marker'> </td><td style="background-color: #f9f9f9; color: #333333; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #e6e6e6; vertical-align: top; white-space: pre-wrap;"><div><source lang="php"></div></td></tr>
</table>
Jllort
https://www.openkm.com/wiki/index.php?title=SDK_for_PHP_2.0.2&diff=11736&oldid=prev
Sochoa.gmd: Created page with "{{TOCright}} __TOC__ {{Note|If '''you want to collaborate''' extending features or add newer '''contact with us at''' [http://www.openkm.com/en/contact.html contact website fo..."
2014-07-01T13:25:43Z
<p>Created page with "{{TOCright}} __TOC__ {{Note|If '''you want to collaborate''' extending features or add newer '''contact with us at''' [http://www.openkm.com/en/contact.html contact website fo..."</p>
<p><b>New page</b></p><div>{{TOCright}} __TOC__<br />
{{Note|If '''you want to collaborate''' extending features or add newer '''contact with us at''' [http://www.openkm.com/en/contact.html contact website form] indicating this URL.}}<br />
<br />
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.<br />
<br />
'''Available zip file''' <br />
* [[File:Sdk4php-2.0.2.zip]]<br />
<br />
== Advantage of use ==<br />
<br />
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. <br />
<br />
== Example ==<br />
In zip file into folder called test there are some php testing files. Consider some const values must be changed to get it running in your OpenKM. For example '''const TEST_FLD = "e0856a93-3b25-4726-88fc-632dec7c6ab0"'''; in example you got below must be changed for some folder UUID in your OpenKM.<br />
<br />
<source lang="php"><br />
<?php<br />
include '../src/openkm/OpenKM.php';<br />
<br />
use openkm\OKMWebServicesFactory;<br />
use openkm\OpenKM;<br />
use openkm\bean\Auth;<br />
<br />
/**<br />
* TestAuth<br />
*<br />
* @author sochoa<br />
*/<br />
class TestAuth {<br />
<br />
const HOST = "http://localhost:8080/OpenKM/";<br />
const USER = "okmAdmin";<br />
const PASSWORD = "admin";<br />
const TEST_DOC_PATH = "/okm:root/OpenKM/architecture.html";<br />
const TEST_DOC_UUID = 'e0856a93-3b25-4726-88fc-632dec7c6ab0';<br />
<br />
private $ws;<br />
<br />
public function __construct() {<br />
$this->ws = OKMWebServicesFactory::build(self::HOST, self::USER, self::PASSWORD);<br />
}<br />
<br />
public function test() {<br />
//getGrantedRoles<br />
echo '<h2>getGrantedRoles</h2>';<br />
$grantedRoles = $this->ws->getGrantedRoles(self::TEST_DOC_UUID);<br />
foreach ($grantedRoles as $grantedRole) {<br />
echo '<div style="margin-left:30px">';<br />
echo '<h3>GrantedRole</h3>';<br />
echo '<p><strong>Role:</strong>' .$grantedRole->getRole() . '</p>';<br />
echo '<p><strong>Permissions:</strong>' .$grantedRole->getPermissions() . '</p>';<br />
echo '</div>';<br />
}<br />
<br />
//getGrantedUsers<br />
echo '<h2>getGrantedUsers</h2>';<br />
$grantedUsers = $this->ws->getGrantedUsers(self::TEST_DOC_UUID);<br />
foreach ($grantedUsers as $grantedUser) {<br />
echo '<div style="margin-left:30px">';<br />
echo '<h3>GrantedUser</h3>';<br />
echo '<p><strong>User:</strong>' .$grantedUser->getUser() . '</p>';<br />
echo '<p><strong>Permissions:</strong>' . $grantedUser->getPermissions() . '</p>';<br />
echo '</div>';<br />
}<br />
<br />
//getRoles<br />
echo '<h2>getRoles</h2>';<br />
$roles = $this->ws->getRoles();<br />
foreach ($roles as $role) {<br />
echo '<div style="margin-left:30px">';<br />
echo '<p>' . $role . '</p>';<br />
echo '</div>';<br />
}<br />
<br />
//getUsers<br />
echo '<h2>getUsers</h2>';<br />
$users = $this->ws->getUsers();<br />
foreach ($users as $user) {<br />
echo '<div style="margin-left:30px">';<br />
echo '<p>' . $user . '</p>';<br />
echo '</div>';<br />
}<br />
<br />
//getUsersByRole<br />
echo '<h2>getUsersByRole</h2>';<br />
$users = $this->ws->getUsersByRole('ROLE_ADMIN');<br />
foreach ($users as $user) {<br />
echo '<div style="margin-left:30px">';<br />
echo '<p>' . $user . '</p>';<br />
echo '</div>';<br />
} <br />
<br />
//getRolesByUser<br />
echo '<h2>getRolesByUser</h2>';<br />
$roles = $this->ws->getRolesByUser('okmAdmin');<br />
foreach ($roles as $role) {<br />
echo '<div style="margin-left:30px">';<br />
echo '<p>' . $role . '</p>';<br />
echo '</div>';<br />
}<br />
<br />
//getMail<br />
echo '<h2>getMail</h2>';<br />
echo '<p>' . $this->ws->getMail('okmAdmin') , '</p>';<br />
<br />
//getName<br />
echo '<h2>getName</h2>';<br />
echo '<p>' . $this->ws->getName('okmAdmin') . '</p>';<br />
}<br />
<br />
}<br />
<br />
$openkm = new OpenKM();<br />
$testAuth = new TestAuth();<br />
$testAuth->test();<br />
?><br />
</source><br />
<br />
An example of searching with the sdk and how to know if a document or folder. <br />
<br />
<source lang="php"><br />
<?php<br />
<br />
include '../src/openkm/OpenKM.php';<br />
<br />
use openkm\OKMWebServicesFactory;<br />
use openkm\OpenKM;<br />
use openkm\bean\Folder;<br />
use openkm\bean\Document;<br />
use openkm\bean\Version;<br />
use openkm\bean\LockInfo;<br />
use openkm\bean\QueryResult;<br />
use openkm\bean\QueryParams;<br />
<br />
/**<br />
* TestSearch<br />
*<br />
* @author sochoa<br />
*/<br />
class TestSearch {<br />
<br />
const HOST = "http://localhost:8080/OpenKM/";<br />
const USER = "okmAdmin";<br />
const PASSWORD = "admin";<br />
<br />
private $ws;<br />
<br />
public function __construct() {<br />
$this->ws = OKMWebServicesFactory::build(self::HOST, self::USER, self::PASSWORD);<br />
}<br />
<br />
public function test() {<br />
<br />
//find<br />
$queryParams = new QueryParams();<br />
$queryParams->setDomain(QueryParams::DOCUMENT + QueryParams::FOLDER);<br />
$queryParams->setName('text');<br />
$queryResults = $this->ws->find($queryParams);<br />
foreach ($queryResults as $queryResult) {<br />
$this->printQueryResult($queryResult, 'find');<br />
} <br />
}<br />
<br />
public function printQueryResult(QueryResult $queryResult, $title) { <br />
echo '<h2>QueryResult - ' . $title . '</h2>';<br />
echo '<div style="margin-left:30px">';<br />
echo '<p><strong>Attachment</strong>:' . $queryResult->isAttachment() . '</p>';<br />
echo '<p><strong>Excerpt</strong>:' . $queryResult->getExcerpt() . '</p>';<br />
echo '<p><strong>Score</strong>:' . $queryResult->getScore() . '</p>';<br />
if($queryResult->getNode() instanceof Document){<br />
$this->printDocument($queryResult->getNode(), $title);<br />
} else if($queryResult->getNode() instanceof Folder){<br />
$this->printFolder($queryResult->getNode(), $title);<br />
}<br />
echo '</div>';<br />
} <br />
<br />
public function printDocument(Document $document, $title) {<br />
echo '<h2>Document - ' . $title . '</h2>';<br />
echo '<div style="margin-left:30px">';<br />
echo '<p><strong>Author</strong>:' . $document->getAuthor() . '</p>';<br />
echo '<p><strong>Created</strong>:' . $document->getCreated() . '</p>';<br />
echo '<p><strong>NodeClass:</stron>' . $document->getNodeClass() . '</p>';<br />
echo '<p><strong>Path</strong>:' . $document->getPath() . '</p>';<br />
echo '<p><strong>Permissions</strong>:' . $document->getPermissions() . '</p>';<br />
echo '<p><strong>Subscribed</strong>:' . $document->isSubscribed() . '</p>';<br />
echo '<p><strong>Uuid</strong>:' . $document->getUuid() . '</p>';<br />
echo '<p><strong>CheckedOut</strong>:' . $document->isCheckedOut() . '</p>';<br />
echo '<p><strong>ConvertibleDxf</strong>:' . $document->isConvertibleToDxf() . '</p>';<br />
echo '<p><strong>ConvertiblePdf</strong>:' . $document->isConvertibleToPdf() . '</p>';<br />
echo '<p><strong>ConvertibleSwf</strong>:' . $document->isConvertibleToSwf() . '</p>';<br />
echo '<p><strong>Description</strong>:' . $document->getDescription() . '</p>';<br />
echo '<p><strong>Language</strong>:' . $document->getLanguage() . '</p>';<br />
echo '<p><strong>LastModified</strong>:' . $document->getLastModified() . '</p>';<br />
echo '<p><strong>Locked</strong>:' . $document->isLocked() . '</p>';<br />
echo '<p><strong>MineType</strong>:' . $document->getMimeType() . '</p>';<br />
echo '<p><strong>Signed</strong>:' . $document->isSigned() . '</p>';<br />
echo '<p><strong>Title</strong>:' . $document->getTitle() . '</p>';<br />
<br />
$this->printVersion($document->getActualVersion());<br />
<br />
$this->printLockInfo($document->getLockInfo());<br />
<br />
foreach ($document->getCategories() as $category) {<br />
echo '<h3>Categories</h3>';<br />
echo '<p><strong>Author</strong>:' . $category->getAuthor() . '</p>';<br />
echo '<p><strong>Created</strong>:' . $category->getCreated() . '</p>'; <br />
echo '<p><strong>NodeClass:</stron>' . $category->getNodeClass() . '</p>';<br />
echo '<p><strong>Path</strong>:' . $category->getPath() . '</p>';<br />
echo '<p><strong>Permissions</strong>:' . $category->getPermissions() . '</p>';<br />
echo '<p><strong>Subscribed</strong>:' . $category->isSubscribed() . '</p>';<br />
echo '<p><strong>Uuid</strong>:' . $category->getUuid() . '</p>';<br />
echo '<p><strong>HasChildrend</strong>:' . $category->isHasChildren() . '</p>';<br />
echo '<p><strong>Style</strong>:' . $category->getStyle() . '</p>';<br />
}<br />
foreach ($document->getKeywords() as $keyword) {<br />
echo '<h3>Keywords: ' . $keyword . '</h3>';<br />
}<br />
<br />
foreach ($document->getNotes() as $note) {<br />
echo '<h3>Notes</h3>';<br />
echo '<p><strong>Author</strong>:' . $note->getAuthor() . '</p>';<br />
echo '<p><strong>Date</strong>:' . $note->getDate() . '</p>';<br />
echo '<p><strong>Path</strong>:' . $note->getPath() . '</p>';<br />
echo '<p><strong>text</strong>:' . $note->getText() . '</p>';<br />
}<br />
foreach ($document->getSubscriptors() as $subscriptor) {<br />
echo '<h3>Subscriptors: ' . $subscriptor . '</h3>';<br />
}<br />
echo '</div>';<br />
}<br />
<br />
public function printVersion(Version $version) {<br />
echo '<h2>Version</h2>';<br />
echo '<p><strong>Actual</strong>:' . $version->getActual() . '</p>';<br />
echo '<p><strong>Author</strong>:' . $version->getAuthor() . '</p>';<br />
echo '<p><strong>Checksum</strong>:' . $version->getChecksum() . '</p>';<br />
echo '<p><strong>Created</strong>:' . $version->getCreated() . '</p>';<br />
echo '<p><strong>Name</strong>:' . $version->getName() . '</p>';<br />
echo '<p><strong>Size</strong>:' . $version->getSize() . '</p>';<br />
}<br />
<br />
public function printLockInfo(LockInfo $lockInfo) {<br />
echo '<h2>LockInfo</h2>';<br />
echo '<p><strong>NodePath</strong>:' . $lockInfo->getNodePath() . '</p>';<br />
echo '<p><strong>Owner</strong>:' . $lockInfo->getOwner() . '</p>';<br />
echo '<p><strong>Token</strong>:' . $lockInfo->getToken() . '</p>';<br />
}<br />
<br />
public function printFolder(Folder $folder, $title) {<br />
echo '<h2>Folder - ' . $title . '</h2>';<br />
echo '<div style="margin-left:30px">';<br />
echo '<p><strong>Author</strong>:' . $folder->getAuthor() . '</p>';<br />
echo '<p><strong>Created</strong>:' . $folder->getCreated() . '</p>';<br />
echo '<p><strong>NodeClass:</stron>' . $folder->getNodeClass() . '</p>';<br />
echo '<p><strong>Path</strong>:' . $folder->getPath() . '</p>';<br />
echo '<p><strong>Permissions</strong>:' . $folder->getPermissions() . '</p>';<br />
echo '<p><strong>Subscribed</strong>:' . $folder->isSubscribed() . '</p>';<br />
echo '<p><strong>Uuid</strong>:' . $folder->getUuid() . '</p>';<br />
echo '<p><strong>HasChildrend</strong>:' . $folder->isHasChildren() . '</p>';<br />
echo '<p><strong>Style</strong>:' . $folder->getStyle() . '</p>';<br />
foreach ($folder->getCategories() as $category) {<br />
echo '<h3>Categories</h3>';<br />
echo '<p><strong>Author</strong>:' . $category->getAuthor() . '</p>';<br />
echo '<p><strong>Created</strong>:' . $category->getCreated() . '</p>';<br />
echo '<p><strong>NodeClass:</stron>' . $category->getNodeClass() . '</p>';<br />
echo '<p><strong>Path</strong>:' . $category->getPath() . '</p>';<br />
echo '<p><strong>Permissions</strong>:' . $category->getPermissions() . '</p>';<br />
echo '<p><strong>Subscribed</strong>:' . $category->isSubscribed() . '</p>';<br />
echo '<p><strong>Uuid</strong>:' . $category->getUuid() . '</p>';<br />
echo '<p><strong>HasChildrend</strong>:' . $category->isHasChildren() . '</p>';<br />
echo '<p><strong>Style</strong>:' . $category->getStyle() . '</p>';<br />
}<br />
foreach ($folder->getKeywords() as $keyword) {<br />
echo '<h3>Keywords: ' . $keyword . '</h3>';<br />
}<br />
<br />
foreach ($folder->getNotes() as $note) {<br />
echo '<h3>Notes</h3>';<br />
echo '<p><strong>Author</strong>:' . $note->getAuthor() . '</p>';<br />
echo '<p><strong>Date</strong>:' . $note->getDate() . '</p>';<br />
echo '<p><strong>Path</strong>:' . $note->getPath() . '</p>';<br />
echo '<p><strong>text</strong>:' . $note->getText() . '</p>';<br />
}<br />
foreach ($folder->getSubscriptors() as $subscriptor) {<br />
echo '<h3>Subscriptors: ' . $subscriptor . '</h3>';<br />
}<br />
echo '</div>';<br />
} <br />
<br />
}<br />
<br />
$openkm = new OpenKM();<br />
$testSearch = new TestSearch();<br />
$testSearch->test();<br />
?><br />
<br />
</source><br />
<br />
== Available functions and classes ==<br />
=== Classes ===<br />
* AppVersion <br />
* CheckBox<br />
* Document<br />
* Entry <br />
* Folder<br />
* FormElement<br />
* FormElementComplex<br />
* GrantedRole<br />
* GrantedUser<br />
* Input<br />
* KeywordMap <br />
* LockInfo<br />
* Node <br />
* Note<br />
* Option<br />
* Permission<br />
* PropertyGroup<br />
* ProposedQueryReceived<br />
* ProposedQuerySent<br />
* QueryParams<br />
* QueryResult<br />
* ResultSet <br />
* Select <br />
* Separator <br />
* SuggestBox<br />
* SimplePropertyGroup<br />
* Text<br />
* TextArea<br />
* Validator<br />
* Version<br />
<br />
=== Auth ===<br />
<source lang="php"><br />
public function getGrantedRoles($nodeId);<br />
public function getGrantedUsers($nodeId);<br />
public function getMail($user);<br />
public function getName($user);<br />
public function getRoles();<br />
public function getRolesByUser($user);<br />
public function getUsers();<br />
public function getUsersByRole($role);<br />
public function revokeRole($nodeId, $role, $permissions, $recursive);<br />
public function revokeUser($nodeId, $user, $permissions, $recursive);<br />
public function grantRole($nodeId, $role, $permissions, $recursive);<br />
public function grantUser($nodeId, $user, $permissions, $recursive);<br />
public void createUser($user, $password, $email, $name, $active);<br />
public void deleteUser($user);<br />
public void updateUser($user, $password, $email, $name, $active);<br />
public void createRole($role, $active);<br />
public void deleteRole($role);<br />
public void updateRole($role, $active);<br />
public void assignRole($user, $role);<br />
public void removeRole($user, $role);<br />
</source><br />
<br />
=== Repository ===<br />
<source lang="php"><br />
public function getRootFolder();<br />
public function getTrashFolder();<br />
public function getTemplatesFolder();<br />
public function getPersonalFolder();<br />
public function getMailFolder();<br />
public function getThesaurusFolder();<br />
public function getCategoriesFolder();<br />
public function purgeTrash();<br />
public function getUpdateMessage();<br />
public function getRepositoryUuid();<br />
public function hasNode($nodeId);<br />
public function getNodePath($uuid);<br />
public function getNodeUuid($nodePath);<br />
public function getAppVersion();<br />
</source><br />
<br />
=== Document ===<br />
<source lang="php"><br />
public function createDocument(Document $okmDocument, $is);<br />
public function createDocumentSimple($docPath, $is);<br />
public function deleteDocument($docId);<br />
public function getDocumentProperties($docId);<br />
public function getContent($docId);<br />
public function getContentByVersion($docId, $versionId);<br />
public function getDocumentChildren($fldId);<br />
public function renameDocument($docId, $newName);<br />
public function setProperties(Document $okmDocument);<br />
public function setLanguage($docId, $lang);<br />
public function setTitle($docId, $title);<br />
public function checkout($docId);<br />
public function cancelCheckout($docId);<br />
public function forceCancelCheckout($docId);<br />
public function isCheckedOut($docId);<br />
public function checkin($docId, $is, $comment);<br />
public function getVersionHistory($docId);<br />
public function lock($docId);<br />
public function unlock($docId);<br />
public function forceUnlock($docId);<br />
public function isLocked($docId);<br />
public function getLockInfo($docId);<br />
public function purgeDocument($docId);<br />
public function moveDocument($docId, $dstId);<br />
public function copyDocument($docId, $dstId);<br />
public function restoreVersion($docId, $versionId);<br />
public function purgeVersionHistory($docId);<br />
public function getVersionHistorySize($docId);<br />
public function isValidDocument($docId);<br />
public function getDocumentPath($uuid);<br />
public function setLanguage($docId, $lang);<br />
public function setTitle($docId, $title);<br />
public function setDocumentNodeClass($docId, $ncId);<br />
public Function getDetectedLanguages();<br />
</source><br />
<br />
=== Folder ===<br />
<source lang="php"><br />
public function createFolder(Folder $okmFolder);<br />
public function createFolderSimple($fldPath);<br />
public function getFolderProperties($fldId);<br />
public function deleteFolder($fldId);<br />
public function renameFolder($fldId, $newName);<br />
public function moveFolder($fldId, $dstId);<br />
public function getFolderChildren($fldId);<br />
public function isValidFolder($fldId);<br />
public function getFolderPath($uuid);<br />
</source><br />
<br />
=== Note ===<br />
<source lang="php"><br />
public function addNote($nodeId, $text);<br />
public function getNote($noteId);<br />
public function deleteNote($noteId);<br />
public function setNote($noteId, $text);<br />
public function listNotes($nodeId);<br />
</source><br />
<br />
=== PropertyGroup ===<br />
<source lang="php"><br />
public function addGroup($nodeId, $grpName);<br />
public function removeGroup($nodeId, $grpName);<br />
public function getGroups($nodeId);<br />
public function getAllGroups();<br />
public function getPropertyGroupProperties($nodeId, $grpName);<br />
public function setPropetyGroupProperties($nodeId, $grpName, $formElementList = array());<br />
public function setPropertyGroupPropertiesSimple($nodeId, $grpName, $properties = array());<br />
public function hasGroup($nodeId, $grpName);<br />
public function getPropertyGroupForm($grpName);<br />
</source><br />
<br />
=== Property ===<br />
<source lang="php"><br />
public function addCategory($nodeId, $catId);<br />
public function removeCategory($nodeId, $catId);<br />
public function addKeyword($nodeId, $keyword);<br />
public function removeKeyword($nodeId, $keyword);<br />
public function setEncryption($nodeId, $cipherName);<br />
public function unsetEncryption($nodeId);<br />
public function setSigned($nodeId, $signed);<br />
</source><br />
<br />
=== Search ===<br />
<source lang="php"><br />
public function findByContent($content);<br />
public function findByName($name);<br />
public function findByKeywords($keywords = array());<br />
public function find(QueryParams $queryParams);<br />
public function findPaginated(QueryParams $queryParams, $offset, $limit);<br />
public function findSimpleQueryPaginated($statement, $offset, $limit);<br />
public function findMoreLikeThis($uuid, $max);<br />
public function getKeywordMap($filter = array());<br />
public function getCategorizedDocuments($categoryId);<br />
public function saveSearch(QueryParams $params);<br />
public function updateSearch(QueryParams $params);<br />
public function getSearch($qpId);<br />
public function getAllSearchs();<br />
public function deleteSearch($qpId);<br />
</source><br />
<br />
[[Category: Extension Guide]]</div>
Sochoa.gmd