PHP 클래스 EtherpadLite\Client

파일 보기 프로젝트 열기: tomnomnom/etherpad-lite-client 1 사용 예제들

보호된 프로퍼티들

프로퍼티 타입 설명
$apiKey
$baseUrl

공개 메소드들

메소드 설명
__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

보호된 메소드들

메소드 설명
call ( $function, array $arguments = [], $method = 'GET' )
convertBools ( $candidate )
get ( $function, array $arguments = [] )
handleResult ( $result )
post ( $function, array $arguments = [] )

메소드 상세

__construct() 공개 메소드

public __construct ( $apiKey, $baseUrl = null )

call() 보호된 메소드

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

checkToken() 공개 메소드

checkToken
public checkToken ( )

convertBools() 보호된 메소드

protected convertBools ( $candidate )

copyPad() 공개 메소드

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

createAuthor() 공개 메소드

createAuthor
public createAuthor ( $name = null )

createAuthorIfNotExistsFor() 공개 메소드

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

createDiffHTML() 공개 메소드

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

createGroup() 공개 메소드

createGroup
public createGroup ( )

createGroupIfNotExistsFor() 공개 메소드

createGroupIfNotExistsFor
public createGroupIfNotExistsFor ( $groupMapper )

createGroupPad() 공개 메소드

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

createPad() 공개 메소드

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

createSession() 공개 메소드

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

deleteGroup() 공개 메소드

deleteGroup
public deleteGroup ( $groupID )

deletePad() 공개 메소드

deletePad
public deletePad ( $padID )

deleteSession() 공개 메소드

deleteSession
public deleteSession ( $sessionID )

get() 보호된 메소드

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

getAttributePool() 공개 메소드

getAttributePool
public getAttributePool ( $padID )

getAuthorName() 공개 메소드

getAuthorName
public getAuthorName ( $authorID )

getChatHead() 공개 메소드

getChatHead
public getChatHead ( $padID )

getChatHistory() 공개 메소드

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

getHTML() 공개 메소드

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

getLastEdited() 공개 메소드

getLastEdited
public getLastEdited ( $padID )

getPadID() 공개 메소드

getPadID
public getPadID ( $roID )

getPublicStatus() 공개 메소드

getPublicStatus
public getPublicStatus ( $padID )

getReadOnlyID() 공개 메소드

getReadOnlyID
public getReadOnlyID ( $padID )

getRevisionChangeset() 공개 메소드

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

getRevisionsCount() 공개 메소드

getRevisionsCount
public getRevisionsCount ( $padID )

getSavedRevisionsCount() 공개 메소드

getSavedRevisionsCount
public getSavedRevisionsCount ( $padID )

getSessionInfo() 공개 메소드

getSessionInfo
public getSessionInfo ( $sessionID )

getText() 공개 메소드

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

handleResult() 보호된 메소드

protected handleResult ( $result )

isPasswordProtected() 공개 메소드

isPasswordProtected
public isPasswordProtected ( $padID )

listAllGroups() 공개 메소드

listAllGroups
public listAllGroups ( )

listAllPads() 공개 메소드

listAllPads
public listAllPads ( )

listAuthorsOfPad() 공개 메소드

listAuthorsOfPad
public listAuthorsOfPad ( $padID )

listPads() 공개 메소드

listPads
public listPads ( $groupID )

listPadsOfAuthor() 공개 메소드

listPadsOfAuthor
public listPadsOfAuthor ( $authorID )

listSavedRevisions() 공개 메소드

listSavedRevisions
public listSavedRevisions ( $padID )

listSessionsOfAuthor() 공개 메소드

listSessionsOfAuthor
public listSessionsOfAuthor ( $authorID )

listSessionsOfGroup() 공개 메소드

listSessionsOfGroup
public listSessionsOfGroup ( $groupID )

movePad() 공개 메소드

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

padUsers() 공개 메소드

padUsers
public padUsers ( $padID )

padUsersCount() 공개 메소드

padUsersCount
public padUsersCount ( $padID )

post() 보호된 메소드

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

restoreRevision() 공개 메소드

restoreRevision
public restoreRevision ( $padID, $rev )

saveRevision() 공개 메소드

saveRevision
public saveRevision ( $padID, $rev )

sendClientsMessage() 공개 메소드

sendClientsMessage
public sendClientsMessage ( $padID, $msg )

setHTML() 공개 메소드

setHTML
public setHTML ( $padID, $html )

setPassword() 공개 메소드

setPassword
public setPassword ( $padID, $password )

setPublicStatus() 공개 메소드

setPublicStatus
public setPublicStatus ( $padID, $publicStatus )

setText() 공개 메소드

setText
public setText ( $padID, $text )

프로퍼티 상세

$apiKey 보호되어 있는 프로퍼티

protected $apiKey

$baseUrl 보호되어 있는 프로퍼티

protected $baseUrl