CodeCraft\Pathfinder\Model\Store\RequestVarProgressStore
Can be used to pass progress on to the next step via the URL
Synopsis
class RequestVarProgressStore
extends ProgressStore
{
- // members
- private static string $progress_var_name = 'progress';
- protected $encodedProgress;
- // methods
- public void __construct()
- public static void encode()
- public static array decode()
- public string getProgressVarName()
- public string getEncodedProgress()
- public string getEncodedStore()
- public array getDecodedStore()
- public string mergeRequestVarsWithURL()
- public void augmentURL()
- // Inherited methods from ProgressStore
- public void initAfterRequestHandler()
- public ProgressStore add()
- public array get()
- public ProgressStore set()
- public ProgressStore clear()
- public ProgressStore clearAfterPos()
- public ProgressStore addProgress()
- public Pathfinder getHandler()
- public ProgressStore setHandler()
- public void updateForm()
- public string augmentURL()
- public string getStorageName()
- public ProgressEntry|null getByPos()
- public array toArray()
- public int count()
- public ProgressEntry|null last()
- public bool canValidateSequence()
- public bool|null isInSequence()
Hierarchy
Members
private
- $progress_var_name — string
protected
- $encodedProgress — string
- $entries — array
- $handler — CodeCraft\Pathfinder\Model\Pathfinder
Methods
public
- __construct() — {@inheritDoc}
- augmentURL() — {@inheritDoc}
- decode()
- encode()
- getDecodedStore()
- getEncodedProgress()
- getEncodedStore() — Gzip, Base64 and URL encode the store
- getProgressVarName()
- mergeRequestVarsWithURL()
Inherited from CodeCraft\Pathfinder\Model\Store\ProgressStore
public
- add() — Add an item to the current progress
- addProgress() — Add progress by question, answer and choices
- augmentURL() — Modify the redirect url used to continue to the next step in the pathfinder
- canValidateSequence() — A heuristic for whether this story can/should determine if a specific question is the next in sequence
- clear() — Clear the current progress store
- clearAfterPos()
- count()
- get() — Get the current progress
- getByPos()
- getHandler()
- getStorageName()
- initAfterRequestHandler()
- isInSequence() — Determines if a question is the next in sequence
- last()
- set() — Set the current progress
- setHandler()
- toArray()
- updateForm() — Invoked as part of {@see PathfinderRequestHandler::Form()}