[Summary view] [Print] [Text view]

   1  <?php declare(strict_types=1);
   2  
   3  /**
   4  * @package   s9e\TextFormatter
   5  * @copyright Copyright (c) 2010-2022 The s9e authors
   6  * @license   http://www.opensource.org/licenses/mit-license.php The MIT License
   7  */
   8  namespace s9e\TextFormatter\Plugins\TaskLists;
   9  
  10  use s9e\TextFormatter\Parser;
  11  use s9e\TextFormatter\Parser\Tag;
  12  
  13  class Helper
  14  {
  15  	public static function filterListItem(Parser $parser, Tag $listItem, string $text): void
  16      {
  17          // Test whether the list item is followed by a task checkbox
  18          $pos  = $listItem->getPos() + $listItem->getLen();
  19          $pos += strspn($text, ' ', $pos);
  20          $str  = substr($text, $pos, 3);
  21          if (!preg_match('/\\[[ Xx]\\]/', $str))
  22          {
  23              return;
  24          }
  25  
  26          // Create a tag for the task and assign it a random ID
  27          $taskId    = uniqid();
  28          $taskState = ($str === '[ ]') ? 'unchecked' : 'checked';
  29  
  30          $task = $parser->addSelfClosingTag('TASK', $pos, 3);
  31          $task->setAttribute('id',    $taskId);
  32          $task->setAttribute('state', $taskState);
  33  
  34          $listItem->cascadeInvalidationTo($task);
  35      }
  36  
  37      /**
  38      * Return stats from a parsed representation
  39      *
  40      * @param  string $xml Parsed XML
  41      * @return array       Number of "checked" and "unchecked" tasks
  42      */
  43  	public static function getStats(string $xml): array
  44      {
  45          $stats = ['checked' => 0, 'unchecked' => 0];
  46  
  47          preg_match_all('((?<=<)TASK(?: [^=]++="[^"]*+")*? state="\\K\\w++)', $xml, $m);
  48          foreach ($m[0] as $state)
  49          {
  50              if (!isset($stats[$state]))
  51              {
  52                  $stats[$state] = 0;
  53              }
  54              ++$stats[$state];
  55          }
  56  
  57          return $stats;
  58      }
  59  
  60      /**
  61      * Mark given task checked in XML
  62      *
  63      * @param  string $xml Parsed XML
  64      * @param  string $id  Task's ID
  65      * @return string      Updated XML
  66      */
  67  	public static function checkTask(string $xml, string $id): string
  68      {
  69          return self::setTaskState($xml, $id, 'checked', 'x');
  70      }
  71  
  72      /**
  73      * Mark given task unchecked in XML
  74      *
  75      * @param  string $xml Parsed XML
  76      * @param  string $id  Task's ID
  77      * @return string      Updated XML
  78      */
  79  	public static function uncheckTask(string $xml, string $id): string
  80      {
  81          return self::setTaskState($xml, $id, 'unchecked', ' ');
  82      }
  83  
  84      /**
  85      * Change the state and marker of given task in XML
  86      *
  87      * @param  string $xml    Parsed XML
  88      * @param  string $id     Task's ID
  89      * @param  string $state  Task's state ("checked" or "unchecked")
  90      * @param  string $marker State marker ("x" or " ")
  91      * @return string         Updated XML
  92      */
  93  	protected static function setTaskState(string $xml, string $id, string $state, string $marker): string
  94      {
  95          return preg_replace_callback(
  96              '((?<=<)TASK(?: [^=]++="[^"]*+")*? id="' . preg_quote($id) . '"\\K([^>]*+)>[^<]*+(?=</TASK>))',
  97              function ($m) use ($state, $marker)
  98              {
  99                  preg_match_all('( ([^=]++)="[^"]*+")', $m[1], $m);
 100  
 101                  $attributes          = array_combine($m[1], $m[0]);
 102                  $attributes['state'] = ' state="' . $state . '"';
 103                  ksort($attributes);
 104  
 105                  return implode('', $attributes) . '>[' . $marker . ']';
 106              },
 107              $xml
 108          );
 109      }
 110  }