Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Refactor Config #182

Merged
merged 10 commits into from
Dec 29, 2024
Merged

Refactor Config #182

Changes from 1 commit
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
4e0c6c6
Convert array to properties
Dec 22, 2024
b3aac50
Replace method calls with property access
Dec 22, 2024
9b92d47
Refactor methods mass getting and setting options
Dec 22, 2024
3b7843e
Fix color output related methods
Dec 22, 2024
da20c56
Refactor copyright
Dec 22, 2024
496ef48
Add PHP format related properties
Dec 22, 2024
297cd32
Make constant explicitly public
Dec 22, 2024
aa6ba65
Replace method calls with property access
Dec 22, 2024
6cbb374
Fix tests
Dec 22, 2024
627460d
Change property names to camel case
Dec 29, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
88 changes: 45 additions & 43 deletions phpdotnet/phd/Config.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,49 +5,51 @@ class Config
{
const VERSION = '@phd_version@';

private static $optionArrayDefault = array(
'output_format' => array(),
'no_index' => false,
'force_index' => false,
'no_toc' => false,
'xml_root' => '.',
'xml_file' => './.manual.xml',
'history_file' => './fileModHistory.php',
'lang_dir' => './',
'language' => 'en',
'fallback_language' => 'en',
'verbose' => VERBOSE_DEFAULT,
'date_format' => 'H:i:s',
'render_ids' => array(
),
'skip_ids' => array(
),
'color_output' => true,
'output_dir' => './output/',
'output_filename' => '',
'php_error_output' => STDERR,
'php_error_color' => '01;31', // Red
'user_error_output' => STDERR,
'user_error_color' => '01;33', // Yellow
'phd_info_output' => STDOUT,
'phd_info_color' => '01;32', // Green
'phd_warning_output' => STDOUT,
'phd_warning_color' => '01;35', // Magenta
'highlighter' => 'phpdotnet\\phd\\Highlighter',
'package' => array(
'Generic',
),
'css' => array(),
'process_xincludes' => false,
'ext' => null,
'package_dirs' => array(__INSTALLDIR__),
'saveconfig' => false,
'quit' => false,
'indexcache' => '',
'memoryindex' => '',
);

private static $optionArray = null;
/** @var array<string, string> */
public array $output_format = [];
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is the change from static to instance properties okay? (not that I think having it static in the first place made a lot of sense).

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it makes sense that one set of configuration options can be assigned to one object of the class Config and then we just pass the appropriate object when needed.

As far as how Config is used in PhD, this doesn't make much of a difference as only one Config object is used throughout. :-)

public bool $no_index = false;
public bool $force_index = false;
public bool $no_toc = false;
public string $xml_root = '.';
public string $xml_file = './.manual.xml';
public string $history_file = './fileModHistory.php';
public string $lang_dir = './';
public string $language = 'en';
public string $fallback_language = 'en';
public int $verbose = VERBOSE_DEFAULT;
public string $date_format = 'H:i:s';
/** @var array<string> */
public array $render_ids = [];
/** @var array<string> */
public array $skip_ids = [];
private bool $color_output = true;
public string $output_dir = './output/';
public string $output_filename = '';
/** @var resource */
public $php_error_output = \STDERR;
public string $php_error_color = '01;31'; // Red
/** @var resource */
public $user_error_output = \STDERR;
public string $user_error_color = '01;33'; // Yellow
/** @var resource */
public $phd_info_output = \STDOUT;
public string $phd_info_color = '01;32'; // Green
/** @var resource */
public $phd_warning_output = \STDOUT;
public string $phd_warning_color = '01;35'; // Magenta
public string $highlighter = 'phpdotnet\\phd\\Highlighter';
/** @var array<string> */
public array $package =['Generic'];
/** @var array<string> $css */
public array $css = [];
public bool $process_xincludes = false;
public ?string $ext = null;
/** @var array<string> */
public array $package_dirs = [__INSTALLDIR__];
public bool $saveconfig = false;
public bool $quit = false;
public ?IndexRepository $indexcache = null;
public bool $memoryindex = false;

public static function init(array $a) {
// Override any defaults due to operating system constraints
Expand Down