PHP Class EtherpadLite\Client

Show file Open project: tomnomnom/etherpad-lite-client Class Usage Examples

Protected Properties

Property Type Description
$apiKey
$baseUrl

Public Methods

Method Description
__construct ( $apiKey, $baseUrl = null )
checkToken ( ) checkToken
copyPad ( $sourceID, $destinationID, $force = null ) copyPad
createAuthor ( $name = null ) createAuthor
createAuthorIfNotExistsFor ( $authorMapper, $name = null ) createAuthorIfNotExistsFor
createDiffHTML ( $padID, $startRev, $endRev ) createDiffHTML
createGroup ( ) createGroup
createGroupIfNotExistsFor ( $groupMapper ) createGroupIfNotExistsFor
createGroupPad ( $groupID, $padName, $text = null ) createGroupPad
createPad ( $padID, $text = null ) createPad
createSession ( $groupID, $authorID, $validUntil ) createSession
deleteGroup ( $groupID ) deleteGroup
deletePad ( $padID ) deletePad
deleteSession ( $sessionID ) deleteSession
getAttributePool ( $padID ) getAttributePool
getAuthorName ( $authorID ) getAuthorName
getChatHead ( $padID ) getChatHead
getChatHistory ( $padID, $start = null, $end = null ) getChatHistory
getHTML ( $padID, $rev = null ) getHTML
getLastEdited ( $padID ) getLastEdited
getPadID ( $roID ) getPadID
getPublicStatus ( $padID ) getPublicStatus
getReadOnlyID ( $padID ) getReadOnlyID
getRevisionChangeset ( $padID, $rev = null ) getRevisionChangeset
getRevisionsCount ( $padID ) getRevisionsCount
getSavedRevisionsCount ( $padID ) getSavedRevisionsCount
getSessionInfo ( $sessionID ) getSessionInfo
getText ( $padID, $rev = null ) getText
isPasswordProtected ( $padID ) isPasswordProtected
listAllGroups ( ) listAllGroups
listAllPads ( ) listAllPads
listAuthorsOfPad ( $padID ) listAuthorsOfPad
listPads ( $groupID ) listPads
listPadsOfAuthor ( $authorID ) listPadsOfAuthor
listSavedRevisions ( $padID ) listSavedRevisions
listSessionsOfAuthor ( $authorID ) listSessionsOfAuthor
listSessionsOfGroup ( $groupID ) listSessionsOfGroup
movePad ( $sourceID, $destinationID, $force = null ) movePad
padUsers ( $padID ) padUsers
padUsersCount ( $padID ) padUsersCount
restoreRevision ( $padID, $rev ) restoreRevision
saveRevision ( $padID, $rev ) saveRevision
sendClientsMessage ( $padID, $msg ) sendClientsMessage
setHTML ( $padID, $html ) setHTML
setPassword ( $padID, $password ) setPassword
setPublicStatus ( $padID, $publicStatus ) setPublicStatus
setText ( $padID, $text ) setText

Protected Methods

Method Description
call ( $function, array $arguments = [], $method = 'GET' )
convertBools ( $candidate )
get ( $function, array $arguments = [] )
handleResult ( $result )
post ( $function, array $arguments = [] )

Method Details

__construct() public method

public __construct ( $apiKey, $baseUrl = null )

call() protected method

protected call ( $function, array $arguments = [], $method = 'GET' )
$arguments array

checkToken() public method

checkToken
public checkToken ( )

convertBools() protected method

protected convertBools ( $candidate )

copyPad() public method

copyPad
public copyPad ( $sourceID, $destinationID, $force = null )

createAuthor() public method

createAuthor
public createAuthor ( $name = null )

createAuthorIfNotExistsFor() public method

createAuthorIfNotExistsFor
public createAuthorIfNotExistsFor ( $authorMapper, $name = null )

createDiffHTML() public method

