PHP Class Evernote\Client

Exibir arquivo Open project: evernote/evernote-cloud-sdk-php Class Usage Examples

Protected Properties

Property Type Description
$advancedClient Evernote\AdvancedClient
$businessAuth EDAM\UserStore\AuthenticationResult
$businessNoteStore EDAM\NoteStore\NoteStoreClient
$businessToken string
$china boolean
$isBusinessUser
$logger Psr\Log\LoggerInterface
$sandbox boolean
$token string
$userNoteStore EDAM\NoteStore\NoteStoreClient

Public Methods

Method Description
__construct ( string | null $token = null, boolean $sandbox = true, Evernote\AdvancedClient | null $advancedClient = null, Psr\Log\LoggerInterface $logger = null, boolean $china = false )
deleteNote ( Evernote\Model\Note $note ) : boolean Deletes a note
findNotesWithSearch ( $noteSearch, Evernote\Model\Notebook $notebook = null, integer $scope, integer $sortOrder, integer $maxResults = 20 ) : array | boolean Searches for notes
getAdvancedClient ( ) : Evernote\AdvancedClient Returns the advancedClient
getBusinessLinkedNotebooks ( ) : array Returns the list of notebooks shared to the user through the business account
getBusinessNoteStore ( ) : EDAM\NoteStore\NoteStoreClient | mixed Returns the business notestore
getBusinessSharedNotebooks ( ) : null Returns the list of notebooks shared by the user with her business account
getBusinessToken ( ) : string Returns the token used to access the business notestore
getChina ( ) : boolean Gets the current china flag
getNote ( $guid, null $scope = null ) : Evernote\Model\Note | null Retrieves an existing note
getNotebook ( $notebook_guid, null $scope = null ) : Evernote\Model\Notebook | null Retrieves a notebook
getSandbox ( ) : boolean Gets the current sandbox flag
getToken ( ) : string Returns the current authentication token
getUserNotestore ( ) : EDAM\NoteStore\NoteStoreClient | mixed Returns the personal notestore of the user
isAppNotebookToken ( $token ) : boolean Checks if the token is an "app notebook" one
isBusinessUser ( ) : boolean Returns a boolean indicating if the user has a business account
listLinkedNotebooks ( ) : array Returns the list of notebooks shared to the user
listNotebooks ( ) : array Returns the list of notebooks
listPersonalNotebooks ( ) : array Returns the list of personal notebooks
listSharedNotebooks ( ) : array Returns the list of notebooks shared by the user
moveNote ( Evernote\Model\Note $note, Evernote\Model\Notebook $notebook ) : Evernote\Model\Note Moves a note to another notebook
replaceNote ( Evernote\Model\Note $noteToReplace, Evernote\Model\Note $note ) : Evernote\Model\Note Replaces an existing note by another one (new or existing)
setAdvancedClient ( Evernote\AdvancedClient $advancedClient ) Sets the advancedClient
setChina ( boolean $china ) Sets the china flag to true or false
setSandbox ( boolean $sandbox ) Sets the sandbox flag to true or false
setToken ( string $token ) Sets the authentication token
shareNote ( Evernote\Model\Note $note ) : null | string Shares a note and returns the share url
uploadNote ( Evernote\Model\Note $note, Evernote\Model\Notebook $notebook = null ) : Evernote\Model\Note Sends a new Note to the API

Protected Methods

Method Description
compareByCreated ( $obj1, $obj2 )
compareByTitle ( $obj1, $obj2 )
compareByUpdated ( $obj1, $obj2 )
findNotes_findInBusinessScopeWithContext ( $context )
findNotes_findInLinkedScopeWithContext ( $context )
findNotes_findInPersonalScopeWithContext ( $context )
findNotes_listNotebooksWithContext ( $context )
findNotes_nextFindInLinkedScopeWithContext ( $context )
findNotes_processResultsWithContext ( $context )
getBusinessAuth ( ) : EDAM\UserStore\AuthenticationResult
getNoteBookByLinkedNotebook ( EDAM\Types\LinkedNotebook $linkedNotebook )
getNoteInstance ( EDAM\Types\Note $edamNote = null, $noteStore = null, $token = null )
getNoteStore ( $noteStoreUrl ) ************************
getShardIdFromToken ( $token )
getShareUrl ( $guid, $shardId, $shareKey, $serviceHost )
getSharedNotebookAuthResult ( EDAM\Types\LinkedNotebook $linkedNotebook )
isFlagSet ( $flags, $flag )

