nextcloud/lib/public/Files/LockNotAcquiredException.php

63 lines
1.8 KiB
PHP
Raw Normal View History

2014-05-21 01:44:57 +04:00
<?php
/**
2016-07-21 18:07:57 +03:00
* @copyright Copyright (c) 2016, ownCloud, Inc.
*
2015-03-26 13:44:34 +03:00
* @author Morris Jobke <hey@morrisjobke.de>
* @author Owen Winkler <a_github@midnightcircus.com>
2016-07-21 19:13:36 +03:00
* @author Robin Appelman <robin@icewind.nl>
2014-05-21 01:44:57 +04:00
*
2015-03-26 13:44:34 +03:00
* @license AGPL-3.0
2014-05-21 01:44:57 +04:00
*
2015-03-26 13:44:34 +03:00
* This code is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License, version 3,
* as published by the Free Software Foundation.
*
* This program is distributed in the hope that it will be useful,
2014-05-21 01:44:57 +04:00
* but WITHOUT ANY WARRANTY; without even the implied warranty of
2015-03-26 13:44:34 +03:00
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
2014-05-21 01:44:57 +04:00
*
2015-03-26 13:44:34 +03:00
* You should have received a copy of the GNU Affero General Public License, version 3,
* along with this program. If not, see <http://www.gnu.org/licenses/>
2014-05-21 01:44:57 +04:00
*
*/
/**
* Public interface of ownCloud for apps to use.
* Files/LockNotAcquiredException class
*/
2014-05-21 01:44:57 +04:00
// use OCP namespace for all classes that are considered public.
// This means that they should be used by apps instead of the internal ownCloud classes
namespace OCP\Files;
/**
* Exception for a file that is locked
* @since 7.0.0
2014-05-21 01:44:57 +04:00
*/
class LockNotAcquiredException extends \Exception {
/** @var string $path The path that could not be locked */
public $path;
/** @var integer $lockType The type of the lock that was attempted */
public $lockType;
2015-06-19 11:51:36 +03:00
/**
* @since 7.0.0
*/
2014-05-21 01:44:57 +04:00
public function __construct($path, $lockType, $code = 0, \Exception $previous = null) {
2014-08-31 12:05:59 +04:00
$message = \OC::$server->getL10N('core')->t('Could not obtain lock type %d on "%s".', array($lockType, $path));
2014-05-21 01:44:57 +04:00
parent::__construct($message, $code, $previous);
}
2015-06-19 11:51:36 +03:00
/**
* custom string representation of object
*
* @return string
* @since 7.0.0
*/
2014-05-21 01:44:57 +04:00
public function __toString() {
return __CLASS__ . ": [{$this->code}]: {$this->message}\n";
}
2014-08-31 12:05:59 +04:00
}