Merge pull request #102 from ticktackk/develop

1.3.5

Author: ticktackk

CHANGELOG.md

@@ -1,6 +1,13 @@
 CHANGELOG
 ==========================
 
+## 1.3.5 (`1030570`)
+
+- **Change:** Improvement to how `XF\PermissionCache` class is extended (#99) (Thanks @Xon)
+- **Change:** Disable the "View template modifications" feature of this add-on if standard library 1.5.0+ is detected (#101)
+- **Fix:** Many hard-coded text instead of using phrases in "View template modifications" page (#100)
+- General code improvements and compatibility fixes
+
 ## 1.3.4 (`1030470`)
 
 - **Fix:** Testing template modification for specific style does not work (#97)

Cli/Command/EntityFromTable.php

@@ -4,17 +4,13 @@
 
 use Closure;
 use Symfony\Component\Console\Command\Command;
-use Symfony\Component\Console\Helper\ProcessHelper;
 use Symfony\Component\Console\Helper\QuestionHelper;
+use Symfony\Component\Console\Input\ArrayInput;
 use Symfony\Component\Console\Input\InputArgument;
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Input\InputOption;
 use Symfony\Component\Console\Output\OutputInterface;
 use Symfony\Component\Console\Question\Question;
-use Symfony\Component\Process\Exception\ProcessFailedException;
-use Symfony\Component\Process\PhpExecutableFinder;
-use Symfony\Component\Process\Process;
-use Symfony\Component\Process\ProcessBuilder;
 use XF\Cli\Command\AddOnActionTrait;
 use XF\Cli\Command\Development\RequiresDevModeTrait;
 use XF\Util\File;
@@ -45,7 +41,7 @@ protected function configure() : void
                 'table to inspect'
             )
             ->addArgument(
-                'RelationName',
+                'name',
                 InputArgument::REQUIRED,
                 'The entity\'s name'
             )
@@ -58,10 +54,12 @@ protected function configure() : void
     }
 
     /**
-     * @param InputInterface  $input
+     * @param InputInterface $input
      * @param OutputInterface $output
      *
      * @return int
+     *
+     * @throws \Exception
      */
     protected function execute(InputInterface $input, OutputInterface $output) : int
     {
@@ -94,7 +92,7 @@ protected function execute(InputInterface $input, OutputInterface $output) : int
             $output->writeln('');
         }
 
-        $name = $input->getArgument('RelationName');
+        $name = $input->getArgument('name');
         if (!$name)
         {
             $question = new Question('<question>Enter the relationship name for the entity:</question> ');
@@ -252,20 +250,20 @@ public static function getStructure(Structure \$structure)
 TEMPLATE;
         $entityName = "{$namespace}:{$name}";
         $entityName = str_replace('/', '\\', $entityName);
+        File::writeFile($filename, $template, false);
 
         $output->writeln("Writing entity for {$entityName}");
-        echo $template . "\n\n";
-        File::writeFile($filename, $template, false);
+        $output->writeln($template);
 
-        $this->runSubAction($output, [
-            'xf-dev:entity-class-properties',
-            $entityName
-        ]);
+        $command = $this->getApplication()->find('xf-dev:entity-class-properties');
+        $childInput = new ArrayInput(['addon-or-entity' => $entityName]);
+        $command->run($childInput, $output);
+        $output->writeln('');
 
-        $this->runSubAction($output, [
-            'tdt-addon:generate-schema-entity',
-            $entityName
-        ]);
+        $command = $this->getApplication()->find('tck-dt:generate-schema-entity');
+        $childInput = new ArrayInput(['id' => $entityName]);
+        $command->run($childInput, $output);
+        $output->writeln('');
 
         return 0;
     }
@@ -397,56 +395,6 @@ protected function parseSqlType(string $sqlType) : array
         return [$type, $len, $allowedValues];
     }
 
-    /**
-     * @param OutputInterface $output
-     * @param array           $args
-     */
-    public function runSubAction(OutputInterface $output, array $args = []) : void
-    {
-        $execFinder = new PhpExecutableFinder();
-
-        $builderOptions = [
-            $execFinder->find(false),
-            \XF::getRootDirectory() . DIRECTORY_SEPARATOR . 'cmd.php',
-            '-n'
-        ];
-        $builderOptions = \array_merge($builderOptions, $args);
-
-        if ($verbosityOption = $this->getVerbosityOption($output->getVerbosity()))
-        {
-            $builderOptions[] = $verbosityOption;
-        }
-
-        $process = new Process($builderOptions);
-        $process->setTimeout(null);
-
-        /** @var ProcessHelper $processHelper */
-        $processHelper = $this->getHelper('process');
-
-        try
-        {
-            $processHelper->mustRun($output, $process, null, function ($type, $data) use ($output)
-            {
-                if ($type === Process::OUT)
-                {
-                    $output->write($data);
-                }
-                // Note that progress bar output is in Process::ERR/stderr, but they get streamed to this callback
-                // interleaved, so displaying both is difficult. Thus, we need to only display stuff sent stdout.
-            });
-        }
-        catch (ProcessFailedException $e)
-        {
-            $process = $e->getProcess();
-            if ($process->getExitCode() === 222)
-            {
-                // This indicates that the sub-process threw an exception. It will have been printed and logged
-                // so don't trigger the normal exception handling. However, we can't continue so exit.
-                exit(1);
-            }
-        }
-    }
-
     /**
      * @param $key
      *

Cli/Command/Exception/InvalidAddOnQuestionFieldAnswerException.php

@@ -51,6 +51,7 @@ protected function execute(InputInterface $input, OutputInterface $output) : int
         {
             $entity = \XF::em()->create($id);
         }
+            /** @noinspection PhpUnusedLocalVariableInspection */
         catch (\Exception $e)
         {
             $class = \XF::stringToClass($id, '%s\Entity\%s');

Cli/Command/GenerateSchemaEntity.php

@@ -6,23 +6,19 @@
 use XF\Mvc\Entity\Structure as EntityStructure;
 
 /**
- * Class EmailLog
- *
- * @package TickTackk\DeveloperTools\Entity
- *
  * COLUMNS
  * @property int|null email_id
  * @property string subject
  * @property int log_date
  * @property string return_path
- * @property array<string, string> sender
- * @property array<string, string> from
- * @property string[] reply_to
- * @property string[] to
- * @property string[] cc
- * @property string[] bcc
- * @property string html_message
- * @property string text_message
+ * @property array|null|null sender
+ * @property array|null from
+ * @property array|null|null reply_to
+ * @property array|null to
+ * @property array|null|null cc
+ * @property array|null|null bcc
+ * @property string|null html_message
+ * @property string|null text_message
  */
 class EmailLog extends Entity
 {

Entity/EmailLog.php

@@ -2,14 +2,13 @@
 
 namespace TickTackk\DeveloperTools;
 
-use TickTackk\DeveloperTools\XF\PermissionCache as ExtendedPermissionCache;
 use TickTackk\DeveloperTools\XF\Template\Templater as ExtendedTemplater;
 use XF\App as BaseApp;
-use XF\Container;
 use XF\Http\Response;
 use XF\Mvc\Dispatcher;
 use XF\Mvc\Reply\AbstractReply;
 use XF\Mvc\Renderer\AbstractRenderer;
+use XF\PermissionCache;
 use XF\Util\File as FileUtil;
 
 /**
@@ -28,7 +27,15 @@ class Listener
      * @param AbstractRenderer $renderer   Renderer object.
      * @param Response         $response   HTTP Response object.
      */
-    public static function dispatcherPostRender(Dispatcher $dispatcher, ?string &$content, AbstractReply $reply, AbstractRenderer $renderer, Response $response) : void
+    public static function dispatcherPostRender
+    (
+        /** @noinspection PhpUnusedParameterInspection */
+        Dispatcher $dispatcher,
+        ?string &$content,
+        AbstractReply $reply,
+        AbstractRenderer $renderer,
+        Response $response
+    ) : void
     {
         if (!\is_string($content))
         {
@@ -71,11 +78,11 @@ public static function dispatcherPostRender(Dispatcher $dispatcher, ?string &$co
      */
     public static function appSetup(BaseApp $app) : void
     {
-        $container = $app->container();
-
-        $container['permission.cache'] = function (Container $container)
+        $app->offsetSet('permission.cache', function ($c) use ($app)
         {
-            return new ExtendedPermissionCache($container['db']);
-        };
+            $class = $app->extendClass(PermissionCache::class);
+
+            return new $class($c['db']);
+        });
     }
 }

Listener.php

@@ -163,13 +163,12 @@ class {$listenerClass}
 PHP;
     }
 
-    /**
-     * @param string $listenerMethod
-     * @param string $indent
-     *
-     * @return string
-     */
-    public function getListenerMethodBlock(string $listenerMethod, string $indent = null)
+    public function getListenerMethodBlock
+    (
+        /** @noinspection PhpUnusedParameterInspection */
+        string $listenerMethod,
+        string $indent = null
+    ) : string
     {
         $codeEvent = $this->getCodeEvent();