summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDaniel Weipert <code@drogueronin.de>2020-10-26 18:03:48 +0100
committerDaniel Weipert <code@drogueronin.de>2020-10-26 18:03:48 +0100
commit992a9d6ca186bb4399143dd5ee72a27a3b4909aa (patch)
treee9da01ac2ed233308b1477de5463ae80065afcd4
Initial commitv1.0.0
-rw-r--r--.gitignore1
-rw-r--r--LICENSE339
-rw-r--r--Readme.md36
-rw-r--r--composer.json19
-rw-r--r--src/MetaBox.php81
-rw-r--r--src/Settings.php97
-rw-r--r--src/ThemeEditor.php73
-rw-r--r--src/TimberEditor.php148
-rw-r--r--src/codemirror-themes.php67
-rw-r--r--timber-editor.php16
10 files changed, 877 insertions, 0 deletions
diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..57872d0
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1 @@
+/vendor/
diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..4b66fcb
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,339 @@
+ GNU GENERAL PUBLIC LICENSE
+ Version 2, June 1991
+
+ Copyright (C) 1989, 1991 Free Software Foundation, Inc., <http://fsf.org/>
+ 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+ Preamble
+
+ The licenses for most software are designed to take away your
+freedom to share and change it. By contrast, the GNU General Public
+License is intended to guarantee your freedom to share and change free
+software--to make sure the software is free for all its users. This
+General Public License applies to most of the Free Software
+Foundation's software and to any other program whose authors commit to
+using it. (Some other Free Software Foundation software is covered by
+the GNU Lesser General Public License instead.) You can apply it to
+your programs, too.
+
+ When we speak of free software, we are referring to freedom, not
+price. Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+this service if you wish), that you receive source code or can get it
+if you want it, that you can change the software or use pieces of it
+in new free programs; and that you know you can do these things.
+
+ To protect your rights, we need to make restrictions that forbid
+anyone to deny you these rights or to ask you to surrender the rights.
+These restrictions translate to certain responsibilities for you if you
+distribute copies of the software, or if you modify it.
+
+ For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must give the recipients all the rights that
+you have. You must make sure that they, too, receive or can get the
+source code. And you must show them these terms so they know their
+rights.
+
+ We protect your rights with two steps: (1) copyright the software, and
+(2) offer you this license which gives you legal permission to copy,
+distribute and/or modify the software.
+
+ Also, for each author's protection and ours, we want to make certain
+that everyone understands that there is no warranty for this free
+software. If the software is modified by someone else and passed on, we
+want its recipients to know that what they have is not the original, so
+that any problems introduced by others will not reflect on the original
+authors' reputations.
+
+ Finally, any free program is threatened constantly by software
+patents. We wish to avoid the danger that redistributors of a free
+program will individually obtain patent licenses, in effect making the
+program proprietary. To prevent this, we have made it clear that any
+patent must be licensed for everyone's free use or not licensed at all.
+
+ The precise terms and conditions for copying, distribution and
+modification follow.
+
+ GNU GENERAL PUBLIC LICENSE
+ TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+ 0. This License applies to any program or other work which contains
+a notice placed by the copyright holder saying it may be distributed
+under the terms of this General Public License. The "Program", below,
+refers to any such program or work, and a "work based on the Program"
+means either the Program or any derivative work under copyright law:
+that is to say, a work containing the Program or a portion of it,
+either verbatim or with modifications and/or translated into another
+language. (Hereinafter, translation is included without limitation in
+the term "modification".) Each licensee is addressed as "you".
+
+Activities other than copying, distribution and modification are not
+covered by this License; they are outside its scope. The act of
+running the Program is not restricted, and the output from the Program
+is covered only if its contents constitute a work based on the
+Program (independent of having been made by running the Program).
+Whether that is true depends on what the Program does.
+
+ 1. You may copy and distribute verbatim copies of the Program's
+source code as you receive it, in any medium, provided that you
+conspicuously and appropriately publish on each copy an appropriate
+copyright notice and disclaimer of warranty; keep intact all the
+notices that refer to this License and to the absence of any warranty;
+and give any other recipients of the Program a copy of this License
+along with the Program.
+
+You may charge a fee for the physical act of transferring a copy, and
+you may at your option offer warranty protection in exchange for a fee.
+
+ 2. You may modify your copy or copies of the Program or any portion
+of it, thus forming a work based on the Program, and copy and
+distribute such modifications or work under the terms of Section 1
+above, provided that you also meet all of these conditions:
+
+ a) You must cause the modified files to carry prominent notices
+ stating that you changed the files and the date of any change.
+
+ b) You must cause any work that you distribute or publish, that in
+ whole or in part contains or is derived from the Program or any
+ part thereof, to be licensed as a whole at no charge to all third
+ parties under the terms of this License.
+
+ c) If the modified program normally reads commands interactively
+ when run, you must cause it, when started running for such
+ interactive use in the most ordinary way, to print or display an
+ announcement including an appropriate copyright notice and a
+ notice that there is no warranty (or else, saying that you provide
+ a warranty) and that users may redistribute the program under
+ these conditions, and telling the user how to view a copy of this
+ License. (Exception: if the Program itself is interactive but
+ does not normally print such an announcement, your work based on
+ the Program is not required to print an announcement.)
+
+These requirements apply to the modified work as a whole. If
+identifiable sections of that work are not derived from the Program,
+and can be reasonably considered independent and separate works in
+themselves, then this License, and its terms, do not apply to those
+sections when you distribute them as separate works. But when you
+distribute the same sections as part of a whole which is a work based
+on the Program, the distribution of the whole must be on the terms of
+this License, whose permissions for other licensees extend to the
+entire whole, and thus to each and every part regardless of who wrote it.
+
+Thus, it is not the intent of this section to claim rights or contest
+your rights to work written entirely by you; rather, the intent is to
+exercise the right to control the distribution of derivative or
+collective works based on the Program.
+
+In addition, mere aggregation of another work not based on the Program
+with the Program (or with a work based on the Program) on a volume of
+a storage or distribution medium does not bring the other work under
+the scope of this License.
+
+ 3. You may copy and distribute the Program (or a work based on it,
+under Section 2) in object code or executable form under the terms of
+Sections 1 and 2 above provided that you also do one of the following:
+
+ a) Accompany it with the complete corresponding machine-readable
+ source code, which must be distributed under the terms of Sections
+ 1 and 2 above on a medium customarily used for software interchange; or,
+
+ b) Accompany it with a written offer, valid for at least three
+ years, to give any third party, for a charge no more than your
+ cost of physically performing source distribution, a complete
+ machine-readable copy of the corresponding source code, to be
+ distributed under the terms of Sections 1 and 2 above on a medium
+ customarily used for software interchange; or,
+
+ c) Accompany it with the information you received as to the offer
+ to distribute corresponding source code. (This alternative is
+ allowed only for noncommercial distribution and only if you
+ received the program in object code or executable form with such
+ an offer, in accord with Subsection b above.)
+
+The source code for a work means the preferred form of the work for
+making modifications to it. For an executable work, complete source
+code means all the source code for all modules it contains, plus any
+associated interface definition files, plus the scripts used to
+control compilation and installation of the executable. However, as a
+special exception, the source code distributed need not include
+anything that is normally distributed (in either source or binary
+form) with the major components (compiler, kernel, and so on) of the
+operating system on which the executable runs, unless that component
+itself accompanies the executable.
+
+If distribution of executable or object code is made by offering
+access to copy from a designated place, then offering equivalent
+access to copy the source code from the same place counts as
+distribution of the source code, even though third parties are not
+compelled to copy the source along with the object code.
+
+ 4. You may not copy, modify, sublicense, or distribute the Program
+except as expressly provided under this License. Any attempt
+otherwise to copy, modify, sublicense or distribute the Program is
+void, and will automatically terminate your rights under this License.
+However, parties who have received copies, or rights, from you under
+this License will not have their licenses terminated so long as such
+parties remain in full compliance.
+
+ 5. You are not required to accept this License, since you have not
+signed it. However, nothing else grants you permission to modify or
+distribute the Program or its derivative works. These actions are
+prohibited by law if you do not accept this License. Therefore, by
+modifying or distributing the Program (or any work based on the
+Program), you indicate your acceptance of this License to do so, and
+all its terms and conditions for copying, distributing or modifying
+the Program or works based on it.
+
+ 6. Each time you redistribute the Program (or any work based on the
+Program), the recipient automatically receives a license from the
+original licensor to copy, distribute or modify the Program subject to
+these terms and conditions. You may not impose any further
+restrictions on the recipients' exercise of the rights granted herein.
+You are not responsible for enforcing compliance by third parties to
+this License.
+
+ 7. If, as a consequence of a court judgment or allegation of patent
+infringement or for any other reason (not limited to patent issues),
+conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License. If you cannot
+distribute so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you
+may not distribute the Program at all. For example, if a patent
+license would not permit royalty-free redistribution of the Program by
+all those who receive copies directly or indirectly through you, then
+the only way you could satisfy both it and this License would be to
+refrain entirely from distribution of the Program.
+
+If any portion of this section is held invalid or unenforceable under
+any particular circumstance, the balance of the section is intended to
+apply and the section as a whole is intended to apply in other
+circumstances.
+
+It is not the purpose of this section to induce you to infringe any
+patents or other property right claims or to contest validity of any
+such claims; this section has the sole purpose of protecting the
+integrity of the free software distribution system, which is
+implemented by public license practices. Many people have made
+generous contributions to the wide range of software distributed
+through that system in reliance on consistent application of that
+system; it is up to the author/donor to decide if he or she is willing
+to distribute software through any other system and a licensee cannot
+impose that choice.
+
+This section is intended to make thoroughly clear what is believed to
+be a consequence of the rest of this License.
+
+ 8. If the distribution and/or use of the Program is restricted in
+certain countries either by patents or by copyrighted interfaces, the
+original copyright holder who places the Program under this License
+may add an explicit geographical distribution limitation excluding
+those countries, so that distribution is permitted only in or among
+countries not thus excluded. In such case, this License incorporates
+the limitation as if written in the body of this License.
+
+ 9. The Free Software Foundation may publish revised and/or new versions
+of the General Public License from time to time. Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+Each version is given a distinguishing version number. If the Program
+specifies a version number of this License which applies to it and "any
+later version", you have the option of following the terms and conditions
+either of that version or of any later version published by the Free
+Software Foundation. If the Program does not specify a version number of
+this License, you may choose any version ever published by the Free Software
+Foundation.
+
+ 10. If you wish to incorporate parts of the Program into other free
+programs whose distribution conditions are different, write to the author
+to ask for permission. For software which is copyrighted by the Free
+Software Foundation, write to the Free Software Foundation; we sometimes
+make exceptions for this. Our decision will be guided by the two goals
+of preserving the free status of all derivatives of our free software and
+of promoting the sharing and reuse of software generally.
+
+ NO WARRANTY
+
+ 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
+FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
+OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
+PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
+OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
+TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
+PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
+REPAIR OR CORRECTION.
+
+ 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
+REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
+INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
+OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
+TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
+YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
+PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGES.
+
+ END OF TERMS AND CONDITIONS
+
+ How to Apply These Terms to Your New Programs
+
+ If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+ To do so, attach the following notices to the program. It is safest
+to attach them to the start of each source file to most effectively
+convey the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+ {description}
+ Copyright (C) 2020 Daniel Weipert
+
+ This program is free software; you can redistribute it and/or modify
+ it under the terms of the GNU General Public License as published by
+ the Free Software Foundation; either version 2 of the License, or
+ (at your option) any later version.
+
+ This program is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU General Public License for more details.
+
+ You should have received a copy of the GNU General Public License along
+ with this program; if not, write to the Free Software Foundation, Inc.,
+ 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+
+Also add information on how to contact you by electronic and paper mail.
+
+If the program is interactive, make it output a short notice like this
+when it starts in an interactive mode:
+
+ Gnomovision version 69, Copyright (C) year name of author
+ Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+ This is free software, and you are welcome to redistribute it
+ under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License. Of course, the commands you use may
+be called something other than `show w' and `show c'; they could even be
+mouse-clicks or menu items--whatever suits your program.
+
+You should also get your employer (if you work as a programmer) or your
+school, if any, to sign a "copyright disclaimer" for the program, if
+necessary. Here is a sample; alter the names:
+
+ Yoyodyne, Inc., hereby disclaims all copyright interest in the program
+ `Gnomovision' (which makes passes at compilers) written by James Hacker.
+
+ {signature of Ty Coon}, 1 April 1989
+ Ty Coon, President of Vice
+
+This General Public License does not permit incorporating your program into
+proprietary programs. If your program is a subroutine library, you may
+consider it more useful to permit linking proprietary applications with the
+library. If this is what you want to do, use the GNU Lesser General
+Public License instead of this License.
diff --git a/Readme.md b/Readme.md
new file mode 100644
index 0000000..fdd336a
--- /dev/null
+++ b/Readme.md
@@ -0,0 +1,36 @@
+## Features
+
+- adds a metabox to configurable Post-Types to create and edit Twig templates
+- adds Twig support to the WP Theme & Plugin editors
+ - you can even customize the CodeMirror theme
+
+## Plugin Dependencies
+
+- https://wordpress.org/plugins/timber-library/
+- https://wordpress.org/plugins/classic-editor/
+
+## How to use the MetaBox Feature
+
+The plugin uses the path defined in `Timber::$locations` as the templates path or falls back to the uploads folder if none is provided.
+
+Either adjust your `Timber::render('page.twig', $context)`-functions like this:
+```
+$filenames = [TimberEditor::getTemplateFilename(), 'page.twig'];
+Timber::render($filenames, $context);
+```
+
+like this
+```
+TimberEditor::render('page.twig', $context);
+# 'page.twig' serves as a fallback if the current posts's template doesn't exist
+```
+
+or like this
+```
+TimberEditor::renderPost('page.twig', $context);
+# renderPost() automatically adds ['post' => new Timber\Post()] to the $context
+```
+
+## License
+
+(GPL v2)[LICENSE]
diff --git a/composer.json b/composer.json
new file mode 100644
index 0000000..4cd5a60
--- /dev/null
+++ b/composer.json
@@ -0,0 +1,19 @@
+{
+ "name": "dweipert/timber-editor",
+ "version": "1.0.0",
+ "type": "wordpress-plugin",
+ "authors": [
+ {
+ "name": "Daniel Weipert",
+ "email": "code@drogueronin.de"
+ }
+ ],
+ "require": {
+ "php": ">=7.4"
+ },
+ "autoload": {
+ "psr-4": {
+ "TimberEditor\\": "src/"
+ }
+ }
+}
diff --git a/src/MetaBox.php b/src/MetaBox.php
new file mode 100644
index 0000000..d11336f
--- /dev/null
+++ b/src/MetaBox.php
@@ -0,0 +1,81 @@
+<?php
+
+namespace TimberEditor;
+
+class MetaBox
+{
+ /**
+ * Metabox constructor.
+ */
+ public function __construct()
+ {
+ add_action('add_meta_boxes', [$this, 'addMetaBoxes']);
+
+ foreach (Settings::getGeneralSupportedPostTypes() as $postType) {
+ add_action("save_post_{$postType}", [$this, 'savePost']);
+ }
+ }
+
+ /**
+ * add_meta_boxes action callback
+ *
+ * @param $postType
+ */
+ public function addMetaBoxes($postType)
+ {
+ if (! in_array($postType, Settings::getGeneralSupportedPostTypes())) {
+ return;
+ }
+
+ add_meta_box('timber-editor', 'Timber Editor', [$this, 'metaBoxTimberEditor'], '', 'advanced', 'high');
+ }
+
+ /**
+ * save_post action callback
+ * Writes the content to file
+ *
+ * @param $postId
+ */
+ public function savePost($postId)
+ {
+ if (
+ (defined('DOING_AUTOSAVE') && DOING_AUTOSAVE) ||
+ (! isset($_POST['post_ID']) || $_POST['post_ID'] != $postId) ||
+ ! check_admin_referer('metaBoxTimberEditor', 'metaBoxTimberEditor') ||
+ ! isset($_POST['timber-editor_content'])
+ ) {
+ return;
+ }
+
+ file_put_contents(TimberEditor::getTemplateFilePath($postId), $_POST['timber-editor_content']);
+ if (empty($_POST['timber-editor_content'])) {
+ wp_delete_file(TimberEditor::getTemplateFilePath($postId));
+ }
+ }
+
+ /**
+ * add_meta_box callback
+ */
+ public function metaBoxTimberEditor()
+ {
+ $file = TimberEditor::getTemplateFilePath();
+ if (file_exists($file)) {
+ $f = fopen($file, 'r');
+ $content = fread($f, filesize($file));
+ fclose($f);
+ }
+
+ wp_nonce_field('metaBoxTimberEditor', 'metaBoxTimberEditor');
+ ?>
+ <textarea name="timber-editor_content" id="timber-editor_content"><?= esc_textarea($content ?? '') ?></textarea>
+ <?php
+
+ $settings = wp_enqueue_code_editor([
+ 'file' => $file,
+ 'codemirror' => [
+ 'theme' => Settings::getCodeMirrorTheme(),
+ ],
+ ]);
+ wp_add_inline_script('code-editor', sprintf('jQuery( function() { wp.codeEditor.initialize( "timber-editor_content", %s ); } );', wp_json_encode($settings)));
+ }
+}
diff --git a/src/Settings.php b/src/Settings.php
new file mode 100644
index 0000000..d9947f8
--- /dev/null
+++ b/src/Settings.php
@@ -0,0 +1,97 @@
+<?php
+
+namespace TimberEditor;
+
+class Settings
+{
+ /**
+ * Settings constructor.
+ */
+ public function __construct()
+ {
+ add_action('admin_menu', [$this, 'adminMenu']);
+ add_action('admin_init', [$this, 'adminInit']);
+ }
+
+ /**
+ * admin_menu action callback
+ */
+ public function adminMenu()
+ {
+ add_submenu_page('options-general.php', 'Timber Editor', 'Timber Editor', 'manage_options', 'timber-editor', [$this, 'addSubmenuPage']);
+ }
+
+ /**
+ * add_submenu_page callback
+ */
+ public function addSubmenuPage()
+ {
+ ?>
+ <div class="wrap">
+ <h1><?= esc_html(get_admin_page_title()) ?></h1>
+ <form action="options.php" method="post">
+ <?php
+ settings_fields('timber-editor');
+ do_settings_sections('timber-editor');
+ submit_button();
+ ?>
+ </form>
+ </div>
+ <?php
+ }
+
+ /**
+ * admin_init action callback
+ */
+ public function adminInit()
+ {
+ register_setting('timber-editor', 'timber-editor_general_supported-post-types');
+ add_settings_section('timber-editor_general', __('General'), function () {}, 'timber-editor');
+ add_settings_field('timber-editor_general_supported-post-types', __('Supported Post Types'), function () {
+ $postTypes = get_post_types([], 'objects');
+ $supportedPostTypes = self::getGeneralSupportedPostTypes();
+ ?>
+ <select name="timber-editor_general_supported-post-types[]" id="timber-editor_general_supported-post-types" multiple>
+ <?php foreach ($postTypes as $pt): ?>
+ <option value="<?= $pt->name ?>" <?= in_array($pt->name, $supportedPostTypes) ? 'selected' : '' ?>><?= $pt->label ?></option>
+ <?php endforeach; ?>
+ </select>
+ <?php
+ }, 'timber-editor', 'timber-editor_general', ['label_for' => 'timber-editor_general_supported-post-types']);
+
+ register_setting('timber-editor', 'timber-editor_codemirror_theme');
+ add_settings_section('timber-editor_codemirror', 'CodeMirror', function () {}, 'timber-editor');
+ add_settings_field('timber-editor_codemirror_theme', 'Theme', function () {
+ $theme = self::getCodeMirrorTheme();
+ $themes = include_once 'codemirror-themes.php';
+ ?>
+ <select name="timber-editor_codemirror_theme" id="timber-editor_codemirror_theme">
+ <?php foreach ($themes as $t): ?>
+ <option value="<?= $t ?>" <?php selected($theme, $t) ?>><?= $t ?></option>
+ <?php endforeach; ?>
+ </select>
+ <p class="description">
+ <a href="https://codemirror.net/demo/theme.html#<?= $theme ?>" target="_blank">
+ <?= __('Preview') ?>
+ </a>
+ </p>
+ <?php
+ }, 'timber-editor', 'timber-editor_codemirror', ['label_for' => 'timber-editor_codemirror_theme']);
+ }
+
+ /**
+ * @return string[]
+ */
+ public static function getGeneralSupportedPostTypes()
+ {
+ return get_option('timber-editor_general_supported-post-types', ['page']) ?: [];
+ }
+
+ /**
+ * @return string
+ */
+ public static function getCodeMirrorTheme()
+ {
+ return get_option('timber-editor_codemirror_theme', 'default');
+ }
+}
diff --git a/src/ThemeEditor.php b/src/ThemeEditor.php
new file mode 100644
index 0000000..0b62264
--- /dev/null
+++ b/src/ThemeEditor.php
@@ -0,0 +1,73 @@
+<?php
+
+namespace TimberEditor;
+
+class ThemeEditor
+{
+ /**
+ * ThemeEditor constructor.
+ */
+ public function __construct()
+ {
+ add_filter('wp_theme_editor_filetypes', [$this, 'editableExtensions']);
+ add_filter('editable_extensions', [$this, 'editableExtensions']);
+ add_filter('wp_code_editor_settings', [$this, 'codeEditorSettings'], 10, 2);
+ add_action('wp_enqueue_code_editor', [$this, 'enqueueCodeEditor']);
+ }
+
+ /**
+ * wp_theme_editor_filetypes and editable_extensions filter callback
+ * Adds twig extension support
+ *
+ * @param $types
+ *
+ * @return array
+ */
+ public function editableExtensions($types)
+ {
+ $types[] = 'twig';
+
+ return $types;
+ }
+
+ /**
+ * wp_code_editor_settings filter callback
+ * Adds twig support and sets theme
+ *
+ * @param $settings
+ * @param $args
+ *
+ * @return array
+ */
+ public function codeEditorSettings($settings, $args) {
+ if (strpos($args['file'], '.twig') !== false) {
+ $settings['codemirror']['mode'] = ['name' => 'twig', 'base' => 'text/html'];
+ }
+
+ $settings['codemirror']['theme'] = Settings::getCodeMirrorTheme();
+
+ return $settings;
+ }
+
+ /**
+ * wp_enqueue_code_editor action callback
+ * Adds twig and custom mode support
+ * Adds selected theme css
+ *
+ * @param $settings
+ */
+ public function enqueueCodeEditor($settings) {
+ if (isset($settings['codemirror']['mode']['name']) && $settings['codemirror']['mode']['name'] == 'twig') {
+ wp_add_inline_script( # fix as described here: https://make.wordpress.org/core/2017/10/22/code-editing-improvements-in-wordpress-4-9/
+ 'wp-codemirror',
+ 'window.CodeMirror = wp.CodeMirror;'
+ );
+ wp_enqueue_script('mode-twig', 'https://unpkg.com/codemirror@5/mode/twig/twig.js', ['wp-codemirror']);
+ }
+
+ $theme = $settings['codemirror']['theme'];
+ if ($theme != 'default') {
+ wp_enqueue_style('codemirror-theme', "https://unpkg.com/codemirror@5/theme/$theme.css", ['wp-codemirror']);
+ }
+ }
+}
diff --git a/src/TimberEditor.php b/src/TimberEditor.php
new file mode 100644
index 0000000..2eb3b36
--- /dev/null
+++ b/src/TimberEditor.php
@@ -0,0 +1,148 @@
+<?php
+
+namespace TimberEditor;
+
+use Timber\Loader;
+use Timber\Post;
+use Timber\Timber;
+
+class TimberEditor
+{
+ /**
+ * TimberEditor constructor.
+ */
+ public function __construct()
+ {
+ if (! class_exists(Timber::class)) {
+ add_action('admin_notices', [$this, 'adminNoticeTimberLibraryMissing']);
+ return;
+ }
+ if (! class_exists(\Classic_Editor::class)) {
+ add_action('admin_notices', [$this, 'adminNoticeClassicEditor']);
+ }
+
+ $this->run();
+ }
+
+ /**
+ * admin_notices action callback for missing Timber Library
+ */
+ public function adminNoticeTimberLibraryMissing()
+ {
+ ?>
+ <div class="notice notice-error">
+ <p>
+ <a href="https://wordpress.org/plugins/timber-library/" target="_blank">Timber</a>
+ (<a href="http://word.press/wp-admin/plugin-install.php?s=timber&tab=search&type=term">install</a>)
+ needs to be installed and active.
+ </p>
+ </div>
+ <?php
+ }
+
+ /**
+ * admin_notices action callback for missing Classic Editor
+ */
+ public function adminNoticeClassicEditor()
+ {
+ ?>
+ <div class="notice notice-warning is-dismissible">
+ <p>
+ <a href="https://wordpress.org/plugins/classic-editor/" target="_blank">Classic Editor</a>
+ (<a href="http://word.press/wp-admin/plugin-install.php?s=classic+editor&tab=search&type=term">install</a>)
+ should be installed and active, because the <b>Gutenberg Editor</b> doesn't play well with <b>CodeMirror</b> <i>currently</i>.
+ </p>
+ </div>
+ <?php
+ }
+
+ /**
+ * Run the plugin
+ */
+ public function run()
+ {
+ if (is_null(Timber::$locations)) {
+ Timber::$locations = self::getTemplatesLocation();
+ }
+
+ new Settings();
+ new ThemeEditor();
+ new MetaBox();
+ }
+
+ /**
+ * Get the plugins' templates location
+ * try to use user provided location via Timber::$locations
+ * or fall back to uploads folder
+ *
+ * @return string
+ */
+ public static function getTemplatesLocation()
+ {
+ $location = Timber::$locations;
+ if (is_array($location)) {
+ $location = $location[array_key_first($location)];
+ } else if (is_null($location)) {
+ $location = wp_upload_dir()['basedir'] . '/timber-editor';
+ }
+
+ return apply_filters('TimberEditor/getTemplatesLocation', $location);
+ }
+
+ /**
+ * Get the current posts' template filename
+ *
+ * @param int|null $postId
+ *
+ * @return string
+ */
+ public static function getTemplateFilename($postId = null)
+ {
+ return apply_filters('TimberEditor/getTemplateFilename', ($postId ?? get_the_ID()) . '.twig', $postId);
+ }
+
+ /**
+ * Get the current posts' template filepath
+ *
+ * @param int|null $postId
+ *
+ * @return string
+ */
+ public static function getTemplateFilePath($postId = null)
+ {
+ return self::getTemplatesLocation() . '/' . self::getTemplateFilename($postId);
+ }
+
+ /**
+ * @param array|string $filenames
+ * @param array $context
+ * @param bool $expires
+ * @param string $cacheMode
+ *
+ * @return bool|string
+ */
+ public static function render($filenames = [], $context = [], $expires = false, $cacheMode = Loader::CACHE_USE_DEFAULT)
+ {
+ $filenames = (array)$filenames;
+ array_unshift($filenames, self::getTemplateFilename());
+
+ return Timber::render($filenames, $context, $expires, $cacheMode);
+ }
+
+ /**
+ * @param array|string $filenames
+ * @param array $context
+ * @param bool $expires
+ * @param string $cacheMode
+ *
+ * @return bool|string
+ */
+ public static function renderPost($filenames = [], $context = [], $expires = false, $cacheMode = Loader::CACHE_USE_DEFAULT)
+ {
+ if (! isset($context['post'])) {
+ $context['post'] = new Post();
+ }
+
+ return self::render($filenames, $context, $expires, $cacheMode);
+ }
+}
diff --git a/src/codemirror-themes.php b/src/codemirror-themes.php
new file mode 100644
index 0000000..a51779d
--- /dev/null
+++ b/src/codemirror-themes.php
@@ -0,0 +1,67 @@
+<?php
+
+return [
+ 'default',
+ '3024-day',
+ '3024-night',
+ 'abcdef',
+ 'ambiance',
+ 'ayu-dark',
+ 'ayu-mirage',
+ 'base16-dark',
+ 'base16-light',
+ 'bespin',
+ 'blackboard',
+ 'cobalt',
+ 'colorforth',
+ 'darcula',
+ 'dracula',
+ 'duotone-dark',
+ 'duotone-light',
+ 'eclipse',
+ 'elegant',
+ 'erlang-dark',
+ 'gruvbox-dark',
+ 'hopscotch',
+ 'icecoder',
+ 'idea',
+ 'isotope',
+ 'lesser-dark',
+ 'liquibyte',
+ 'lucario',
+ 'material',
+ 'material-darker',
+ 'material-palenight',
+ 'material-ocean',
+ 'mbo',
+ 'mdn-like',
+ 'midnight',
+ 'monokai',
+ 'moxer',
+ 'neat',
+ 'neo',
+ 'night',
+ 'nord',
+ 'oceanic-next',
+ 'panda-syntax',
+ 'paraiso-dark',
+ 'paraiso-light',
+ 'pastel-on-dark',
+ 'railscasts',
+ 'rubyblue',
+ 'seti',
+ 'shadowfox',
+ 'solarized dark',
+ 'solarized light',
+ 'the-matrix',
+ 'tomorrow-night-bright',
+ 'tomorrow-night-eighties',
+ 'ttcn',
+ 'twilight',
+ 'vibrant-ink',
+ 'xq-dark',
+ 'xq-light',
+ 'yeti',
+ 'yonce',
+ 'zenburn',
+];
diff --git a/timber-editor.php b/timber-editor.php
new file mode 100644
index 0000000..10b6007
--- /dev/null
+++ b/timber-editor.php
@@ -0,0 +1,16 @@
+<?php
+/**
+ * Plugin Name: Timber Editor
+ * Description: Admin Editor for Timber
+ * Plugin URI: https://gitlab.com/DRogueRonin/wp-plugin-timber-editor
+ * Author: Daniel Weipert
+ * Version: 1.0.0
+ * Author URI: https://dweipert.de
+*/
+
+require 'vendor/autoload.php';
+
+add_action('plugins_loaded', 'timberEditor');
+function timberEditor() {
+ new \TimberEditor\TimberEditor();
+}