Reference¶
The enumerable parts of this section, the settings and the states a request can
be in, are written from the extension's own code by oce docs:reference, so
they cannot drift away from what the version you installed does.
- Settings: every key, its default and what it does, alongside what the module fixes on purpose and why.
- Wording and limits: what each wording box says until you write your own, and the range every number is held to.
- What a request can say: the nine states on the Requests tab, and the three flags.
- The API: the two read resources an integration may call, every field on them, and what the promise covers.
- What this holds about a person: every column of the seven tables, and what retention and an erasure do to each.
- Security verdict: how this extension stands against the shared security baseline.
- What it costs: what it adds to nineteen stock pages, in queries, bytes and requests.
Where things are¶
The screen is at Extensions → Extensions → Modules → Review Requests,
and carries three tabs: Requests, Settings and Suppression. Its route, which is
also the permission you grant, is
extension/review_requests/module/review_requests.
Reviews are core's. Everything collected here is written through OpenCart's
own review model, so it lands in Catalog → Reviews for moderation like any
other review, fires whatever alert mail you have configured, and counts in
Reports → Statistics. This extension never writes to oc_review any other
way.
The tables, all prefixed the way your store prefixes core's:
| Table | Holds |
|---|---|
review_requests_ask |
One row per order asked, its state, its token and its flags |
review_requests_line |
One row per product on that order, and what became of it |
review_requests_suppression |
Addresses this store may not email, per store |
review_requests_pass |
What each pass found, sent, skipped and failed on |
review_requests_mark |
How far through your order history the extension has read |
review_requests_memory |
The copy of your settings that survives an update |
review_requests_reply |
Your reply to a review, one per review, beside a copy of its product |
None of them is ever dropped. Removing them is a deliberate act of yours against the database, not something a screen here offers.
The routes, which is what a link in an email opens:
| Route | What it is |
|---|---|
extension/review_requests/review_requests/review_requests |
The page the request link opens |
…/review_requests.unsubscribe |
The page the footer link opens |
extension/review_requests/cron/review_requests |
The hourly pass, reachable only by OpenCart's own scheduler |
extension/review_requests/cli/review_requests |
The same pass from a terminal, refused over the web |
extension/review_requests/api/v1/ask |
The API's ask resource, off unless you switch the API on |
extension/review_requests/api/v1/run |
The API's run resource, the same |
Two screens under Customers, each its own permission entry:
Personal Data at extension/review_requests/customer/personal_data, and
Remove everything held about a person at
extension/review_requests/customer/purge. See
requirements and install for what each needs.
Fourteen event rows, all under the code review_requests, and three of
them matter here. One is on catalog/view/product/review_list/before, which is
what puts the badge, the disclosure line and your replies on the review list.
Another is on admin/view/catalog/review_form/before, which adds the Reply
box to core's review form. The third is the API's
gateway, on this extension's whole controller namespace: it is what
authenticates a call, refuses a verb and decides a version before OpenCart has
heard of the route, and it costs one string comparison on every storefront page
of this extension when the call is not an API call.
What a generated list cannot tell you is which of these you should change, and what happens when you do. That is guides and limits and guarantees.