Skip to content
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.

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

Add deprecation. #76

Merged
merged 4 commits into from
Nov 28, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
3 changes: 3 additions & 0 deletions src/Db/DbResolver.php
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,9 @@
use Doctrine\DBAL\Connection;
use Pimcore\Db;

/**
* @deprecated Will be marked as internal and final in v2.0.0
*/
class DbResolver implements DbResolverInterface
{
public function getConnection(): Connection
Expand Down
3 changes: 3 additions & 0 deletions src/Db/DbResolverInterface.php
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,9 @@

use Doctrine\DBAL\Connection;

/**
* @deprecated Will be marked as internal in v2.0.0
*/
interface DbResolverInterface
{
public function getConnection(): Connection;
Expand Down
3 changes: 3 additions & 0 deletions src/Lib/Cache/RuntimeCacheResolver.php
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,9 @@

use Pimcore\Cache\RuntimeCache;

/**
* @deprecated Will be marked as internal and final in v2.0.0
*/
class RuntimeCacheResolver implements RuntimeCacheResolverInterface
{
public function load(string $id): mixed
Expand Down
3 changes: 3 additions & 0 deletions src/Lib/Cache/RuntimeCacheResolverInterface.php
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,9 @@

namespace Pimcore\Bundle\StaticResolverBundle\Lib\Cache;

/**
* @deprecated Will be marked as internal in v2.0.0
*/
interface RuntimeCacheResolverInterface
{
public function load(string $id): mixed;
Expand Down
3 changes: 3 additions & 0 deletions src/Lib/CacheResolver.php
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,9 @@
use DateInterval;
use Pimcore\Cache;

/**
* @deprecated Will be marked as internal and final in v2.0.0
*/
class CacheResolver
{
public function save(
Expand Down
3 changes: 3 additions & 0 deletions src/Lib/ToolResolver.php
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,9 @@
use Exception;
use Pimcore\Tool;

/**
* @deprecated Will be marked as internal and final in v2.0.0
*/
class ToolResolver implements ToolResolverInterface
{
public function getValidLanguages(): array
Expand Down
3 changes: 3 additions & 0 deletions src/Lib/ToolResolverInterface.php
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,9 @@

namespace Pimcore\Bundle\StaticResolverBundle\Lib;

/**
* @deprecated Will be marked as internal in v2.0.0
*/
interface ToolResolverInterface
{
public function getValidLanguages(): array;
Expand Down
3 changes: 3 additions & 0 deletions src/Lib/Tools/Authentication/AuthenticationResolver.php
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,9 @@
use Pimcore\Tool\Authentication;
use Symfony\Component\HttpFoundation\Request;

/**
* @deprecated Will be marked as internal and final in v2.0.0
*/
class AuthenticationResolver implements AuthenticationResolverInterface
{
public function authenticateSession(Request $request = null): ?User
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,9 @@
use Pimcore\Model\User;
use Symfony\Component\HttpFoundation\Request;

/**
* @deprecated Will be marked as internal in v2.0.0
*/
interface AuthenticationResolverInterface
{
public function authenticateSession(Request $request = null): ?User;
Expand Down
3 changes: 3 additions & 0 deletions src/Models/Asset/AssetResolverInterface.php
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,9 @@
use Pimcore\Model\Asset;
use Pimcore\Model\Asset\Listing;

/**
* @deprecated Will be marked as internal in v2.0.0
*/
interface AssetResolverInterface
{
public function getById(int|string $id, array $params = []): ?Asset;
Expand Down
3 changes: 3 additions & 0 deletions src/Models/Asset/AssetServiceResolverInterface.php
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,9 @@

use Pimcore\Model\Asset\Folder;

/**
* @deprecated Will be marked as internal in v2.0.0
*/
interface AssetServiceResolverInterface
{
public function createFolderByPath(string $path, array $options = []): Folder;
Expand Down
3 changes: 3 additions & 0 deletions src/Models/DataObject/ClassDefinitionResolver.php
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,9 @@
use Exception;
use Pimcore\Model\DataObject\ClassDefinition;

/**
* @deprecated Will be marked as internal and final in v2.0.0
*/
class ClassDefinitionResolver implements ClassDefinitionResolverInterface
{
/**
Expand Down
3 changes: 3 additions & 0 deletions src/Models/DataObject/ClassDefinitionResolverInterface.php
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,9 @@
use Exception;
use Pimcore\Model\DataObject\ClassDefinition;

/**
* @deprecated Will be marked as internal in v2.0.0
*/
interface ClassDefinitionResolverInterface
{
/**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,9 @@
use Pimcore\Model\DataObject\Classificationstore\KeyConfig;
use Pimcore\Model\DataObject\Classificationstore\KeyGroupRelation;

/**
* @deprecated Will be marked as internal in v2.0.0
*/
interface ServiceResolverInterface
{
public function getFieldDefinitionFromKeyConfig(
Expand Down
3 changes: 3 additions & 0 deletions src/Models/DataObject/ConcreteObjectResolver.php
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,9 @@

use Pimcore\Model\DataObject\Concrete;

/**
* @deprecated Will be marked as internal and final in v2.0.0
*/
class ConcreteObjectResolver implements ConcreteObjectResolverInterface
{
public function getById(int $id, array $params = []): null|Concrete
Expand Down
3 changes: 3 additions & 0 deletions src/Models/DataObject/ConcreteObjectResolverInterface.php
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,9 @@

use Pimcore\Model\DataObject\Concrete;

/**
* @deprecated Will be marked as internal in v2.0.0
*/
interface ConcreteObjectResolverInterface
{
public function getById(int $id, array $params = []): null|Concrete;
Expand Down
3 changes: 3 additions & 0 deletions src/Models/DataObject/DataObjectResolverInterface.php
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,9 @@
use Pimcore\Model\DataObject;
use Pimcore\Model\DataObject\Listing;

/**
* @deprecated Will be marked as internal in v2.0.0
*/
interface DataObjectResolverInterface
{
public function getById(int|string $id, array $params = []): ?DataObject;
Expand Down
3 changes: 3 additions & 0 deletions src/Models/DataObject/DataObjectServiceResolverInterface.php
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,9 @@

use Pimcore\Model\DataObject\Folder;

/**
* @deprecated Will be marked as internal in v2.0.0
*/
interface DataObjectServiceResolverInterface
{
public function useInheritedValues(
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,9 @@

use Pimcore\Model\DataObject\Fieldcollection\Definition;

/**
* @deprecated Will be marked as internal in v2.0.0
*/
interface DefinitionResolverInterface
{
public function getByKey(string $key): ?Definition;
Expand Down
3 changes: 3 additions & 0 deletions src/Models/DataObject/Objectbrick/DefinitionResolver.php
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,9 @@

use Pimcore\Model\DataObject\Objectbrick\Definition;

/**
* @deprecated Will be marked as internal and final in v2.0.0
*/
class DefinitionResolver implements DefinitionResolverInterface
{
public function getByKey(string $key): ?Definition
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,9 @@

use Pimcore\Model\DataObject\Objectbrick\Definition;

/**
* @deprecated Will be marked as internal in v2.0.0
*/
interface DefinitionResolverInterface
{
public function getByKey(string $key): ?Definition;
Expand Down
3 changes: 3 additions & 0 deletions src/Models/DataObject/QuantityValue/UnitResolverInterface.php
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,9 @@

use Pimcore\Model\DataObject\QuantityValue\Unit;

/**
* @deprecated Will be marked as internal in v2.0.0
*/
interface UnitResolverInterface
{
public function getById(string $id): ?Unit;
Expand Down
3 changes: 3 additions & 0 deletions src/Models/Document/DocumentResolverInterface.php
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,9 @@
use Pimcore\Model\Document;
use Pimcore\Model\Document\Listing;

/**
* @deprecated Will be marked as internal in v2.0.0
*/
interface DocumentResolverInterface
{
public function getById(int|string $id, array $params = []): ?Document;
Expand Down
3 changes: 3 additions & 0 deletions src/Models/Document/DocumentServiceResolverInterface.php
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,9 @@

use Pimcore\Model\Document\Folder;

/**
* @deprecated Will be marked as internal in v2.0.0
*/
interface DocumentServiceResolverInterface
{
public function createFolderByPath(string $path, array $options = []): Folder;
Expand Down
3 changes: 3 additions & 0 deletions src/Models/Element/ServiceResolver.php
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,9 @@
use Pimcore\Model\Element\Service;
use Pimcore\Model\User;

/**
* @deprecated Will be marked as internal in v2.0.0
*/
final class ServiceResolver implements ServiceResolverInterface
{
public function getElementById(string $type, int|string $id, array $params = []): Asset|Document|AbstractObject|null
Expand Down
3 changes: 3 additions & 0 deletions src/Models/Element/ServiceResolverInterface.php
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,9 @@
use Pimcore\Model\Element\ElementInterface;
use Pimcore\Model\User;

/**
* @deprecated Will be marked as internal in v2.0.0
*/
interface ServiceResolverInterface
{
public function getElementById(
Expand Down
3 changes: 3 additions & 0 deletions src/Models/Schedule/TaskResolver.php
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,9 @@

use Pimcore\Model\Schedule\Task;

/**
* @deprecated Will be marked as internal and final in v2.0.0
*/
class TaskResolver implements TaskResolverInterface
{
public function getById(int $id): ?Task
Expand Down
3 changes: 3 additions & 0 deletions src/Models/Schedule/TaskResolverInterface.php
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,9 @@

use Pimcore\Model\Schedule\Task;

/**
* @deprecated Will be marked as internal in v2.0.0
*/
interface TaskResolverInterface
{
public function getById(int $id): ?Task;
Expand Down
3 changes: 3 additions & 0 deletions src/Models/Tool/SettingsStoreResolverInterface.php
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,9 @@

use Pimcore\Model\Tool\SettingsStore;

/**
* @deprecated Will be marked as internal in v2.0.0
*/
interface SettingsStoreResolverInterface
{
public function set(string $id, float|bool|int|string $data, string $type = 'string', ?string $scope = null): bool;
Expand Down
3 changes: 3 additions & 0 deletions src/Models/Tool/TmpStoreResolver.php
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,9 @@

use Pimcore\Model\Tool\TmpStore;

/**
* @deprecated Will be marked as internal in v2.0.0
*/
final class TmpStoreResolver implements TmpStoreResolverInterface
{
public function add(string $id, mixed $data, ?string $tag = null, ?int $lifetime = null): bool
Expand Down
3 changes: 3 additions & 0 deletions src/Models/Tool/TmpStoreResolverInterface.php
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,9 @@

use Pimcore\Model\Tool\TmpStore;

/**
* @deprecated Will be marked as internal in v2.0.0
*/
interface TmpStoreResolverInterface
{
public function add(string $id, mixed $data, ?string $tag, ?int $lifetime): bool;
Expand Down
3 changes: 3 additions & 0 deletions src/Models/User/Permission/DefinitionResolverInterface.php
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,9 @@

use Pimcore\Model\User\Permission\Definition;

/**
* @deprecated Will be marked as internal in v2.0.0
*/
interface DefinitionResolverInterface
{
public function getByKey(string $permission): ?Definition;
Expand Down
3 changes: 3 additions & 0 deletions src/Models/User/UserResolver.php
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,9 @@

use Pimcore\Model\User;

/**
* @deprecated Will be marked as internal and final in v2.0.0
*/
class UserResolver implements UserResolverInterface
{
public function getById(int $id): ?User
Expand Down
3 changes: 3 additions & 0 deletions src/Models/User/UserResolverInterface.php
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,9 @@

use Pimcore\Model\User;

/**
* @deprecated Will be marked as internal in v2.0.0
*/
interface UserResolverInterface
{
public function getById(int $id): ?User;
Expand Down
3 changes: 3 additions & 0 deletions src/Models/Version/VersionResolver.php
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,9 @@

use Pimcore\Model\Version;

/**
* @deprecated Will be marked as internal and final in v2.0.0
*/
class VersionResolver implements VersionResolverInterface
{
public function enable(): void
Expand Down
3 changes: 3 additions & 0 deletions src/Models/Version/VersionResolverInterface.php
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,9 @@

use Pimcore\Model\Version;

/**
* @deprecated Will be marked as internal in v2.0.0
*/
interface VersionResolverInterface
{
public function enable(): void;
Expand Down