icons.php

<?php
/*
 * Copyright (C) 2024 Anthony Damhet <a.damhet@progiseize.fr>
 * Copyright (C) 2026   MDW       <mdeweerd@users.noreply.github.com>
 *
 * This program and files/directory inner it is free software: you can
 * redistribute it and/or modify it under the terms of the
 * GNU Affero General Public License (AGPL) as published by
 * the Free Software Foundation, either version 3 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 AGPL for more details.
 *
 * You should have received a copy of the GNU AGPL
 * along with this program. If not, see <https://www.gnu.org/licenses/agpl-3.0.html>.
 */
 
// Load Dolibarr environment
require '../../../../main.inc.php';
 
// Protection if external user
if ($user->socid > 0) {
  accessforbidden();
}
 
// Includes
require_once DOL_DOCUMENT_ROOT . '/admin/tools/ui/class/documentation.class.php';
 
// Load documentation translations
$langs->load('uxdocumentation');
 
//
$documentation = new Documentation($db);
 
// Output html head + body - Param is Title
$documentation->docHeader('Icons', [], ['admin/tools/ui/css/doc-icons.css'], GETPOST('hidenavmenu'));
 
// Set view for menu and breadcrumb
// Menu must be set in constructor of documentation class
$documentation->view = array('Components','Icons');
$form = new Form($db);
 
$mode = GETPOST('mode'); // ex : no-btn
$displayMode = GETPOST('displayMode') == 'kanban' ? 'kanban' : 'icon-only';
$revertDisplayMode = $displayMode == 'kanban' ? 'icon-only' : 'kanban';
$revertDisplayName = $displayMode == 'kanban' ? $langs->trans('ViewList') : $langs->trans('ViewKanban');
$switchDisplayLink = dol_buildpath($documentation->baseUrl . '/components/icons.php', 1) . '?displayMode=' . $revertDisplayMode;
$switchDisplayLinkIcon = $displayMode == 'kanban' ? 'fa fa-th' : 'fa fa-th-list';
 
// Output sidebar
if (!GETPOST('hidenavmenu')) {
  $documentation->showSidebar();
}
?>
 
