NamingContract.class.php

Go to the documentation of this file.

<?php
/* Copyright (C) 2026 ATM Consulting <support@atm-consulting.fr>
 * Copyright (C) 2026   MDW       <mdeweerd@users.noreply.github.com>
 *
 * 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 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program. If not, see <https://www.gnu.org/licenses/>.
 */
 
require_once DOL_DOCUMENT_ROOT . '/core/lib/functions.lib.php';
 
final class NamingContract
{
  public $moduleNameCase;
 
  public $moduleNameLower;
 
  public $moduleNameUpper;
 
  public $objectNameCase;
 
  public $objectNameLower;
 
  public $objectNameUpper;
 
  public function __construct(string $moduleName, string $objectName = '')
  {
    $this->moduleNameCase  = dol_ucfirst($moduleName);
    $this->moduleNameLower = dol_strtolower($moduleName);
    $this->moduleNameUpper = dol_strtoupper($moduleName);
 
    if ($objectName === '') {
      $this->objectNameCase  = '';
      $this->objectNameLower = '';
      $this->objectNameUpper = '';
      return;
    }
 
    if (dol_strtolower($moduleName) === dol_strtolower($objectName)) {
      throw new \InvalidArgumentException(
        'Module and object names cannot be identical (case-insensitive match): "'
        . $moduleName . '" vs "' . $objectName . '"'
      );
    }
 
    $this->objectNameCase  = dol_ucfirst($objectName);
    $this->objectNameLower = dol_strtolower($objectName);
    $this->objectNameUpper = dol_strtoupper($objectName);
  }
 
  public function getSubstitutionMap(): array
  {
    $map = [
      'MYMODULE'   => $this->moduleNameUpper,
      'MyModule'   => $this->moduleNameCase,
      'My module'  => $this->moduleNameCase,
      'my module'  => $this->moduleNameLower,
      'Mon module' => $this->moduleNameCase,
      'mon module' => $this->moduleNameLower,
      'mymodule'   => $this->moduleNameLower,
    ];
 
    if ($this->objectNameLower !== '') {
      $map['MYOBJECT']  = $this->objectNameUpper;
      $map['MyObject']  = $this->objectNameCase;
      $map['My Object'] = $this->objectNameCase;
      $map['my object'] = $this->objectNameLower;
      $map['myobject']  = $this->objectNameLower;
    }
 
    return $map;
  }
 
  public function applyTo(string $content): string
  {
    $map = $this->getSubstitutionMap();
    return str_replace(array_keys($map), array_values($map), $content);
  }
 
  public function applyToFilename(string $filename): string
  {
    $search  = ['mymodule'];
    $replace = [$this->moduleNameLower];
 
    if ($this->objectNameLower !== '') {
      $search[]  = 'myobject';
      $replace[] = $this->objectNameLower;
    }
 
    return str_replace($search, $replace, $filename);
  }
}