Remove stale Flourish/PHP references from docs and comments (#734)#1066
Open
dduugg wants to merge 1 commit into
Open
Remove stale Flourish/PHP references from docs and comments (#734)#1066dduugg wants to merge 1 commit into
dduugg wants to merge 1 commit into
Conversation
dduugg
force-pushed
the
issue-734-flourish-refs
branch
from
e583f60 to
7bf9561
Compare
…g#734) The PHP backend (and the Flourish library it used) was removed in shift-org#694, so comments and docs that describe behavior in terms of Flourish, PHP source files, or PHP-only upload mechanics are now inaccurate. Rather than just renaming "flourish" to "legacy PHP backend", reword them to describe what the current Node code actually does: - app/endpoints/events.js: describe the event pooling / end-time handling directly instead of contrasting with the old PHP/ORM behavior. - app/models/calDaily.js, calEventValidator.js: state the current null/24-hour conversion behavior and its rationale (data consistency), dropping Flourish framing and dead flourishlib.com links. - docs/TABLES.md: point image config at app/config.js (config.image.*) and the manage_event endpoint instead of config.php/manage_event.php. - docs/cache_busting.md: rewrite the upload flow to match the Node implementation (multer in-memory upload, uploader.write writing the base-format name), removing references to upload_attached_file(), updateImageUrl(), and GET-time renaming that no longer exist. - site theme addevent.js: clarify the 413 comment (nginx sends it). Also fix dead PHP source-file references in the same spirit: - retrieve_event.js / delete_event.js: errors.php -> util/errors.js - calDaily.js @see: DateStatus.php, manage_event.php -> .js equivalents - docs/TABLES.md: 'manage_event.php slices...' -> 'the manage_event endpoint' Legitimate /api/*.php URL paths (still how endpoints are served) are left as-is, as is docs/AllEvents.md, which is a historical design memo describing the PHP-era implementation.
dduugg
force-pushed
the
issue-734-flourish-refs
branch
from
7bf9561 to
ff8c81f
Compare
dduugg
changed the title
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #734.
The PHP backend — and the Flourish library it used — was removed in #694. As a result, various comments and docs still describe behavior in terms of Flourish, PHP source files, or PHP-only mechanics that no longer exist. This reworks those references to describe what the current Node code actually does.
Flourish references
app/endpoints/events.js— describe the event pooling / end-time handling directly, instead of contrasting it with the old PHP/ORM behavior.app/models/calDaily.js&app/models/calEventValidator.js— state the current null / 24-hour-conversion behavior and its rationale (consistency with existing data), dropping the Flourish framing and the deadflourishlib.comdoc links.docs/TABLES.md— point the image config atapp/config.js(config.image.*) and themanage_eventendpoint, instead ofconfig.php/manage_event.php/$IMAGEDIR.docs/cache_busting.md— rewrite the upload flow to match the Node implementation (in-memory multer upload;uploader.write()writing the base-formatid.ext; the sequence number living only in the db field and URL). Removesupload_attached_file(),updateImageUrl(), and the GET-time renaming that no longer exist. Kept the still-accurate cache-busting concept and nginx URL handling.site/themes/s2b_hugo_theme/assets/js/cal/addevent.js— replace the dangling "so the error message sent by flourish" comment with a clearer note that nginx (not the backend) sends the 413.Related dead PHP source-file references (same spirit)
app/endpoints/retrieve_event.js&app/endpoints/delete_event.js—see errors.php→see util/errors.js.app/models/calDaily.js—@see: DateStatus.php, manage_event.php→dateStatus.js, manage_event.js.docs/TABLES.md— "manage_event.phpslices the first 24 characters…" → "themanage_eventendpoint slices…".Deliberately left as-is
/api/*.phpURL paths — the endpoints are still served at these URLs (appEndpoints.jshosts each at/api/<name>.php), so request examples, tests, nginx routes, and the frontend API config that reference them remain correct.docs/AllEvents.md— a historical design memo describing the PHP-era implementation; its.phpreferences are accurate to the era it narrates, so rewriting filenames there would misrepresent the history rather than fix anything.These are comment/documentation edits only; no behavior changes.