prismicio-community / php-kit

Community maintained development kit for Prismic and the PHP language
https://prismic.io
Other
109 stars 83 forks source link

Detect Preview or Experiment Mode #144

Closed gsteel closed 6 years ago

gsteel commented 7 years ago

Added 2 methods and tests to determine whether the current session is a preview or an experiment.

The use-case for this is based around the idea that if you are caching rendered content separately to the cached api calls, you'll probably want to know if you're in the middle of a preview so that you can return fresh content to the editor. This is particularly relevant when you're working with content that doesn't directly relate to the document being previewed, for example cached layout elements/content.

Whilst the use case doesn't really hold for experiments, I don't think it hurts to have a helpful accessor that can tell you whether you're in experiment mode or not (?)