<div class="doc-wrapper<?php print GETPOST('hidenavmenu') ? "-bis" : ""; ?>">
 
    <?php
    if (!GETPOST('hidenavmenu')) {
      $documentation->showBreadCrumb();
    }
    ?>
 
    <div class="doc-content-wrapper">
 
      <h1 class="documentation-title"><?php echo $langs->trans('DocIconsTitle'); ?></h1>
      <p class="documentation-text"><?php echo $langs->trans('DocIconsMainDescription'); ?></p>
 
      <!-- Summary -->
      <?php $documentation->showSummary(); ?>
 
      <br>
 
      <!-- List of usage font awesome icon -->
      <div class="documentation-section" id="img-picto-section-list">
 
        <?php
        $iconFileName = 'shims.json';
        $iconFilePath = DOL_DOCUMENT_ROOT . '/theme/common/fontawesome-5/metadata';
 
        $fontAwesomeIconRaw = file_get_contents($iconFilePath. '/' .$iconFileName);
        if ($fontAwesomeIconRaw === false) {
          dol_print_error($db, 'Error missing file  '. $iconFilePath . '/' . $iconFileName);
        }
 
        $fontAwesomeIcons = json_decode($fontAwesomeIconRaw);
        if ($fontAwesomeIcons === null) {
          dol_print_error($db, 'Error decoding '. $iconFilePath . '/' . $iconFileName);
        }
        ?>
 
        <h2 class="documentation-title"><?php echo $langs->trans('DocIconsListImgPicto'); ?></h2>
        <?php /* <p class="documentation-text"><?php echo $langs->trans('DocDocIconsListDescription'); ?></p>*/ ?>
 
        <?php print $form->getSearchFilterToolInput(
          '.documentation-img-picto-icon-list .info-box, .documentation-img-picto-icon-list .doc-icon-list-item',
          'search-tools-input',
          '',
          ['attr' => [
              'data-no-item-target' => '#img-picto-section-list .search-tool-no-results',
            ],
          ]
        ); ?>
 
        <div class="right">
          <?php
          if ($mode != 'no-btn') {
            print dolGetButtonTitle($revertDisplayName, '', $switchDisplayLinkIcon, $switchDisplayLink.'#img-picto-section-list', '', 1, ['forcenohideoftext' => 1]);
          }
          ?>
        </div>
 
        <div class="documentation-example">
          <div class="documentation-img-picto-icon-list">
            <?php
            $arrayofdolibarriconkey = getImgPictoNameList();
 
            foreach ($arrayofdolibarriconkey as $iconName) {
              $labelAlt = 'Text on title tag for tooltip';
 
              if ($displayMode == 'kanban') {
                $iconCode =  img_picto($iconName, $iconName);
                print '<div class="info-box ">
                  <span class="info-box-icon bg-infobox-expensereport">
                    '.$iconCode.'
                  </span>
                  <div class="info-box-content">
                    <div class="info-box-title" >'. $iconName .'</div>
                    <div class="info-box-lines">
                      <div class="info-box-line spanoverflow nowrap">
                        <div class="inline-block nowraponall">
                          <div class="documentation-code"><pre>'.dol_htmlentities('img_picto(\''.$labelAlt.'\', \''.$iconName.'\')').'</pre></div>
                        </div>
                      </div>
                    </div><!-- /.info-box-lines -->
                  </div><!-- /.info-box-content -->
                </div>';
              } else {
                $tooltip = '<u>'.$langs->trans("DocCodeForMenuOrModuleBuilder").':</u><br>'.$iconName;
                $tooltip .= '<br><br><u>'.$langs->trans("DocExampleForPHPCode").':</u><br>img_picto(\''.$labelAlt.'\', \''.$iconName.'\')';
                $iconCode = img_picto($tooltip, $iconName, '', 0, 0, 0, '', 'classfortooltip');
                print '<span class="doc-icon-list-item">'.$iconCode;
                print '<span class="doc-icon-hidden-name-for-search">'.$iconName.'</span></span>';
              }
            }
            ?>
          </div>
 
          <div class="search-tool-no-results center hidden-search-result" ><?php print $langs->trans('NoResults') ?></div>
        </div>
      </div>
      <!--  -->
 
 
      <br><br>
 
 
      <!-- List of usage font awesome icon -->
      <div class="documentation-section" id="icon-section-list">
 
        <?php
        $iconFileFa   = 'icons.json';
        $iconFilePath = DOL_DOCUMENT_ROOT . '/theme/common/fontawesome-5/metadata';
 
        // Load the full FontAwesome 5 icons JSON
        $allIconsRaw = file_get_contents($iconFilePath . '/' . $iconFileFa);
        $fontAwesomeIcons = []; // This will be the output array in shims.json format
 
        if ($allIconsRaw === false) {
          dol_print_error($db, 'Error: missing file ' . $iconFilePath . '/' . $iconFileFa);
        } else {
          $allIcons = json_decode($allIconsRaw, true);
          if ($allIcons === null) {
            dol_print_error($db, 'Error: cannot decode JSON from ' . $iconFilePath . '/' . $iconFileFa);
          } else {
            foreach ($allIcons as $iconName => $iconData) {
              // Determine prefix: 'fab' for brands, 'fas' or 'far' can be added later if needed
              $prefix = in_array('brands', $iconData['styles']) ? 'fab' : null;
              // Format: [ "icon-name", "prefix if any", null ]
              $fontAwesomeIcons[] = [$iconName, $prefix, null]; // null reserved for future alias
            }
          }
        }
        ?>
 
        <h2 class="documentation-title"><?php echo $langs->trans('DocIconsListFontAwesome'); ?></h2>
        <?php /* <p class="documentation-text"><?php echo $langs->trans('DocDocIconsListDescription'); ?></p>*/ ?>
 
        <?php print $form->getSearchFilterToolInput('.documentation-fontawesome-icon-list .info-box, .documentation-fontawesome-icon-list .doc-icon-list-item',
          'search-tools-input',
          '',
          ['attr' => [
              'data-no-item-target' => '#icon-section-list .search-tool-no-results',
            ],
          ]
        ); ?>
 
        <div class="right">
          <?php
          if ($mode != 'no-btn') {
            print dolGetButtonTitle($revertDisplayName, '', $switchDisplayLinkIcon, $switchDisplayLink.'#icon-section-list', '', 1, ['forcenohideoftext' => 1]);
          }
          ?>
        </div>
 
        <div class="documentation-example">
          <div class="documentation-fontawesome-icon-list">
          <?php
          $alreadyDisplay = [];
          if ($fontAwesomeIcons) {
            foreach ($fontAwesomeIcons as $iconData) {
              $class = $iconData[1] ?? 'fa';
              if (!empty($iconData[2])) {
                $class .= ' fa-'.$iconData[2];
              } else {
                $class .= ' fa-'.$iconData[0];
              }
 
              if (in_array($class, $alreadyDisplay)) {
                continue;
              }
 
              $alreadyDisplay[] = $class;
              $iconCode =  '<span class="'.$class.'" ></span>';
              $iconLabel = !empty($iconData[2]) ? $iconData[2] : $iconData[0];
 
              if ($displayMode == 'kanban') {
                print '<div class="info-box ">
                    <span class="info-box-icon bg-infobox-expensereport">
                      ' . $iconCode . '
                    </span>
                    <div class="info-box-content">
                      <div class="info-box-title" >' . $iconLabel . '</div>
                      <div class="info-box-lines">
                        <div class="info-box-line spanoverflow nowrap">
                          <div class="inline-block nowraponall">
                            <div class="documentation-code"><pre>' . dol_htmlentities($iconCode) . '</pre></div>
                          </div>
                        </div>
                      </div><!-- /.info-box-lines -->
                    </div><!-- /.info-box-content -->
                  </div>';
              } else {
                $tooltip = '<u>'.$langs->trans("DocCodeForMenuOrModuleBuilder").':</u><br>'.$class;
                print '<span class="doc-icon-list-item classfortooltip" title="'.dol_escape_htmltag($tooltip).'">'.$iconCode.'<span class="doc-icon-hidden-name-for-search">'.$class.'</span></span>';
              }
            }
          }
          ?>
          </div>
 
          <div class="search-tool-no-results center hidden-search-result" ><?php print $langs->trans('NoResults') ?></div>
        </div>
      </div>
      <!--  -->
    </div>
  </div>
 
