nextcloud/lib/public/DirectEditing/IToken.php
Christoph Wurst caff1023ea
Format control structures, classes, methods and function
To continue this formatting madness, here's a tiny patch that adds
unified formatting for control structures like if and loops as well as
classes, their methods and anonymous functions. This basically forces
the constructs to start on the same line. This is not exactly what PSR2
wants, but I think we can have a few exceptions with "our" style. The
starting of braces on the same line is pracrically standard for our
code.

This also removes and empty lines from method/function bodies at the
beginning and end.

Signed-off-by: Christoph Wurst <christoph@winzerhof-wurst.at>
2020-04-10 14:19:56 +02:00

83 lines
1.7 KiB
PHP

<?php
/**
* @copyright Copyright (c) 2019 Julius Härtl <jus@bitgrid.net>
*
* @author Julius Härtl <jus@bitgrid.net>
*
* @license GNU AGPL version 3 or any later version
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
*/
namespace OCP\DirectEditing;
use OCP\Files\File;
use OCP\Files\NotFoundException;
/**
* @since 18.0.0
*/
interface IToken {
/**
* Extend the token validity time
*
* @since 18.0.0
*/
public function extend(): void;
/**
* Invalidate the token
*
* @since 18.0.0
*/
public function invalidate(): void;
/**
* Check if the token has already been used
*
* @since 18.0.0
* @return bool
*/
public function hasBeenAccessed(): bool;
/**
* Change to the user scope of the token
*
* @since 18.0.0
*/
public function useTokenScope(): void;
/**
* Get the file that is related to the token
*
* @since 18.0.0
* @return File
* @throws NotFoundException
*/
public function getFile(): File;
/**
* @since 18.0.0
* @return string
*/
public function getEditor(): string;
/**
* @since 18.0.0
* @return string
*/
public function getUser(): string;
}