createDiffHTML
public createDiffHTML ( $padID, $startRev, $endRev )

createGroup() public method

createGroup
public createGroup ( )

createGroupIfNotExistsFor() public method

createGroupIfNotExistsFor
public createGroupIfNotExistsFor ( $groupMapper )

createGroupPad() public method

createGroupPad
public createGroupPad ( $groupID, $padName, $text = null )

createPad() public method

createPad
public createPad ( $padID, $text = null )

createSession() public method

createSession
public createSession ( $groupID, $authorID, $validUntil )

deleteGroup() public method

deleteGroup
public deleteGroup ( $groupID )

deletePad() public method

deletePad
public deletePad ( $padID )

deleteSession() public method

deleteSession
public deleteSession ( $sessionID )

get() protected method

protected get ( $function, array $arguments = [] )
$arguments array

getAttributePool() public method

getAttributePool
public getAttributePool ( $padID )

getAuthorName() public method

getAuthorName
public getAuthorName ( $authorID )

getChatHead() public method

getChatHead
public getChatHead ( $padID )

getChatHistory() public method

getChatHistory
public getChatHistory ( $padID, $start = null, $end = null )

getHTML() public method

getHTML
public getHTML ( $padID, $rev = null )

getLastEdited() public method

getLastEdited
public getLastEdited ( $padID )

getPadID() public method

getPadID
public getPadID ( $roID )

getPublicStatus() public method

getPublicStatus
public getPublicStatus ( $padID )

getReadOnlyID() public method

getReadOnlyID
public getReadOnlyID ( $padID )

getRevisionChangeset() public method

getRevisionChangeset
public getRevisionChangeset ( $padID, $rev = null )

getRevisionsCount() public method

getRevisionsCount
public getRevisionsCount ( $padID )

getSavedRevisionsCount() public method

getSavedRevisionsCount
public getSavedRevisionsCount ( $padID )

getSessionInfo() public method

getSessionInfo
public getSessionInfo ( $sessionID )

getText() public method

getText
public getText ( $padID, $rev = null )

handleResult() protected method

protected handleResult ( $result )

isPasswordProtected() public method

isPasswordProtected
public isPasswordProtected ( $padID )

listAllGroups() public method

listAllGroups
public listAllGroups ( )

listAllPads() public method

listAllPads
public listAllPads ( )

listAuthorsOfPad() public method

listAuthorsOfPad
public listAuthorsOfPad ( $padID )

listPads() public method

listPads
public listPads ( $groupID )

listPadsOfAuthor() public method

listPadsOfAuthor
public listPadsOfAuthor ( $authorID )

listSavedRevisions() public method

listSavedRevisions
public listSavedRevisions ( $padID )

listSessionsOfAuthor() public method

listSessionsOfAuthor
public listSessionsOfAuthor ( $authorID )

listSessionsOfGroup() public method

listSessionsOfGroup
public listSessionsOfGroup ( $groupID )

movePad() public method

movePad
public movePad ( $sourceID, $destinationID, $force = null )

padUsers() public method

padUsers
public padUsers ( $padID )

padUsersCount() public method

padUsersCount
public padUsersCount ( $padID )

post() protected method

protected post ( $function, array $arguments = [] )
$arguments array

restoreRevision() public method

restoreRevision
public restoreRevision ( $padID, $rev )

saveRevision() public method

saveRevision
public saveRevision ( $padID, $rev )

sendClientsMessage() public method

sendClientsMessage
public sendClientsMessage ( $padID, $msg )

setHTML() public method

setHTML
public setHTML ( $padID, $html )

setPassword() public method

setPassword
public setPassword ( $padID, $password )

setPublicStatus() public method

setPublicStatus
public setPublicStatus ( $padID, $publicStatus )

setText() public method

setText
public setText ( $padID, $text )

Property Details

$apiKey protected property

protected $apiKey

$baseUrl protected property

protected $baseUrl