Skip to content

refactor: Remove old deprecated methods from OCP\Calendar #60955

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
CarlSchwan wants to merge 1 commit into
base: master
Choose a base branch
from
+28 −358
Open

refactor: Remove old deprecated methods from OCP\Calendar #60955

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 3 additions & 46 deletions lib/private/Calendar/Resource/Manager.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,6 @@

use OC\AppFramework\Bootstrap\Coordinator;
use OC\Calendar\ResourcesRoomsUpdater;
use OCP\AppFramework\QueryException;
use OCP\Calendar\Resource\IBackend;
use OCP\Calendar\Resource\IManager;
use Psr\Container\ContainerInterface;
Expand All @@ -21,11 +20,11 @@ class Manager implements IManager {

/**
* @var string[] holds all registered resource backends
* @psalm-var class-string<IBackend>[]
* @psalm-var list<class-string<IBackend>>
*/
private array $backends = [];

/** @var IBackend[] holds all backends that have been initialized already */
/** @var array<class-string<IBackend>, IBackend> holds all backends that have been initialized already */
private array $initializedBackends = [];

public function __construct(
Expand All @@ -35,26 +34,6 @@ public function __construct(
) {
}

/**
* Registers a resource backend
*
* @since 14.0.0
*/
#[\Override]
public function registerBackend(string $backendClass): void {
$this->backends[$backendClass] = $backendClass;
}

/**
* Unregisters a resource backend
*
* @since 14.0.0
*/
#[\Override]
public function unregisterBackend(string $backendClass): void {
unset($this->backends[$backendClass], $this->initializedBackends[$backendClass]);
}

private function fetchBootstrapBackends(): void {
if ($this->bootstrapBackendsLoaded) {
return;
Expand All @@ -71,12 +50,6 @@ private function fetchBootstrapBackends(): void {
}
}

/**
* @return IBackend[]
* @throws QueryException
* @since 14.0.0
*/
#[\Override]
public function getBackends():array {
$this->fetchBootstrapBackends();

Expand All @@ -91,12 +64,7 @@ public function getBackends():array {
return array_values($this->initializedBackends);
}

/**
* @param string $backendId
* @throws QueryException
*/
#[\Override]
public function getBackend($backendId): ?IBackend {
public function getBackend(string $backendId): ?IBackend {
$backends = $this->getBackends();
foreach ($backends as $backend) {
if ($backend->getBackendIdentifier() === $backendId) {
Expand All @@ -107,17 +75,6 @@ public function getBackend($backendId): ?IBackend {
return null;
}

/**
* removes all registered backend instances
*
* @since 14.0.0
*/
#[\Override]
public function clear(): void {
$this->backends = [];
$this->initializedBackends = [];
}

#[\Override]
public function update(): void {
$this->updater->updateResources();
Expand Down
18 changes: 5 additions & 13 deletions lib/private/Calendar/ResourcesRoomsUpdater.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,7 @@
use OCP\Calendar\BackendTemporarilyUnavailableException;
use OCP\Calendar\IMetadataProvider;
use OCP\Calendar\Resource\IBackend as IResourceBackend;
use OCP\Calendar\Resource\IManager as IResourceManager;
use OCP\Calendar\Resource\IResource;
use OCP\Calendar\Room\IManager as IRoomManager;
use OCP\Calendar\Room\IRoom;
use OCP\IDBConnection;
use Psr\Container\ContainerInterface;
Expand All @@ -33,7 +31,7 @@ public function __construct(
*/
public function updateResources(): void {
$this->updateFromBackend(
$this->container->get(IResourceManager::class),
$this->container->get(Resource\Manager::class),
'calendar_resources',
'calendar_resources_md',
'resource_id',
Expand All @@ -46,7 +44,7 @@ public function updateResources(): void {
*/
public function updateRooms(): void {
$this->updateFromBackend(
$this->container->get(IRoomManager::class),
$this->container->get(Room\Manager::class),
'calendar_rooms',
'calendar_rooms_md',
'room_id',
Expand All @@ -57,7 +55,7 @@ public function updateRooms(): void {
/**
* Update cache from one specific backend manager, either ResourceManager or RoomManager
*
* @param IResourceManager|IRoomManager $backendManager
* @param Resource\Manager|Room\Manager $backendManager
*/
private function updateFromBackend($backendManager,
string $dbTable,
Expand Down Expand Up @@ -311,15 +309,9 @@ private function serializeGroupRestrictions(array $groups): string {
/**
* Gets all metadata of a backend
*
* @param IResource|IRoom $resource
*
* @return array
* @return array<string, ?string>
*/
private function getAllMetadataOfBackend($resource): array {
if (!($resource instanceof IMetadataProvider)) {
return [];
}

private function getAllMetadataOfBackend(IMetadataProvider $resource): array {
$keys = $resource->getAllAvailableMetadataKeys();
$metadata = [];
foreach ($keys as $key) {
Expand Down
48 changes: 2 additions & 46 deletions lib/private/Calendar/Room/Manager.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,6 @@

use OC\AppFramework\Bootstrap\Coordinator;
use OC\Calendar\ResourcesRoomsUpdater;
use OCP\AppFramework\QueryException;
use OCP\Calendar\Room\IBackend;
use OCP\Calendar\Room\IManager;
use Psr\Container\ContainerInterface;
Expand All @@ -35,27 +34,6 @@ public function __construct(
) {
}

/**
* Registers a resource backend
*
* @since 14.0.0
*/
#[\Override]
public function registerBackend(string $backendClass): void {
$this->backends[$backendClass] = $backendClass;
}

/**
* Unregisters a resource backend
*
* @param string $backendClass
* @since 14.0.0
*/
#[\Override]
public function unregisterBackend(string $backendClass): void {
unset($this->backends[$backendClass], $this->initializedBackends[$backendClass]);
}

private function fetchBootstrapBackends(): void {
if ($this->bootstrapBackendsLoaded) {
return;
Expand All @@ -72,12 +50,6 @@ private function fetchBootstrapBackends(): void {
}
}

/**
* @return IBackend[]
* @throws QueryException
* @since 14.0.0
*/
#[\Override]
public function getBackends():array {
$this->fetchBootstrapBackends();

Expand All @@ -89,7 +61,7 @@ public function getBackends():array {
/**
* @todo fetch from the app container
*
* The backend might have services injected that can't be build from the
* The backend might have services injected that can't be built from the
* server container.
*/
$this->initializedBackends[$backend] = $this->container->get($backend);
Expand All @@ -98,12 +70,7 @@ public function getBackends():array {
return array_values($this->initializedBackends);
}

/**
* @param string $backendId
* @throws QueryException
*/
#[\Override]
public function getBackend($backendId): ?IBackend {
public function getBackend(string $backendId): ?IBackend {
$backends = $this->getBackends();
foreach ($backends as $backend) {
if ($backend->getBackendIdentifier() === $backendId) {
Expand All @@ -114,17 +81,6 @@ public function getBackend($backendId): ?IBackend {
return null;
}

/**
* removes all registered backend instances
*
* @since 14.0.0
*/
#[\Override]
public function clear(): void {
$this->backends = [];
$this->initializedBackends = [];
}

#[\Override]
public function update(): void {
$this->updater->updateRooms();
Expand Down
43 changes: 0 additions & 43 deletions lib/public/Calendar/Resource/IManager.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,49 +13,6 @@
* @since 14.0.0
*/
interface IManager {
/**
* Registers a resource backend
*
* @param string $backendClass
* @return void
* @since 14.0.0
* @deprecated 24.0.0 use \OCP\AppFramework\Bootstrap\IRegistrationContext::registerCalendarResourceBackend
*/
public function registerBackend(string $backendClass);

/**
* Unregisters a resource backend
*
* @param string $backendClass
* @return void
* @since 14.0.0
* @deprecated 24.0.0
*/
public function unregisterBackend(string $backendClass);

/**
* @return IBackend[]
* @since 14.0.0
* @deprecated 24.0.0
*/
public function getBackends():array;

/**
* @param string $backendId
* @return IBackend|null
* @since 14.0.0
* @deprecated 24.0.0
*/
public function getBackend($backendId);

/**
* removes all registered backend instances
* @return void
* @since 14.0.0
* @deprecated 24.0.0
*/
public function clear();

/**
* Update all resources from all backends right now.
*
Expand Down
8 changes: 4 additions & 4 deletions lib/public/Calendar/Room/IBackend.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
*/
interface IBackend {
/**
* get a list of all rooms in this backend
* Get a list of all rooms in this backend.
*
* @throws BackendTemporarilyUnavailableException
* @return IRoom[]
Expand All @@ -25,7 +25,7 @@ interface IBackend {
public function getAllRooms():array;

/**
* get a list of all room identifiers in this backend
* Get a list of all room identifiers in this backend.
*
* @throws BackendTemporarilyUnavailableException
* @return string[]
Expand All @@ -34,7 +34,7 @@ public function getAllRooms():array;
public function listAllRooms():array;

/**
* get a room by it's id
* Get a room by its id.
*
* @param string $id
* @throws BackendTemporarilyUnavailableException
Expand All @@ -44,7 +44,7 @@ public function listAllRooms():array;
public function getRoom($id);

/**
* Get unique identifier of the backend
* Get unique identifier of the backend.
*
* @return string
* @since 14.0.0
Expand Down
43 changes: 0 additions & 43 deletions lib/public/Calendar/Room/IManager.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,49 +13,6 @@
* @since 14.0.0
*/
interface IManager {
/**
* Registers a room backend
*
* @param string $backendClass
* @return void
* @since 14.0.0
* @deprecated 24.0.0 use \OC\AppFramework\Bootstrap\::registerCalendarRoomBackend
*/
public function registerBackend(string $backendClass);

/**
* Unregisters a room backend
*
* @param string $backendClass
* @return void
* @since 14.0.0
* @deprecated 24.0.0
*/
public function unregisterBackend(string $backendClass);

/**
* @return IBackend[]
* @since 14.0.0
* @deprecated 24.0.0
*/
public function getBackends():array;

/**
* @param string $backendId
* @return IBackend|null
* @since 14.0.0
* @deprecated 24.0.0
*/
public function getBackend($backendId);

/**
* removes all registered backend instances
* @return void
* @since 14.0.0
* @deprecated 24.0.0
*/
public function clear();

/**
* Update all rooms from all backends right now.
*
Expand Down
Loading
Loading