forked from solariumphp/solarium
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Refactor duplicate code in Managed Resources (solariumphp#847)
- Loading branch information
1 parent
5b2cc06
commit 11fecf8
Showing
38 changed files
with
530 additions
and
1,040 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,186 @@ | ||
| <?php | ||
|
|
||
| /* | ||
| * This file is part of the Solarium package. | ||
| * | ||
| * For the full copyright and license information, please view the COPYING | ||
| * file that was distributed with this source code. | ||
| */ | ||
|
|
||
| namespace Solarium\QueryType\ManagedResources\Query; | ||
|
|
||
| use Solarium\Core\Query\AbstractQuery as BaseQuery; | ||
| use Solarium\Core\Query\RequestBuilderInterface; | ||
| use Solarium\Core\Query\ResponseParserInterface; | ||
| use Solarium\Exception\InvalidArgumentException; | ||
| use Solarium\QueryType\ManagedResources\RequestBuilder\Resource as RequestBuilder; | ||
|
|
||
| abstract class AbstractQuery extends BaseQuery | ||
| { | ||
| /** | ||
| * Command add. | ||
| */ | ||
| const COMMAND_ADD = 'add'; | ||
|
|
||
| /** | ||
| * Command config. | ||
| */ | ||
| const COMMAND_CONFIG = 'config'; | ||
|
|
||
| /** | ||
| * Command create. | ||
| */ | ||
| const COMMAND_CREATE = 'create'; | ||
|
|
||
| /** | ||
| * Command delete. | ||
| */ | ||
| const COMMAND_DELETE = 'delete'; | ||
|
|
||
| /** | ||
| * Command exists. | ||
| */ | ||
| const COMMAND_EXISTS = 'exists'; | ||
|
|
||
| /** | ||
| * Command remove. | ||
| */ | ||
| const COMMAND_REMOVE = 'remove'; | ||
|
|
||
| /** | ||
| * Command types. | ||
| * | ||
| * @var array | ||
| */ | ||
| protected $commandTypes; | ||
|
|
||
| /** | ||
| * Name of the managed resource. | ||
| * | ||
| * @var string | ||
| */ | ||
| protected $name = ''; | ||
|
|
||
| /** | ||
| * Command. | ||
| * | ||
| * @var \Solarium\QueryType\ManagedResources\Query\AbstractCommand | ||
| */ | ||
| protected $command; | ||
|
|
||
| /** | ||
| * Get query type. | ||
| * | ||
| * @return string | ||
| */ | ||
| abstract public function getType(): string; | ||
|
|
||
| /** | ||
| * Get the request builder class for this query. | ||
| * | ||
| * @return \Solarium\QueryType\ManagedResources\RequestBuilder\Resource | ||
| */ | ||
| public function getRequestBuilder(): RequestBuilderInterface | ||
| { | ||
| return new RequestBuilder(); | ||
| } | ||
|
|
||
| /** | ||
| * Get the response parser class for this query. | ||
| * | ||
| * @return \Solarium\Core\Query\ResponseParserInterface | ||
| */ | ||
| abstract public function getResponseParser(): ResponseParserInterface; | ||
|
|
||
| /** | ||
| * Get the name of the managed resource. | ||
| * | ||
| * @return string | ||
| */ | ||
| public function getName(): string | ||
| { | ||
| return $this->name; | ||
| } | ||
|
|
||
| /** | ||
| * Set the name of the managed resource. | ||
| * | ||
| * @param string $name | ||
| * | ||
| * @return self | ||
| */ | ||
| public function setName(string $name): self | ||
| { | ||
| $this->name = $name; | ||
|
|
||
| return $this; | ||
| } | ||
|
|
||
| /** | ||
| * Create a command instance. | ||
| * | ||
| * @param string $type | ||
| * @param mixed $options | ||
| * | ||
| * @throws \Solarium\Exception\InvalidArgumentException | ||
| * | ||
| * @return \Solarium\QueryType\ManagedResources\Query\AbstractCommand | ||
| */ | ||
| public function createCommand($type, $options = null): AbstractCommand | ||
| { | ||
| $type = strtolower($type); | ||
|
|
||
| if (!isset($this->commandTypes[$type])) { | ||
| throw new InvalidArgumentException(sprintf('Managed resource command type unknown: %s', $type)); | ||
| } | ||
|
|
||
| $class = $this->commandTypes[$type]; | ||
|
|
||
| return new $class($options); | ||
| } | ||
|
|
||
| /** | ||
| * Get command for this query. | ||
| * | ||
| * @return \Solarium\QueryType\ManagedResources\Query\AbstractCommand|null | ||
| */ | ||
| public function getCommand(): ?AbstractCommand | ||
| { | ||
| return $this->command; | ||
| } | ||
|
|
||
| /** | ||
| * Set a command to the query. | ||
| * | ||
| * @param \Solarium\QueryType\ManagedResources\Query\AbstractCommand $command | ||
| * | ||
| * @return self Provides fluent interface | ||
| */ | ||
| public function setCommand(AbstractCommand $command): self | ||
| { | ||
| $this->command = $command; | ||
|
|
||
| return $this; | ||
| } | ||
|
|
||
| /** | ||
| * Remove command from the query. | ||
| * | ||
| * @return self Provides fluent interface | ||
| */ | ||
| public function removeCommand(): self | ||
| { | ||
| $this->command = null; | ||
|
|
||
| return $this; | ||
| } | ||
|
|
||
| /** | ||
| * Create an init args instance. | ||
| * | ||
| * @param array $initArgs | ||
| * | ||
| * @return \Solarium\QueryType\ManagedResources\Query\InitArgsInterface | ||
| */ | ||
| abstract public function createInitArgs(array $initArgs = null): InitArgsInterface; | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.