Method Details

__construct() public method

public __construct ( string | null $token = null, boolean $sandbox = true, Evernote\AdvancedClient | null $advancedClient = null, Psr\Log\LoggerInterface $logger = null, boolean $china = false )
$token string | null
$sandbox boolean
$advancedClient Evernote\AdvancedClient | null
$logger Psr\Log\LoggerInterface
$china boolean

compareByCreated() protected method

protected compareByCreated ( $obj1, $obj2 )

compareByTitle() protected method

protected compareByTitle ( $obj1, $obj2 )

compareByUpdated() protected method

protected compareByUpdated ( $obj1, $obj2 )

deleteNote() public method

Deletes a note
public deleteNote ( Evernote\Model\Note $note ) : boolean
$note Evernote\Model\Note
return boolean

findNotesWithSearch() public method

Searches for notes
public findNotesWithSearch ( $noteSearch, Evernote\Model\Notebook $notebook = null, integer $scope, integer $sortOrder, integer $maxResults = 20 ) : array | boolean
$noteSearch
$notebook Evernote\Model\Notebook
$scope integer
$sortOrder integer
$maxResults integer
return array | boolean

findNotes_findInBusinessScopeWithContext() protected method

findNotes_findInLinkedScopeWithContext() protected method

findNotes_findInPersonalScopeWithContext() protected method

findNotes_listNotebooksWithContext() protected method

protected findNotes_listNotebooksWithContext ( $context )

findNotes_nextFindInLinkedScopeWithContext() protected method

findNotes_processResultsWithContext() protected method

protected findNotes_processResultsWithContext ( $context )

getAdvancedClient() public method

Returns the advancedClient
public getAdvancedClient ( ) : Evernote\AdvancedClient
return Evernote\AdvancedClient

getBusinessAuth() protected method

protected getBusinessAuth ( ) : EDAM\UserStore\AuthenticationResult
return EDAM\UserStore\AuthenticationResult

getBusinessLinkedNotebooks() public method

Returns the list of notebooks shared to the user through the business account
public getBusinessLinkedNotebooks ( ) : array
return array

getBusinessNoteStore() public method

Returns the business notestore
public getBusinessNoteStore ( ) : EDAM\NoteStore\NoteStoreClient | mixed
return EDAM\NoteStore\NoteStoreClient | mixed

getBusinessSharedNotebooks() public method

Returns the list of notebooks shared by the user with her business account
public getBusinessSharedNotebooks ( ) : null
return null

getBusinessToken() public method

Returns the token used to access the business notestore
public getBusinessToken ( ) : string
return string

getChina() public method

Gets the current china flag
public getChina ( ) : boolean
return boolean

getNote() public method

Retrieves an existing note
public getNote ( $guid, null $scope = null ) : Evernote\Model\Note | null
$guid
$scope null
return Evernote\Model\Note | null

getNoteBookByLinkedNotebook() protected method

protected getNoteBookByLinkedNotebook ( EDAM\Types\LinkedNotebook $linkedNotebook )
$linkedNotebook EDAM\Types\LinkedNotebook

getNoteInstance() protected method

protected getNoteInstance ( EDAM\Types\Note $edamNote = null, $noteStore = null, $token = null )
$edamNote EDAM\Types\Note

getNoteStore() protected method

************************
protected getNoteStore ( $noteStoreUrl )

getNotebook() public method

Retrieves a notebook
public getNotebook ( $notebook_guid, null $scope = null ) : Evernote\Model\Notebook | null
$notebook_guid
$scope null
return Evernote\Model\Notebook | null

getSandbox() public method

Gets the current sandbox flag
public getSandbox ( ) : boolean
return boolean

