Skip to content

Commit

Permalink
rebased commands document patch, see liip#533
Browse files Browse the repository at this point in the history
  • Loading branch information
helios-ag committed Dec 18, 2015
1 parent c2dfddf commit 65833d6
Show file tree
Hide file tree
Showing 2 changed files with 69 additions and 0 deletions.
68 changes: 68 additions & 0 deletions Resources/doc/commands.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
# Commands

## Remove cache


All cache for a given paths will be removed:

``` bash
$ php app/console liip:imagine:cache:remove path1 path
```


If you use --filters parameter, all cache for a given filters will be lost:

``` bash
$ php app/console liip:imagine:cache:remove --filters=thumb1 --filters=thumb2
```

You can combine these parameters:

``` bash
$ php app/console liip:imagine:cache:remove path1 path2 --filters=thumb1 --filters=thumb2
```

Cache for all paths and filters will be lost when executing this command without parameters :

``` bash
$ php app/console liip:imagine:cache:remove
```

## Resolve cache


``` bash
$ php app/console liip:imagine:cache:resolve path1 path2 --filters=thumb1
```

Cache for the two paths will be resolved using the passed filter.
As a result you will get:
``` bash
http://localhost/media/cache/thumb1/path1
http://localhost/media/cache/thumb1/path2
```

You can pass few filters:

``` bash
$ php app/console liip:imagine:cache:resolve path1 --filters=thumb1 --filters=thumb2
```

As a result you will get:
``` bash
http://localhost/media/cache/thumb1/path1
http://localhost/media/cache/thumb2/path1
```

If you omit --filters parameter then to resolve given paths will be used all configured and available filters in application:
``` bash
$ php app/console liip:imagine:cache:resolve path1
```

As a result you will get:
``` bash
http://localhost/media/cache/thumb1/path1
http://localhost/media/cache/thumb2/path1
```

[Back to the index](index.md)
1 change: 1 addition & 0 deletions Resources/doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,3 +13,4 @@ performance, altered images can be cached locally and in Amazon S3 service.
* :doc:`DataLoaders <data-loaders>`
* :doc:`CacheResolvers <cache-resolvers>`
* :doc:`CacheManager <cache-manager>`
* :doc:`Commands <commands>`

0 comments on commit 65833d6

Please sign in to comment.