Local JSON

[tw2113]

We will be borrowing a lot from the pros, I mean, Advanced Custom Fields. Do we dare outright copy https://plugins.trac.wordpress.org/browser/advanced-custom-fields/tags/5.12.3/includes/local-json.php and amend as needed?

Enabling

• UI setting vs folder existence
  • We don't really have a page with random-ish settings available, so enabling dynamically would be awesome and save time/options pages.
• "is enabled" method, which checks if folder exists and if yes return true. else return false.
  • return false if not write-able to.
    • Throw an admin notice of some sort if so.

Saving in UI

• New items should be added to file.
• Existing items should update update to file.
• Deleted items should be removed from file.

Avoiding file deletion.

• With ACF, you have to version control the file, and do a git reset to restore after clearing out database version. How can we avoid this nuisance step?
  • Tools menu and {""} import method doesn't trigger saving/deleting hooks, but still removes database options.

Loading and precedence

• DB option should be used before local JSON copy.

Sync settings

• Show if local version is different or more specifically newer?
• Timestamps like Advanced Custom Fields?
  • New CPTUI option for last save time?
    • Prevents need to edit our existing data.
    • Only if we enable local JSON version?
• UI needed to sync.
  • Link in "Listings" page?

CPTUI UI data display like tools, get code, listings.

• Should we show local loaded data in the same places, perhaps with notes of "loaded via theme" or similar wording?
  • Show but have various links like "edit" etc disabled because there's nothing in the UI to edit without sync?

Multi-Site

• append ID to file name, if Multi-Site and not main site. Leave main site ID off to avoid potential backwards compatibility breaking for people using the functionality already.

Extra testing

Confirm this does not interfere with CPTUI-Extended. Bonus points if made to work with Network-wide content types, or made to be able to work with that.

[tw2113]

Enabling

All bullet points done and available in https://github.com/WebDevStudios/custom-post-type-ui/tree/891-local-json

[tw2113]

Saving in UI

All bullet points done and available in https://github.com/WebDevStudios/custom-post-type-ui/tree/891-local-json

[tw2113]

Multisite ID appending got handled as part of the Saving in UI section

[tw2113]

Loading and precedence

Now passing in existing cptui data to override filters, and returning those if not empty, else reading from local JSON. Also available in https://github.com/WebDevStudios/custom-post-type-ui/tree/891-local-json

[tw2113]

CONFLICT

As is, we're wanting to prefer the database version over local JSON version. However, we allow adding new via UI, even if local version exists, and that would create a new option, BUT ONLY WITH THAT ONE NEW ITEM. So we have potential to freak people out if they have many registered which is very common.

Do we want to try and merge database versions of specific types, and override loaded local copy of same slug, with the database version? Or perhaps if we have a local version, and no database version, force importing?

[tw2113]

local_is_being_used()
check if files exist, not just if folder is writable

switch to saving individual json files per post type/taxonomy ?

instead of filtering the get content type functions, leave those alone and create new function for just reading json file(s) and load/combine data, dependent on if still 1 file or all files? a case of if is local being used, pull in info with this function, else, currently used function?

[tw2113]

creating some local content types, and then deleting the db copy, and then adding new afterwards would wipe out the local json copy IF storing all of them. So we need to get around that somehow.

[tw2113]

Need to account for any helper functions that are meant to fetch slugs and data.