You are here

README.txt in Views custom cache 7

CONTENTS OF THIS FILE
---------------------

 * Introduction
 * Recommended modules
 * Installation
 * Configuration

INTRODUCTION
------------

This module provides two new simple caches for views which takes view's
arguments into account:

* Custom cache: view's all arguments: All view's arguments, including
  contextual and exposed filters, will be taken into account (recommended).
* Custom cache: view's first argument: Only first view argument, even if it
  is a contextual or exposed filter, will be taken into account.

It is recommended to use this module in views which take arguments and where
cache hasn't to be content aware (doesn't matter if new content is added or
updated, cache will refresh when it expires according to user selection).
Performance gains will vary depending on views configuration and the amount
of results.

Module features:

* You can configure cache duration time
* You can enable/disable cache per role
* Works well with Views AJAX pagination

 * For a full description of the module, visit the project page:
   https://www.drupal.org/project/views_custom_cache

RECOMMENDED MODULES
-------------------

* Views argument cache. This module is very similar to Views custom cache
  except by the fact it doesn't allow to configure cache expiration time and
  doesn't allow to enable/disable cache per role. However, it allows you to
  choose how many arguments will have to be taken into account by cache. This
  module is great but I decided to do Views custom cache from scratch because
  it didn't work for me at all with views with exposed filters. And most
  important, this module requires you to manually flush caches because they
  don't automatically expire.

* Views content cache. This module is quite different of mine's because cache
  expiration is content based instead of time based like Views custom cache.
  You can set up this module to update cache once listed content is updated
  or a new related node has been created.

INSTALLATION
------------

 * Install as you would normally install a contributed Drupal module. See:
   https://drupal.org/documentation/install/modules-themes/modules-7
   for further information.

CONFIGURATION
-------------

 * Edit a View you would like to cache. On "Advanced" column (third one) look
   for "Caching" option and click it. Then choose the cache type which better
   fits your view:

    - Custom cache: view's all arguments:

      Takes into account all views arguments (recommended).

    - Custom cache: view's first argument:

      Takes into account only first view argument.

* Then you will be prompted to choose cache options:

    - Cache duration time

      Choose expiration time for cache.

    - Custom time

      Cache duration time in seconds (this option is only available if "Custom"
      option is selected on previous "Cache duration time" select).

    - Cache per role?

      Enable or disable cache per each role.

    - Updates awareness

      * Unaware: cache will NOT be refreshed when content is updated.

      * Node aware: cache will be refreshed when a node is updated. You can
      select which bundles have to be monitored to detect changes.

File

README.txt
View source
  1. CONTENTS OF THIS FILE
  2. ---------------------
  3. * Introduction
  4. * Recommended modules
  5. * Installation
  6. * Configuration
  7. INTRODUCTION
  8. ------------
  9. This module provides two new simple caches for views which takes view's
  10. arguments into account:
  11. * Custom cache: view's all arguments: All view's arguments, including
  12. contextual and exposed filters, will be taken into account (recommended).
  13. * Custom cache: view's first argument: Only first view argument, even if it
  14. is a contextual or exposed filter, will be taken into account.
  15. It is recommended to use this module in views which take arguments and where
  16. cache hasn't to be content aware (doesn't matter if new content is added or
  17. updated, cache will refresh when it expires according to user selection).
  18. Performance gains will vary depending on views configuration and the amount
  19. of results.
  20. Module features:
  21. * You can configure cache duration time
  22. * You can enable/disable cache per role
  23. * Works well with Views AJAX pagination
  24. * For a full description of the module, visit the project page:
  25. https://www.drupal.org/project/views_custom_cache
  26. RECOMMENDED MODULES
  27. -------------------
  28. * Views argument cache. This module is very similar to Views custom cache
  29. except by the fact it doesn't allow to configure cache expiration time and
  30. doesn't allow to enable/disable cache per role. However, it allows you to
  31. choose how many arguments will have to be taken into account by cache. This
  32. module is great but I decided to do Views custom cache from scratch because
  33. it didn't work for me at all with views with exposed filters. And most
  34. important, this module requires you to manually flush caches because they
  35. don't automatically expire.
  36. * Views content cache. This module is quite different of mine's because cache
  37. expiration is content based instead of time based like Views custom cache.
  38. You can set up this module to update cache once listed content is updated
  39. or a new related node has been created.
  40. INSTALLATION
  41. ------------
  42. * Install as you would normally install a contributed Drupal module. See:
  43. https://drupal.org/documentation/install/modules-themes/modules-7
  44. for further information.
  45. CONFIGURATION
  46. -------------
  47. * Edit a View you would like to cache. On "Advanced" column (third one) look
  48. for "Caching" option and click it. Then choose the cache type which better
  49. fits your view:
  50. - Custom cache: view's all arguments:
  51. Takes into account all views arguments (recommended).
  52. - Custom cache: view's first argument:
  53. Takes into account only first view argument.
  54. * Then you will be prompted to choose cache options:
  55. - Cache duration time
  56. Choose expiration time for cache.
  57. - Custom time
  58. Cache duration time in seconds (this option is only available if "Custom"
  59. option is selected on previous "Cache duration time" select).
  60. - Cache per role?
  61. Enable or disable cache per each role.
  62. - Updates awareness
  63. * Unaware: cache will NOT be refreshed when content is updated.
  64. * Node aware: cache will be refreshed when a node is updated. You can
  65. select which bundles have to be monitored to detect changes.