cphipps/watchstate
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

Updated help doc for backend:ignore:*

Browse Source
This commit is contained in:
Abdulmhsen B. A. A
2022-07-07 19:05:32 +03:00
parent 1752e55042
commit 5929fc0b4b
2 changed files with 20 additions and 28 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
src/Commands/Backend/Ignore/ListCommand.php
View File

@@ -44,25 +44,26 @@ final class ListCommand extends Command
->addOption('backend', null, InputOption::VALUE_REQUIRED, 'Filter based on backend.')
->addOption('db', null, InputOption::VALUE_REQUIRED, 'Filter based on db.')
->addOption('id', null, InputOption::VALUE_REQUIRED, 'Filter based on id.')
->addOption('with-title', null, InputOption::VALUE_NONE, 'Include entity title in response. Slow operation')
->setDescription('List Ignored external ids.')
->setHelp(
<<<HELP
This command display list of ignored external ids.
This command display list of ignored external ids. You can filter the list by
using one or more of the provided options like [<info>--type</info>, <info>--backend</info>, <info>--db</info>, <info>--id</info>].
You can filter the results by using one or more of the provided options like <info>--type</info>, <info>--backend</info>, <info>--db</info>
------------
<comment>[ Examples ]</comment>
------------
For example, To list all ids that are being ignored for specific <info>backend</info>, You can do something like
<comment># List all ignore rules that reletes to specific backend.</comment>
{$cmdContext} backend:ignore:list --backend plex_home
{$cmdContext} backend:ignore:list <info>--backend</info> <comment>my_backend</comment>
You can append more filters to narrow down the list. For example, to filter on both <info>backend</info> and <info>db</info>:
<comment># Appending more filters to narrow down list</comment>
{$cmdContext} backend:ignore:list --backend plex_home --db tvdb
{$cmdContext} backend:ignore:list <info>--backend</info> <comment>my_backend</comment> <info>--db</info> <comment>tvdb</comment>
HELP
);
}

31
src/Commands/Backend/Ignore/ManageCommand.php
View File

@@ -45,7 +45,7 @@ final class ManageCommand extends Command
$this->setName($cmdRoute)
->setDescription('Add/Remove external id from ignore list.')
->addOption('remove', 'r', InputOption::VALUE_NONE, 'Remove id from ignore list.')
->addArgument('id', InputArgument::REQUIRED, 'Id to ignore. Id format: type://db:id@backend_name')
->addArgument('id', InputArgument::REQUIRED, 'Id to ignore.')
->setHelp(
<<<HELP
@@ -69,36 +69,27 @@ The <info>id</info> format is: <info>type</info>://<info>db</info>:<info>id</inf
<comment># Adding exteranl id to ignore list</comment>
To ignore <info>tvdb</info> id <info>320234</info> from <info>plex_home</info> backend you would do something like
To ignore <info>tvdb</info> id <info>320234</info> from <info>my_backend</info> backend you would do something like
For <comment>shows</comment> external id:
{$cmdContext} {$cmdRoute} <comment>show</comment>://<info>tvdb</info>:<info>320234</info>@<info>plex_home</info>
{$cmdContext} {$cmdRoute} <comment>show</comment>://<info>tvdb</info>:<info>320234</info>@<info>my_backend</info>
For <comment>movies</comment> external id:
{$cmdContext} {$cmdRoute} <comment>movie</comment>://<info>tvdb</info>:<info>320234</info>@<info>plex_home</info>
If you want to limit this rule to specfic item id you would add [<info>?id=</info><comment>backend_id</comment>] to the rule, for example
For <comment>episodes</comment> external id:
{$cmdContext} {$cmdRoute} <comment>episode</comment>://<info>tvdb</info>:<info>320234</info>@<info>plex_home</info>
{$cmdContext} {$cmdRoute} <comment>show</comment>://<info>tvdb</info>:<info>320234</info>@<info>my_backend</info>?id=<info>1212111</info>
To scope ignore rule to specfic item from backend, You can do the same as before and add [<info>?id=backend_id</info>].
This will ignore [<info>tvdb://320234</info>] id only when the context id = [<info>1212111</info>]
<comment>[backend_id]:</comment>
Refers to the item id from backend. To ignore a specfic guid for item id <info>1212111</info> you can do something like this:
{$cmdContext} {$cmdRoute} <comment>episode</comment>://<info>tvdb</info>:<info>320234</info>@<info>plex_home</info>?id=<info>1212111</info>
<comment># Removing exteranl id from ignore list ?</comment>
<comment># Removing exteranl id from ignore list</comment>
To Remove an external id from ignore list just append <info>[-r, --remove]</info> to the command. For example,
{$cmdContext} {$cmdRoute} --remove <comment>episode</comment>://<info>tvdb</info>:<info>320234</info>@<info>plex_home</info>
{$cmdContext} {$cmdRoute} --remove <comment>episode</comment>://<info>tvdb</info>:<info>320234</info>@<info>my_backend</info>
The id should match what what entered.
The <info>id</info> should match what was added exactly.
<comment># Where the list is stored?</comment>
<comment># ignore.yaml file location</comment>
By defualt we store the list at {$ignoreListFile}
By defualt it should be at {$ignoreListFile}
HELP
);