<?php
// Output close body + html
$documentation->docFooter();
 
 
function getImgPictoNameList()
{
  $imgpicto = array_merge(array_keys(getImgPictoConv()), array(
    // Keep in this list only picto that are NOT already into getImgPictoConv()
    '1downarrow',
    '1uparrow',
    '1leftarrow',
    '1rightarrow',
    '1uparrow_selected',
    '1downarrow_selected',
    '1leftarrow_selected',
    '1rightarrow_selected',
    'angle-double-down',
    'angle-double-up',
    'barcode',
    'bank',
    'bell',
    'birthday-cake',
    'briefcase-medical',
    'bug',
    'building',
    'hourglass',
    'cash-register',
    'clock',
    'clone',
    'code',
    'cog',
    'cron',
    'cubes',
    'check-circle',
    'check-square',
    'circle',
    'chevron-left',
    'chevron-right',
    'chevron-down',
    'chevron-up',
    'dolly',
    'download',
    'ellipsis-h',
    'envelope',
    'eraser',
    'external-link-alt',
    'external-link-square-alt',
    'eye',
    'file',
    'file-code',
    'file-export',
    'file-import',
    'file-upload',
    'autofill',
    'folder',
    'folder-open',
    'folder-plus',
    'font',
    'generic',
    'globe-americas',
    'hands-helping',
    'id-card',
    'images',
    'key',
    'language',
    'link',
    'list',
    'listlight',
    'lock',
    'long-arrow-alt-right',
    'map-marker-alt',
    'minus',
    'money-bill-alt',
    'note',
    'off',
    'on',
    'paragraph',
    'play',
    'phone',
    'search',
    'share-alt',
    'stripe-s',
    'unlink',
    'user',
    'user-tie',
    'wrench',
    'discord',
    'facebook',
    'flickr',
    'instagram',
    'linkedin',
    'github',
    'google',
    'meetup',
    'microsoft',
    'skype',
    'slack',
    'twitter',
    'pinterest',
    'reddit',
    'snapchat',
    'tumblr',
    'youtube',
    'viadeo',
    'google-plus-g',
    'whatsapp',
    'home',
    'pencil-ruler',
    'question',
    'rss',
    'search-plus',
    'shapes',
    'square',
    'sort-numeric-down',
    'supplier_invoice',
    'terminal',
    'undo',
    'user-cog',
    'user-injured',
    'user-md',
    'upload',
    'stamp',
    'signature'
  ));
 
  asort($imgpicto);
 
  return array_unique($imgpicto);  // @phpstan-ignore return.type
}