PHP Класс VersionPress\Api\VersionPressApi

Показать файл Открыть проект Примеры использования класса

Открытые методы

Метод Описание
__construct ( GitRepository $gitRepository, Reverter $reverter, SynchronizationProcess $synchronizationProcess, CommitMessageParser $commitMessageParser )
canRevert ( ) : WP_REST_Respons\WP_REST_Response | WP_Erro\WP_Error
checkPermissions ( WP_REST_Request $request ) : WP_Erro\WP_Error | boolean
commit ( WP_REST_Request $request ) : WP_REST_Respons\WP_REST_Response | WP_Erro\WP_Error Creates manual commit. Adds everything to stage.
discardChanges ( ) : WP_REST_Response Discards all changes in working directory.
displayWelcomePanel ( ) : WP_REST_Response
getAutocompleteConfig ( ) : WP_REST_Response Returns current WP configuration for autocomplete component.
getCommits ( WP_REST_Request $request ) : WP_REST_Respons\WP_REST_Response | WP_Erro\WP_Error
getDiff ( WP_REST_Request $request ) : WP_REST_Respons\WP_REST_Response | WP_Erro\WP_Error Returns diff of given commit.
getError ( string $status ) : WP_Error
getGitStatus ( ) : WP_REST_Response Returns list of files with modification types.
hideWelcomePanel ( ) : WP_REST_Response
registerRoutes ( ) Register the VersionPress related routes
revertCommits ( string $reverterMethod, array $commits ) : WP_REST_Respons\WP_REST_Response | WP_Erro\WP_Error
rollbackToCommit ( WP_REST_Request $request ) : WP_REST_Respons\WP_REST_Response | WP_Erro\WP_Error
shouldUpdate ( WP_REST_Request $request )
undoCommits ( WP_REST_Request $request ) : WP_REST_Respons\WP_REST_Response | WP_Erro\WP_Error

Приватные методы

Метод Описание
convertChangeInfo ( $changeInfo )
convertChangeInfoList ( $getChangeInfoList )
getFileChanges ( Commit $commit, boolean $skipVpdbFiles ) : array
getInitialCommitHash ( ) : string
handleAsAdminSectionRoute ( string $routeHandler ) : Closure Adds WP_ADMIN constant before route handling function is called. Routes calls are than evaluated as called in admin section of WordPress even if the routes are called using AJAX (WordPress native function is_admin() evaluates call correctly.
handleErrorOutput ( callable | string $routeHandler ) : Closure Prevents unexpected output from displaying to output, adds it to the response json instead.
registerRestRoute ( $route, $args = [], $override = false )
updateDatabase ( $status )

Описание методов

__construct() публичный Метод

public __construct ( GitRepository $gitRepository, Reverter $reverter, SynchronizationProcess $synchronizationProcess, CommitMessageParser $commitMessageParser )
$gitRepository VersionPress\Git\GitRepository
$reverter VersionPress\Git\Reverter
$synchronizationProcess VersionPress\Synchronizers\SynchronizationProcess
$commitMessageParser VersionPress\ChangeInfos\CommitMessageParser

canRevert() публичный Метод

public canRevert ( ) : WP_REST_Respons\WP_REST_Response | WP_Erro\WP_Error
Результат WP_REST_Respons\WP_REST_Response | WP_Erro\WP_Error

checkPermissions() публичный Метод

public checkPermissions ( WP_REST_Request $request ) : WP_Erro\WP_Error | boolean
$request WP_REST_Request
Результат WP_Erro\WP_Error | boolean

commit() публичный Метод

Creates manual commit. Adds everything to stage.
public commit ( WP_REST_Request $request ) : WP_REST_Respons\WP_REST_Response | WP_Erro\WP_Error
$request WP_REST_Request
Результат WP_REST_Respons\WP_REST_Response | WP_Erro\WP_Error

discardChanges() публичный Метод

Discards all changes in working directory.
public discardChanges ( ) : WP_REST_Response
Результат WP_REST_Response

displayWelcomePanel() публичный Метод

public displayWelcomePanel ( ) : WP_REST_Response
Результат WP_REST_Response

getAutocompleteConfig() публичный Метод

Returns current WP configuration for autocomplete component.
public getAutocompleteConfig ( ) : WP_REST_Response
Результат WP_REST_Response

getCommits() публичный Метод

public getCommits ( WP_REST_Request $request ) : WP_REST_Respons\WP_REST_Response | WP_Erro\WP_Error
$request WP_REST_Request
Результат WP_REST_Respons\WP_REST_Response | WP_Erro\WP_Error

getDiff() публичный Метод

If there's provided no commit hash, returns diff of working directory and HEAD.
public getDiff ( WP_REST_Request $request ) : WP_REST_Respons\WP_REST_Response | WP_Erro\WP_Error
$request WP_REST_Request
Результат WP_REST_Respons\WP_REST_Response | WP_Erro\WP_Error

getError() публичный Метод

public getError ( string $status ) : WP_Error
$status string
Результат WP_Error

getGitStatus() публичный Метод

Example: [ ["A", "some-file.txt"], ["M", "other-file.txt"] ] Modification types: ?? - untracked file A - added file M - modified file D - deleted file
public getGitStatus ( ) : WP_REST_Response
Результат WP_REST_Response

hideWelcomePanel() публичный Метод

public hideWelcomePanel ( ) : WP_REST_Response
Результат WP_REST_Response

registerRoutes() публичный Метод

Register the VersionPress related routes
public registerRoutes ( )

revertCommits() публичный Метод

public revertCommits ( string $reverterMethod, array $commits ) : WP_REST_Respons\WP_REST_Response | WP_Erro\WP_Error
$reverterMethod string
$commits array
Результат WP_REST_Respons\WP_REST_Response | WP_Erro\WP_Error

rollbackToCommit() публичный Метод

public rollbackToCommit ( WP_REST_Request $request ) : WP_REST_Respons\WP_REST_Response | WP_Erro\WP_Error
$request WP_REST_Request
Результат WP_REST_Respons\WP_REST_Response | WP_Erro\WP_Error

shouldUpdate() публичный Метод

public shouldUpdate ( WP_REST_Request $request )
$request WP_REST_Request

undoCommits() публичный Метод

public undoCommits ( WP_REST_Request $request ) : WP_REST_Respons\WP_REST_Response | WP_Erro\WP_Error
$request WP_REST_Request
Результат WP_REST_Respons\WP_REST_Response | WP_Erro\WP_Error