pluswerk/mail_logger

View on GitHub

Showing 10 of 10 total issues

MailTemplate has 24 functions (exceeds 20 allowed). Consider refactoring.
Open

class MailTemplate extends AbstractModel
{
    protected string $typoScriptKey = '';

    protected string $templatePathKey = '';
Severity: Minor
Found in Classes/Domain/Model/MailTemplate.php - About 2 hrs to fix

    Similar blocks of code found in 2 locations. Consider refactoring.
    Open

            'starttime' => [
                'exclude' => 1,
                'label' => 'LLL:EXT:core/Resources/Private/Language/locallang_general.xlf:LGL.starttime',
                'config' => [
                    'type' => 'input',
    Configuration/TCA/tx_maillogger_domain_model_mailtemplate.php on lines 83..100

    Duplicated Code

    Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

    Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

    When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

    Tuning

    This issue has a mass of 126.

    We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

    The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

    If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

    See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

    Refactorings

    Further Reading

    Similar blocks of code found in 2 locations. Consider refactoring.
    Open

            'endtime' => [
                'exclude' => 1,
                'label' => 'LLL:EXT:core/Resources/Private/Language/locallang_general.xlf:LGL.endtime',
                'config' => [
                    'type' => 'input',
    Configuration/TCA/tx_maillogger_domain_model_mailtemplate.php on lines 65..82

    Duplicated Code

    Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

    Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

    When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

    Tuning

    This issue has a mass of 126.

    We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

    The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

    If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

    See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

    Refactorings

    Further Reading

    TemplateBasedMailMessage has 21 functions (exceeds 20 allowed). Consider refactoring.
    Open

    class TemplateBasedMailMessage extends MailMessage
    {
        protected MailTemplate $mailTemplate;
    
        /**
    Severity: Minor
    Found in Classes/Domain/Model/TemplateBasedMailMessage.php - About 2 hrs to fix

      Method assignMailTemplateValues has 35 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

          private function assignMailTemplateValues(array $values): void
          {
              if (!empty($values['typoScriptKey'])) {
                  $this->assignDefaultsFromTypoScript($values['typoScriptKey'], $this->mailTemplate->getTemplatePathKey());
              }
      Severity: Minor
      Found in Classes/Domain/Model/TemplateBasedMailMessage.php - About 1 hr to fix

        Function showMailLogModal has 34 lines of code (exceeds 25 allowed). Consider refactoring.
        Open

          function showMailLogModal(html, title) {
            const typo3Window = (opener != null && typeof opener.top.TYPO3 !== 'undefined' ? opener.top : top);
            const buttonClass = Severity.getCssClass(Severity.info);
        
            const buttons = [{
        Severity: Minor
        Found in Resources/Public/JavaScript/MailLogModal.js - About 1 hr to fix

          Similar blocks of code found in 2 locations. Consider refactoring.
          Open

              public function getDkimKeys(array &$config): void
              {
                  $items = [['', '']];
                  $settings = ConfigurationUtility::getCurrentModuleConfiguration('settings');
                  foreach ($settings['dkim'] ?? [] as $key => $value) {
          Severity: Major
          Found in Classes/Wizard/MailTemplate.php and 1 other location - About 1 hr to fix
          Classes/Wizard/MailTemplate.php on lines 15..24

          Duplicated Code

          Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

          Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

          When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

          Tuning

          This issue has a mass of 106.

          We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

          The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

          If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

          See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

          Refactorings

          Further Reading

          Similar blocks of code found in 2 locations. Consider refactoring.
          Open

              public function getTypoScriptKeys(array &$config): void
              {
                  $items = [['', '']];
                  $settings = ConfigurationUtility::getCurrentModuleConfiguration('settings');
                  foreach ($settings['mailTemplates'] ?? [] as $key => $value) {
          Severity: Major
          Found in Classes/Wizard/MailTemplate.php and 1 other location - About 1 hr to fix
          Classes/Wizard/MailTemplate.php on lines 29..38

          Duplicated Code

          Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

          Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

          When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

          Tuning

          This issue has a mass of 106.

          We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

          The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

          If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

          See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

          Refactorings

          Further Reading

          Function assignMailTemplateValues has a Cognitive Complexity of 9 (exceeds 5 allowed). Consider refactoring.
          Open

              private function assignMailTemplateValues(array $values): void
              {
                  if (!empty($values['typoScriptKey'])) {
                      $this->assignDefaultsFromTypoScript($values['typoScriptKey'], $this->mailTemplate->getTemplatePathKey());
                  }
          Severity: Minor
          Found in Classes/Domain/Model/TemplateBasedMailMessage.php - About 55 mins to fix

          Cognitive Complexity

          Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

          A method's cognitive complexity is based on a few simple rules:

          • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
          • Code is considered more complex for each "break in the linear flow of the code"
          • Code is considered more complex when "flow breaking structures are nested"

          Further reading

          Function getBodyAsHtml has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
          Open

              protected function getBodyAsHtml(AbstractPart $part): string
              {
                  if ($part instanceof AbstractMultipartPart) {
                      $messageString = '';
                      foreach ($part->getParts() as $childPart) {
          Severity: Minor
          Found in Classes/Logging/LoggingTransport.php - About 25 mins to fix

          Cognitive Complexity

          Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

          A method's cognitive complexity is based on a few simple rules:

          • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
          • Code is considered more complex for each "break in the linear flow of the code"
          • Code is considered more complex when "flow breaking structures are nested"

          Further reading

          Severity
          Category
          Status
          Source
          Language