getShardIdFromToken() protected method

protected getShardIdFromToken ( $token )

getShareUrl() protected method

protected getShareUrl ( $guid, $shardId, $shareKey, $serviceHost )

getSharedNotebookAuthResult() protected method

protected getSharedNotebookAuthResult ( EDAM\Types\LinkedNotebook $linkedNotebook )
$linkedNotebook EDAM\Types\LinkedNotebook

getToken() public method

Returns the current authentication token
public getToken ( ) : string
return string

getUserNotestore() public method

Returns the personal notestore of the user
public getUserNotestore ( ) : EDAM\NoteStore\NoteStoreClient | mixed
return EDAM\NoteStore\NoteStoreClient | mixed

isAppNotebookToken() public method

Checks if the token is an "app notebook" one
public isAppNotebookToken ( $token ) : boolean
$token
return boolean

isBusinessUser() public method

Returns a boolean indicating if the user has a business account
public isBusinessUser ( ) : boolean
return boolean

isFlagSet() protected method

protected isFlagSet ( $flags, $flag )

listLinkedNotebooks() public method

Returns the list of notebooks shared to the user
public listLinkedNotebooks ( ) : array
return array

listNotebooks() public method

Returns the list of notebooks
public listNotebooks ( ) : array
return array

listPersonalNotebooks() public method

Returns the list of personal notebooks
public listPersonalNotebooks ( ) : array
return array

listSharedNotebooks() public method

Returns the list of notebooks shared by the user
public listSharedNotebooks ( ) : array
return array

moveNote() public method

Moves a note to another notebook
public moveNote ( Evernote\Model\Note $note, Evernote\Model\Notebook $notebook ) : Evernote\Model\Note
$note Evernote\Model\Note
$notebook Evernote\Model\Notebook
return Evernote\Model\Note

replaceNote() public method

Replaces an existing note by another one (new or existing)
public replaceNote ( Evernote\Model\Note $noteToReplace, Evernote\Model\Note $note ) : Evernote\Model\Note
$noteToReplace Evernote\Model\Note
$note Evernote\Model\Note
return Evernote\Model\Note

setAdvancedClient() public method

Sets the advancedClient
public setAdvancedClient ( Evernote\AdvancedClient $advancedClient )
$advancedClient Evernote\AdvancedClient

setChina() public method

Sets the china flag to true or false
public setChina ( boolean $china )
$china boolean

setSandbox() public method

Sets the sandbox flag to true or false
public setSandbox ( boolean $sandbox )
$sandbox boolean

setToken() public method

Sets the authentication token
public setToken ( string $token )
$token string

shareNote() public method

Shares a note and returns the share url
public shareNote ( Evernote\Model\Note $note ) : null | string
$note Evernote\Model\Note
return null | string

uploadNote() public method

Sends a new Note to the API
public uploadNote ( Evernote\Model\Note $note, Evernote\Model\Notebook $notebook = null ) : Evernote\Model\Note
$note Evernote\Model\Note
$notebook Evernote\Model\Notebook
return Evernote\Model\Note

Property Details

$advancedClient protected_oe property

protected AdvancedClient,Evernote $advancedClient
return Evernote\AdvancedClient

$businessAuth protected_oe property

protected AuthenticationResult,EDAM\UserStore $businessAuth
return EDAM\UserStore\AuthenticationResult

$businessNoteStore protected_oe property

protected NoteStoreClient,EDAM\NoteStore $businessNoteStore
return EDAM\NoteStore\NoteStoreClient

$businessToken protected_oe property

protected string $businessToken
return string

$china protected_oe property

protected bool $china
return boolean

$isBusinessUser protected_oe property

protected $isBusinessUser

$logger protected_oe property

protected LoggerInterface,Psr\Log $logger
return Psr\Log\LoggerInterface

$sandbox protected_oe property

protected bool $sandbox
return boolean

$token protected_oe property

protected string $token
return string

$userNoteStore protected_oe property

protected NoteStoreClient,EDAM\NoteStore $userNoteStore
return EDAM\NoteStore\NoteStoreClient