Compare commits
97 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
c57e798591 | ||
|
|
8126f08b8c | ||
|
|
6f657f2890 | ||
|
|
92214ae136 | ||
|
|
71f9afd6c7 | ||
|
|
11de4f9915 | ||
|
|
dfb46d4f4a | ||
|
|
53c7dda9a0 | ||
|
|
daf2706e7e | ||
|
|
6d3a7b7b28 | ||
|
|
745340a7f5 | ||
|
|
419c578c46 | ||
|
|
6beff9c6ac | ||
|
|
79dbd053fa | ||
|
|
74004e5221 | ||
|
|
0392187299 | ||
|
|
edcc65df3e | ||
|
|
5dde52a309 | ||
|
|
5f223fb50d | ||
|
|
2eaf80b1bd | ||
|
|
b5d601aec0 | ||
|
|
edcc77a6ab | ||
|
|
0b1df7a901 | ||
|
|
e0f8bad2d9 | ||
|
|
f5cd71cfbc | ||
|
|
1203164d7e | ||
|
|
b82e08ba05 | ||
|
|
6dfb68a6da | ||
|
|
5b944cd12d | ||
|
|
65cac4c6e2 | ||
|
|
1c1ace58db | ||
|
|
16e12b5b8f | ||
|
|
73063d28b2 | ||
|
|
e80d8006a2 | ||
|
|
d648e4339a | ||
|
|
4b084f8785 | ||
|
|
d0d088b354 | ||
|
|
e0d42af1d2 | ||
|
|
c1d26f122e | ||
|
|
2c2826ac24 | ||
|
|
72f0810898 | ||
|
|
b69539b340 | ||
|
|
0b133133dd | ||
|
|
8fbe855fd4 | ||
|
|
d7410dfe78 | ||
|
|
5d36ac2f3e | ||
|
|
2e4ace1a39 | ||
|
|
aa5c3b9dcc | ||
|
|
24f7a903ef | ||
|
|
72993925f0 | ||
|
|
29d5ef92d4 | ||
|
|
f66f8f282e | ||
|
|
c010673705 | ||
|
|
b16ff4c613 | ||
|
|
e9c791c164 | ||
|
|
c7ec1300b7 | ||
|
|
064710324e | ||
|
|
e0356dcadf | ||
|
|
62a5992e3a | ||
|
|
6bb957fcb3 | ||
|
|
0c1f060759 | ||
|
|
aad46ec80a | ||
|
|
f5e9f0610d | ||
|
|
14a5250cd7 | ||
|
|
6e6edef57d | ||
|
|
d3810db965 | ||
|
|
187a012284 | ||
|
|
b3d2662fd2 | ||
|
|
1189aecae9 | ||
|
|
024d6d2d7a | ||
|
|
f2d5377347 | ||
|
|
af11bd8199 | ||
|
|
0e6a43a2c2 | ||
|
|
94eeaaaa51 | ||
|
|
4a246bec5f | ||
|
|
46b2b60718 | ||
|
|
9616d956cb | ||
|
|
df401b9add | ||
|
|
4b9e393971 | ||
|
|
6cda319ed0 | ||
|
|
583edbfe0a | ||
|
|
67a8e1a533 | ||
|
|
38788dddce | ||
|
|
cf196d56dd | ||
|
|
0cb76c8db2 | ||
|
|
db02bdd102 | ||
|
|
d9b71a64b3 | ||
|
|
f410d761ba | ||
|
|
fb4b9f3f81 | ||
|
|
1e94cd7b57 | ||
|
|
cba6a3f969 | ||
|
|
bea8629d10 | ||
|
|
b2751872a3 | ||
|
|
0a80abe8a4 | ||
|
|
1d220f25eb | ||
|
|
1716b2c627 | ||
|
|
a0126f70ab |
123
.phan/config.old-20230828.php
Normal file
123
.phan/config.old-20230828.php
Normal file
@@ -0,0 +1,123 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
/**
|
||||||
|
* This configuration will be read and overlaid on top of the
|
||||||
|
* default configuration. Command line arguments will be applied
|
||||||
|
* after this file is read.
|
||||||
|
*
|
||||||
|
* @see src/Phan/Config.php
|
||||||
|
* See Config for all configurable options.
|
||||||
|
*
|
||||||
|
* A Note About Paths
|
||||||
|
* ==================
|
||||||
|
*
|
||||||
|
* Files referenced from this file should be defined as
|
||||||
|
*
|
||||||
|
* ```
|
||||||
|
* Config::projectPath('relative_path/to/file')
|
||||||
|
* ```
|
||||||
|
*
|
||||||
|
* where the relative path is relative to the root of the
|
||||||
|
* project which is defined as either the working directory
|
||||||
|
* of the phan executable or a path passed in via the CLI
|
||||||
|
* '-d' flag.
|
||||||
|
*/
|
||||||
|
|
||||||
|
use Phan\Config;
|
||||||
|
|
||||||
|
return [
|
||||||
|
// "target_php_version" => "8.2",
|
||||||
|
// turn color on (-C)
|
||||||
|
"color_issue_messages_if_supported" => true,
|
||||||
|
// If true, missing properties will be created when
|
||||||
|
// they are first seen. If false, we'll report an
|
||||||
|
// error message.
|
||||||
|
"allow_missing_properties" => false,
|
||||||
|
|
||||||
|
// Allow null to be cast as any type and for any
|
||||||
|
// type to be cast to null.
|
||||||
|
"null_casts_as_any_type" => false,
|
||||||
|
|
||||||
|
// Backwards Compatibility Checking
|
||||||
|
'backward_compatibility_checks' => false,
|
||||||
|
|
||||||
|
// Run a quick version of checks that takes less
|
||||||
|
// time
|
||||||
|
"quick_mode" => false,
|
||||||
|
|
||||||
|
// Only emit critical issues to start with
|
||||||
|
// (0 is low severity, 5 is normal severity, 10 is critical)
|
||||||
|
"minimum_severity" => 0,
|
||||||
|
|
||||||
|
// enable for dead code check
|
||||||
|
// this will spill out errors for all methods never called
|
||||||
|
// use after all is OK to try to find unused code blocks
|
||||||
|
// ignore recommended: PhanUnreferencedPublicMethod
|
||||||
|
// "dead_code_detection" => true,
|
||||||
|
|
||||||
|
// default false for include path check
|
||||||
|
"enable_include_path_checks" => true,
|
||||||
|
"include_paths" => [
|
||||||
|
'.',
|
||||||
|
// '../test/configs/'
|
||||||
|
],
|
||||||
|
'ignore_undeclared_variables_in_global_scope' => true,
|
||||||
|
|
||||||
|
"file_list" => [
|
||||||
|
"./test/configs/config.php",
|
||||||
|
// "./test/configs/config.db.php",
|
||||||
|
// "./test/configs/config.host.php",
|
||||||
|
// "./test/configs/config.path.php",
|
||||||
|
"./test/configs/config.other.php",
|
||||||
|
"./test/configs/config.master.php",
|
||||||
|
],
|
||||||
|
|
||||||
|
// A list of directories that should be parsed for class and
|
||||||
|
// method information. After excluding the directories
|
||||||
|
// defined in exclude_analysis_directory_list, the remaining
|
||||||
|
// files will be statically analyzed for errors.
|
||||||
|
//
|
||||||
|
// Thus, both first-party and third-party code being used by
|
||||||
|
// your application should be included in this list.
|
||||||
|
'directory_list' => [
|
||||||
|
// Change this to include the folders you wish to analyze
|
||||||
|
// (and the folders of their dependencies)
|
||||||
|
'src',
|
||||||
|
// To speed up analysis, we recommend going back later and
|
||||||
|
// limiting this to only the vendor/ subdirectories your
|
||||||
|
// project depends on.
|
||||||
|
// `phan --init` will generate a list of folders for you
|
||||||
|
'vendor/egrajp/smarty-extended',
|
||||||
|
],
|
||||||
|
|
||||||
|
|
||||||
|
// A list of directories holding code that we want
|
||||||
|
// to parse, but not analyze
|
||||||
|
"exclude_analysis_directory_list" => [
|
||||||
|
'vendor/egrajp/smarty-extended',
|
||||||
|
],
|
||||||
|
'exclude_file_list' => [
|
||||||
|
],
|
||||||
|
|
||||||
|
// what not to show as problem
|
||||||
|
'suppress_issue_types' => [
|
||||||
|
// 'PhanUndeclaredMethod',
|
||||||
|
'PhanEmptyFile',
|
||||||
|
// ignore unreferences public methods, etc here (for dead code check)
|
||||||
|
'PhanUnreferencedPublicMethod',
|
||||||
|
'PhanUnreferencedClass',
|
||||||
|
'PhanWriteOnlyPublicProperty',
|
||||||
|
'PhanUnreferencedConstant',
|
||||||
|
'PhanWriteOnlyPublicProperty',
|
||||||
|
'PhanReadOnlyPublicProperty',
|
||||||
|
// start ignore annotations
|
||||||
|
'PhanUnextractableAnnotationElementName',
|
||||||
|
'PhanUnextractableAnnotationSuffix',
|
||||||
|
],
|
||||||
|
|
||||||
|
// Override to hardcode existence and types of (non-builtin) globals in the global scope.
|
||||||
|
// Class names should be prefixed with `\`.
|
||||||
|
//
|
||||||
|
// (E.g. `['_FOO' => '\FooClass', 'page' => '\PageClass', 'userId' => 'int']`)
|
||||||
|
'globals_type_map' => [],
|
||||||
|
];
|
||||||
408
.phan/config.php
408
.phan/config.php
@@ -1,12 +1,25 @@
|
|||||||
<?php
|
<?php
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
* This configuration file was automatically generated by 'phan --init --init-level=3'
|
||||||
|
*
|
||||||
|
* TODOs (added by 'phan --init'):
|
||||||
|
*
|
||||||
|
* - Go through this file and verify that there are no missing/unnecessary files/directories.
|
||||||
|
* (E.g. this only includes direct composer dependencies
|
||||||
|
* - You may have to manually add indirect composer dependencies to 'directory_list')
|
||||||
|
* - Look at 'plugins' and add or remove plugins if appropriate
|
||||||
|
* (see https://github.com/phan/phan/tree/v5/.phan/plugins#plugins)
|
||||||
|
* - Add global suppressions for pre-existing issues to suppress_issue_types
|
||||||
|
* (https://github.com/phan/phan/wiki/Tutorial-for-Analyzing-a-Large-Sloppy-Code-Base)
|
||||||
|
* - Consider setting up a baseline if there are a large number of pre-existing issues (see `phan --extended-help`)
|
||||||
|
*
|
||||||
* This configuration will be read and overlaid on top of the
|
* This configuration will be read and overlaid on top of the
|
||||||
* default configuration. Command line arguments will be applied
|
* default configuration. Command line arguments will be applied
|
||||||
* after this file is read.
|
* after this file is read.
|
||||||
*
|
*
|
||||||
* @see src/Phan/Config.php
|
* @see https://github.com/phan/phan/wiki/Phan-Config-Settings for all configurable options
|
||||||
* See Config for all configurable options.
|
* @see https://github.com/phan/phan/tree/v5/src/Phan/Config.php
|
||||||
*
|
*
|
||||||
* A Note About Paths
|
* A Note About Paths
|
||||||
* ==================
|
* ==================
|
||||||
@@ -23,98 +36,343 @@
|
|||||||
* '-d' flag.
|
* '-d' flag.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
use Phan\Config;
|
use Phan\Issue;
|
||||||
|
|
||||||
return [
|
return [
|
||||||
// "target_php_version" => "8.2",
|
|
||||||
// turn color on (-C)
|
// The PHP version that the codebase will be checked for compatibility against.
|
||||||
"color_issue_messages_if_supported" => true,
|
// For best results, the PHP binary used to run Phan should have the same PHP version.
|
||||||
// If true, missing properties will be created when
|
// (Phan relies on Reflection for some types, param counts,
|
||||||
|
// and checks for undefined classes/methods/functions)
|
||||||
|
//
|
||||||
|
// Supported values: `'5.6'`, `'7.0'`, `'7.1'`, `'7.2'`, `'7.3'`, `'7.4'`,
|
||||||
|
// `'8.0'`, `'8.1'`, `null`.
|
||||||
|
// If this is set to `null`,
|
||||||
|
// then Phan assumes the PHP version which is closest to the minor version
|
||||||
|
// of the php executable used to execute Phan.
|
||||||
|
//
|
||||||
|
// Note that the **only** effect of choosing `'5.6'` is to infer that functions removed in php 7.0 exist.
|
||||||
|
// (See `backward_compatibility_checks` for additional options)
|
||||||
|
// Automatically inferred from composer.json requirement for "php" of ">=8.2"
|
||||||
|
'target_php_version' => '8.1',
|
||||||
|
|
||||||
|
// If enabled, missing properties will be created when
|
||||||
// they are first seen. If false, we'll report an
|
// they are first seen. If false, we'll report an
|
||||||
// error message.
|
// error message if there is an attempt to write
|
||||||
"allow_missing_properties" => false,
|
// to a class property that wasn't explicitly
|
||||||
|
// defined.
|
||||||
|
'allow_missing_properties' => false,
|
||||||
|
|
||||||
// Allow null to be cast as any type and for any
|
// If enabled, null can be cast to any type and any
|
||||||
// type to be cast to null.
|
// type can be cast to null. Setting this to true
|
||||||
"null_casts_as_any_type" => false,
|
// will cut down on false positives.
|
||||||
|
'null_casts_as_any_type' => false,
|
||||||
|
|
||||||
// Backwards Compatibility Checking
|
// If enabled, allow null to be cast as any array-like type.
|
||||||
'backward_compatibility_checks' => false,
|
//
|
||||||
|
// This is an incremental step in migrating away from `null_casts_as_any_type`.
|
||||||
|
// If `null_casts_as_any_type` is true, this has no effect.
|
||||||
|
'null_casts_as_array' => true,
|
||||||
|
|
||||||
// Run a quick version of checks that takes less
|
// If enabled, allow any array-like type to be cast to null.
|
||||||
// time
|
// This is an incremental step in migrating away from `null_casts_as_any_type`.
|
||||||
"quick_mode" => false,
|
// If `null_casts_as_any_type` is true, this has no effect.
|
||||||
|
'array_casts_as_null' => true,
|
||||||
|
|
||||||
// Only emit critical issues to start with
|
// If enabled, scalars (int, float, bool, string, null)
|
||||||
// (0 is low severity, 5 is normal severity, 10 is critical)
|
// are treated as if they can cast to each other.
|
||||||
"minimum_severity" => 0,
|
// This does not affect checks of array keys. See `scalar_array_key_cast`.
|
||||||
|
'scalar_implicit_cast' => false,
|
||||||
|
|
||||||
// enable for dead code check
|
// If enabled, any scalar array keys (int, string)
|
||||||
// this will spill out errors for all methods never called
|
// are treated as if they can cast to each other.
|
||||||
// use after all is OK to try to find unused code blocks
|
// E.g. `array<int,stdClass>` can cast to `array<string,stdClass>` and vice versa.
|
||||||
// ignore recommended: PhanUnreferencedPublicMethod
|
// Normally, a scalar type such as int could only cast to/from int and mixed.
|
||||||
// "dead_code_detection" => true,
|
'scalar_array_key_cast' => true,
|
||||||
|
|
||||||
// default false for include path check
|
// If this has entries, scalars (int, float, bool, string, null)
|
||||||
"enable_include_path_checks" => true,
|
// are allowed to perform the casts listed.
|
||||||
"include_paths" => [
|
//
|
||||||
'.',
|
// E.g. `['int' => ['float', 'string'], 'float' => ['int'], 'string' => ['int'], 'null' => ['string']]`
|
||||||
// '../test/configs/'
|
// allows casting null to a string, but not vice versa.
|
||||||
],
|
// (subset of `scalar_implicit_cast`)
|
||||||
|
'scalar_implicit_partial' => [],
|
||||||
|
|
||||||
|
// If enabled, Phan will warn if **any** type in a method invocation's object
|
||||||
|
// is definitely not an object,
|
||||||
|
// or if **any** type in an invoked expression is not a callable.
|
||||||
|
// Setting this to true will introduce numerous false positives
|
||||||
|
// (and reveal some bugs).
|
||||||
|
'strict_method_checking' => false,
|
||||||
|
|
||||||
|
// If enabled, Phan will warn if **any** type of the object expression for a property access
|
||||||
|
// does not contain that property.
|
||||||
|
'strict_object_checking' => false,
|
||||||
|
|
||||||
|
// If enabled, Phan will warn if **any** type in the argument's union type
|
||||||
|
// cannot be cast to a type in the parameter's expected union type.
|
||||||
|
// Setting this to true will introduce numerous false positives
|
||||||
|
// (and reveal some bugs).
|
||||||
|
'strict_param_checking' => false,
|
||||||
|
|
||||||
|
// If enabled, Phan will warn if **any** type in a property assignment's union type
|
||||||
|
// cannot be cast to a type in the property's declared union type.
|
||||||
|
// Setting this to true will introduce numerous false positives
|
||||||
|
// (and reveal some bugs).
|
||||||
|
'strict_property_checking' => false,
|
||||||
|
|
||||||
|
// If enabled, Phan will warn if **any** type in a returned value's union type
|
||||||
|
// cannot be cast to the declared return type.
|
||||||
|
// Setting this to true will introduce numerous false positives
|
||||||
|
// (and reveal some bugs).
|
||||||
|
'strict_return_checking' => false,
|
||||||
|
|
||||||
|
// If true, seemingly undeclared variables in the global
|
||||||
|
// scope will be ignored.
|
||||||
|
//
|
||||||
|
// This is useful for projects with complicated cross-file
|
||||||
|
// globals that you have no hope of fixing.
|
||||||
'ignore_undeclared_variables_in_global_scope' => true,
|
'ignore_undeclared_variables_in_global_scope' => true,
|
||||||
|
|
||||||
"file_list" => [
|
// Set this to false to emit `PhanUndeclaredFunction` issues for internal functions that Phan has signatures for,
|
||||||
"./test/configs/config.php",
|
// but aren't available in the codebase, or from Reflection.
|
||||||
// "./test/configs/config.db.php",
|
// (may lead to false positives if an extension isn't loaded)
|
||||||
// "./test/configs/config.host.php",
|
|
||||||
// "./test/configs/config.path.php",
|
|
||||||
"./test/configs/config.other.php",
|
|
||||||
"./test/configs/config.master.php",
|
|
||||||
],
|
|
||||||
|
|
||||||
// A list of directories that should be parsed for class and
|
|
||||||
// method information. After excluding the directories
|
|
||||||
// defined in exclude_analysis_directory_list, the remaining
|
|
||||||
// files will be statically analyzed for errors.
|
|
||||||
//
|
//
|
||||||
// Thus, both first-party and third-party code being used by
|
// If this is true(default), then Phan will not warn.
|
||||||
// your application should be included in this list.
|
//
|
||||||
'directory_list' => [
|
// Even when this is false, Phan will still infer return values and check parameters of internal functions
|
||||||
// Change this to include the folders you wish to analyze
|
// if Phan has the signatures.
|
||||||
// (and the folders of their dependencies)
|
'ignore_undeclared_functions_with_known_signatures' => true,
|
||||||
'src',
|
|
||||||
// To speed up analysis, we recommend going back later and
|
|
||||||
// limiting this to only the vendor/ subdirectories your
|
|
||||||
// project depends on.
|
|
||||||
// `phan --init` will generate a list of folders for you
|
|
||||||
'vendor/egrajp/smarty-extended',
|
|
||||||
],
|
|
||||||
|
|
||||||
|
// Backwards Compatibility Checking. This is slow
|
||||||
|
// and expensive, but you should consider running
|
||||||
|
// it before upgrading your version of PHP to a
|
||||||
|
// new version that has backward compatibility
|
||||||
|
// breaks.
|
||||||
|
//
|
||||||
|
// If you are migrating from PHP 5 to PHP 7,
|
||||||
|
// you should also look into using
|
||||||
|
// [php7cc (no longer maintained)](https://github.com/sstalle/php7cc)
|
||||||
|
// and [php7mar](https://github.com/Alexia/php7mar),
|
||||||
|
// which have different backwards compatibility checks.
|
||||||
|
//
|
||||||
|
// If you are still using versions of php older than 5.6,
|
||||||
|
// `PHP53CompatibilityPlugin` may be worth looking into if you are not running
|
||||||
|
// syntax checks for php 5.3 through another method such as
|
||||||
|
// `InvokePHPNativeSyntaxCheckPlugin` (see .phan/plugins/README.md).
|
||||||
|
'backward_compatibility_checks' => false,
|
||||||
|
|
||||||
// A list of directories holding code that we want
|
// If true, check to make sure the return type declared
|
||||||
// to parse, but not analyze
|
// in the doc-block (if any) matches the return type
|
||||||
"exclude_analysis_directory_list" => [
|
// declared in the method signature.
|
||||||
'vendor/egrajp/smarty-extended',
|
'check_docblock_signature_return_type_match' => false,
|
||||||
],
|
|
||||||
'exclude_file_list' => [
|
|
||||||
],
|
|
||||||
|
|
||||||
// what not to show as problem
|
// This setting maps case-insensitive strings to union types.
|
||||||
'suppress_issue_types' => [
|
//
|
||||||
// 'PhanUndeclaredMethod',
|
// This is useful if a project uses phpdoc that differs from the phpdoc2 standard.
|
||||||
'PhanEmptyFile',
|
//
|
||||||
// ignore unreferences public methods, etc here (for dead code check)
|
// If the corresponding value is the empty string,
|
||||||
'PhanUnreferencedPublicMethod',
|
// then Phan will ignore that union type (E.g. can ignore 'the' in `@return the value`)
|
||||||
'PhanUnreferencedClass',
|
//
|
||||||
'PhanWriteOnlyPublicProperty',
|
// If the corresponding value is not empty,
|
||||||
'PhanUnreferencedConstant',
|
// then Phan will act as though it saw the corresponding UnionTypes(s)
|
||||||
'PhanWriteOnlyPublicProperty',
|
// when the keys show up in a UnionType of `@param`, `@return`, `@var`, `@property`, etc.
|
||||||
'PhanReadOnlyPublicProperty'
|
//
|
||||||
],
|
// This matches the **entire string**, not parts of the string.
|
||||||
|
// (E.g. `@return the|null` will still look for a class with the name `the`,
|
||||||
|
// but `@return the` will be ignored with the below setting)
|
||||||
|
//
|
||||||
|
// (These are not aliases, this setting is ignored outside of doc comments).
|
||||||
|
// (Phan does not check if classes with these names exist)
|
||||||
|
//
|
||||||
|
// Example setting: `['unknown' => '', 'number' => 'int|float', 'char' => 'string', 'long' => 'int', 'the' => '']`
|
||||||
|
'phpdoc_type_mapping' => [],
|
||||||
|
|
||||||
|
// Set to true in order to attempt to detect dead
|
||||||
|
// (unreferenced) code. Keep in mind that the
|
||||||
|
// results will only be a guess given that classes,
|
||||||
|
// properties, constants and methods can be referenced
|
||||||
|
// as variables (like `$class->$property` or
|
||||||
|
// `$class->$method()`) in ways that we're unable
|
||||||
|
// to make sense of.
|
||||||
|
//
|
||||||
|
// To more aggressively detect dead code,
|
||||||
|
// you may want to set `dead_code_detection_prefer_false_negative` to `false`.
|
||||||
|
'dead_code_detection' => false,
|
||||||
|
|
||||||
|
// Set to true in order to attempt to detect unused variables.
|
||||||
|
// `dead_code_detection` will also enable unused variable detection.
|
||||||
|
//
|
||||||
|
// This has a few known false positives, e.g. for loops or branches.
|
||||||
|
'unused_variable_detection' => false,
|
||||||
|
|
||||||
|
// Set to true in order to attempt to detect redundant and impossible conditions.
|
||||||
|
//
|
||||||
|
// This has some false positives involving loops,
|
||||||
|
// variables set in branches of loops, and global variables.
|
||||||
|
'redundant_condition_detection' => false,
|
||||||
|
|
||||||
|
// If enabled, Phan will act as though it's certain of real return types of a subset of internal functions,
|
||||||
|
// even if those return types aren't available in reflection
|
||||||
|
// (real types were taken from php 7.3 or 8.0-dev, depending on target_php_version).
|
||||||
|
//
|
||||||
|
// Note that with php 7 and earlier, php would return null or false for many internal functions
|
||||||
|
// if the argument types or counts were incorrect.
|
||||||
|
// As a result, enabling this setting with target_php_version 8.0 may result in false positives
|
||||||
|
// for `--redundant-condition-detection` when codebases also support php 7.x.
|
||||||
|
'assume_real_types_for_internal_functions' => false,
|
||||||
|
|
||||||
|
// If true, this runs a quick version of checks that takes less
|
||||||
|
// time at the cost of not running as thorough
|
||||||
|
// of an analysis. You should consider setting this
|
||||||
|
// to true only when you wish you had more **undiagnosed** issues
|
||||||
|
// to fix in your code base.
|
||||||
|
//
|
||||||
|
// In quick-mode the scanner doesn't rescan a function
|
||||||
|
// or a method's code block every time a call is seen.
|
||||||
|
// This means that the problem here won't be detected:
|
||||||
|
//
|
||||||
|
// ```php
|
||||||
|
// <?php
|
||||||
|
// function test($arg):int {
|
||||||
|
// return $arg;
|
||||||
|
// }
|
||||||
|
// test("abc");
|
||||||
|
// ```
|
||||||
|
//
|
||||||
|
// This would normally generate:
|
||||||
|
//
|
||||||
|
// ```
|
||||||
|
// test.php:3 PhanTypeMismatchReturn Returning type string but test() is declared to return int
|
||||||
|
// ```
|
||||||
|
//
|
||||||
|
// The initial scan of the function's code block has no
|
||||||
|
// type information for `$arg`. It isn't until we see
|
||||||
|
// the call and rescan `test()`'s code block that we can
|
||||||
|
// detect that it is actually returning the passed in
|
||||||
|
// `string` instead of an `int` as declared.
|
||||||
|
'quick_mode' => false,
|
||||||
|
|
||||||
// Override to hardcode existence and types of (non-builtin) globals in the global scope.
|
// Override to hardcode existence and types of (non-builtin) globals in the global scope.
|
||||||
// Class names should be prefixed with `\`.
|
// Class names should be prefixed with `\`.
|
||||||
//
|
//
|
||||||
// (E.g. `['_FOO' => '\FooClass', 'page' => '\PageClass', 'userId' => 'int']`)
|
// (E.g. `['_FOO' => '\FooClass', 'page' => '\PageClass', 'userId' => 'int']`)
|
||||||
'globals_type_map' => [],
|
'globals_type_map' => [],
|
||||||
|
|
||||||
|
// The minimum severity level to report on. This can be
|
||||||
|
// set to `Issue::SEVERITY_LOW`, `Issue::SEVERITY_NORMAL` or
|
||||||
|
// `Issue::SEVERITY_CRITICAL`. Setting it to only
|
||||||
|
// critical issues is a good place to start on a big
|
||||||
|
// sloppy mature code base.
|
||||||
|
'minimum_severity' => Issue::SEVERITY_LOW,
|
||||||
|
|
||||||
|
// Add any issue types (such as `'PhanUndeclaredMethod'`)
|
||||||
|
// to this list to inhibit them from being reported.
|
||||||
|
'suppress_issue_types' => [
|
||||||
|
// start ignore annotations
|
||||||
|
'PhanUnextractableAnnotationElementName',
|
||||||
|
'PhanUnextractableAnnotationSuffix',
|
||||||
|
// wrongly thinks Enum is class
|
||||||
|
'PhanCommentObjectInClassConstantType',
|
||||||
|
],
|
||||||
|
|
||||||
|
// A regular expression to match files to be excluded
|
||||||
|
// from parsing and analysis and will not be read at all.
|
||||||
|
//
|
||||||
|
// This is useful for excluding groups of test or example
|
||||||
|
// directories/files, unanalyzable files, or files that
|
||||||
|
// can't be removed for whatever reason.
|
||||||
|
// (e.g. `'@Test\.php$@'`, or `'@vendor/.*/(tests|Tests)/@'`)
|
||||||
|
'exclude_file_regex' => '@^vendor/.*/(tests?|Tests?)/@',
|
||||||
|
|
||||||
|
// A list of files that will be excluded from parsing and analysis
|
||||||
|
// and will not be read at all.
|
||||||
|
//
|
||||||
|
// This is useful for excluding hopelessly unanalyzable
|
||||||
|
// files that can't be removed for whatever reason.
|
||||||
|
'exclude_file_list' => [],
|
||||||
|
|
||||||
|
// A directory list that defines files that will be excluded
|
||||||
|
// from static analysis, but whose class and method
|
||||||
|
// information should be included.
|
||||||
|
//
|
||||||
|
// Generally, you'll want to include the directories for
|
||||||
|
// third-party code (such as "vendor/") in this list.
|
||||||
|
//
|
||||||
|
// n.b.: If you'd like to parse but not analyze 3rd
|
||||||
|
// party code, directories containing that code
|
||||||
|
// should be added to the `directory_list` as well as
|
||||||
|
// to `exclude_analysis_directory_list`.
|
||||||
|
'exclude_analysis_directory_list' => [
|
||||||
|
'vendor/',
|
||||||
|
],
|
||||||
|
|
||||||
|
// Enable this to enable checks of require/include statements referring to valid paths.
|
||||||
|
// The settings `include_paths` and `warn_about_relative_include_statement` affect the checks.
|
||||||
|
'enable_include_path_checks' => true,
|
||||||
|
"include_paths" => [
|
||||||
|
'.',
|
||||||
|
],
|
||||||
|
|
||||||
|
// The number of processes to fork off during the analysis
|
||||||
|
// phase.
|
||||||
|
'processes' => 1,
|
||||||
|
|
||||||
|
// List of case-insensitive file extensions supported by Phan.
|
||||||
|
// (e.g. `['php', 'html', 'htm']`)
|
||||||
|
'analyzed_file_extensions' => [
|
||||||
|
'php',
|
||||||
|
],
|
||||||
|
|
||||||
|
// You can put paths to stubs of internal extensions in this config option.
|
||||||
|
// If the corresponding extension is **not** loaded, then Phan will use the stubs instead.
|
||||||
|
// Phan will continue using its detailed type annotations,
|
||||||
|
// but load the constants, classes, functions, and classes (and their Reflection types)
|
||||||
|
// from these stub files (doubling as valid php files).
|
||||||
|
// Use a different extension from php to avoid accidentally loading these.
|
||||||
|
// The `tools/make_stubs` script can be used to generate your own stubs (compatible with php 7.0+ right now)
|
||||||
|
//
|
||||||
|
// (e.g. `['xdebug' => '.phan/internal_stubs/xdebug.phan_php']`)
|
||||||
|
'autoload_internal_extension_signatures' => [],
|
||||||
|
|
||||||
|
// A list of plugin files to execute.
|
||||||
|
//
|
||||||
|
// Plugins which are bundled with Phan can be added here by providing their name (e.g. `'AlwaysReturnPlugin'`)
|
||||||
|
//
|
||||||
|
// Documentation about available bundled plugins can be found
|
||||||
|
// [here](https://github.com/phan/phan/tree/v5/.phan/plugins).
|
||||||
|
//
|
||||||
|
// Alternately, you can pass in the full path to a PHP file with the plugin's implementation
|
||||||
|
// (e.g. `'vendor/phan/phan/.phan/plugins/AlwaysReturnPlugin.php'`)
|
||||||
|
'plugins' => [
|
||||||
|
'AlwaysReturnPlugin',
|
||||||
|
'PregRegexCheckerPlugin',
|
||||||
|
'UnreachableCodePlugin',
|
||||||
|
],
|
||||||
|
|
||||||
|
// A list of directories that should be parsed for class and
|
||||||
|
// method information. After excluding the directories
|
||||||
|
// defined in `exclude_analysis_directory_list`, the remaining
|
||||||
|
// files will be statically analyzed for errors.
|
||||||
|
//
|
||||||
|
// Thus, both first-party and third-party code being used by
|
||||||
|
// your application should be included in this list.
|
||||||
|
'directory_list' => [
|
||||||
|
'src',
|
||||||
|
'vendor/egrajp/smarty-extended/src',
|
||||||
|
'vendor/phan/phan/src/Phan',
|
||||||
|
'vendor/phpunit/phpunit/src',
|
||||||
|
'vendor/psr/log/src',
|
||||||
|
'vendor/vimeo/psalm/src/Psalm',
|
||||||
|
'vendor/gullevek/dotenv',
|
||||||
|
],
|
||||||
|
|
||||||
|
// A list of individual files to include in analysis
|
||||||
|
// with a path relative to the root directory of the
|
||||||
|
// project.
|
||||||
|
'file_list' => [
|
||||||
|
"./test/configs/config.php",
|
||||||
|
"./test/configs/config.other.php",
|
||||||
|
"./test/configs/config.master.php",
|
||||||
|
],
|
||||||
];
|
];
|
||||||
|
|||||||
40
ReadMe.composer-release.md
Normal file
40
ReadMe.composer-release.md
Normal file
@@ -0,0 +1,40 @@
|
|||||||
|
# Create new package in system gitea/gitlab/composer.egplusww.jp
|
||||||
|
|
||||||
|
## Prepare
|
||||||
|
|
||||||
|
The following things must have been done:
|
||||||
|
|
||||||
|
- full phpstan check/phan check where possible
|
||||||
|
- a valid version tag `vX.Y.Z` must have been created and pushed to all services
|
||||||
|
|
||||||
|
## Publish
|
||||||
|
|
||||||
|
To do the final publish
|
||||||
|
|
||||||
|
### GITEA and GITLAB
|
||||||
|
|
||||||
|
Run `publish/publish.sh` script to create composer packages.
|
||||||
|
|
||||||
|
This will automatically run all commands to create the packages
|
||||||
|
|
||||||
|
### composer.egplusww.jp web host
|
||||||
|
|
||||||
|
For the local composer package host.
|
||||||
|
|
||||||
|
update `/storage/var/www/html/composer/www/pacakges.json` file with new version and commit
|
||||||
|
The entry is a copy of the `composer.json` with the following new entries:
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
...,
|
||||||
|
"version": "X.Y.Z",
|
||||||
|
...
|
||||||
|
"dist": {
|
||||||
|
"url": "https://git.egplusww.jp/Composer/CoreLibs-Composer-All/archive/vX.Y.Z.zip",
|
||||||
|
"type": "zip"
|
||||||
|
},
|
||||||
|
...
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
run `git pull egra-gitea master` on udon-core in `/var/www/html/composer/www`
|
||||||
@@ -22,4 +22,4 @@ Alternative setup composer local zip file repot:
|
|||||||
|
|
||||||
## Install package
|
## Install package
|
||||||
|
|
||||||
`composer require egrajp/corelibs-composer-all:^7.11`
|
`composer require egrajp/corelibs-composer-all:^8.0`
|
||||||
|
|||||||
@@ -16,13 +16,16 @@
|
|||||||
],
|
],
|
||||||
"minimum-stability": "dev",
|
"minimum-stability": "dev",
|
||||||
"require": {
|
"require": {
|
||||||
"php": ">=8.1"
|
"php": ">=8.2",
|
||||||
|
"psr/log": "^3.0@dev"
|
||||||
},
|
},
|
||||||
"require-dev": {
|
"require-dev": {
|
||||||
"phpstan/phpstan": "1.10.x-dev",
|
"phpstan/phpstan": "^1.10",
|
||||||
"phan/phan": "v5.x-dev",
|
"phan/phan": "v5.x-dev",
|
||||||
"phpunit/phpunit": "^9",
|
"phpunit/phpunit": "^9",
|
||||||
"egrajp/smarty-extended": "^4.3"
|
"egrajp/smarty-extended": "^4.3",
|
||||||
|
"vimeo/psalm": "^5.0@dev",
|
||||||
|
"gullevek/dotenv": "dev-master"
|
||||||
},
|
},
|
||||||
"repositories": {
|
"repositories": {
|
||||||
"git.egplusww.jp.Composer": {
|
"git.egplusww.jp.Composer": {
|
||||||
|
|||||||
@@ -25,9 +25,9 @@ parameters:
|
|||||||
#- # this error is ignore because of the PHP 8.0 to 8.1 change for pg_*, only for 8.0 or lower
|
#- # this error is ignore because of the PHP 8.0 to 8.1 change for pg_*, only for 8.0 or lower
|
||||||
# message: "#^Parameter \\#1 \\$(result|connection) of function pg_\\w+ expects resource(\\|null)?, object\\|resource(\\|bool)? given\\.$#"
|
# message: "#^Parameter \\#1 \\$(result|connection) of function pg_\\w+ expects resource(\\|null)?, object\\|resource(\\|bool)? given\\.$#"
|
||||||
# path: %currentWorkingDirectory%/www/lib/CoreLibs/DB/SQL/PgSQL.php
|
# path: %currentWorkingDirectory%/www/lib/CoreLibs/DB/SQL/PgSQL.php
|
||||||
- # this is for 8.1 or newer
|
# - # this is for 8.1 or newer
|
||||||
message: "#^Parameter \\#1 \\$(result|connection) of function pg_\\w+ expects PgSql\\\\(Result|Connection(\\|string)?(\\|null)?), object\\|resource given\\.$#"
|
# message: "#^Parameter \\#1 \\$(result|connection) of function pg_\\w+ expects PgSql\\\\(Result|Connection(\\|string)?(\\|null)?), object\\|resource given\\.$#"
|
||||||
path: %currentWorkingDirectory%/src/DB/SQL/PgSQL.php
|
# path: %currentWorkingDirectory%/src/DB/SQL/PgSQL.php
|
||||||
# this is ignored for now
|
# this is ignored for now
|
||||||
# - '#Expression in empty\(\) is always falsy.#'
|
# - '#Expression in empty\(\) is always falsy.#'
|
||||||
# -
|
# -
|
||||||
|
|||||||
1
publish/.gitignore
vendored
Normal file
1
publish/.gitignore
vendored
Normal file
@@ -0,0 +1 @@
|
|||||||
|
.env*
|
||||||
1
publish/last.published
Normal file
1
publish/last.published
Normal file
@@ -0,0 +1 @@
|
|||||||
|
9.5.1
|
||||||
1
publish/package-download/.gitignore
vendored
Normal file
1
publish/package-download/.gitignore
vendored
Normal file
@@ -0,0 +1 @@
|
|||||||
|
*.zip
|
||||||
82
publish/publish.sh
Executable file
82
publish/publish.sh
Executable file
@@ -0,0 +1,82 @@
|
|||||||
|
#!/usr/bin/env bash
|
||||||
|
|
||||||
|
BASE_FOLDER=$(dirname $(readlink -f $0))"/";
|
||||||
|
PACKAGE_DOWNLOAD="${BASE_FOLDER}package-download/";
|
||||||
|
if [ ! -d "${PACKAGE_DOWNLOAD}" ]; then
|
||||||
|
mkdir "${PACKAGE_DOWNLOAD}";
|
||||||
|
fi;
|
||||||
|
VERSION=$(git tag --list | sort -V | tail -n1 | sed -e "s/^v//");
|
||||||
|
file_last_published="${BASE_FOLDER}last.published";
|
||||||
|
go_flag="$1";
|
||||||
|
|
||||||
|
if [ -z "${VERSION}" ]; then
|
||||||
|
echo "Version must be set in the form x.y.z without any leading characters";
|
||||||
|
exit;
|
||||||
|
fi;
|
||||||
|
# compare version, if different or newer, deploy
|
||||||
|
if [ -f "${file_last_published}" ]; then
|
||||||
|
LAST_PUBLISHED_VERSION=$(cat ${file_last_published});
|
||||||
|
if $(dpkg --compare-versions "${VERSION}" le "${LAST_PUBLISHED_VERSION}"); then
|
||||||
|
echo "git tag version ${VERSION} is not newer than previous published version ${LAST_PUBLISHED_VERSION}";
|
||||||
|
exit;
|
||||||
|
fi;
|
||||||
|
fi;
|
||||||
|
|
||||||
|
# read in the .env.deploy file and we must have
|
||||||
|
# GITEA_UPLOAD_FILENAME
|
||||||
|
# GITLAB_USER
|
||||||
|
# GITLAB_TOKEN
|
||||||
|
# GITLAB_URL
|
||||||
|
# GITEA_USER
|
||||||
|
# GITEA_DEPLOY_TOKEN
|
||||||
|
# GITEA_URL_DL
|
||||||
|
# GITEA_URL_PUSH
|
||||||
|
if [ ! -f "${BASE_FOLDER}.env.deploy" ]; then
|
||||||
|
echo "Deploy enviroment file .env.deploy is missing";
|
||||||
|
exit;
|
||||||
|
fi;
|
||||||
|
set -o allexport;
|
||||||
|
cd ${BASE_FOLDER};
|
||||||
|
source .env.deploy;
|
||||||
|
cd -;
|
||||||
|
set +o allexport;
|
||||||
|
|
||||||
|
if [ "${go_flag}" != "go" ]; then
|
||||||
|
echo "No go flag given";
|
||||||
|
echo "Would publish ${VERSION}";
|
||||||
|
echo "[END]";
|
||||||
|
exit;
|
||||||
|
fi;
|
||||||
|
|
||||||
|
echo "[START]";
|
||||||
|
# gitea
|
||||||
|
if [ ! -z "${GITEA_UPLOAD_FILENAME}" ] &&
|
||||||
|
[ ! -z "${GITEA_URL_DL}" ] && [ ! -z "${GITEA_URL_PUSH}" ] &&
|
||||||
|
[ ! -z "${GITEA_USER}" ] && [ ! -z "${GITEA_TOKEN}" ]; then
|
||||||
|
curl -LJO \
|
||||||
|
--output-dir "${PACKAGE_DOWNLOAD}" \
|
||||||
|
${GITEA_URL_DL}/v${VERSION}.zip;
|
||||||
|
curl --user ${GITEA_USER}:${GITEA_TOKEN} \
|
||||||
|
--upload-file "${PACKAGE_DOWNLOAD}${GITEA_UPLOAD_FILENAME}-v${VERSION}.zip" \
|
||||||
|
${GITEA_URL_PUSH}?version=${VERSION};
|
||||||
|
echo "${VERSION}" > "${file_last_published}";
|
||||||
|
else
|
||||||
|
echo "Missing either GITEA_UPLOAD_FILENAME, GITEA_URL_DL, GITEA_URL_PUSH, GITEA_USER or GITEA_TOKEN environment variable";
|
||||||
|
fi;
|
||||||
|
|
||||||
|
# gitlab
|
||||||
|
if [ ! -z "${GITLAB_URL}" ] && [ ! -z "${GITLAB_DEPLOY_TOKEN}" ]; then
|
||||||
|
curl --data tag=v${VERSION} \
|
||||||
|
--header "Deploy-Token: ${GITLAB_DEPLOY_TOKEN}" \
|
||||||
|
"${GITLAB_URL}";
|
||||||
|
curl --data branch=master \
|
||||||
|
--header "Deploy-Token: ${GITLAB_DEPLOY_TOKEN}" \
|
||||||
|
"${GITLAB_URL}";
|
||||||
|
echo "${VERSION}" > "${file_last_published}";
|
||||||
|
else
|
||||||
|
echo "Missing GITLAB_DEPLOY_TOKEN environment variable";
|
||||||
|
fi;
|
||||||
|
echo "";
|
||||||
|
echo "[DONE]";
|
||||||
|
|
||||||
|
# __END__
|
||||||
File diff suppressed because it is too large
Load Diff
@@ -35,105 +35,105 @@ class Backend
|
|||||||
{
|
{
|
||||||
// page name
|
// page name
|
||||||
/** @var array<mixed> */
|
/** @var array<mixed> */
|
||||||
public $menu = [];
|
public array $menu = [];
|
||||||
/** @var int|string */
|
/** @var int|string */
|
||||||
public $menu_show_flag = 0; // top menu flag (mostly string)
|
public int|string $menu_show_flag = 0; // top menu flag (mostly string)
|
||||||
// action ids
|
// action ids
|
||||||
/** @var array<string> */
|
/** @var array<string> */
|
||||||
public $action_list = [
|
public array $action_list = [
|
||||||
'action', 'action_id', 'action_sub_id', 'action_yes', 'action_flag',
|
'action', 'action_id', 'action_sub_id', 'action_yes', 'action_flag',
|
||||||
'action_menu', 'action_value', 'action_error', 'action_loaded'
|
'action_menu', 'action_value', 'action_error', 'action_loaded'
|
||||||
];
|
];
|
||||||
/** @var string */
|
/** @var string */
|
||||||
public $action;
|
public string $action;
|
||||||
/** @var string|int */
|
/** @var string|int */
|
||||||
public $action_id;
|
public string|int $action_id;
|
||||||
/** @var string|int */
|
/** @var string|int */
|
||||||
public $action_sub_id;
|
public string|int $action_sub_id;
|
||||||
/** @var string|int|bool */
|
/** @var string|int|bool */
|
||||||
public $action_yes;
|
public string|int|bool $action_yes;
|
||||||
/** @var string */
|
/** @var string */
|
||||||
public $action_flag;
|
public string $action_flag;
|
||||||
/** @var string */
|
/** @var string */
|
||||||
public $action_menu;
|
public string $action_menu;
|
||||||
/** @var string */
|
/** @var string */
|
||||||
public $action_loaded;
|
public string $action_loaded;
|
||||||
/** @var string */
|
/** @var string */
|
||||||
public $action_value;
|
public string $action_value;
|
||||||
/** @var string */
|
/** @var string */
|
||||||
public $action_error;
|
public string $action_error;
|
||||||
// ACL array variable if we want to set acl data from outisde
|
// ACL array variable if we want to set acl data from outisde
|
||||||
/** @var array<mixed> */
|
/** @var array<mixed> */
|
||||||
public $acl = [];
|
public array $acl = [];
|
||||||
/** @var int */
|
/** @var int */
|
||||||
public $default_acl;
|
public int $default_acl;
|
||||||
// queue key
|
// queue key
|
||||||
/** @var string */
|
/** @var string */
|
||||||
public $queue_key;
|
public string $queue_key;
|
||||||
// the current active edit access id
|
// the current active edit access id
|
||||||
/** @var int */
|
/** @var int|null */
|
||||||
public $edit_access_id;
|
public int|null $edit_access_id;
|
||||||
/** @var string */
|
/** @var string */
|
||||||
public $page_name;
|
public string $page_name;
|
||||||
// error/warning/info messages
|
// error/warning/info messages
|
||||||
/** @var array<mixed> */
|
/** @var array<mixed> */
|
||||||
public $messages = [];
|
public array $messages = [];
|
||||||
/** @var bool */
|
/** @var bool */
|
||||||
public $error = false;
|
public bool $error = false;
|
||||||
/** @var bool */
|
/** @var bool */
|
||||||
public $warning = false;
|
public bool $warning = false;
|
||||||
/** @var bool */
|
/** @var bool */
|
||||||
public $info = false;
|
public bool $info = false;
|
||||||
// internal lang & encoding vars
|
// internal lang & encoding vars
|
||||||
/** @var string */
|
/** @var string */
|
||||||
public $lang_dir = '';
|
public string $lang_dir = '';
|
||||||
/** @var string */
|
/** @var string */
|
||||||
public $lang;
|
public string $lang;
|
||||||
/** @var string */
|
/** @var string */
|
||||||
public $lang_short;
|
public string $lang_short;
|
||||||
/** @var string */
|
/** @var string */
|
||||||
public $domain;
|
public string $domain;
|
||||||
/** @var string */
|
/** @var string */
|
||||||
public $encoding;
|
public string $encoding;
|
||||||
/** @var \CoreLibs\Debug\Logging logger */
|
/** @var \CoreLibs\Logging\Logging logger */
|
||||||
public $log;
|
public \CoreLibs\Logging\Logging $log;
|
||||||
/** @var \CoreLibs\DB\IO database */
|
/** @var \CoreLibs\DB\IO database */
|
||||||
public $db;
|
public \CoreLibs\DB\IO $db;
|
||||||
/** @var \CoreLibs\Language\L10n language */
|
/** @var \CoreLibs\Language\L10n language */
|
||||||
public $l;
|
public \CoreLibs\Language\L10n $l;
|
||||||
/** @var \CoreLibs\Create\Session session class */
|
/** @var \CoreLibs\Create\Session session class */
|
||||||
public $session;
|
public \CoreLibs\Create\Session $session;
|
||||||
// smarty publics [end processing in smarty class]
|
// smarty publics [end processing in smarty class]
|
||||||
/** @var array<mixed> */
|
/** @var array<mixed> */
|
||||||
public $DATA;
|
public array $DATA = [];
|
||||||
/** @var array<mixed> */
|
/** @var array<mixed> */
|
||||||
public $HEADER;
|
public array $HEADER = [];
|
||||||
/** @var array<mixed> */
|
/** @var array<mixed> */
|
||||||
public $DEBUG_DATA;
|
public array $DEBUG_DATA = [];
|
||||||
/** @var array<mixed> */
|
/** @var array<mixed> */
|
||||||
public $CONTENT_DATA;
|
public array $CONTENT_DATA = [];
|
||||||
|
|
||||||
// CONSTRUCTOR / DECONSTRUCTOR |====================================>
|
// CONSTRUCTOR / DECONSTRUCTOR |====================================>
|
||||||
/**
|
/**
|
||||||
* main class constructor
|
* main class constructor
|
||||||
*
|
*
|
||||||
* @param \CoreLibs\DB\IO $db Database connection class
|
* @param \CoreLibs\DB\IO $db Database connection class
|
||||||
* @param \CoreLibs\Debug\Logging $log Logging class
|
* @param \CoreLibs\Logging\Logging $log Logging class
|
||||||
* @param \CoreLibs\Create\Session $session Session interface class
|
* @param \CoreLibs\Create\Session $session Session interface class
|
||||||
* @param \CoreLibs\Language\L10n $l10n l10n language class
|
* @param \CoreLibs\Language\L10n $l10n l10n language class
|
||||||
* @param array<string,string> $locale locale data read from setLocale
|
* @param int|null $set_default_acl_level Default ACL level
|
||||||
*/
|
*/
|
||||||
public function __construct(
|
public function __construct(
|
||||||
\CoreLibs\DB\IO $db,
|
\CoreLibs\DB\IO $db,
|
||||||
\CoreLibs\Debug\Logging $log,
|
\CoreLibs\Logging\Logging $log,
|
||||||
\CoreLibs\Create\Session $session,
|
\CoreLibs\Create\Session $session,
|
||||||
\CoreLibs\Language\L10n $l10n,
|
\CoreLibs\Language\L10n $l10n,
|
||||||
array $locale
|
?int $set_default_acl_level = null
|
||||||
) {
|
) {
|
||||||
// attach db class
|
// attach db class
|
||||||
$this->db = $db;
|
$this->db = $db;
|
||||||
// set to log not per class
|
// set to log not per class
|
||||||
$log->setLogPer('class', false);
|
$log->unsetLogFlag(\CoreLibs\Logging\Logger\Flag::per_class);
|
||||||
// attach logger
|
// attach logger
|
||||||
$this->log = $log;
|
$this->log = $log;
|
||||||
// attach session class
|
// attach session class
|
||||||
@@ -141,12 +141,12 @@ class Backend
|
|||||||
// get the language sub class & init it
|
// get the language sub class & init it
|
||||||
$this->l = $l10n;
|
$this->l = $l10n;
|
||||||
// parse and read, legacy stuff
|
// parse and read, legacy stuff
|
||||||
|
$locale = $this->l->getLocaleAsArray();
|
||||||
$this->encoding = $locale['encoding'];
|
$this->encoding = $locale['encoding'];
|
||||||
$this->lang = $locale['lang'];
|
$this->lang = $locale['lang'];
|
||||||
// get first part from lang
|
$this->lang_short = $locale['lang_short'];
|
||||||
$this->lang_short = explode('_', $locale['lang'])[0];
|
$this->domain = $locale['domain'];
|
||||||
$this->domain = $this->l->getDomain();
|
$this->lang_dir = $locale['path'];
|
||||||
$this->lang_dir = $this->l->getBaseLocalePath();
|
|
||||||
|
|
||||||
// set the page name
|
// set the page name
|
||||||
$this->page_name = \CoreLibs\Get\System::getPageName();
|
$this->page_name = \CoreLibs\Get\System::getPageName();
|
||||||
@@ -156,7 +156,18 @@ class Backend
|
|||||||
$this->$_action = $_POST[$_action] ?? '';
|
$this->$_action = $_POST[$_action] ?? '';
|
||||||
}
|
}
|
||||||
|
|
||||||
$this->default_acl = DEFAULT_ACL_LEVEL;
|
if ($set_default_acl_level === null) {
|
||||||
|
/** @deprecated Admin::__construct missing default_acl_level parameter */
|
||||||
|
trigger_error(
|
||||||
|
'Calling Admin::__construct without default_acl_level parameter is deprecated',
|
||||||
|
E_USER_DEPRECATED
|
||||||
|
);
|
||||||
|
}
|
||||||
|
$this->default_acl = $set_default_acl_level ?? DEFAULT_ACL_LEVEL;
|
||||||
|
// if negative or larger than 100, reset to 0
|
||||||
|
if ($this->default_acl < 0 || $this->default_acl > 100) {
|
||||||
|
$this->default_acl = 0;
|
||||||
|
}
|
||||||
|
|
||||||
// queue key
|
// queue key
|
||||||
if (preg_match("/^(add|save|delete|remove|move|up|down|push_live)$/", $this->action)) {
|
if (preg_match("/^(add|save|delete|remove|move|up|down|push_live)$/", $this->action)) {
|
||||||
@@ -190,35 +201,34 @@ class Backend
|
|||||||
* @param string $event any kind of event description,
|
* @param string $event any kind of event description,
|
||||||
* @param string|array<mixed> $data any kind of data related to that event
|
* @param string|array<mixed> $data any kind of data related to that event
|
||||||
* @param string $write_type write type can bei STRING or BINARY
|
* @param string $write_type write type can bei STRING or BINARY
|
||||||
|
* @param string|null $db_schema override target schema
|
||||||
* @return void
|
* @return void
|
||||||
*/
|
*/
|
||||||
public function adbEditLog(
|
public function adbEditLog(
|
||||||
string $event = '',
|
string $event = '',
|
||||||
$data = '',
|
string|array $data = '',
|
||||||
string $write_type = 'STRING'
|
string $write_type = 'STRING',
|
||||||
|
?string $db_schema = null
|
||||||
): void {
|
): void {
|
||||||
$data_binary = '';
|
$data_binary = '';
|
||||||
|
$data_write = '';
|
||||||
if ($write_type == 'BINARY') {
|
if ($write_type == 'BINARY') {
|
||||||
$data_binary = $this->db->dbEscapeBytea((string)bzcompress(serialize($data)));
|
$data_binary = $this->db->dbEscapeBytea((string)bzcompress(serialize($data)));
|
||||||
$data = 'see bzip compressed data_binary field';
|
$data_write = 'see bzip compressed data_binary field';
|
||||||
}
|
}
|
||||||
if ($write_type == 'STRING') {
|
if ($write_type == 'STRING') {
|
||||||
$data_binary = '';
|
$data_binary = '';
|
||||||
$data = $this->db->dbEscapeString(serialize($data));
|
$data_write = $this->db->dbEscapeString(serialize($data));
|
||||||
}
|
}
|
||||||
|
|
||||||
// check schema
|
/** @var string $DB_SCHEMA check schema */
|
||||||
$SCHEMA = 'public';
|
$DB_SCHEMA = 'public';
|
||||||
/** @phpstan-ignore-next-line */
|
if ($db_schema !== null) {
|
||||||
if (defined('LOGIN_DB_SCHEMA') && !empty(LOGIN_DB_SCHEMA)) {
|
$DB_SCHEMA = $db_schema;
|
||||||
$SCHEMA = LOGIN_DB_SCHEMA;
|
} elseif (!empty($this->db->dbGetSchema())) {
|
||||||
} elseif ($this->db->dbGetSchema()) {
|
$DB_SCHEMA = $this->db->dbGetSchema();
|
||||||
$SCHEMA = $this->db->dbGetSchema();
|
|
||||||
} elseif (defined('PUBLIC_SCHEMA')) {
|
|
||||||
$SCHEMA = PUBLIC_SCHEMA;
|
|
||||||
}
|
}
|
||||||
/** @phpstan-ignore-next-line for whatever reason $SCHEMA is seen as possible array */
|
$q = "INSERT INTO " . $DB_SCHEMA . ".edit_log "
|
||||||
$q = "INSERT INTO " . $SCHEMA . ".edit_log "
|
|
||||||
. "(euid, event_date, event, data, data_binary, page, "
|
. "(euid, event_date, event, data, data_binary, page, "
|
||||||
. "ip, user_agent, referer, script_name, query_string, server_name, http_host, "
|
. "ip, user_agent, referer, script_name, query_string, server_name, http_host, "
|
||||||
. "http_accept, http_accept_charset, http_accept_encoding, session_id, "
|
. "http_accept, http_accept_charset, http_accept_encoding, session_id, "
|
||||||
@@ -229,10 +239,12 @@ class Backend
|
|||||||
'NULL')
|
'NULL')
|
||||||
. ", "
|
. ", "
|
||||||
. "NOW(), "
|
. "NOW(), "
|
||||||
. "'" . $this->db->dbEscapeString((string)$event) . "', '" . $data . "', "
|
. "'" . $this->db->dbEscapeString((string)$event) . "', "
|
||||||
. "'" . $data_binary . "', '" . $this->db->dbEscapeString((string)$this->page_name) . "', "
|
. "'" . $data_write . "', "
|
||||||
. "'" . @$_SERVER["REMOTE_ADDR"] . "', "
|
. "'" . $data_binary . "', "
|
||||||
. "'" . $this->db->dbEscapeString(@$_SERVER['HTTP_USER_AGENT']) . "', "
|
. "'" . $this->db->dbEscapeString((string)$this->page_name) . "', "
|
||||||
|
. "'" . ($_SERVER["REMOTE_ADDR"] ?? '') . "', "
|
||||||
|
. "'" . $this->db->dbEscapeString($_SERVER['HTTP_USER_AGENT'] ?? '') . "', "
|
||||||
. "'" . $this->db->dbEscapeString($_SERVER['HTTP_REFERER'] ?? '') . "', "
|
. "'" . $this->db->dbEscapeString($_SERVER['HTTP_REFERER'] ?? '') . "', "
|
||||||
. "'" . $this->db->dbEscapeString($_SERVER['SCRIPT_FILENAME'] ?? '') . "', "
|
. "'" . $this->db->dbEscapeString($_SERVER['SCRIPT_FILENAME'] ?? '') . "', "
|
||||||
. "'" . $this->db->dbEscapeString($_SERVER['QUERY_STRING'] ?? '') . "', "
|
. "'" . $this->db->dbEscapeString($_SERVER['QUERY_STRING'] ?? '') . "', "
|
||||||
@@ -262,7 +274,7 @@ class Backend
|
|||||||
* @param string|int $menu_show_flag
|
* @param string|int $menu_show_flag
|
||||||
* @return string|int
|
* @return string|int
|
||||||
*/
|
*/
|
||||||
public function adbSetMenuShowFlag($menu_show_flag)
|
public function adbSetMenuShowFlag(string|int $menu_show_flag): string|int
|
||||||
{
|
{
|
||||||
// must be string or int
|
// must be string or int
|
||||||
$this->menu_show_flag = $menu_show_flag;
|
$this->menu_show_flag = $menu_show_flag;
|
||||||
@@ -274,7 +286,7 @@ class Backend
|
|||||||
*
|
*
|
||||||
* @return string|int
|
* @return string|int
|
||||||
*/
|
*/
|
||||||
public function adbGetMenuShowFlag()
|
public function adbGetMenuShowFlag(): string|int
|
||||||
{
|
{
|
||||||
return $this->menu_show_flag;
|
return $this->menu_show_flag;
|
||||||
}
|
}
|
||||||
@@ -282,11 +294,25 @@ class Backend
|
|||||||
/**
|
/**
|
||||||
* menu creater (from login menu session pages)
|
* menu creater (from login menu session pages)
|
||||||
*
|
*
|
||||||
* @param int $flag visible flag trigger
|
* @param string|null $set_content_path
|
||||||
|
* @param int $flag visible flag trigger
|
||||||
* @return array<mixed> menu array for output on page (smarty)
|
* @return array<mixed> menu array for output on page (smarty)
|
||||||
*/
|
*/
|
||||||
public function adbTopMenu(int $flag = 0): array
|
public function adbTopMenu(
|
||||||
{
|
?string $set_content_path = null,
|
||||||
|
int $flag = 0,
|
||||||
|
): array {
|
||||||
|
if (
|
||||||
|
$set_content_path === null ||
|
||||||
|
!is_string($set_content_path)
|
||||||
|
) {
|
||||||
|
/** @deprecated adbTopMenu missing set_content_path parameter */
|
||||||
|
trigger_error(
|
||||||
|
'Calling adbTopMenu without set_content_path parameter is deprecated',
|
||||||
|
E_USER_DEPRECATED
|
||||||
|
);
|
||||||
|
}
|
||||||
|
$set_content_path = $set_content_path ?? CONTENT_PATH;
|
||||||
if ($this->menu_show_flag) {
|
if ($this->menu_show_flag) {
|
||||||
$flag = $this->menu_show_flag;
|
$flag = $this->menu_show_flag;
|
||||||
}
|
}
|
||||||
@@ -377,7 +403,7 @@ class Backend
|
|||||||
\CoreLibs\Get\System::getPageName() == $data['filename'] &&
|
\CoreLibs\Get\System::getPageName() == $data['filename'] &&
|
||||||
(!isset($data['hostname']) || (
|
(!isset($data['hostname']) || (
|
||||||
isset($data['hostname']) &&
|
isset($data['hostname']) &&
|
||||||
(!$data['hostname'] || strstr($data['hostname'], CONTENT_PATH) !== false)
|
(!$data['hostname'] || strstr($data['hostname'], $set_content_path) !== false)
|
||||||
))
|
))
|
||||||
) {
|
) {
|
||||||
$selected = 1;
|
$selected = 1;
|
||||||
@@ -427,69 +453,6 @@ class Backend
|
|||||||
};
|
};
|
||||||
return $enabled;
|
return $enabled;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* creates out of a normal db_return array an assoc array
|
|
||||||
*
|
|
||||||
* @param array<mixed> $db_array input array
|
|
||||||
* @param string|int|bool $key key
|
|
||||||
* @param string|int|bool $value value
|
|
||||||
* @return array<mixed> associative array
|
|
||||||
* @deprecated \CoreLibs\Combined\ArrayHandler::genAssocArray()
|
|
||||||
*/
|
|
||||||
public function adbAssocArray(array $db_array, $key, $value): array
|
|
||||||
{
|
|
||||||
trigger_error(
|
|
||||||
'Method ' . __METHOD__ . ' is deprecated: \CoreLibs\Combined\ArrayHandler::genAssocArray',
|
|
||||||
E_USER_DEPRECATED
|
|
||||||
);
|
|
||||||
return \CoreLibs\Combined\ArrayHandler::genAssocArray($db_array, $key, $value);
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* converts bytes into formated string with KB, MB, etc
|
|
||||||
*
|
|
||||||
* @param string|int|float $number string or int or number
|
|
||||||
* @return string formatted string
|
|
||||||
* @deprecated \CoreLibs\Convert\Byte::humanReadableByteFormat()
|
|
||||||
*/
|
|
||||||
public function adbByteStringFormat($number): string
|
|
||||||
{
|
|
||||||
trigger_error(
|
|
||||||
'Method ' . __METHOD__ . ' is deprecated: \CoreLibs\Convert\Byte::humanReadableByteFormat()',
|
|
||||||
E_USER_DEPRECATED
|
|
||||||
);
|
|
||||||
return \CoreLibs\Convert\Byte::humanReadableByteFormat($number);
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* converts picture to a thumbnail with max x and max y size
|
|
||||||
*
|
|
||||||
* @param string $pic source image file with or without path
|
|
||||||
* @param int $size_x maximum size width
|
|
||||||
* @param int $size_y maximum size height
|
|
||||||
* @param string $dummy empty, or file_type to show an icon
|
|
||||||
* instead of nothing if file is not found
|
|
||||||
* @param string $path if source start is not ROOT path
|
|
||||||
* if empty ROOT is choosen
|
|
||||||
* @return string|bool thumbnail name, or false for error
|
|
||||||
* @deprecated \CoreLibs\Output\Image::createThumbnail()
|
|
||||||
*/
|
|
||||||
public function adbCreateThumbnail(
|
|
||||||
string $pic,
|
|
||||||
int $size_x,
|
|
||||||
int $size_y,
|
|
||||||
string $dummy = '',
|
|
||||||
string $path = '',
|
|
||||||
string $cache = ''
|
|
||||||
) {
|
|
||||||
trigger_error(
|
|
||||||
'Method ' . __METHOD__ . ' is deprecated: \CoreLibs\Output\Image::createThumbnail()',
|
|
||||||
E_USER_DEPRECATED
|
|
||||||
);
|
|
||||||
return \CoreLibs\Output\Image::createThumbnail($pic, $size_x, $size_y, $dummy, $path, $cache);
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* wrapper function to fill up the mssages array
|
* wrapper function to fill up the mssages array
|
||||||
*
|
*
|
||||||
@@ -523,15 +486,16 @@ class Backend
|
|||||||
/**
|
/**
|
||||||
* writes live queue
|
* writes live queue
|
||||||
*
|
*
|
||||||
* @param string $queue_key string to identfy the queue
|
* @param string $queue_key string to identfy the queue
|
||||||
* @param string $type [description]
|
* @param string $type [description]
|
||||||
* @param string $target [description]
|
* @param string $target [description]
|
||||||
* @param string $data [description]
|
* @param string $data [description]
|
||||||
* @param string $key_name [description]
|
* @param string $key_name [description]
|
||||||
* @param string $key_value [description]
|
* @param string $key_value [description]
|
||||||
* @param ?string $associate [description]
|
* @param string|null $associate [description]
|
||||||
* @param ?string $file [description]
|
* @param string|null $file [description]
|
||||||
* @return void has no return
|
* @param string|null $db_schema override target schema
|
||||||
|
* @return void
|
||||||
*/
|
*/
|
||||||
public function adbLiveQueue(
|
public function adbLiveQueue(
|
||||||
string $queue_key,
|
string $queue_key,
|
||||||
@@ -541,19 +505,17 @@ class Backend
|
|||||||
string $key_name,
|
string $key_name,
|
||||||
string $key_value,
|
string $key_value,
|
||||||
string $associate = null,
|
string $associate = null,
|
||||||
string $file = null
|
string $file = null,
|
||||||
|
string $db_schema = null,
|
||||||
): void {
|
): void {
|
||||||
/** @phpstan-ignore-next-line */
|
/** @var string $DB_SCHEMA check schema */
|
||||||
if (defined('GLOBAL_DB_SCHEMA') && !empty(GLOBAL_DB_SCHEMA)) {
|
$DB_SCHEMA = 'public';
|
||||||
$SCHEMA = GLOBAL_DB_SCHEMA;
|
if ($db_schema !== null) {
|
||||||
} elseif ($this->db->dbGetSchema()) {
|
$DB_SCHEMA = $db_schema;
|
||||||
$SCHEMA = $this->db->dbGetSchema();
|
} elseif (!empty($this->db->dbGetSchema())) {
|
||||||
} elseif (defined('PUBLIC_SCHEMA')) {
|
$DB_SCHEMA = $this->db->dbGetSchema();
|
||||||
$SCHEMA = PUBLIC_SCHEMA;
|
|
||||||
} else {
|
|
||||||
$SCHEMA = 'public';
|
|
||||||
}
|
}
|
||||||
$q = "INSERT INTO " . $SCHEMA . ".live_queue ("
|
$q = "INSERT INTO " . $DB_SCHEMA . ".live_queue ("
|
||||||
. "queue_key, key_value, key_name, type, target, data, group_key, action, associate, file"
|
. "queue_key, key_value, key_name, type, target, data, group_key, action, associate, file"
|
||||||
. ") VALUES ("
|
. ") VALUES ("
|
||||||
. "'" . $this->db->dbEscapeString($queue_key) . "', '" . $this->db->dbEscapeString($key_value) . "', "
|
. "'" . $this->db->dbEscapeString($queue_key) . "', '" . $this->db->dbEscapeString($key_value) . "', "
|
||||||
@@ -569,32 +531,32 @@ class Backend
|
|||||||
* Basic class holds exact the same, except the Year/Month/Day/etc strings
|
* Basic class holds exact the same, except the Year/Month/Day/etc strings
|
||||||
* are translated in this call
|
* are translated in this call
|
||||||
*
|
*
|
||||||
* @param int $year year YYYY
|
* @param int|string $year year YYYY
|
||||||
* @param int $month month m
|
* @param int|string $month month m
|
||||||
* @param int $day day d
|
* @param int|string $day day d
|
||||||
* @param int $hour hour H
|
* @param int|string $hour hour H
|
||||||
* @param int $min min i
|
* @param int|string $min min i
|
||||||
* @param string $suffix additional info printed after the date time
|
* @param string $suffix additional info printed after the date time
|
||||||
* variable in the drop down
|
* variable in the drop down
|
||||||
* also used for ID in the on change JS call
|
* also used for ID in the on change JS call
|
||||||
* @param int $min_steps default is 1 (minute), can set to anything,
|
* @param int $min_steps default is 1 (minute), can set to anything,
|
||||||
* is used as sum up from 0
|
* is used as sum up from 0
|
||||||
* @param bool $name_pos_back default false, if set to true,
|
* @param bool $name_pos_back default false, if set to true,
|
||||||
* the name will be printend
|
* the name will be printend
|
||||||
* after the drop down and not before the drop down
|
* after the drop down and not before the drop down
|
||||||
* @return string HTML formated strings for drop down lists
|
* @return string HTML formated strings for drop down lists
|
||||||
* of date and time
|
* of date and time
|
||||||
*/
|
*/
|
||||||
public function adbPrintDateTime(
|
public function adbPrintDateTime(
|
||||||
$year,
|
int|string $year,
|
||||||
$month,
|
int|string $month,
|
||||||
$day,
|
int|string $day,
|
||||||
$hour,
|
int|string $hour,
|
||||||
$min,
|
int|string $min,
|
||||||
string $suffix = '',
|
string $suffix = '',
|
||||||
int $min_steps = 1,
|
int $min_steps = 1,
|
||||||
bool $name_pos_back = false
|
bool $name_pos_back = false
|
||||||
) {
|
): string {
|
||||||
// get the build layout
|
// get the build layout
|
||||||
$html_time = \CoreLibs\Output\Form\Elements::printDateTime(
|
$html_time = \CoreLibs\Output\Form\Elements::printDateTime(
|
||||||
$year,
|
$year,
|
||||||
|
|||||||
@@ -20,49 +20,58 @@ use SmartyException;
|
|||||||
class EditBase
|
class EditBase
|
||||||
{
|
{
|
||||||
/** @var array<mixed> */
|
/** @var array<mixed> */
|
||||||
private $HEADER = [];
|
private array $HEADER = [];
|
||||||
/** @var array<mixed> */
|
/** @var array<mixed> */
|
||||||
private $DATA = [];
|
private array $DATA = [];
|
||||||
/** @var array<mixed> */
|
/** @var array<mixed> */
|
||||||
private $DEBUG_DATA = [];
|
private array $DEBUG_DATA = [];
|
||||||
|
|
||||||
/** @var string the template name */
|
/** @var string the template name */
|
||||||
private $EDIT_TEMPLATE = '';
|
private string $EDIT_TEMPLATE = '';
|
||||||
|
|
||||||
/** @var \CoreLibs\Template\SmartyExtend smarty system */
|
/** @var \CoreLibs\Template\SmartyExtend smarty system */
|
||||||
private $smarty;
|
private \CoreLibs\Template\SmartyExtend $smarty;
|
||||||
/** @var \CoreLibs\Output\Form\Generate form generate system */
|
/** @var \CoreLibs\Output\Form\Generate form generate system */
|
||||||
private $form;
|
private \CoreLibs\Output\Form\Generate $form;
|
||||||
/** @var \CoreLibs\Debug\Logging */
|
/** @var \CoreLibs\Logging\Logging */
|
||||||
public $log;
|
public \CoreLibs\Logging\Logging $log;
|
||||||
|
/** @var \CoreLibs\ACL\Login */
|
||||||
|
public \CoreLibs\ACL\Login $login;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* construct form generator
|
* construct form generator
|
||||||
*
|
*
|
||||||
* @param array<mixed> $db_config db config array, mandatory
|
* phpcs:ignore
|
||||||
* @param \CoreLibs\Debug\Logging $log Logging class, null auto set
|
* @param array{db_name:string,db_user:string,db_pass:string,db_host:string,db_port:int,db_schema:string,db_encoding:string,db_type:string,db_ssl:string,db_convert_type?:string[]} $db_config db config array, mandatory
|
||||||
|
* @param \CoreLibs\Logging\Logging $log Logging class, null auto set
|
||||||
* @param \CoreLibs\Language\L10n $l10n l10n language class, null auto set
|
* @param \CoreLibs\Language\L10n $l10n l10n language class, null auto set
|
||||||
* @param array<string,string> $locale locale array from ::setLocale,
|
* @param \CoreLibs\ACL\Login $login login class for ACL settings
|
||||||
* null auto set
|
* @param array<string,mixed> $options Various settings options
|
||||||
*/
|
*/
|
||||||
public function __construct(
|
public function __construct(
|
||||||
array $db_config,
|
array $db_config,
|
||||||
\CoreLibs\Debug\Logging $log,
|
\CoreLibs\Logging\Logging $log,
|
||||||
\CoreLibs\Language\L10n $l10n,
|
\CoreLibs\Language\L10n $l10n,
|
||||||
array $locale
|
\CoreLibs\ACL\Login $login,
|
||||||
|
array $options
|
||||||
) {
|
) {
|
||||||
$this->log = $log;
|
$this->log = $log;
|
||||||
|
$this->login = $login;
|
||||||
// smarty template engine (extended Translation version)
|
// smarty template engine (extended Translation version)
|
||||||
$this->smarty = new \CoreLibs\Template\SmartyExtend($l10n, $locale);
|
$this->smarty = new \CoreLibs\Template\SmartyExtend(
|
||||||
|
$l10n,
|
||||||
|
$options['cache_id'] ?? '',
|
||||||
|
$options['compile_id'] ?? '',
|
||||||
|
);
|
||||||
// turn off set log per class
|
// turn off set log per class
|
||||||
$log->setLogPer('class', false);
|
$log->unsetLogFlag(\CoreLibs\Logging\Logger\Flag::per_class);
|
||||||
|
|
||||||
// create form class
|
// create form class
|
||||||
$this->form = new \CoreLibs\Output\Form\Generate(
|
$this->form = new \CoreLibs\Output\Form\Generate(
|
||||||
$db_config,
|
$db_config,
|
||||||
$log,
|
$log,
|
||||||
$l10n,
|
$l10n,
|
||||||
$locale
|
$this->login->loginGetAcl()
|
||||||
);
|
);
|
||||||
if ($this->form->mobile_phone) {
|
if ($this->form->mobile_phone) {
|
||||||
echo "I am sorry, but this page cannot be viewed by a mobile phone";
|
echo "I am sorry, but this page cannot be viewed by a mobile phone";
|
||||||
@@ -228,10 +237,14 @@ class EditBase
|
|||||||
/**
|
/**
|
||||||
* all edit pages
|
* all edit pages
|
||||||
*
|
*
|
||||||
|
* @param string $set_root
|
||||||
|
* @param string $set_content_path
|
||||||
* @return void
|
* @return void
|
||||||
*/
|
*/
|
||||||
private function editPageFlow(): void
|
private function editPageFlow(
|
||||||
{
|
string $set_root,
|
||||||
|
string $set_content_path,
|
||||||
|
): void {
|
||||||
// set table width
|
// set table width
|
||||||
$table_width = '100%';
|
$table_width = '100%';
|
||||||
// load call only if id is set
|
// load call only if id is set
|
||||||
@@ -268,23 +281,16 @@ class EditBase
|
|||||||
|
|
||||||
// MENU START
|
// MENU START
|
||||||
// request some session vars
|
// request some session vars
|
||||||
if (empty($_SESSION['HEADER_COLOR'])) {
|
$this->DATA['HEADER_COLOR'] = $this->login->loginGetHeaderColor() ?? '#E0E2FF';
|
||||||
$this->DATA['HEADER_COLOR'] = '#E0E2FF';
|
$this->DATA['USER_NAME'] = $this->login->loginGetAcl()['user_name'] ?? '';
|
||||||
} else {
|
$this->DATA['EUID'] = $this->login->loginGetEuid();
|
||||||
$this->DATA['HEADER_COLOR'] = $_SESSION['HEADER_COLOR'];
|
$this->DATA['GROUP_NAME'] = $this->login->loginGetAcl()['group_name'] ?? '';
|
||||||
}
|
$this->DATA['ACCESS_LEVEL'] = $this->login->loginGetAcl()['base'] ?? '';
|
||||||
$this->DATA['USER_NAME'] = $_SESSION['USER_NAME'];
|
// below is old and to removed when edit_body.tpl is updates
|
||||||
$this->DATA['EUID'] = $_SESSION['EUID'];
|
$this->DATA['GROUP_LEVEL'] = $this->DATA['ACCESS_LEVEL'];
|
||||||
$this->DATA['GROUP_NAME'] = $_SESSION['GROUP_NAME'];
|
$PAGES = $this->login->loginGetPages();
|
||||||
$this->DATA['GROUP_LEVEL'] = $_SESSION['GROUP_ACL_LEVEL'];
|
|
||||||
$PAGES = $_SESSION['PAGES'];
|
|
||||||
|
|
||||||
//$this->form->log->debug('menu', $this->form->log->prAr($PAGES));
|
//$this->form->log->debug('menu', $this->form->log->prAr($PAGES));
|
||||||
|
|
||||||
// build nav from $PAGES ...
|
|
||||||
if (!isset($PAGES) || !is_array($PAGES)) {
|
|
||||||
$PAGES = [];
|
|
||||||
}
|
|
||||||
$menuarray = [];
|
$menuarray = [];
|
||||||
foreach ($PAGES as $PAGE_CUID => $PAGE_DATA) {
|
foreach ($PAGES as $PAGE_CUID => $PAGE_DATA) {
|
||||||
if ($PAGE_DATA['menu'] && $PAGE_DATA['online']) {
|
if ($PAGE_DATA['menu'] && $PAGE_DATA['online']) {
|
||||||
@@ -334,7 +340,7 @@ class EditBase
|
|||||||
$menu_element['filename'] == \CoreLibs\Get\System::getPageName() &&
|
$menu_element['filename'] == \CoreLibs\Get\System::getPageName() &&
|
||||||
(!isset($menu_element['hostname']) || (
|
(!isset($menu_element['hostname']) || (
|
||||||
isset($menu_element['hostname']) &&
|
isset($menu_element['hostname']) &&
|
||||||
(!$menu_element['hostname'] || strstr($menu_element['hostname'], CONTENT_PATH) !== false)
|
(!$menu_element['hostname'] || strstr($menu_element['hostname'], $set_content_path) !== false)
|
||||||
))
|
))
|
||||||
) {
|
) {
|
||||||
$position = $i;
|
$position = $i;
|
||||||
@@ -414,6 +420,8 @@ class EditBase
|
|||||||
$elements[] = $this->form->formCreateElement('additional_acl');
|
$elements[] = $this->form->formCreateElement('additional_acl');
|
||||||
break;
|
break;
|
||||||
case 'edit_schemes':
|
case 'edit_schemes':
|
||||||
|
// @deprecated Will be removed
|
||||||
|
case 'edit_schemas':
|
||||||
$elements[] = $this->form->formCreateElement('enabled');
|
$elements[] = $this->form->formCreateElement('enabled');
|
||||||
$elements[] = $this->form->formCreateElement('name');
|
$elements[] = $this->form->formCreateElement('name');
|
||||||
$elements[] = $this->form->formCreateElement('header_color');
|
$elements[] = $this->form->formCreateElement('header_color');
|
||||||
@@ -429,7 +437,7 @@ class EditBase
|
|||||||
$search_glob = [];
|
$search_glob = [];
|
||||||
foreach ($folders as $folder) {
|
foreach ($folders as $folder) {
|
||||||
// make sure this folder actually exists
|
// make sure this folder actually exists
|
||||||
if (is_dir(ROOT . $folder)) {
|
if (is_dir($set_root . $folder)) {
|
||||||
foreach ($files as $file) {
|
foreach ($files as $file) {
|
||||||
$search_glob[] = $folder . $file;
|
$search_glob[] = $folder . $file;
|
||||||
}
|
}
|
||||||
@@ -532,31 +540,74 @@ class EditBase
|
|||||||
* @throws Exception
|
* @throws Exception
|
||||||
* @throws SmartyException
|
* @throws SmartyException
|
||||||
*/
|
*/
|
||||||
public function editBaseRun()
|
public function editBaseRun(
|
||||||
{
|
?string $template_dir = null,
|
||||||
|
?string $compile_dir = null,
|
||||||
|
?string $cache_dir = null,
|
||||||
|
?string $set_admin_stylesheet = null,
|
||||||
|
?string $set_default_encoding = null,
|
||||||
|
?string $set_css = null,
|
||||||
|
?string $set_js = null,
|
||||||
|
?string $set_root = null,
|
||||||
|
?string $set_content_path = null
|
||||||
|
): void {
|
||||||
|
// trigger deprecated warning
|
||||||
|
if (
|
||||||
|
$template_dir === null ||
|
||||||
|
$compile_dir === null ||
|
||||||
|
$cache_dir === null ||
|
||||||
|
$set_admin_stylesheet === null ||
|
||||||
|
$set_default_encoding === null ||
|
||||||
|
$set_css === null ||
|
||||||
|
$set_js === null ||
|
||||||
|
$set_root === null ||
|
||||||
|
$set_content_path === null
|
||||||
|
) {
|
||||||
|
/** @deprecated editBaseRun call without parameters */
|
||||||
|
trigger_error(
|
||||||
|
'Calling editBaseRun without paramters is deprecated',
|
||||||
|
E_USER_DEPRECATED
|
||||||
|
);
|
||||||
|
}
|
||||||
|
// set vars (to be deprecated)
|
||||||
|
$template_dir = $template_dir ?? BASE . INCLUDES . TEMPLATES . CONTENT_PATH;
|
||||||
|
$compile_dir = $compile_dir ?? BASE . TEMPLATES_C;
|
||||||
|
$cache_dir = $cache_dir ?? BASE . CACHE;
|
||||||
|
$set_admin_stylesheet = $set_admin_stylesheet ?? ADMIN_STYLESHEET;
|
||||||
|
$set_default_encoding = $set_default_encoding ?? DEFAULT_ENCODING;
|
||||||
|
$set_css = $set_css ?? LAYOUT . CSS;
|
||||||
|
$set_js = $set_js ?? LAYOUT . JS;
|
||||||
|
$set_root = $set_root ?? ROOT;
|
||||||
|
$set_content_path = $set_content_path ?? CONTENT_PATH;
|
||||||
|
|
||||||
// set the template dir
|
// set the template dir
|
||||||
// WARNING: this has a special check for the mailing tool layout (old layout)
|
// WARNING: this has a special check for the mailing tool layout (old no layout folder)
|
||||||
if (defined('LAYOUT')) {
|
if (!defined('LAYOUT')) {
|
||||||
$this->smarty->setTemplateDir(BASE . INCLUDES . TEMPLATES . CONTENT_PATH);
|
trigger_error(
|
||||||
$this->DATA['css'] = LAYOUT . CSS;
|
'EditBase with unset LAYOUT is deprecated',
|
||||||
$this->DATA['js'] = LAYOUT . JS;
|
E_USER_DEPRECATED
|
||||||
} else {
|
);
|
||||||
$this->smarty->setTemplateDir(TEMPLATES);
|
$this->smarty->setTemplateDir(TEMPLATES);
|
||||||
$this->DATA['css'] = CSS;
|
$this->DATA['css'] = CSS;
|
||||||
$this->DATA['js'] = JS;
|
$this->DATA['js'] = JS;
|
||||||
|
} else {
|
||||||
|
$this->smarty->setTemplateDir($template_dir);
|
||||||
|
$this->DATA['css'] = $set_css;
|
||||||
|
$this->DATA['js'] = $set_js;
|
||||||
}
|
}
|
||||||
$ADMIN_STYLESHEET = 'edit.css';
|
|
||||||
// define all needed smarty stuff for the general HTML/page building
|
// define all needed smarty stuff for the general HTML/page building
|
||||||
$this->HEADER['CSS'] = CSS;
|
$this->HEADER['CSS'] = $set_css;
|
||||||
$this->HEADER['DEFAULT_ENCODING'] = DEFAULT_ENCODING;
|
$this->HEADER['DEFAULT_ENCODING'] = $set_default_encoding;
|
||||||
/** @phpstan-ignore-next-line because ADMIN_STYLESHEET can be null */
|
$this->HEADER['STYLESHEET'] = $set_admin_stylesheet;
|
||||||
$this->HEADER['STYLESHEET'] = $ADMIN_STYLESHEET ?? ADMIN_STYLESHEET;
|
|
||||||
|
|
||||||
// main run
|
// main run
|
||||||
if ($this->form->my_page_name == 'edit_order') {
|
if ($this->form->my_page_name == 'edit_order') {
|
||||||
$this->editOrderPage();
|
$this->editOrderPage();
|
||||||
} else {
|
} else {
|
||||||
$this->editPageFlow();
|
$this->editPageFlow(
|
||||||
|
$set_root,
|
||||||
|
$set_content_path
|
||||||
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
// debug data, if DEBUG flag is on, this data is print out
|
// debug data, if DEBUG flag is on, this data is print out
|
||||||
@@ -569,11 +620,11 @@ class EditBase
|
|||||||
foreach ($CONTENT_DATA as $key => $value) {
|
foreach ($CONTENT_DATA as $key => $value) {
|
||||||
$this->smarty->assign($key, $value);
|
$this->smarty->assign($key, $value);
|
||||||
}
|
}
|
||||||
if (is_dir(BASE . TEMPLATES_C)) {
|
if (is_dir($compile_dir)) {
|
||||||
$this->smarty->setCompileDir(BASE . TEMPLATES_C);
|
$this->smarty->setCompileDir($compile_dir);
|
||||||
}
|
}
|
||||||
if (is_dir(BASE . CACHE)) {
|
if (is_dir($cache_dir)) {
|
||||||
$this->smarty->setCacheDir(BASE . CACHE);
|
$this->smarty->setCacheDir($cache_dir);
|
||||||
}
|
}
|
||||||
$this->smarty->display(
|
$this->smarty->display(
|
||||||
$this->EDIT_TEMPLATE,
|
$this->EDIT_TEMPLATE,
|
||||||
|
|||||||
126
src/Basic.php
126
src/Basic.php
@@ -58,39 +58,39 @@ class Basic
|
|||||||
{
|
{
|
||||||
// page and host name
|
// page and host name
|
||||||
/** @var string */
|
/** @var string */
|
||||||
public $page_name;
|
public string $page_name;
|
||||||
/** @var string */
|
/** @var string */
|
||||||
public $host_name;
|
public string $host_name;
|
||||||
/** @var int */
|
/** @var int */
|
||||||
public $host_port;
|
public int $host_port;
|
||||||
// logging interface, Debug\Logging class
|
// logging interface, Debug\Logging class
|
||||||
/** @var \CoreLibs\Debug\Logging */
|
/** @var \CoreLibs\Logging\Logging */
|
||||||
public $log;
|
public \CoreLibs\Logging\Logging $log;
|
||||||
/** @var \CoreLibs\Create\Session */
|
/** @var \CoreLibs\Create\Session */
|
||||||
public $session;
|
public \CoreLibs\Create\Session $session;
|
||||||
|
|
||||||
// email valid checks
|
// email valid checks
|
||||||
/** @var array<mixed> */
|
/** @var array<mixed> */
|
||||||
public $email_regex_check = [];
|
public array $email_regex_check = [];
|
||||||
/** @var string */
|
/** @var string */
|
||||||
public $email_regex; // regex var for email check
|
public string $email_regex; // regex var for email check
|
||||||
|
|
||||||
// data path for files
|
// data path for files
|
||||||
/** @var array<mixed> */
|
/** @var array<mixed> */
|
||||||
public $data_path = [];
|
public array $data_path = [];
|
||||||
|
|
||||||
// ajax flag
|
// ajax flag
|
||||||
/** @var bool */
|
/** @var bool */
|
||||||
protected $ajax_page_flag = false;
|
protected bool $ajax_page_flag = false;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* main Basic constructor to init and check base settings
|
* main Basic constructor to init and check base settings
|
||||||
* @param \CoreLibs\Debug\Logging|null $log Logging class
|
* @param \CoreLibs\Logging\Logging|null $log Logging class
|
||||||
* @param string|null $session_name Set session name
|
* @param string|null $session_name Set session name
|
||||||
* @deprecated DO NOT USE Class\Basic anymore. Use dedicated logger and sub classes
|
* @deprecated DO NOT USE Class\Basic anymore. Use dedicated logger and sub classes
|
||||||
*/
|
*/
|
||||||
public function __construct(
|
public function __construct(
|
||||||
\CoreLibs\Debug\Logging $log = null,
|
\CoreLibs\Logging\Logging $log = null,
|
||||||
?string $session_name = null
|
?string $session_name = null
|
||||||
) {
|
) {
|
||||||
trigger_error('Class \CoreLibs\Basic is deprected', E_USER_DEPRECATED);
|
trigger_error('Class \CoreLibs\Basic is deprected', E_USER_DEPRECATED);
|
||||||
@@ -120,7 +120,10 @@ class Basic
|
|||||||
}
|
}
|
||||||
|
|
||||||
// logging interface moved here (->debug is now ->log->debug)
|
// logging interface moved here (->debug is now ->log->debug)
|
||||||
$this->log = $log ?? new \CoreLibs\Debug\Logging();
|
$this->log = $log ?? new \CoreLibs\Logging\Logging([
|
||||||
|
'log_folder' => BASE . LOG,
|
||||||
|
'log_file_id' => 'ClassBasic-DEPRECATED',
|
||||||
|
]);
|
||||||
|
|
||||||
// set ajax page flag based on the AJAX_PAGE varaibles
|
// set ajax page flag based on the AJAX_PAGE varaibles
|
||||||
// convert to true/false so if AJAX_PAGE is 0 or false it is
|
// convert to true/false so if AJAX_PAGE is 0 or false it is
|
||||||
@@ -176,8 +179,9 @@ class Basic
|
|||||||
*/
|
*/
|
||||||
public function basicSetLogId(string $string): string
|
public function basicSetLogId(string $string): string
|
||||||
{
|
{
|
||||||
trigger_error('Method ' . __METHOD__ . ' is deprecated, use $basic->log->basicSetLogId() or use \CoreLibs\Debug\Logging() class', E_USER_DEPRECATED);
|
trigger_error('Method ' . __METHOD__ . ' is deprecated, use log->setLogId() or use \CoreLibs\Logging\Logging() class', E_USER_DEPRECATED);
|
||||||
return $this->log->setLogId($string);
|
$this->log->setLogFileId($string);
|
||||||
|
return $this->log->getLogFileId();
|
||||||
}
|
}
|
||||||
|
|
||||||
// ****** DEBUG/ERROR FUNCTIONS ******
|
// ****** DEBUG/ERROR FUNCTIONS ******
|
||||||
@@ -252,7 +256,7 @@ class Basic
|
|||||||
}
|
}
|
||||||
|
|
||||||
// ****** DEBUG LOGGING FUNCTIONS ******
|
// ****** DEBUG LOGGING FUNCTIONS ******
|
||||||
// Moved to \CoreLibs\Debug\Logging
|
// Moved to \CoreLibs\Logging\Logging
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* passes list of level names, to turn on debug
|
* passes list of level names, to turn on debug
|
||||||
@@ -265,68 +269,9 @@ class Basic
|
|||||||
*/
|
*/
|
||||||
public function debugFor(string $type, string $flag): void
|
public function debugFor(string $type, string $flag): void
|
||||||
{
|
{
|
||||||
trigger_error('Method ' . __METHOD__ . ' is deprecated, use $basic->log->debugFor() or use \CoreLibs\Debug\Logging() class', E_USER_DEPRECATED);
|
trigger_error('Method ' . __METHOD__ . ' functionaility is fully deprecated', E_USER_DEPRECATED);
|
||||||
/** @phan-suppress-next-line PhanTypeMismatchArgumentReal, PhanParamTooFew @phpstan-ignore-next-line */
|
|
||||||
$this->log->setLogLevel(...[func_get_args()]);
|
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* checks if we have a need to work on certain debug output
|
|
||||||
* Needs debug/echo/print ad target for which of the debug flag groups we check
|
|
||||||
* also needs level string to check in the per level output flag check.
|
|
||||||
* In case we have invalid target it will return false
|
|
||||||
* @param string $target target group to check debug/echo/print
|
|
||||||
* @param string $level level to check in detailed level flag
|
|
||||||
* @return bool true on access allowed or false on no access
|
|
||||||
*/
|
|
||||||
/* private function doDebugTrigger(string $target, string $level): bool
|
|
||||||
{
|
|
||||||
$access = false;
|
|
||||||
// check if we do debug, echo or print
|
|
||||||
switch ($target) {
|
|
||||||
case 'debug':
|
|
||||||
if ((
|
|
||||||
(isset($this->debug_output[$level]) && $this->debug_output[$level]) ||
|
|
||||||
$this->debug_output_all
|
|
||||||
) &&
|
|
||||||
(!isset($this->debug_output_not[$level]) ||
|
|
||||||
(isset($this->debug_output_not[$level]) && !$this->debug_output_not[$level])
|
|
||||||
)
|
|
||||||
) {
|
|
||||||
$access = true;
|
|
||||||
}
|
|
||||||
break;
|
|
||||||
case 'echo':
|
|
||||||
if ((
|
|
||||||
(isset($this->echo_output[$level]) && $this->echo_output[$level]) ||
|
|
||||||
$this->echo_output_all
|
|
||||||
) &&
|
|
||||||
(!isset($this->echo_output_not[$level]) ||
|
|
||||||
(isset($this->echo_output_not[$level]) && !$this->echo_output_not[$level])
|
|
||||||
)
|
|
||||||
) {
|
|
||||||
$access = true;
|
|
||||||
}
|
|
||||||
break;
|
|
||||||
case 'print':
|
|
||||||
if ((
|
|
||||||
(isset($this->print_output[$level]) && $this->print_output[$level]) ||
|
|
||||||
$this->print_output_all
|
|
||||||
) &&
|
|
||||||
(!isset($this->print_output_not[$level]) ||
|
|
||||||
(isset($this->print_output_not[$level]) && !$this->print_output_not[$level])
|
|
||||||
)
|
|
||||||
) {
|
|
||||||
$access = true;
|
|
||||||
}
|
|
||||||
break;
|
|
||||||
default:
|
|
||||||
// fall through with access false
|
|
||||||
break;
|
|
||||||
}
|
|
||||||
return $access;
|
|
||||||
} */
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* write debug data to error_msg array
|
* write debug data to error_msg array
|
||||||
* @param string $level id for error message, groups messages together
|
* @param string $level id for error message, groups messages together
|
||||||
@@ -335,11 +280,12 @@ class Basic
|
|||||||
* all html tags will be stripped and <br> changed to \n
|
* all html tags will be stripped and <br> changed to \n
|
||||||
* this is only used for debug output
|
* this is only used for debug output
|
||||||
* @return void has no return
|
* @return void has no return
|
||||||
* @deprecated Use $basic->log->debug() instead
|
* @deprecated Use Logger\Logger->debug() instead
|
||||||
*/
|
*/
|
||||||
public function debug(string $level, string $string, bool $strip = false): void
|
public function debug(string $level, string $string, bool $strip = false): void
|
||||||
{
|
{
|
||||||
$this->log->debug($level, $string, $strip);
|
trigger_error('Method ' . __METHOD__ . ' has moved to Logger\Logger->debug()', E_USER_DEPRECATED);
|
||||||
|
$this->log->debug($level, $string);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -351,8 +297,7 @@ class Basic
|
|||||||
*/
|
*/
|
||||||
public function mergeErrors(array $error_msg = []): void
|
public function mergeErrors(array $error_msg = []): void
|
||||||
{
|
{
|
||||||
trigger_error('Method ' . __METHOD__ . ' is deprecated, use $basic->log->mergeErrors() or use \CoreLibs\Debug\Logging() class', E_USER_DEPRECATED);
|
trigger_error('Method ' . __METHOD__ . ' is fully deprecated', E_USER_DEPRECATED);
|
||||||
$this->log->mergeErrors($error_msg);
|
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -363,7 +308,8 @@ class Basic
|
|||||||
*/
|
*/
|
||||||
public function printErrorMsg(string $string = ''): string
|
public function printErrorMsg(string $string = ''): string
|
||||||
{
|
{
|
||||||
return $this->log->printErrorMsg($string);
|
trigger_error('Method ' . __METHOD__ . ' is fully deprecated', E_USER_DEPRECATED);
|
||||||
|
return '';
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -376,8 +322,7 @@ class Basic
|
|||||||
*/
|
*/
|
||||||
public function resetErrorMsg(string $level = ''): void
|
public function resetErrorMsg(string $level = ''): void
|
||||||
{
|
{
|
||||||
trigger_error('Method ' . __METHOD__ . ' is deprecated, use $basic->log->resetErrorMsg() or use \CoreLibs\Debug\Logging() class', E_USER_DEPRECATED);
|
trigger_error('Method ' . __METHOD__ . ' is fully deprecated', E_USER_DEPRECATED);
|
||||||
$this->log->resetErrorMsg($level);
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// ****** DEBUG SUPPORT FUNCTIONS ******
|
// ****** DEBUG SUPPORT FUNCTIONS ******
|
||||||
@@ -388,11 +333,11 @@ class Basic
|
|||||||
* prints a html formatted (pre) array
|
* prints a html formatted (pre) array
|
||||||
* @param array<mixed> $array any array
|
* @param array<mixed> $array any array
|
||||||
* @return string formatted array for output with <pre> tag added
|
* @return string formatted array for output with <pre> tag added
|
||||||
* @deprecated Use $this->log->prAr() instead
|
* @deprecated Use \CoreLibs\Debug\Support::prAr() instead
|
||||||
*/
|
*/
|
||||||
public function printAr(array $array): string
|
public function printAr(array $array): string
|
||||||
{
|
{
|
||||||
return $this->log->prAr($array);
|
return \CoreLibs\Debug\Support::prAr($array);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -672,9 +617,6 @@ class Basic
|
|||||||
public static function arrayToString(array $array, string $connect_char): string
|
public static function arrayToString(array $array, string $connect_char): string
|
||||||
{
|
{
|
||||||
trigger_error('Method ' . __METHOD__ . ' is deprecated, use join()', E_USER_DEPRECATED);
|
trigger_error('Method ' . __METHOD__ . ' is deprecated, use join()', E_USER_DEPRECATED);
|
||||||
if (!is_array($array)) {
|
|
||||||
$array = [];
|
|
||||||
}
|
|
||||||
return join($connect_char, $array);
|
return join($connect_char, $array);
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -992,7 +934,7 @@ class Basic
|
|||||||
int $jpeg_quality = 80
|
int $jpeg_quality = 80
|
||||||
) {
|
) {
|
||||||
trigger_error('Method ' . __METHOD__ . ' is deprecated, use \CoreLibs\Output\Image::createThumbnailSimple()', E_USER_DEPRECATED);
|
trigger_error('Method ' . __METHOD__ . ' is deprecated, use \CoreLibs\Output\Image::createThumbnailSimple()', E_USER_DEPRECATED);
|
||||||
return \CoreLibs\Output\Image::createThumbnailSimple($filename, $thumb_width, $thumb_height, $thumbnail_path, $create_dummy, $use_cache, $high_quality, $jpeg_quality);
|
return \CoreLibs\Output\Image::createThumbnailSimple($filename, $thumb_width, $thumb_height, $thumbnail_path, null, $create_dummy, $use_cache, $high_quality, $jpeg_quality);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -1167,7 +1109,7 @@ class Basic
|
|||||||
public function passwordSet(string $password): string
|
public function passwordSet(string $password): string
|
||||||
{
|
{
|
||||||
trigger_error('Method ' . __METHOD__ . ' is deprecated, use \CoreLibs\Check\Password::passwordSet()', E_USER_DEPRECATED);
|
trigger_error('Method ' . __METHOD__ . ' is deprecated, use \CoreLibs\Check\Password::passwordSet()', E_USER_DEPRECATED);
|
||||||
return \CoreLibs\Check\Password::passwordSet($password);
|
return \CoreLibs\Security\Password::passwordSet($password);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -1180,7 +1122,7 @@ class Basic
|
|||||||
public function passwordVerify(string $password, string $hash): bool
|
public function passwordVerify(string $password, string $hash): bool
|
||||||
{
|
{
|
||||||
trigger_error('Method ' . __METHOD__ . ' is deprecated, use \CoreLibs\Check\Password::passwordVerify()', E_USER_DEPRECATED);
|
trigger_error('Method ' . __METHOD__ . ' is deprecated, use \CoreLibs\Check\Password::passwordVerify()', E_USER_DEPRECATED);
|
||||||
return \CoreLibs\Check\Password::passwordVerify($password, $hash);
|
return \CoreLibs\Security\Password::passwordVerify($password, $hash);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -1192,7 +1134,7 @@ class Basic
|
|||||||
public function passwordRehashCheck(string $hash): bool
|
public function passwordRehashCheck(string $hash): bool
|
||||||
{
|
{
|
||||||
trigger_error('Method ' . __METHOD__ . ' is deprecated, use \CoreLibs\Check\Password::passwordRehashCheck()', E_USER_DEPRECATED);
|
trigger_error('Method ' . __METHOD__ . ' is deprecated, use \CoreLibs\Check\Password::passwordRehashCheck()', E_USER_DEPRECATED);
|
||||||
return \CoreLibs\Check\Password::passwordRehashCheck($hash);
|
return \CoreLibs\Security\Password::passwordRehashCheck($hash);
|
||||||
}
|
}
|
||||||
|
|
||||||
// *** BETTER PASSWORD OPTIONS END ***
|
// *** BETTER PASSWORD OPTIONS END ***
|
||||||
|
|||||||
@@ -14,8 +14,6 @@ declare(strict_types=1);
|
|||||||
|
|
||||||
namespace CoreLibs\Check;
|
namespace CoreLibs\Check;
|
||||||
|
|
||||||
use Exception;
|
|
||||||
|
|
||||||
class Colors
|
class Colors
|
||||||
{
|
{
|
||||||
/** @var int 1 for HEX rgb */
|
/** @var int 1 for HEX rgb */
|
||||||
@@ -41,15 +39,19 @@ class Colors
|
|||||||
* @param int|false $rgb_flag flag to check for rgb
|
* @param int|false $rgb_flag flag to check for rgb
|
||||||
* @param int|false $hsl_flag flag to check for hsl type
|
* @param int|false $hsl_flag flag to check for hsl type
|
||||||
* @return bool True if no error, False if error
|
* @return bool True if no error, False if error
|
||||||
|
* @throws \UnexpectedValueException 1: cannot extract color from string
|
||||||
*/
|
*/
|
||||||
private static function rgbHslContentCheck(string $color, $rgb_flag, $hsl_flag): bool
|
private static function rgbHslContentCheck(
|
||||||
{
|
string $color,
|
||||||
|
int|false $rgb_flag,
|
||||||
|
int|false $hsl_flag
|
||||||
|
): bool {
|
||||||
// extract string between () and split into elements
|
// extract string between () and split into elements
|
||||||
preg_match("/\((.*)\)/", $color, $matches);
|
preg_match("/\((.*)\)/", $color, $matches);
|
||||||
if (
|
if (
|
||||||
!is_array($color_list = preg_split("/,\s*/", $matches[1] ?? ''))
|
!is_array($color_list = preg_split("/,\s*/", $matches[1] ?? ''))
|
||||||
) {
|
) {
|
||||||
throw new \Exception("Could not extract color list from rgg/hsl", 3);
|
throw new \UnexpectedValueException("Could not extract color list from rgg/hsl", 1);
|
||||||
}
|
}
|
||||||
// based on rgb/hsl settings check that entries are valid
|
// based on rgb/hsl settings check that entries are valid
|
||||||
// rgb: either 0-255 OR 0-100%
|
// rgb: either 0-255 OR 0-100%
|
||||||
@@ -121,7 +123,8 @@ class Colors
|
|||||||
* @param int $flags defaults to ALL, else use | to combined from
|
* @param int $flags defaults to ALL, else use | to combined from
|
||||||
* HEX_RGB, HEX_RGBA, RGB, RGBA, HSL, HSLA
|
* HEX_RGB, HEX_RGBA, RGB, RGBA, HSL, HSLA
|
||||||
* @return bool True if valid, False if not
|
* @return bool True if valid, False if not
|
||||||
* @throws Exception 1: no valid flag set
|
* @throws \UnexpectedValueException 1: no valid flag set
|
||||||
|
* @throws \InvalidArgumentException 2: no regex block set
|
||||||
*/
|
*/
|
||||||
public static function validateColor(string $color, int $flags = self::ALL): bool
|
public static function validateColor(string $color, int $flags = self::ALL): bool
|
||||||
{
|
{
|
||||||
@@ -149,10 +152,10 @@ class Colors
|
|||||||
}
|
}
|
||||||
// wrong flag set
|
// wrong flag set
|
||||||
if ($flags > self::ALL) {
|
if ($flags > self::ALL) {
|
||||||
throw new \Exception("Invalid flags parameter: $flags", 1);
|
throw new \UnexpectedValueException("Invalid flags parameter: $flags", 1);
|
||||||
}
|
}
|
||||||
if (!count($regex_blocks)) {
|
if (!count($regex_blocks)) {
|
||||||
throw new \Exception("No regex blocks set: $flags", 2);
|
throw new \InvalidArgumentException("No regex blocks set: $flags", 2);
|
||||||
}
|
}
|
||||||
|
|
||||||
// build regex
|
// build regex
|
||||||
|
|||||||
@@ -8,7 +8,7 @@ class Email
|
|||||||
{
|
{
|
||||||
// this is for error check parts in where the email regex failed
|
// this is for error check parts in where the email regex failed
|
||||||
/** @var array<int,string> */
|
/** @var array<int,string> */
|
||||||
private static $email_regex_check = [
|
private static array $email_regex_check = [
|
||||||
0 => "^[A-Za-z0-9!#$%&'*+\-\/=?^_`{|}~][A-Za-z0-9!#$%:\(\)&'*+\-\/=?^_`{|}~\.]{0,63}@"
|
0 => "^[A-Za-z0-9!#$%&'*+\-\/=?^_`{|}~][A-Za-z0-9!#$%:\(\)&'*+\-\/=?^_`{|}~\.]{0,63}@"
|
||||||
. "[a-zA-Z0-9\-]+(\.[a-zA-Z0-9\-]{1,})*\.([a-zA-Z]{2,}){1}$", // MASTER
|
. "[a-zA-Z0-9\-]+(\.[a-zA-Z0-9\-]{1,})*\.([a-zA-Z]{2,}){1}$", // MASTER
|
||||||
1 => "@(.*)@(.*)", // double @
|
1 => "@(.*)@(.*)", // double @
|
||||||
@@ -21,7 +21,7 @@ class Email
|
|||||||
];
|
];
|
||||||
// for above position, description string below
|
// for above position, description string below
|
||||||
/** @var array<int,string> */
|
/** @var array<int,string> */
|
||||||
private static $email_regex_check_message = [
|
private static array $email_regex_check_message = [
|
||||||
0 => 'Invalid email address',
|
0 => 'Invalid email address',
|
||||||
1 => 'Double @ mark in email address',
|
1 => 'Double @ mark in email address',
|
||||||
2 => 'Invalid email part before @ sign',
|
2 => 'Invalid email part before @ sign',
|
||||||
@@ -33,7 +33,7 @@ class Email
|
|||||||
];
|
];
|
||||||
// the array with the mobile types that are valid
|
// the array with the mobile types that are valid
|
||||||
/** @var array<string,string> */
|
/** @var array<string,string> */
|
||||||
private static $mobile_email_type = [
|
private static array $mobile_email_type = [
|
||||||
'.*@docomo\.ne\.jp$' => 'keitai_docomo',
|
'.*@docomo\.ne\.jp$' => 'keitai_docomo',
|
||||||
// correct are a[2-4], b2, c[1-9], e[2-9], h[2-4], t[1-9]
|
// correct are a[2-4], b2, c[1-9], e[2-9], h[2-4], t[1-9]
|
||||||
'.*@([a-z0-9]{2}\.)?ezweb\.ne\.jp$' => 'keitai_kddi_ezweb',
|
'.*@([a-z0-9]{2}\.)?ezweb\.ne\.jp$' => 'keitai_kddi_ezweb',
|
||||||
@@ -72,7 +72,7 @@ class Email
|
|||||||
];
|
];
|
||||||
// short list for mobile email types
|
// short list for mobile email types
|
||||||
/** @var array<string,string> */
|
/** @var array<string,string> */
|
||||||
private static $mobile_email_type_short = [
|
private static array $mobile_email_type_short = [
|
||||||
'keitai_docomo' => 'docomo',
|
'keitai_docomo' => 'docomo',
|
||||||
'keitai_kddi_ezweb' => 'kddi',
|
'keitai_kddi_ezweb' => 'kddi',
|
||||||
'keitai_kddi' => 'kddi',
|
'keitai_kddi' => 'kddi',
|
||||||
@@ -169,10 +169,10 @@ class Email
|
|||||||
* @param string $email email string
|
* @param string $email email string
|
||||||
* @param bool $short default false, if true,
|
* @param bool $short default false, if true,
|
||||||
* returns only short type (pc instead of pc_html)
|
* returns only short type (pc instead of pc_html)
|
||||||
* @return string|bool email type, eg "pc", "docomo", etc,
|
* @return string|false email type, eg "pc", "docomo", etc,
|
||||||
* false for invalid short type
|
* false for invalid short type
|
||||||
*/
|
*/
|
||||||
public static function getEmailType(string $email, bool $short = false)
|
public static function getEmailType(string $email, bool $short = false): string|false
|
||||||
{
|
{
|
||||||
// trip if there is no email address
|
// trip if there is no email address
|
||||||
if (!$email) {
|
if (!$email) {
|
||||||
@@ -200,9 +200,9 @@ class Email
|
|||||||
* gets the short email type from a long email type
|
* gets the short email type from a long email type
|
||||||
*
|
*
|
||||||
* @param string $email_type email string
|
* @param string $email_type email string
|
||||||
* @return string|bool short string or false for invalid
|
* @return string|false short string or false for invalid
|
||||||
*/
|
*/
|
||||||
public static function getShortEmailType(string $email_type)
|
public static function getShortEmailType(string $email_type): string|false
|
||||||
{
|
{
|
||||||
// check if the short email type exists
|
// check if the short email type exists
|
||||||
if (isset(self::$mobile_email_type_short[$email_type])) {
|
if (isset(self::$mobile_email_type_short[$email_type])) {
|
||||||
|
|||||||
@@ -11,7 +11,7 @@ namespace CoreLibs\Check;
|
|||||||
class Encoding
|
class Encoding
|
||||||
{
|
{
|
||||||
/** @var int<min, -1>|int<1, max>|string */
|
/** @var int<min, -1>|int<1, max>|string */
|
||||||
private static $mb_error_char = '';
|
private static int|string $mb_error_char = '';
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* set error char
|
* set error char
|
||||||
@@ -25,7 +25,7 @@ class Encoding
|
|||||||
* if null is set then "none"
|
* if null is set then "none"
|
||||||
* @return void
|
* @return void
|
||||||
*/
|
*/
|
||||||
public static function setErrorChar($string): void
|
public static function setErrorChar(string|int|null $string): void
|
||||||
{
|
{
|
||||||
if (empty($string)) {
|
if (empty($string)) {
|
||||||
$string = 'none';
|
$string = 'none';
|
||||||
@@ -52,7 +52,7 @@ class Encoding
|
|||||||
* directly
|
* directly
|
||||||
* @return string|int Set error character
|
* @return string|int Set error character
|
||||||
*/
|
*/
|
||||||
public static function getErrorChar(bool $return_substitute_func = false)
|
public static function getErrorChar(bool $return_substitute_func = false): string|int
|
||||||
{
|
{
|
||||||
// return mb_substitute_character();
|
// return mb_substitute_character();
|
||||||
if ($return_substitute_func === true) {
|
if ($return_substitute_func === true) {
|
||||||
@@ -78,39 +78,38 @@ class Encoding
|
|||||||
* @param string $string string to test
|
* @param string $string string to test
|
||||||
* @param string $from_encoding encoding of string to test
|
* @param string $from_encoding encoding of string to test
|
||||||
* @param string $to_encoding target encoding
|
* @param string $to_encoding target encoding
|
||||||
* @return bool|array<string> false if no error or
|
* @return array<string>|false false if no error or
|
||||||
* array with failed characters
|
* array with failed characters
|
||||||
*/
|
*/
|
||||||
public static function checkConvertEncoding(
|
public static function checkConvertEncoding(
|
||||||
string $string,
|
string $string,
|
||||||
string $from_encoding,
|
string $from_encoding,
|
||||||
string $to_encoding
|
string $to_encoding
|
||||||
) {
|
): array|false {
|
||||||
// convert to target encoding and convert back
|
// convert to target encoding and convert back
|
||||||
$temp = mb_convert_encoding($string, $to_encoding, $from_encoding);
|
$temp = mb_convert_encoding($string, $to_encoding, $from_encoding);
|
||||||
$compare = mb_convert_encoding($temp, $from_encoding, $to_encoding);
|
$compare = mb_convert_encoding($temp, $from_encoding, $to_encoding);
|
||||||
// if string does not match anymore we have a convert problem
|
// if string does not match anymore we have a convert problem
|
||||||
if ($string != $compare) {
|
if ($string == $compare) {
|
||||||
$failed = [];
|
|
||||||
// go through each character and find the ones that do not match
|
|
||||||
for ($i = 0, $iMax = mb_strlen($string, $from_encoding); $i < $iMax; $i++) {
|
|
||||||
$char = mb_substr($string, $i, 1, $from_encoding);
|
|
||||||
$r_char = mb_substr($compare, $i, 1, $from_encoding);
|
|
||||||
// the ord 194 is a hack to fix the IE7/IE8
|
|
||||||
// bug with line break and illegal character
|
|
||||||
if (
|
|
||||||
(($char != $r_char && (!self::$mb_error_char ||
|
|
||||||
in_array(self::$mb_error_char, ['none', 'long', 'entity']))) ||
|
|
||||||
($char != $r_char && $r_char == self::$mb_error_char && self::$mb_error_char)) &&
|
|
||||||
ord($char) != 194
|
|
||||||
) {
|
|
||||||
$failed[] = $char;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return $failed;
|
|
||||||
} else {
|
|
||||||
return false;
|
return false;
|
||||||
}
|
}
|
||||||
|
$failed = [];
|
||||||
|
// go through each character and find the ones that do not match
|
||||||
|
for ($i = 0, $iMax = mb_strlen($string, $from_encoding); $i < $iMax; $i++) {
|
||||||
|
$char = mb_substr($string, $i, 1, $from_encoding);
|
||||||
|
$r_char = mb_substr($compare, $i, 1, $from_encoding);
|
||||||
|
// the ord 194 is a hack to fix the IE7/IE8
|
||||||
|
// bug with line break and illegal character
|
||||||
|
if (
|
||||||
|
(($char != $r_char && (!self::$mb_error_char ||
|
||||||
|
in_array(self::$mb_error_char, ['none', 'long', 'entity']))) ||
|
||||||
|
($char != $r_char && $r_char == self::$mb_error_char && self::$mb_error_char)) &&
|
||||||
|
ord($char) != 194
|
||||||
|
) {
|
||||||
|
$failed[] = $char;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return $failed;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -1,41 +0,0 @@
|
|||||||
<?php
|
|
||||||
|
|
||||||
/*
|
|
||||||
* DEPRECATED: Use correct Convert\Json:: instead
|
|
||||||
*/
|
|
||||||
|
|
||||||
declare(strict_types=1);
|
|
||||||
|
|
||||||
namespace CoreLibs\Check;
|
|
||||||
|
|
||||||
use CoreLibs\Convert\Json;
|
|
||||||
|
|
||||||
class Jason
|
|
||||||
{
|
|
||||||
/**
|
|
||||||
* @param string|null $json a json string, or null data
|
|
||||||
* @param bool $override if set to true, then on json error
|
|
||||||
* set original value as array
|
|
||||||
* @return array<mixed> returns an array from the json values
|
|
||||||
* @deprecated Use Json::jsonConvertToArray()
|
|
||||||
*/
|
|
||||||
public static function jsonConvertToArray(?string $json, bool $override = false): array
|
|
||||||
{
|
|
||||||
return Json::jsonConvertToArray($json, $override);
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @param bool|boolean $return_string [default=false] if set to true
|
|
||||||
* it will return the message string and not
|
|
||||||
* the error number
|
|
||||||
* @return int|string Either error number (0 for no error)
|
|
||||||
* or error string ('' for no error)
|
|
||||||
* @deprecated Use Json::jsonGetLastError()
|
|
||||||
*/
|
|
||||||
public static function jsonGetLastError(bool $return_string = false)
|
|
||||||
{
|
|
||||||
return Json::jsonGetLastError($return_string);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// __END__
|
|
||||||
@@ -1,6 +1,8 @@
|
|||||||
<?php
|
<?php
|
||||||
|
|
||||||
/*
|
/*
|
||||||
|
* NOTE: this is deprecated and all moved \CoreLibs\Security\Password
|
||||||
|
*
|
||||||
* core password set, check and rehash check wrapper functions
|
* core password set, check and rehash check wrapper functions
|
||||||
*/
|
*/
|
||||||
|
|
||||||
@@ -8,6 +10,8 @@ declare(strict_types=1);
|
|||||||
|
|
||||||
namespace CoreLibs\Check;
|
namespace CoreLibs\Check;
|
||||||
|
|
||||||
|
use CoreLibs\Security\Password as PasswordNew;
|
||||||
|
|
||||||
class Password
|
class Password
|
||||||
{
|
{
|
||||||
/**
|
/**
|
||||||
@@ -15,13 +19,16 @@ class Password
|
|||||||
*
|
*
|
||||||
* @param string $password password
|
* @param string $password password
|
||||||
* @return string hashed password
|
* @return string hashed password
|
||||||
|
* @deprecated v9.0 Moved to \CoreLibs\Security\Password::passwordSet
|
||||||
*/
|
*/
|
||||||
public static function passwordSet(string $password): string
|
public static function passwordSet(string $password): string
|
||||||
{
|
{
|
||||||
// always use the PHP default for the password
|
trigger_error(
|
||||||
// password options ca be set in the password init,
|
'Method ' . __METHOD__ . ' is deprecated, use '
|
||||||
// but should be kept as default
|
. '\CoreLibs\Security\Password::passwordSet',
|
||||||
return password_hash($password, PASSWORD_DEFAULT);
|
E_USER_DEPRECATED
|
||||||
|
);
|
||||||
|
return PasswordNew::passwordSet($password);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -30,14 +37,16 @@ class Password
|
|||||||
* @param string $password password
|
* @param string $password password
|
||||||
* @param string $hash password hash
|
* @param string $hash password hash
|
||||||
* @return bool true or false
|
* @return bool true or false
|
||||||
|
* @deprecated v9.0 Moved to \CoreLibs\Security\Password::passwordVerify
|
||||||
*/
|
*/
|
||||||
public static function passwordVerify(string $password, string $hash): bool
|
public static function passwordVerify(string $password, string $hash): bool
|
||||||
{
|
{
|
||||||
if (password_verify($password, $hash)) {
|
trigger_error(
|
||||||
return true;
|
'Method ' . __METHOD__ . ' is deprecated, use '
|
||||||
} else {
|
. '\CoreLibs\Security\Password::passwordVerify',
|
||||||
return false;
|
E_USER_DEPRECATED
|
||||||
}
|
);
|
||||||
|
return PasswordNew::passwordVerify($password, $hash);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -45,14 +54,16 @@ class Password
|
|||||||
*
|
*
|
||||||
* @param string $hash password hash
|
* @param string $hash password hash
|
||||||
* @return bool true or false
|
* @return bool true or false
|
||||||
|
* @deprecated v9.0 Moved to \CoreLibs\Security\Password::passwordRehashCheck
|
||||||
*/
|
*/
|
||||||
public static function passwordRehashCheck(string $hash): bool
|
public static function passwordRehashCheck(string $hash): bool
|
||||||
{
|
{
|
||||||
if (password_needs_rehash($hash, PASSWORD_DEFAULT)) {
|
trigger_error(
|
||||||
return true;
|
'Method ' . __METHOD__ . ' is deprecated, use '
|
||||||
} else {
|
. '\CoreLibs\Security\Password::passwordRehashCheck',
|
||||||
return false;
|
E_USER_DEPRECATED
|
||||||
}
|
);
|
||||||
|
return PasswordNew::passwordRehashCheck($hash);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -21,12 +21,12 @@ class ArrayHandler
|
|||||||
* the needle can be found in the
|
* the needle can be found in the
|
||||||
* haystack array
|
* haystack array
|
||||||
*/
|
*/
|
||||||
public static function arraySearchRecursive($needle, array $haystack, ?string $key_search_for = null): array
|
public static function arraySearchRecursive(
|
||||||
{
|
string|int $needle,
|
||||||
|
array $haystack,
|
||||||
|
?string $key_search_for = null
|
||||||
|
): array {
|
||||||
$path = [];
|
$path = [];
|
||||||
if (!is_array($haystack)) {
|
|
||||||
$haystack = [];
|
|
||||||
}
|
|
||||||
if (
|
if (
|
||||||
$key_search_for != null &&
|
$key_search_for != null &&
|
||||||
array_key_exists($key_search_for, $haystack) &&
|
array_key_exists($key_search_for, $haystack) &&
|
||||||
@@ -72,7 +72,7 @@ class ArrayHandler
|
|||||||
*
|
*
|
||||||
* @param string|int $needle needle (search for)
|
* @param string|int $needle needle (search for)
|
||||||
* @param array<mixed> $haystack haystack (search in)
|
* @param array<mixed> $haystack haystack (search in)
|
||||||
* @param string|int $key_search_for the key to look for in
|
* @param string|int|null $key_search_for the key to look for in
|
||||||
* @param bool $old [true], if set to false will
|
* @param bool $old [true], if set to false will
|
||||||
* return new flat layout
|
* return new flat layout
|
||||||
* @param array<mixed>|null $path recursive call for previous path
|
* @param array<mixed>|null $path recursive call for previous path
|
||||||
@@ -80,9 +80,9 @@ class ArrayHandler
|
|||||||
* the element was found
|
* the element was found
|
||||||
*/
|
*/
|
||||||
public static function arraySearchRecursiveAll(
|
public static function arraySearchRecursiveAll(
|
||||||
$needle,
|
string|int $needle,
|
||||||
array $haystack,
|
array $haystack,
|
||||||
$key_search_for,
|
string|int|null $key_search_for,
|
||||||
bool $old = true,
|
bool $old = true,
|
||||||
?array $path = null
|
?array $path = null
|
||||||
): ?array {
|
): ?array {
|
||||||
@@ -101,10 +101,6 @@ class ArrayHandler
|
|||||||
$path['work'] = [];
|
$path['work'] = [];
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
// should not be needed because it would trigger a php mehtod error
|
|
||||||
if (!is_array($haystack)) {
|
|
||||||
$haystack = [];
|
|
||||||
}
|
|
||||||
|
|
||||||
// go through the array,
|
// go through the array,
|
||||||
foreach ($haystack as $_key => $_value) {
|
foreach ($haystack as $_key => $_value) {
|
||||||
@@ -152,17 +148,18 @@ class ArrayHandler
|
|||||||
* array search simple. looks for key, value combination, if found, returns true
|
* array search simple. looks for key, value combination, if found, returns true
|
||||||
* on default does not strict check, so string '4' will match int 4 and vica versa
|
* on default does not strict check, so string '4' will match int 4 and vica versa
|
||||||
*
|
*
|
||||||
* @param array<mixed> $array search in as array
|
* @param array<mixed> $array search in as array
|
||||||
* @param string|int $key key (key to search in)
|
* @param string|int $key key (key to search in)
|
||||||
* @param string|int $value value (what to find)
|
* @param string|int|bool $value value (what to find)
|
||||||
* @param bool $strict [false], if set to true, will strict check key/value
|
* @param bool $strict [false], if set to true, will strict check key/value
|
||||||
* @return bool true on found, false on not found
|
* @return bool true on found, false on not found
|
||||||
*/
|
*/
|
||||||
public static function arraySearchSimple(array $array, $key, $value, bool $strict = false): bool
|
public static function arraySearchSimple(
|
||||||
{
|
array $array,
|
||||||
if (!is_array($array)) {
|
string|int $key,
|
||||||
$array = [];
|
string|int|bool $value,
|
||||||
}
|
bool $strict = false
|
||||||
|
): bool {
|
||||||
foreach ($array as $_key => $_value) {
|
foreach ($array as $_key => $_value) {
|
||||||
// if value is an array, we search
|
// if value is an array, we search
|
||||||
if (is_array($_value)) {
|
if (is_array($_value)) {
|
||||||
@@ -180,6 +177,65 @@ class ArrayHandler
|
|||||||
return false;
|
return false;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* search for one or many keys in array and return matching values
|
||||||
|
* If flat is set to true, return flat array with found values only
|
||||||
|
* If prefix is turned on each found group will be prefixed with the
|
||||||
|
* search key
|
||||||
|
*
|
||||||
|
* @param array<mixed> $array array to search in
|
||||||
|
* @param array<mixed> $needles keys to find in array
|
||||||
|
* @param bool $flat [false] Turn on flat output
|
||||||
|
* @param bool $prefix [false] Prefix found with needle key
|
||||||
|
* @return array<mixed> Found values
|
||||||
|
*/
|
||||||
|
public static function arraySearchKey(
|
||||||
|
array $array,
|
||||||
|
array $needles,
|
||||||
|
bool $flat = false,
|
||||||
|
bool $prefix = false
|
||||||
|
): array {
|
||||||
|
$iterator = new \RecursiveArrayIterator($array);
|
||||||
|
$recursive = new \RecursiveIteratorIterator(
|
||||||
|
$iterator,
|
||||||
|
\RecursiveIteratorIterator::SELF_FIRST
|
||||||
|
);
|
||||||
|
$hit_list = [];
|
||||||
|
if ($prefix === true) {
|
||||||
|
$hit_list = array_fill_keys($needles, []);
|
||||||
|
}
|
||||||
|
$key_path = [];
|
||||||
|
$prev_depth = 0;
|
||||||
|
foreach ($recursive as $key => $value) {
|
||||||
|
if ($prev_depth > $recursive->getDepth()) {
|
||||||
|
// remove all trailing to ne depth
|
||||||
|
$diff = $prev_depth - $recursive->getDepth();
|
||||||
|
array_splice($key_path, -$diff, $diff);
|
||||||
|
}
|
||||||
|
$prev_depth = $recursive->getDepth();
|
||||||
|
if ($flat === false) {
|
||||||
|
$key_path[$recursive->getDepth()] = $key;
|
||||||
|
}
|
||||||
|
if (in_array($key, $needles, true)) {
|
||||||
|
ksort($key_path);
|
||||||
|
if ($flat === true) {
|
||||||
|
$hit = $value;
|
||||||
|
} else {
|
||||||
|
$hit = [
|
||||||
|
'value' => $value,
|
||||||
|
'path' => $key_path
|
||||||
|
];
|
||||||
|
}
|
||||||
|
if ($prefix === true) {
|
||||||
|
$hit_list[$key][] = $hit;
|
||||||
|
} else {
|
||||||
|
$hit_list[] = $hit;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return $hit_list;
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* correctly recursive merges as an array as array_merge_recursive
|
* correctly recursive merges as an array as array_merge_recursive
|
||||||
* just glues things together
|
* just glues things together
|
||||||
@@ -189,14 +245,13 @@ class ArrayHandler
|
|||||||
* bool key flag: true: handle keys as string or int
|
* bool key flag: true: handle keys as string or int
|
||||||
* default false: all keys are string
|
* default false: all keys are string
|
||||||
*
|
*
|
||||||
* @return array<mixed>|bool merged array
|
* @return array<mixed> merged array
|
||||||
*/
|
*/
|
||||||
public static function arrayMergeRecursive()
|
public static function arrayMergeRecursive(): array
|
||||||
{
|
{
|
||||||
// croak on not enough arguemnts (we need at least two)
|
// croak on not enough arguemnts (we need at least two)
|
||||||
if (func_num_args() < 2) {
|
if (func_num_args() < 2) {
|
||||||
trigger_error(__FUNCTION__ . ' needs two or more array arguments', E_USER_WARNING);
|
throw new \ArgumentCountError(__FUNCTION__ . ' needs two or more array arguments');
|
||||||
return false;
|
|
||||||
}
|
}
|
||||||
// default key is not string
|
// default key is not string
|
||||||
$key_is_string = false;
|
$key_is_string = false;
|
||||||
@@ -209,15 +264,13 @@ class ArrayHandler
|
|||||||
}
|
}
|
||||||
// check that arrays count is at least two, else we don't have enough to do anything
|
// check that arrays count is at least two, else we don't have enough to do anything
|
||||||
if (count($arrays) < 2) {
|
if (count($arrays) < 2) {
|
||||||
trigger_error(__FUNCTION__ . ' needs two or more array arguments', E_USER_WARNING);
|
throw new \ArgumentCountError(__FUNCTION__ . ' needs two or more array arguments');
|
||||||
return false;
|
|
||||||
}
|
}
|
||||||
$merged = [];
|
$merged = [];
|
||||||
while ($arrays) {
|
while ($arrays) {
|
||||||
$array = array_shift($arrays);
|
$array = array_shift($arrays);
|
||||||
if (!is_array($array)) {
|
if (!is_array($array)) {
|
||||||
trigger_error(__FUNCTION__ . ' encountered a non array argument', E_USER_WARNING);
|
throw new \TypeError(__FUNCTION__ . ' encountered a non array argument');
|
||||||
return false;
|
|
||||||
}
|
}
|
||||||
if (!$array) {
|
if (!$array) {
|
||||||
continue;
|
continue;
|
||||||
@@ -264,10 +317,10 @@ class ArrayHandler
|
|||||||
* @param array<mixed> $needle elements to search for
|
* @param array<mixed> $needle elements to search for
|
||||||
* @param array<mixed> $haystack array where the $needle elements should
|
* @param array<mixed> $haystack array where the $needle elements should
|
||||||
* be searched int
|
* be searched int
|
||||||
* @return array<mixed>|bool either the found elements or
|
* @return array<mixed>|false either the found elements or
|
||||||
* false for nothing found or error
|
* false for nothing found or error
|
||||||
*/
|
*/
|
||||||
public static function inArrayAny(array $needle, array $haystack)
|
public static function inArrayAny(array $needle, array $haystack): array|false
|
||||||
{
|
{
|
||||||
$found = [];
|
$found = [];
|
||||||
foreach ($needle as $element) {
|
foreach ($needle as $element) {
|
||||||
@@ -291,8 +344,12 @@ class ArrayHandler
|
|||||||
* @param bool $set_only flag to return all (default), or set only
|
* @param bool $set_only flag to return all (default), or set only
|
||||||
* @return array<mixed> associative array
|
* @return array<mixed> associative array
|
||||||
*/
|
*/
|
||||||
public static function genAssocArray(array $db_array, $key, $value, bool $set_only = false): array
|
public static function genAssocArray(
|
||||||
{
|
array $db_array,
|
||||||
|
string|int|bool $key,
|
||||||
|
string|int|bool $value,
|
||||||
|
bool $set_only = false
|
||||||
|
): array {
|
||||||
$ret_array = [];
|
$ret_array = [];
|
||||||
// do this to only run count once
|
// do this to only run count once
|
||||||
for ($i = 0, $iMax = count($db_array); $i < $iMax; $i++) {
|
for ($i = 0, $iMax = count($db_array); $i < $iMax; $i++) {
|
||||||
@@ -385,11 +442,8 @@ class ArrayHandler
|
|||||||
* and will be pushed up
|
* and will be pushed up
|
||||||
* @return array<mixed> modified, flattened array
|
* @return array<mixed> modified, flattened array
|
||||||
*/
|
*/
|
||||||
public static function arrayFlatForKey(array $array, $search): array
|
public static function arrayFlatForKey(array $array, string|int $search): array
|
||||||
{
|
{
|
||||||
if (!is_array($array)) {
|
|
||||||
$array = [];
|
|
||||||
}
|
|
||||||
foreach ($array as $key => $value) {
|
foreach ($array as $key => $value) {
|
||||||
// if it is not an array do just nothing
|
// if it is not an array do just nothing
|
||||||
if (!is_array($value)) {
|
if (!is_array($value)) {
|
||||||
|
|||||||
@@ -74,7 +74,7 @@ class DateTime
|
|||||||
* @return string formated date+time in Y-M-D h:m:s ms
|
* @return string formated date+time in Y-M-D h:m:s ms
|
||||||
*/
|
*/
|
||||||
public static function dateStringFormat(
|
public static function dateStringFormat(
|
||||||
$timestamp,
|
int|float $timestamp,
|
||||||
bool $show_micro = false,
|
bool $show_micro = false,
|
||||||
bool $micro_as_float = false
|
bool $micro_as_float = false
|
||||||
): string {
|
): string {
|
||||||
@@ -100,52 +100,53 @@ class DateTime
|
|||||||
* @param bool $show_micro show micro seconds, default true
|
* @param bool $show_micro show micro seconds, default true
|
||||||
* @return string interval formatted string or string as is
|
* @return string interval formatted string or string as is
|
||||||
*/
|
*/
|
||||||
public static function timeStringFormat($timestamp, bool $show_micro = true): string
|
public static function timeStringFormat(
|
||||||
{
|
string|int|float $timestamp,
|
||||||
|
bool $show_micro = true
|
||||||
|
): string {
|
||||||
// check if the timestamp has any h/m/s/ms inside, if yes skip
|
// check if the timestamp has any h/m/s/ms inside, if yes skip
|
||||||
if (!preg_match("/(h|m|s|ms)/", (string)$timestamp)) {
|
if (preg_match("/(h|m|s|ms)/", (string)$timestamp)) {
|
||||||
list($timestamp, $ms) = array_pad(explode('.', (string)round((float)$timestamp, 4)), 2, null);
|
return (string)$timestamp;
|
||||||
// if negative remember
|
}
|
||||||
$negative = false;
|
list($timestamp, $ms) = array_pad(explode('.', (string)round((float)$timestamp, 4)), 2, null);
|
||||||
if ((int)$timestamp < 0) {
|
// if negative remember
|
||||||
$negative = true;
|
$negative = false;
|
||||||
}
|
if ((int)$timestamp < 0) {
|
||||||
$timestamp = abs((float)$timestamp);
|
$negative = true;
|
||||||
$timegroups = [86400, 3600, 60, 1];
|
}
|
||||||
$labels = ['d', 'h', 'm', 's'];
|
$timestamp = abs((float)$timestamp);
|
||||||
$time_string = '';
|
$timegroups = [86400, 3600, 60, 1];
|
||||||
// if timestamp is zero, return zero string
|
$labels = ['d', 'h', 'm', 's'];
|
||||||
if ($timestamp == 0) {
|
$time_string = '';
|
||||||
$time_string = '0s';
|
// if timestamp is zero, return zero string
|
||||||
} else {
|
if ($timestamp == 0) {
|
||||||
for ($i = 0, $iMax = count($timegroups); $i < $iMax; $i++) {
|
$time_string = '0s';
|
||||||
$output = floor((float)$timestamp / $timegroups[$i]);
|
|
||||||
$timestamp = (float)$timestamp % $timegroups[$i];
|
|
||||||
// output has days|hours|min|sec
|
|
||||||
if ($output || $time_string) {
|
|
||||||
$time_string .= $output . $labels[$i] . (($i + 1) != count($timegroups) ? ' ' : '');
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
// only add ms if we have an ms value
|
|
||||||
if ($ms !== null) {
|
|
||||||
// if we have ms and it has leading zeros, remove them, but only if it is nut just 0
|
|
||||||
$ms = preg_replace("/^0+(\d+)$/", '${1}', $ms);
|
|
||||||
if (!is_string($ms) || empty($ms)) {
|
|
||||||
$ms = '0';
|
|
||||||
}
|
|
||||||
// add ms if there
|
|
||||||
if ($show_micro) {
|
|
||||||
$time_string .= ' ' . $ms . 'ms';
|
|
||||||
} elseif (!$time_string) {
|
|
||||||
$time_string .= $ms . 'ms';
|
|
||||||
}
|
|
||||||
}
|
|
||||||
if ($negative) {
|
|
||||||
$time_string = '-' . $time_string;
|
|
||||||
}
|
|
||||||
} else {
|
} else {
|
||||||
$time_string = $timestamp;
|
for ($i = 0, $iMax = count($timegroups); $i < $iMax; $i++) {
|
||||||
|
$output = floor((float)$timestamp / $timegroups[$i]);
|
||||||
|
$timestamp = (float)$timestamp % $timegroups[$i];
|
||||||
|
// output has days|hours|min|sec
|
||||||
|
if ($output || $time_string) {
|
||||||
|
$time_string .= $output . $labels[$i] . (($i + 1) != count($timegroups) ? ' ' : '');
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
// only add ms if we have an ms value
|
||||||
|
if ($ms !== null) {
|
||||||
|
// if we have ms and it has leading zeros, remove them, but only if it is nut just 0
|
||||||
|
$ms = preg_replace("/^0+(\d+)$/", '${1}', $ms);
|
||||||
|
if (!is_string($ms) || empty($ms)) {
|
||||||
|
$ms = '0';
|
||||||
|
}
|
||||||
|
// add ms if there
|
||||||
|
if ($show_micro) {
|
||||||
|
$time_string .= ' ' . $ms . 'ms';
|
||||||
|
} elseif (!$time_string) {
|
||||||
|
$time_string .= $ms . 'ms';
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if ($negative) {
|
||||||
|
$time_string = '-' . $time_string;
|
||||||
}
|
}
|
||||||
return (string)$time_string;
|
return (string)$time_string;
|
||||||
}
|
}
|
||||||
@@ -157,40 +158,39 @@ class DateTime
|
|||||||
* @param string|int|float $timestring formatted interval
|
* @param string|int|float $timestring formatted interval
|
||||||
* @return string|int|float converted float interval, or string as is
|
* @return string|int|float converted float interval, or string as is
|
||||||
*/
|
*/
|
||||||
public static function stringToTime($timestring)
|
public static function stringToTime(string|int|float $timestring): string|int|float
|
||||||
{
|
{
|
||||||
$timestamp = 0;
|
$timestamp = 0;
|
||||||
if (preg_match("/(d|h|m|s|ms)/", (string)$timestring)) {
|
if (!preg_match("/(d|h|m|s|ms)/", (string)$timestring)) {
|
||||||
$timestring = (string)$timestring;
|
|
||||||
// pos for preg match read + multiply factor
|
|
||||||
$timegroups = [2 => 86400, 4 => 3600, 6 => 60, 8 => 1];
|
|
||||||
$matches = [];
|
|
||||||
// if start with -, strip and set negative
|
|
||||||
$negative = false;
|
|
||||||
if (preg_match("/^-/", $timestring)) {
|
|
||||||
$negative = true;
|
|
||||||
$timestring = substr($timestring, 1);
|
|
||||||
}
|
|
||||||
// preg match: 0: full string
|
|
||||||
// 2, 4, 6, 8 are the to need values
|
|
||||||
preg_match("/^((\d+)d ?)?((\d+)h ?)?((\d+)m ?)?((\d+)s ?)?((\d+)ms)?$/", $timestring, $matches);
|
|
||||||
// multiply the returned matches and sum them up. the last one (ms) is added with .
|
|
||||||
foreach ($timegroups as $i => $time_multiply) {
|
|
||||||
if (isset($matches[$i]) && is_numeric($matches[$i])) {
|
|
||||||
$timestamp += (float)$matches[$i] * $time_multiply;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
if (isset($matches[10]) && is_numeric($matches[10])) {
|
|
||||||
$timestamp .= '.' . $matches[10];
|
|
||||||
}
|
|
||||||
if ($negative) {
|
|
||||||
// cast to flaot so we can do a negative multiplication
|
|
||||||
$timestamp = (float)$timestamp * -1;
|
|
||||||
}
|
|
||||||
return $timestamp;
|
|
||||||
} else {
|
|
||||||
return $timestring;
|
return $timestring;
|
||||||
}
|
}
|
||||||
|
$timestring = (string)$timestring;
|
||||||
|
// pos for preg match read + multiply factor
|
||||||
|
$timegroups = [2 => 86400, 4 => 3600, 6 => 60, 8 => 1];
|
||||||
|
$matches = [];
|
||||||
|
// if start with -, strip and set negative
|
||||||
|
$negative = false;
|
||||||
|
if (preg_match("/^-/", $timestring)) {
|
||||||
|
$negative = true;
|
||||||
|
$timestring = substr($timestring, 1);
|
||||||
|
}
|
||||||
|
// preg match: 0: full string
|
||||||
|
// 2, 4, 6, 8 are the to need values
|
||||||
|
preg_match("/^((\d+)d ?)?((\d+)h ?)?((\d+)m ?)?((\d+)s ?)?((\d+)ms)?$/", $timestring, $matches);
|
||||||
|
// multiply the returned matches and sum them up. the last one (ms) is added with .
|
||||||
|
foreach ($timegroups as $i => $time_multiply) {
|
||||||
|
if (isset($matches[$i]) && is_numeric($matches[$i])) {
|
||||||
|
$timestamp += (float)$matches[$i] * $time_multiply;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if (isset($matches[10]) && is_numeric($matches[10])) {
|
||||||
|
$timestamp .= '.' . $matches[10];
|
||||||
|
}
|
||||||
|
if ($negative) {
|
||||||
|
// cast to flaot so we can do a negative multiplication
|
||||||
|
$timestamp = (float)$timestamp * -1;
|
||||||
|
}
|
||||||
|
return $timestamp;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -247,9 +247,9 @@ class DateTime
|
|||||||
* @param string $date a date string in the format YYYY-MM-DD
|
* @param string $date a date string in the format YYYY-MM-DD
|
||||||
* @return bool true if valid date, false if date not valid
|
* @return bool true if valid date, false if date not valid
|
||||||
*/
|
*/
|
||||||
public static function checkDate($date): bool
|
public static function checkDate(string $date): bool
|
||||||
{
|
{
|
||||||
if (!$date) {
|
if (empty($date)) {
|
||||||
return false;
|
return false;
|
||||||
}
|
}
|
||||||
list ($year, $month, $day) = array_pad(
|
list ($year, $month, $day) = array_pad(
|
||||||
@@ -321,36 +321,36 @@ class DateTime
|
|||||||
*
|
*
|
||||||
* @param string $start_date start date string in YYYY-MM-DD
|
* @param string $start_date start date string in YYYY-MM-DD
|
||||||
* @param string $end_date end date string in YYYY-MM-DD
|
* @param string $end_date end date string in YYYY-MM-DD
|
||||||
* @return int|bool false on error
|
* @return int int -1 (s<e)/0 (s=e)/1 (s>e) as difference
|
||||||
* or int -1 (s<e)/0 (s=e)/1 (s>e) as difference
|
* @throws \UnexpectedValueException On empty start/end values
|
||||||
*/
|
*/
|
||||||
public static function compareDate($start_date, $end_date)
|
public static function compareDate(string $start_date, string $end_date): int
|
||||||
{
|
{
|
||||||
// pre check for empty or wrong
|
// pre check for empty or wrong
|
||||||
if ($start_date == '--' || $end_date == '--' || !$start_date || !$end_date) {
|
if ($start_date == '--' || $end_date == '--' || empty($start_date) || empty($end_date)) {
|
||||||
return false;
|
throw new \UnexpectedValueException('Start or End date not set or are just "--"', 1);
|
||||||
}
|
}
|
||||||
// if invalid, quit
|
// if invalid, quit
|
||||||
if (($start_timestamp = strtotime($start_date)) === false) {
|
if (($start_timestamp = strtotime($start_date)) === false) {
|
||||||
return false;
|
throw new \UnexpectedValueException("Error parsing start date through strtotime()", 2);
|
||||||
}
|
}
|
||||||
if (($end_timestamp = strtotime($end_date)) === false) {
|
if (($end_timestamp = strtotime($end_date)) === false) {
|
||||||
return false;
|
throw new \UnexpectedValueException("Error parsing end date through strtotime()", 3);
|
||||||
}
|
}
|
||||||
|
$comp = 0;
|
||||||
// convert anything to Y-m-d and then to timestamp
|
// convert anything to Y-m-d and then to timestamp
|
||||||
// this is to remove any time parts
|
// this is to remove any time parts
|
||||||
$start_timestamp = strtotime(date('Y-m-d', $start_timestamp));
|
$start_timestamp = strtotime(date('Y-m-d', $start_timestamp));
|
||||||
$end_timestamp = strtotime(date('Y-m-d', $end_timestamp));
|
$end_timestamp = strtotime(date('Y-m-d', $end_timestamp));
|
||||||
// compare, or end with false
|
// compare, or end with false
|
||||||
if ($start_timestamp < $end_timestamp) {
|
if ($start_timestamp < $end_timestamp) {
|
||||||
return -1;
|
$comp = -1;
|
||||||
} elseif ($start_timestamp == $end_timestamp) {
|
} elseif ($start_timestamp == $end_timestamp) {
|
||||||
return 0;
|
$comp = 0;
|
||||||
} elseif ($start_timestamp > $end_timestamp) {
|
} elseif ($start_timestamp > $end_timestamp) {
|
||||||
return 1;
|
$comp = 1;
|
||||||
} else {
|
|
||||||
return false;
|
|
||||||
}
|
}
|
||||||
|
return $comp;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -364,32 +364,32 @@ class DateTime
|
|||||||
*
|
*
|
||||||
* @param string $start_datetime start date/time in YYYY-MM-DD HH:mm:ss
|
* @param string $start_datetime start date/time in YYYY-MM-DD HH:mm:ss
|
||||||
* @param string $end_datetime end date/time in YYYY-MM-DD HH:mm:ss
|
* @param string $end_datetime end date/time in YYYY-MM-DD HH:mm:ss
|
||||||
* @return int|bool false for error
|
* @return int -1 (s<e)/0 (s=e)/1 (s>e) as difference
|
||||||
* or -1 (s<e)/0 (s=e)/1 (s>e) as difference
|
* @throws \UnexpectedValueException On empty start/end values
|
||||||
*/
|
*/
|
||||||
public static function compareDateTime($start_datetime, $end_datetime)
|
public static function compareDateTime(string $start_datetime, string $end_datetime): int
|
||||||
{
|
{
|
||||||
// pre check for empty or wrong
|
// pre check for empty or wrong
|
||||||
if ($start_datetime == '--' || $end_datetime == '--' || !$start_datetime || !$end_datetime) {
|
if ($start_datetime == '--' || $end_datetime == '--' || empty($start_datetime) || empty($end_datetime)) {
|
||||||
return false;
|
throw new \UnexpectedValueException('Start or end timestamp not set or are just "--"', 1);
|
||||||
}
|
}
|
||||||
// quit if invalid timestamp
|
// quit if invalid timestamp
|
||||||
if (($start_timestamp = strtotime($start_datetime)) === false) {
|
if (($start_timestamp = strtotime($start_datetime)) === false) {
|
||||||
return false;
|
throw new \UnexpectedValueException("Error parsing start timestamp through strtotime()", 2);
|
||||||
}
|
}
|
||||||
if (($end_timestamp = strtotime($end_datetime)) === false) {
|
if (($end_timestamp = strtotime($end_datetime)) === false) {
|
||||||
return false;
|
throw new \UnexpectedValueException("Error parsing end timestamp through strtotime()", 3);
|
||||||
}
|
}
|
||||||
|
$comp = 0;
|
||||||
// compare, or return false
|
// compare, or return false
|
||||||
if ($start_timestamp < $end_timestamp) {
|
if ($start_timestamp < $end_timestamp) {
|
||||||
return -1;
|
$comp = -1;
|
||||||
} elseif ($start_timestamp == $end_timestamp) {
|
} elseif ($start_timestamp == $end_timestamp) {
|
||||||
return 0;
|
$comp = 0;
|
||||||
} elseif ($start_timestamp > $end_timestamp) {
|
} elseif ($start_timestamp > $end_timestamp) {
|
||||||
return 1;
|
$comp = 1;
|
||||||
} else {
|
|
||||||
return false;
|
|
||||||
}
|
}
|
||||||
|
return $comp;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -402,8 +402,11 @@ class DateTime
|
|||||||
* @param bool $return_named return array type, false (default), true for named
|
* @param bool $return_named return array type, false (default), true for named
|
||||||
* @return array<mixed> 0/overall, 1/weekday, 2/weekend
|
* @return array<mixed> 0/overall, 1/weekday, 2/weekend
|
||||||
*/
|
*/
|
||||||
public static function calcDaysInterval($start_date, $end_date, bool $return_named = false): array
|
public static function calcDaysInterval(
|
||||||
{
|
string $start_date,
|
||||||
|
string $end_date,
|
||||||
|
bool $return_named = false
|
||||||
|
): array {
|
||||||
// pos 0 all, pos 1 weekday, pos 2 weekend
|
// pos 0 all, pos 1 weekday, pos 2 weekend
|
||||||
$days = [];
|
$days = [];
|
||||||
// if anything invalid, return 0,0,0
|
// if anything invalid, return 0,0,0
|
||||||
@@ -447,6 +450,31 @@ class DateTime
|
|||||||
return $days;
|
return $days;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* check if a weekend day (sat/sun) is in the given date range
|
||||||
|
* Can have time too, but is not needed
|
||||||
|
*
|
||||||
|
* @param string $start_date Y-m-d
|
||||||
|
* @param string $end_date Y-m-d
|
||||||
|
* @return bool True for has weekend, False for has not
|
||||||
|
*/
|
||||||
|
public static function dateRangeHasWeekend(
|
||||||
|
string $start_date,
|
||||||
|
string $end_date,
|
||||||
|
): bool {
|
||||||
|
$dd_start = new \DateTime($start_date);
|
||||||
|
$dd_end = new \DateTime($end_date);
|
||||||
|
if (
|
||||||
|
// starts with a weekend
|
||||||
|
$dd_start->format('N') >= 6 ||
|
||||||
|
// start day plus diff will be 6 and so fall into a weekend
|
||||||
|
((int)$dd_start->format('w') + $dd_start->diff($dd_end)->days) >= 6
|
||||||
|
) {
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
return false;
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// __END__
|
// __END__
|
||||||
|
|||||||
@@ -39,7 +39,7 @@ class Byte
|
|||||||
* @return string converted byte number (float) with suffix
|
* @return string converted byte number (float) with suffix
|
||||||
* @throws \Exception 1: no valid flag set
|
* @throws \Exception 1: no valid flag set
|
||||||
*/
|
*/
|
||||||
public static function humanReadableByteFormat($bytes, int $flags = 0): string
|
public static function humanReadableByteFormat(string|int|float $bytes, int $flags = 0): string
|
||||||
{
|
{
|
||||||
// if not numeric, return as is
|
// if not numeric, return as is
|
||||||
if (is_numeric($bytes)) {
|
if (is_numeric($bytes)) {
|
||||||
@@ -121,7 +121,7 @@ class Byte
|
|||||||
* @return string|int|float converted value or original value
|
* @return string|int|float converted value or original value
|
||||||
* @throws \Exception 1: no valid flag set
|
* @throws \Exception 1: no valid flag set
|
||||||
*/
|
*/
|
||||||
public static function stringByteFormat($number, int $flags = 0)
|
public static function stringByteFormat(string|int|float $number, int $flags = 0): string|int|float
|
||||||
{
|
{
|
||||||
// use SI 1000 mod and not 1024 mod
|
// use SI 1000 mod and not 1024 mod
|
||||||
if ($flags & self::BYTE_FORMAT_SI) {
|
if ($flags & self::BYTE_FORMAT_SI) {
|
||||||
|
|||||||
@@ -28,11 +28,15 @@ class Colors
|
|||||||
* @param int $green green 0-255
|
* @param int $green green 0-255
|
||||||
* @param int $blue blue 0-255
|
* @param int $blue blue 0-255
|
||||||
* @param bool $hex_prefix default true, prefix with "#"
|
* @param bool $hex_prefix default true, prefix with "#"
|
||||||
* @return string|bool rgb in hex values with leading # if set,
|
* @return string rgb in hex values with leading # if set,
|
||||||
* false for invalid color
|
* @throws \LengthException If any argument is not in the range of 0~255
|
||||||
*/
|
*/
|
||||||
public static function rgb2hex(int $red, int $green, int $blue, bool $hex_prefix = true)
|
public static function rgb2hex(
|
||||||
{
|
int $red,
|
||||||
|
int $green,
|
||||||
|
int $blue,
|
||||||
|
bool $hex_prefix = true
|
||||||
|
): string {
|
||||||
$hex_color = '';
|
$hex_color = '';
|
||||||
if ($hex_prefix === true) {
|
if ($hex_prefix === true) {
|
||||||
$hex_color = '#';
|
$hex_color = '#';
|
||||||
@@ -40,7 +44,8 @@ class Colors
|
|||||||
foreach (['red', 'green', 'blue'] as $color) {
|
foreach (['red', 'green', 'blue'] as $color) {
|
||||||
// if not valid, abort
|
// if not valid, abort
|
||||||
if ($$color < 0 || $$color > 255) {
|
if ($$color < 0 || $$color > 255) {
|
||||||
return false;
|
throw new \LengthException('Argument value ' . $$color . ' for color ' . $color
|
||||||
|
. ' is not in the range of 0 to 255', 1);
|
||||||
}
|
}
|
||||||
// pad left with 0
|
// pad left with 0
|
||||||
$hex_color .= str_pad(dechex($$color), 2, '0', STR_PAD_LEFT);
|
$hex_color .= str_pad(dechex($$color), 2, '0', STR_PAD_LEFT);
|
||||||
@@ -51,37 +56,39 @@ class Colors
|
|||||||
/**
|
/**
|
||||||
* converts a hex RGB color to the int numbers
|
* converts a hex RGB color to the int numbers
|
||||||
*
|
*
|
||||||
* @param string $hexStr RGB hexstring
|
* @param string $hex_string RGB hexstring
|
||||||
* @param bool $return_as_string flag to return as string
|
* @param bool $return_as_string flag to return as string
|
||||||
* @param string $seperator string seperator: default: ","
|
* @param string $seperator string seperator: default: ","
|
||||||
* @return string|array<string,float|int>|bool false on error or array with RGB
|
* @return string|array<string,float|int> array with RGB
|
||||||
* or a string with the seperator
|
* or a string with the seperator
|
||||||
|
* @throws \InvalidArgumentException if hex string is empty
|
||||||
|
* @throws \UnexpectedValueException if the hex string value is not valid
|
||||||
*/
|
*/
|
||||||
public static function hex2rgb(
|
public static function hex2rgb(
|
||||||
string $hexStr,
|
string $hex_string,
|
||||||
bool $return_as_string = false,
|
bool $return_as_string = false,
|
||||||
string $seperator = ','
|
string $seperator = ','
|
||||||
) {
|
): string|array {
|
||||||
$hexStr = preg_replace("/[^0-9A-Fa-f]/", '', $hexStr); // Gets a proper hex string
|
$hex_string = preg_replace("/[^0-9A-Fa-f]/", '', $hex_string); // Gets a proper hex string
|
||||||
if (!is_string($hexStr)) {
|
if (!is_string($hex_string)) {
|
||||||
return false;
|
throw new \InvalidArgumentException('hex_string argument cannot be empty', 1);
|
||||||
}
|
}
|
||||||
$rgbArray = [];
|
$rgbArray = [];
|
||||||
if (strlen($hexStr) == 6) {
|
if (strlen($hex_string) == 6) {
|
||||||
// If a proper hex code, convert using bitwise operation.
|
// If a proper hex code, convert using bitwise operation.
|
||||||
// No overhead... faster
|
// No overhead... faster
|
||||||
$colorVal = hexdec($hexStr);
|
$colorVal = hexdec($hex_string);
|
||||||
$rgbArray['r'] = 0xFF & ($colorVal >> 0x10);
|
$rgbArray['r'] = 0xFF & ($colorVal >> 0x10);
|
||||||
$rgbArray['g'] = 0xFF & ($colorVal >> 0x8);
|
$rgbArray['g'] = 0xFF & ($colorVal >> 0x8);
|
||||||
$rgbArray['b'] = 0xFF & $colorVal;
|
$rgbArray['b'] = 0xFF & $colorVal;
|
||||||
} elseif (strlen($hexStr) == 3) {
|
} elseif (strlen($hex_string) == 3) {
|
||||||
// If shorthand notation, need some string manipulations
|
// If shorthand notation, need some string manipulations
|
||||||
$rgbArray['r'] = hexdec(str_repeat(substr($hexStr, 0, 1), 2));
|
$rgbArray['r'] = hexdec(str_repeat(substr($hex_string, 0, 1), 2));
|
||||||
$rgbArray['g'] = hexdec(str_repeat(substr($hexStr, 1, 1), 2));
|
$rgbArray['g'] = hexdec(str_repeat(substr($hex_string, 1, 1), 2));
|
||||||
$rgbArray['b'] = hexdec(str_repeat(substr($hexStr, 2, 1), 2));
|
$rgbArray['b'] = hexdec(str_repeat(substr($hex_string, 2, 1), 2));
|
||||||
} else {
|
} else {
|
||||||
// Invalid hex color code
|
// Invalid hex color code
|
||||||
return false;
|
throw new \UnexpectedValueException('Invalid hex_string: ' . $hex_string, 2);
|
||||||
}
|
}
|
||||||
// returns the rgb string or the associative array
|
// returns the rgb string or the associative array
|
||||||
return $return_as_string ? implode($seperator, $rgbArray) : $rgbArray;
|
return $return_as_string ? implode($seperator, $rgbArray) : $rgbArray;
|
||||||
@@ -93,20 +100,21 @@ class Colors
|
|||||||
* returns:
|
* returns:
|
||||||
* array with hue (0-360), sat (0-100%), brightness/value (0-100%)
|
* array with hue (0-360), sat (0-100%), brightness/value (0-100%)
|
||||||
*
|
*
|
||||||
* @param int $red red 0-255
|
* @param int $red red 0-255
|
||||||
* @param int $green green 0-255
|
* @param int $green green 0-255
|
||||||
* @param int $blue blue 0-255
|
* @param int $blue blue 0-255
|
||||||
* @return array<int|float>|bool Hue, Sat, Brightness/Value
|
* @return array<int|float> Hue, Sat, Brightness/Value
|
||||||
* false for input value error
|
* @throws \LengthException If any argument is not in the range of 0~255
|
||||||
*/
|
*/
|
||||||
public static function rgb2hsb(int $red, int $green, int $blue)
|
public static function rgb2hsb(int $red, int $green, int $blue): array
|
||||||
{
|
{
|
||||||
// check that rgb is from 0 to 255
|
// check that rgb is from 0 to 255
|
||||||
foreach (['red', 'green', 'blue'] as $c) {
|
foreach (['red', 'green', 'blue'] as $color) {
|
||||||
if ($$c < 0 || $$c > 255) {
|
if ($$color < 0 || $$color > 255) {
|
||||||
return false;
|
throw new \LengthException('Argument value ' . $$color . ' for color ' . $color
|
||||||
|
. ' is not in the range of 0 to 255', 1);
|
||||||
}
|
}
|
||||||
$$c = $$c / 255;
|
$$color = $$color / 255;
|
||||||
}
|
}
|
||||||
|
|
||||||
$MAX = max($red, $green, $blue);
|
$MAX = max($red, $green, $blue);
|
||||||
@@ -140,13 +148,13 @@ class Colors
|
|||||||
* converts HSB/V to RGB values RGB is full INT
|
* converts HSB/V to RGB values RGB is full INT
|
||||||
* if HSB/V value is invalid, sets this value to 0
|
* if HSB/V value is invalid, sets this value to 0
|
||||||
*
|
*
|
||||||
* @param float $H hue 0-360 (int)
|
* @param float $H hue 0-360 (int)
|
||||||
* @param float $S saturation 0-100 (int)
|
* @param float $S saturation 0-100 (int)
|
||||||
* @param float $V brightness/value 0-100 (int)
|
* @param float $V brightness/value 0-100 (int)
|
||||||
* @return array<int>|bool 0 red/1 green/2 blue array as 0-255
|
* @return array<int> 0 red/1 green/2 blue array as 0-255
|
||||||
* false for input value error
|
* @throws \LengthException If any argument is not in the valid range
|
||||||
*/
|
*/
|
||||||
public static function hsb2rgb(float $H, float $S, float $V)
|
public static function hsb2rgb(float $H, float $S, float $V): array
|
||||||
{
|
{
|
||||||
// check that H is 0 to 359, 360 = 0
|
// check that H is 0 to 359, 360 = 0
|
||||||
// and S and V are 0 to 1
|
// and S and V are 0 to 1
|
||||||
@@ -154,13 +162,13 @@ class Colors
|
|||||||
$H = 0;
|
$H = 0;
|
||||||
}
|
}
|
||||||
if ($H < 0 || $H > 359) {
|
if ($H < 0 || $H > 359) {
|
||||||
return false;
|
throw new \LengthException('Argument value ' . $H . ' for hue is not in the range of 0 to 359', 1);
|
||||||
}
|
}
|
||||||
if ($S < 0 || $S > 100) {
|
if ($S < 0 || $S > 100) {
|
||||||
return false;
|
throw new \LengthException('Argument value ' . $S . ' for saturation is not in the range of 0 to 100', 2);
|
||||||
}
|
}
|
||||||
if ($V < 0 || $V > 100) {
|
if ($V < 0 || $V > 100) {
|
||||||
return false;
|
throw new \LengthException('Argument value ' . $V . ' for brightness is not in the range of 0 to 100', 3);
|
||||||
}
|
}
|
||||||
// convert to internal 0-1 format
|
// convert to internal 0-1 format
|
||||||
$S /= 100;
|
$S /= 100;
|
||||||
@@ -226,20 +234,21 @@ class Colors
|
|||||||
* return:
|
* return:
|
||||||
* array with hue (0-360), saturation (0-100%) and luminance (0-100%)
|
* array with hue (0-360), saturation (0-100%) and luminance (0-100%)
|
||||||
*
|
*
|
||||||
* @param int $red red 0-255
|
* @param int $red red 0-255
|
||||||
* @param int $green green 0-255
|
* @param int $green green 0-255
|
||||||
* @param int $blue blue 0-255
|
* @param int $blue blue 0-255
|
||||||
* @return array<float>|bool hue/sat/luminance
|
* @return array<float> hue/sat/luminance
|
||||||
* false for input value error
|
* @throws \LengthException If any argument is not in the range of 0~255
|
||||||
*/
|
*/
|
||||||
public static function rgb2hsl(int $red, int $green, int $blue)
|
public static function rgb2hsl(int $red, int $green, int $blue): array
|
||||||
{
|
{
|
||||||
// check that rgb is from 0 to 255
|
// check that rgb is from 0 to 255
|
||||||
foreach (['red', 'green', 'blue'] as $c) {
|
foreach (['red', 'green', 'blue'] as $color) {
|
||||||
if ($$c < 0 || $$c > 255) {
|
if ($$color < 0 || $$color > 255) {
|
||||||
return false;
|
throw new \LengthException('Argument value ' . $$color . ' for color ' . $color
|
||||||
|
. ' is not in the range of 0 to 255', 1);
|
||||||
}
|
}
|
||||||
$$c = $$c / 255;
|
$$color = $$color / 255;
|
||||||
}
|
}
|
||||||
|
|
||||||
$min = min($red, $green, $blue);
|
$min = min($red, $green, $blue);
|
||||||
@@ -280,27 +289,25 @@ class Colors
|
|||||||
* converts an HSL to RGB
|
* converts an HSL to RGB
|
||||||
* if HSL value is invalid, set this value to 0
|
* if HSL value is invalid, set this value to 0
|
||||||
*
|
*
|
||||||
* @param float $hue hue: 0-360 (degrees)
|
* @param float $hue hue: 0-360 (degrees)
|
||||||
* @param float $sat saturation: 0-100
|
* @param float $sat saturation: 0-100
|
||||||
* @param float $lum luminance: 0-100
|
* @param float $lum luminance: 0-100
|
||||||
* @return array<int,float|int>|bool red/blue/green 0-255 each
|
* @return array<int,float|int> red/blue/green 0-255 each
|
||||||
|
* @throws \LengthException If any argument is not in the valid range
|
||||||
*/
|
*/
|
||||||
public static function hsl2rgb(float $hue, float $sat, float $lum)
|
public static function hsl2rgb(float $hue, float $sat, float $lum): array
|
||||||
{
|
{
|
||||||
if (!is_numeric($hue)) {
|
|
||||||
return false;
|
|
||||||
}
|
|
||||||
if ($hue == 360) {
|
if ($hue == 360) {
|
||||||
$hue = 0;
|
$hue = 0;
|
||||||
}
|
}
|
||||||
if ($hue < 0 || $hue > 359) {
|
if ($hue < 0 || $hue > 359) {
|
||||||
return false;
|
throw new \LengthException('Argument value ' . $hue . ' for hue is not in the range of 0 to 359', 1);
|
||||||
}
|
}
|
||||||
if ($sat < 0 || $sat > 100) {
|
if ($sat < 0 || $sat > 100) {
|
||||||
return false;
|
throw new \LengthException('Argument value ' . $sat . ' for saturation is not in the range of 0 to 100', 2);
|
||||||
}
|
}
|
||||||
if ($lum < 0 || $lum > 100) {
|
if ($lum < 0 || $lum > 100) {
|
||||||
return false;
|
throw new \LengthException('Argument value ' . $lum . ' for luminance is not in the range of 0 to 100', 3);
|
||||||
}
|
}
|
||||||
// calc to internal convert value for hue
|
// calc to internal convert value for hue
|
||||||
$hue = (1 / 360) * $hue;
|
$hue = (1 / 360) * $hue;
|
||||||
|
|||||||
@@ -19,7 +19,7 @@ class Html
|
|||||||
* @param mixed $string string to html encode
|
* @param mixed $string string to html encode
|
||||||
* @return mixed if string, encoded, else as is (eg null)
|
* @return mixed if string, encoded, else as is (eg null)
|
||||||
*/
|
*/
|
||||||
public static function htmlent($string)
|
public static function htmlent(mixed $string): mixed
|
||||||
{
|
{
|
||||||
if (is_string($string)) {
|
if (is_string($string)) {
|
||||||
return htmlentities($string, ENT_COMPAT | ENT_HTML401, 'UTF-8', false);
|
return htmlentities($string, ENT_COMPAT | ENT_HTML401, 'UTF-8', false);
|
||||||
@@ -52,7 +52,7 @@ class Html
|
|||||||
* @return ?string returns checked or selected,
|
* @return ?string returns checked or selected,
|
||||||
* else returns null
|
* else returns null
|
||||||
*/
|
*/
|
||||||
public static function checked($haystack, string $needle, int $type = 0): ?string
|
public static function checked(array|string $haystack, string $needle, int $type = 0): ?string
|
||||||
{
|
{
|
||||||
if (is_array($haystack)) {
|
if (is_array($haystack)) {
|
||||||
if (in_array($needle, $haystack)) {
|
if (in_array($needle, $haystack)) {
|
||||||
|
|||||||
@@ -49,15 +49,33 @@ class Json
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* returns human readable string for json errors thrown in jsonConvertToArray
|
* convert array to json
|
||||||
|
* Will set empty json {} on false/error
|
||||||
|
* Error can be read with jsonGetLastError
|
||||||
|
* Deos not throw errors
|
||||||
*
|
*
|
||||||
* @param bool|boolean $return_string [default=false] if set to true
|
* @param array<mixed> $data
|
||||||
* it will return the message string and not
|
* @param int $flags json_encode flags as is
|
||||||
* the error number
|
* @return string JSON string or '{}' if false
|
||||||
* @return int|string Either error number (0 for no error)
|
|
||||||
* or error string ('' for no error)
|
|
||||||
*/
|
*/
|
||||||
public static function jsonGetLastError(bool $return_string = false)
|
public static function jsonConvertArrayTo(array $data, int $flags = 0): string
|
||||||
|
{
|
||||||
|
$json_string = json_encode($data, $flags) ?: '{}';
|
||||||
|
self::$json_last_error = json_last_error();
|
||||||
|
return (string)$json_string;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* returns human readable string for json errors thrown in jsonConvertToArray
|
||||||
|
* Source: https://www.php.net/manual/en/function.json-last-error.php
|
||||||
|
*
|
||||||
|
* @param bool $return_string [default=false] if set to true
|
||||||
|
* it will return the message string and not
|
||||||
|
* the error number
|
||||||
|
* @return int|string Either error number (0 for no error)
|
||||||
|
* or error string ('' for no error)
|
||||||
|
*/
|
||||||
|
public static function jsonGetLastError(bool $return_string = false): int|string
|
||||||
{
|
{
|
||||||
$json_error_string = '';
|
$json_error_string = '';
|
||||||
// valid errors as of php 8.0
|
// valid errors as of php 8.0
|
||||||
@@ -80,6 +98,15 @@ class Json
|
|||||||
case JSON_ERROR_UTF8:
|
case JSON_ERROR_UTF8:
|
||||||
$json_error_string = 'Malformed UTF-8 characters, possibly incorrectly encoded';
|
$json_error_string = 'Malformed UTF-8 characters, possibly incorrectly encoded';
|
||||||
break;
|
break;
|
||||||
|
case JSON_ERROR_RECURSION:
|
||||||
|
$json_error_string = 'One or more recursive references in the value to be encoded';
|
||||||
|
break;
|
||||||
|
case JSON_ERROR_INF_OR_NAN:
|
||||||
|
$json_error_string = 'One or more NAN or INF values in the value to be encoded';
|
||||||
|
break;
|
||||||
|
case JSON_ERROR_UNSUPPORTED_TYPE:
|
||||||
|
$json_error_string = ' A value of a type that cannot be encoded was given';
|
||||||
|
break;
|
||||||
case JSON_ERROR_INVALID_PROPERTY_NAME:
|
case JSON_ERROR_INVALID_PROPERTY_NAME:
|
||||||
$json_error_string = 'A key starting with \u0000 character was in the string';
|
$json_error_string = 'A key starting with \u0000 character was in the string';
|
||||||
break;
|
break;
|
||||||
|
|||||||
@@ -48,7 +48,7 @@ class Math
|
|||||||
* @param string|int|float $number string or number to check
|
* @param string|int|float $number string or number to check
|
||||||
* @return float if not number, then returns 0, else original input
|
* @return float if not number, then returns 0, else original input
|
||||||
*/
|
*/
|
||||||
public static function initNumeric($number): float
|
public static function initNumeric(string|int|float $number): float
|
||||||
{
|
{
|
||||||
if (!is_numeric($number)) {
|
if (!is_numeric($number)) {
|
||||||
return 0;
|
return 0;
|
||||||
|
|||||||
@@ -12,7 +12,7 @@ namespace CoreLibs\Convert;
|
|||||||
class MimeAppName
|
class MimeAppName
|
||||||
{
|
{
|
||||||
/** @var array<string,string> */
|
/** @var array<string,string> */
|
||||||
private static $mime_apps = [];
|
private static array $mime_apps = [];
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* constructor: init mime list
|
* constructor: init mime list
|
||||||
|
|||||||
@@ -14,7 +14,7 @@ namespace CoreLibs\Create;
|
|||||||
class Email
|
class Email
|
||||||
{
|
{
|
||||||
/** @var array<string> allowed list for encodings that can do KV folding */
|
/** @var array<string> allowed list for encodings that can do KV folding */
|
||||||
private static $encoding_kv_allowed = [
|
private static array $encoding_kv_allowed = [
|
||||||
'UTF-8',
|
'UTF-8',
|
||||||
'EUC-JP',
|
'EUC-JP',
|
||||||
'SJIS',
|
'SJIS',
|
||||||
@@ -25,7 +25,7 @@ class Email
|
|||||||
'JIS-ms',
|
'JIS-ms',
|
||||||
];
|
];
|
||||||
/** @var string normaly this does not need to be changed */
|
/** @var string normaly this does not need to be changed */
|
||||||
private static $mb_convert_kana_mode = 'KV';
|
private static string $mb_convert_kana_mode = 'KV';
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* create mime encoded email part for to/from emails.
|
* create mime encoded email part for to/from emails.
|
||||||
@@ -137,7 +137,7 @@ class Email
|
|||||||
* @param bool $kv_folding If set to true and a valid encoding,
|
* @param bool $kv_folding If set to true and a valid encoding,
|
||||||
* do KV folding
|
* do KV folding
|
||||||
* @param bool $test test flag, default off
|
* @param bool $test test flag, default off
|
||||||
* @param \CoreLibs\Debug\Logging|null $log Logging class,
|
* @param \CoreLibs\Logging\Logging|null $log Logging class,
|
||||||
* only used if test flag is true
|
* only used if test flag is true
|
||||||
* @return int 2 test only, no sent
|
* @return int 2 test only, no sent
|
||||||
* 1 for ok,
|
* 1 for ok,
|
||||||
@@ -156,7 +156,7 @@ class Email
|
|||||||
string $encoding = 'UTF-8',
|
string $encoding = 'UTF-8',
|
||||||
bool $kv_folding = false,
|
bool $kv_folding = false,
|
||||||
bool $test = false,
|
bool $test = false,
|
||||||
?\CoreLibs\Debug\Logging $log = null
|
?\CoreLibs\Logging\Logging $log = null
|
||||||
): int {
|
): int {
|
||||||
/** @var array<string> */
|
/** @var array<string> */
|
||||||
$to_emails = [];
|
$to_emails = [];
|
||||||
@@ -259,11 +259,11 @@ class Email
|
|||||||
$mail_delivery_status = 2;
|
$mail_delivery_status = 2;
|
||||||
}
|
}
|
||||||
// log if an log instance exists
|
// log if an log instance exists
|
||||||
if ($log instanceof \CoreLibs\Debug\Logging) {
|
if ($log instanceof \CoreLibs\Logging\Logging) {
|
||||||
// build debug strings: convert to UTF-8 if not utf-8
|
// build debug strings: convert to UTF-8 if not utf-8
|
||||||
$log->debug('SEND EMAIL', 'HEADERS: ' . $log->prAr($headers) . ', '
|
$log->debug('SEND EMAIL', 'HEADERS: ' . \CoreLibs\Debug\Support::prAr($headers) . ', '
|
||||||
. 'ENCODING: ' . $encoding . ', '
|
. 'ENCODING: ' . $encoding . ', '
|
||||||
. 'KV FOLDING: ' . $log->prBl($kv_folding) . ', '
|
. 'KV FOLDING: ' . \CoreLibs\Debug\Support::prBl($kv_folding) . ', '
|
||||||
. 'TO: ' . $to_email . ', '
|
. 'TO: ' . $to_email . ', '
|
||||||
. 'SUBJECT: ' . $out_subject . ', '
|
. 'SUBJECT: ' . $out_subject . ', '
|
||||||
. 'BODY: ' . ($encoding == 'UTF-8' ?
|
. 'BODY: ' . ($encoding == 'UTF-8' ?
|
||||||
|
|||||||
@@ -10,6 +10,7 @@ namespace CoreLibs\Create;
|
|||||||
|
|
||||||
class Hash
|
class Hash
|
||||||
{
|
{
|
||||||
|
public const DEFAULT_HASH = 'adler32';
|
||||||
public const STANDARD_HASH_LONG = 'ripemd160';
|
public const STANDARD_HASH_LONG = 'ripemd160';
|
||||||
public const STANDARD_HASH_SHORT = 'adler32';
|
public const STANDARD_HASH_SHORT = 'adler32';
|
||||||
|
|
||||||
@@ -58,7 +59,7 @@ class Hash
|
|||||||
/**
|
/**
|
||||||
* replacemend for __crc32b call (alternate)
|
* replacemend for __crc32b call (alternate)
|
||||||
* defaults to adler 32
|
* defaults to adler 32
|
||||||
* allowed crc32b, adler32, fnv132, fnv1a32, joaat
|
* allowed: any in hash algos list, default to adler 32
|
||||||
* all that create 8 char long hashes
|
* all that create 8 char long hashes
|
||||||
*
|
*
|
||||||
* @param string $string string to hash
|
* @param string $string string to hash
|
||||||
@@ -67,15 +68,15 @@ class Hash
|
|||||||
*/
|
*/
|
||||||
public static function __hash(
|
public static function __hash(
|
||||||
string $string,
|
string $string,
|
||||||
string $hash_type = self::STANDARD_HASH_SHORT
|
string $hash_type = self::DEFAULT_HASH
|
||||||
): string {
|
): string {
|
||||||
|
// if not empty, check if in valid list
|
||||||
if (
|
if (
|
||||||
!in_array(
|
empty($hash_type) ||
|
||||||
$hash_type,
|
!in_array($hash_type, hash_algos())
|
||||||
['crc32b', 'adler32', 'fnv132', 'fnv1a32', 'joaat']
|
|
||||||
)
|
|
||||||
) {
|
) {
|
||||||
$hash_type = 'adler32';
|
// fallback to default hash type if none set or invalid
|
||||||
|
$hash_type = self::DEFAULT_HASH;
|
||||||
}
|
}
|
||||||
return hash($hash_type, $string);
|
return hash($hash_type, $string);
|
||||||
}
|
}
|
||||||
@@ -90,33 +91,6 @@ class Hash
|
|||||||
{
|
{
|
||||||
return hash(self::STANDARD_HASH_LONG, $string);
|
return hash(self::STANDARD_HASH_LONG, $string);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* create a unique id with the standard hash type defined in __hash
|
|
||||||
*
|
|
||||||
* @return string Unique ID with fixed length of 8 characters
|
|
||||||
* @deprecated Use \CoreLibs\Create\Uids::uniqIdShort() instead
|
|
||||||
*/
|
|
||||||
public static function __uniqId(): string
|
|
||||||
{
|
|
||||||
trigger_error('Method ' . __METHOD__ . ' is deprecated, '
|
|
||||||
. '\CoreLibs\Create\Uids::uniqIdShort() class', E_USER_DEPRECATED);
|
|
||||||
return \CoreLibs\Create\Uids::uniqIdShort();
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* create a unique id with the standard long hash type
|
|
||||||
* defined in __hashLong
|
|
||||||
*
|
|
||||||
* @return string Unique ID with length of current default long hash
|
|
||||||
* @deprecated Use \CoreLibs\Create\Uids::uniqIdLong() instead
|
|
||||||
*/
|
|
||||||
public static function __uniqIdLong(): string
|
|
||||||
{
|
|
||||||
trigger_error('Method ' . __METHOD__ . ' is deprecated, '
|
|
||||||
. '\CoreLibs\Create\Uids::uniqIdLong() class', E_USER_DEPRECATED);
|
|
||||||
return \CoreLibs\Create\Uids::uniqIdLong();
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// __END__
|
// __END__
|
||||||
|
|||||||
@@ -12,13 +12,13 @@ class RandomKey
|
|||||||
{
|
{
|
||||||
// key generation
|
// key generation
|
||||||
/** @var string */
|
/** @var string */
|
||||||
private static $key_range = '';
|
private static string $key_range = '';
|
||||||
/** @var int */
|
/** @var int */
|
||||||
private static $one_key_length;
|
private static int $one_key_length;
|
||||||
/** @var int */
|
/** @var int */
|
||||||
private static $key_length = 4; // default key length
|
private static int $key_length = 4; // default key length
|
||||||
/** @var int */
|
/** @var int */
|
||||||
private static $max_key_length = 256; // max allowed length
|
private static int $max_key_length = 256; // max allowed length
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* if launched as class, init random key data first
|
* if launched as class, init random key data first
|
||||||
@@ -32,7 +32,7 @@ class RandomKey
|
|||||||
*
|
*
|
||||||
* @return void has no return
|
* @return void has no return
|
||||||
*/
|
*/
|
||||||
private static function initRandomKeyData()
|
private static function initRandomKeyData(): void
|
||||||
{
|
{
|
||||||
// random key generation base string
|
// random key generation base string
|
||||||
self::$key_range = join('', array_merge(
|
self::$key_range = join('', array_merge(
|
||||||
@@ -52,7 +52,6 @@ class RandomKey
|
|||||||
private static function validateRandomKeyLenght(int $key_length): bool
|
private static function validateRandomKeyLenght(int $key_length): bool
|
||||||
{
|
{
|
||||||
if (
|
if (
|
||||||
is_numeric($key_length) &&
|
|
||||||
$key_length > 0 &&
|
$key_length > 0 &&
|
||||||
$key_length <= self::$max_key_length
|
$key_length <= self::$max_key_length
|
||||||
) {
|
) {
|
||||||
@@ -101,7 +100,9 @@ class RandomKey
|
|||||||
public static function randomKeyGen(int $key_length = -1): string
|
public static function randomKeyGen(int $key_length = -1): string
|
||||||
{
|
{
|
||||||
// init random key strings if not set
|
// init random key strings if not set
|
||||||
if (!is_numeric(self::$one_key_length)) {
|
if (
|
||||||
|
!isset(self::$one_key_length)
|
||||||
|
) {
|
||||||
self::initRandomKeyData();
|
self::initRandomKeyData();
|
||||||
}
|
}
|
||||||
$use_key_length = 0;
|
$use_key_length = 0;
|
||||||
|
|||||||
@@ -15,8 +15,18 @@ namespace CoreLibs\Create;
|
|||||||
|
|
||||||
class Session
|
class Session
|
||||||
{
|
{
|
||||||
/** @var string list for errors */
|
/**
|
||||||
private $session_intern_error_str = '';
|
* init a session, if array is empty or array does not have session_name set
|
||||||
|
* then no auto init is run
|
||||||
|
*
|
||||||
|
* @param string $session_name if set and not empty, will start session
|
||||||
|
*/
|
||||||
|
public function __construct(string $session_name = '')
|
||||||
|
{
|
||||||
|
if (!empty($session_name)) {
|
||||||
|
$this->startSession($session_name);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Start session
|
* Start session
|
||||||
@@ -31,19 +41,6 @@ class Session
|
|||||||
session_start();
|
session_start();
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* init a session, if array is empty or array does not have session_name set
|
|
||||||
* then no auto init is run
|
|
||||||
*
|
|
||||||
* @param string $session_name if set and not empty, will start session
|
|
||||||
*/
|
|
||||||
public function __construct(string $session_name = '')
|
|
||||||
{
|
|
||||||
if (!empty($session_name)) {
|
|
||||||
$this->startSession($session_name);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* check if we are in CLI, we set this, so we can mock this
|
* check if we are in CLI, we set this, so we can mock this
|
||||||
* Not this is just a wrapper for the static System::checkCLI call
|
* Not this is just a wrapper for the static System::checkCLI call
|
||||||
@@ -71,17 +68,6 @@ class Session
|
|||||||
return true;
|
return true;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* Return set error string, empty if none set
|
|
||||||
* Error strings are only set in the startSession method
|
|
||||||
*
|
|
||||||
* @return string Last error string
|
|
||||||
*/
|
|
||||||
public function getErrorStr(): string
|
|
||||||
{
|
|
||||||
return $this->session_intern_error_str;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* check if session name is valid
|
* check if session name is valid
|
||||||
*
|
*
|
||||||
@@ -116,17 +102,15 @@ class Session
|
|||||||
* @param string|null $session_name
|
* @param string|null $session_name
|
||||||
* @return string|bool
|
* @return string|bool
|
||||||
*/
|
*/
|
||||||
public function startSession(?string $session_name = null)
|
public function startSession(?string $session_name = null): string|bool
|
||||||
{
|
{
|
||||||
// we can't start sessions on command line
|
// we can't start sessions on command line
|
||||||
if ($this->checkCliStatus()) {
|
if ($this->checkCliStatus()) {
|
||||||
$this->session_intern_error_str = '[SESSION] No sessions in php cli';
|
throw new \RuntimeException('[SESSION] No sessions in php cli', 1);
|
||||||
return false;
|
|
||||||
}
|
}
|
||||||
// if session are OFF
|
// if session are OFF
|
||||||
if ($this->getSessionStatus() === PHP_SESSION_DISABLED) {
|
if ($this->getSessionStatus() === PHP_SESSION_DISABLED) {
|
||||||
$this->session_intern_error_str = '[SESSION] Sessions are disabled';
|
throw new \RuntimeException('[SESSION] Sessions are disabled', 2);
|
||||||
return false;
|
|
||||||
}
|
}
|
||||||
// session_status
|
// session_status
|
||||||
// initial the session if there is no session running already
|
// initial the session if there is no session running already
|
||||||
@@ -139,8 +123,7 @@ class Session
|
|||||||
if (!empty($session_name)) {
|
if (!empty($session_name)) {
|
||||||
// invalid session name, abort
|
// invalid session name, abort
|
||||||
if (!$this->checkValidSessionName($session_name)) {
|
if (!$this->checkValidSessionName($session_name)) {
|
||||||
$this->session_intern_error_str = '[SESSION] Invalid session name: ' . $session_name;
|
throw new \UnexpectedValueException('[SESSION] Invalid session name: ' . $session_name, 3);
|
||||||
return false;
|
|
||||||
}
|
}
|
||||||
$this->setSessionName($session_name);
|
$this->setSessionName($session_name);
|
||||||
}
|
}
|
||||||
@@ -149,11 +132,10 @@ class Session
|
|||||||
}
|
}
|
||||||
// if we still have no active session
|
// if we still have no active session
|
||||||
if (!$this->checkActiveSession()) {
|
if (!$this->checkActiveSession()) {
|
||||||
$this->session_intern_error_str = '[SESSION] Failed to activate session';
|
throw new \RuntimeException('[SESSION] Failed to activate session', 4);
|
||||||
return false;
|
|
||||||
}
|
}
|
||||||
if (false === ($session_id = $this->getSessionId())) {
|
if (false === ($session_id = $this->getSessionId())) {
|
||||||
$this->session_intern_error_str = '[SESSION] getSessionId did not return a session id';
|
throw new \UnexpectedValueException('[SESSION] getSessionId did not return a session id', 5);
|
||||||
}
|
}
|
||||||
return $session_id;
|
return $session_id;
|
||||||
}
|
}
|
||||||
@@ -163,7 +145,7 @@ class Session
|
|||||||
*
|
*
|
||||||
* @return string|bool
|
* @return string|bool
|
||||||
*/
|
*/
|
||||||
public function getSessionId()
|
public function getSessionId(): string|bool
|
||||||
{
|
{
|
||||||
return session_id();
|
return session_id();
|
||||||
}
|
}
|
||||||
@@ -173,7 +155,7 @@ class Session
|
|||||||
*
|
*
|
||||||
* @return string|bool
|
* @return string|bool
|
||||||
*/
|
*/
|
||||||
public function getSessionName()
|
public function getSessionName(): string|bool
|
||||||
{
|
{
|
||||||
return session_name();
|
return session_name();
|
||||||
}
|
}
|
||||||
@@ -275,7 +257,7 @@ class Session
|
|||||||
* @param mixed $value value to set (can be anything)
|
* @param mixed $value value to set (can be anything)
|
||||||
* @return void
|
* @return void
|
||||||
*/
|
*/
|
||||||
public function setS($name, $value): void
|
public function setS(string|int $name, mixed $value): void
|
||||||
{
|
{
|
||||||
$_SESSION[$name] = $value;
|
$_SESSION[$name] = $value;
|
||||||
}
|
}
|
||||||
@@ -286,7 +268,7 @@ class Session
|
|||||||
* @param string|int $name value key to get from _SESSION
|
* @param string|int $name value key to get from _SESSION
|
||||||
* @return mixed value stored in _SESSION
|
* @return mixed value stored in _SESSION
|
||||||
*/
|
*/
|
||||||
public function getS($name)
|
public function getS(string|int $name): mixed
|
||||||
{
|
{
|
||||||
return $_SESSION[$name] ?? '';
|
return $_SESSION[$name] ?? '';
|
||||||
}
|
}
|
||||||
@@ -297,7 +279,7 @@ class Session
|
|||||||
* @param string|int $name Name to check for
|
* @param string|int $name Name to check for
|
||||||
* @return bool True for set, False fornot set
|
* @return bool True for set, False fornot set
|
||||||
*/
|
*/
|
||||||
public function issetS($name): bool
|
public function issetS(string|int $name): bool
|
||||||
{
|
{
|
||||||
return isset($_SESSION[$name]);
|
return isset($_SESSION[$name]);
|
||||||
}
|
}
|
||||||
@@ -308,7 +290,7 @@ class Session
|
|||||||
* @param string|int $name _SESSION key name to remove
|
* @param string|int $name _SESSION key name to remove
|
||||||
* @return void
|
* @return void
|
||||||
*/
|
*/
|
||||||
public function unsetS($name): void
|
public function unsetS(string|int $name): void
|
||||||
{
|
{
|
||||||
if (isset($_SESSION[$name])) {
|
if (isset($_SESSION[$name])) {
|
||||||
unset($_SESSION[$name]);
|
unset($_SESSION[$name]);
|
||||||
@@ -325,7 +307,7 @@ class Session
|
|||||||
* @param mixed $value
|
* @param mixed $value
|
||||||
* @return void
|
* @return void
|
||||||
*/
|
*/
|
||||||
public function __set($name, $value): void
|
public function __set(string|int $name, mixed $value): void
|
||||||
{
|
{
|
||||||
$_SESSION[$name] = $value;
|
$_SESSION[$name] = $value;
|
||||||
}
|
}
|
||||||
@@ -334,13 +316,14 @@ class Session
|
|||||||
* Undocumented function
|
* Undocumented function
|
||||||
*
|
*
|
||||||
* @param string|int $name
|
* @param string|int $name
|
||||||
* @return mixed
|
* @return mixed If name is not found, it will return null
|
||||||
*/
|
*/
|
||||||
public function __get($name)
|
public function __get(string|int $name): mixed
|
||||||
{
|
{
|
||||||
if (isset($_SESSION[$name])) {
|
if (isset($_SESSION[$name])) {
|
||||||
return $_SESSION[$name];
|
return $_SESSION[$name];
|
||||||
}
|
}
|
||||||
|
return null;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -349,7 +332,7 @@ class Session
|
|||||||
* @param string|int $name
|
* @param string|int $name
|
||||||
* @return bool
|
* @return bool
|
||||||
*/
|
*/
|
||||||
public function __isset($name): bool
|
public function __isset(string|int $name): bool
|
||||||
{
|
{
|
||||||
return isset($_SESSION[$name]);
|
return isset($_SESSION[$name]);
|
||||||
}
|
}
|
||||||
@@ -360,7 +343,7 @@ class Session
|
|||||||
* @param string|int $name
|
* @param string|int $name
|
||||||
* @return void
|
* @return void
|
||||||
*/
|
*/
|
||||||
public function __unset($name): void
|
public function __unset(string|int $name): void
|
||||||
{
|
{
|
||||||
if (isset($_SESSION[$name])) {
|
if (isset($_SESSION[$name])) {
|
||||||
unset($_SESSION[$name]);
|
unset($_SESSION[$name]);
|
||||||
|
|||||||
@@ -1,5 +1,12 @@
|
|||||||
<?php
|
<?php
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Create uniqIds
|
||||||
|
*
|
||||||
|
* If convert ID to hash:
|
||||||
|
* https://github.com/vinkla/hashids
|
||||||
|
*/
|
||||||
|
|
||||||
declare(strict_types=1);
|
declare(strict_types=1);
|
||||||
|
|
||||||
namespace CoreLibs\Create;
|
namespace CoreLibs\Create;
|
||||||
@@ -7,10 +14,39 @@ namespace CoreLibs\Create;
|
|||||||
class Uids
|
class Uids
|
||||||
{
|
{
|
||||||
// what to use as a default hash if non ise set and no DEFAULT_HASH is defined
|
// what to use as a default hash if non ise set and no DEFAULT_HASH is defined
|
||||||
public const DEFAULT_HASH = 'sha256';
|
|
||||||
|
/** @var int */
|
||||||
|
public const DEFAULT_UNNIQ_ID_LENGTH = 64;
|
||||||
|
/** @var string */
|
||||||
public const STANDARD_HASH_LONG = 'ripemd160';
|
public const STANDARD_HASH_LONG = 'ripemd160';
|
||||||
|
/** @var string */
|
||||||
public const STANDARD_HASH_SHORT = 'adler32';
|
public const STANDARD_HASH_SHORT = 'adler32';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Create unique id, lower length is for
|
||||||
|
*
|
||||||
|
* @param int $length Length for uniq id, min is 4 characters
|
||||||
|
* Uneven lengths will return lower bound (9 -> 8)
|
||||||
|
* @param bool $force_length [default=false] if set to true and we have
|
||||||
|
* uneven length, then we shorten to this length
|
||||||
|
* @return string Uniq id
|
||||||
|
*/
|
||||||
|
private static function uniqIdL(int $length = 64, bool $force_length = false): string
|
||||||
|
{
|
||||||
|
$uniqid_length = ($length < 4) ? 4 : $length;
|
||||||
|
if ($force_length) {
|
||||||
|
$uniqid_length++;
|
||||||
|
}
|
||||||
|
/** @var int<1,max> make sure that internal this is correct */
|
||||||
|
$random_bytes_length = ($uniqid_length - ($uniqid_length % 2)) / 2;
|
||||||
|
$uniqid = bin2hex(random_bytes($random_bytes_length));
|
||||||
|
// if not forced shorten return next lower length
|
||||||
|
if (!$force_length) {
|
||||||
|
return $uniqid;
|
||||||
|
}
|
||||||
|
return substr($uniqid, 0, $length);
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* creates psuedo random uuid v4
|
* creates psuedo random uuid v4
|
||||||
* Code take from class here:
|
* Code take from class here:
|
||||||
@@ -20,7 +56,7 @@ class Uids
|
|||||||
*/
|
*/
|
||||||
public static function uuidv4(): string
|
public static function uuidv4(): string
|
||||||
{
|
{
|
||||||
return sprintf(
|
/* return sprintf(
|
||||||
'%04x%04x-%04x-%04x-%04x-%04x%04x%04x',
|
'%04x%04x-%04x-%04x-%04x-%04x%04x%04x',
|
||||||
// 32 bits for "time_low"
|
// 32 bits for "time_low"
|
||||||
mt_rand(0, 0xffff),
|
mt_rand(0, 0xffff),
|
||||||
@@ -38,49 +74,62 @@ class Uids
|
|||||||
mt_rand(0, 0xffff),
|
mt_rand(0, 0xffff),
|
||||||
mt_rand(0, 0xffff),
|
mt_rand(0, 0xffff),
|
||||||
mt_rand(0, 0xffff)
|
mt_rand(0, 0xffff)
|
||||||
);
|
); */
|
||||||
|
|
||||||
|
$data = random_bytes(16);
|
||||||
|
assert(strlen($data) == 16);
|
||||||
|
|
||||||
|
// 0-1: 32 bits for "time_low"
|
||||||
|
// 2: 16 bits for "time_mid"
|
||||||
|
// 3: 16 bits for "time_hi_and_version",
|
||||||
|
// four most significant bits holds version number 4
|
||||||
|
$data[6] = chr(ord($data[6]) & 0x0f | 0x40); // set version to 0100
|
||||||
|
// 4: 16 bits, 8 bits for "clk_seq_hi_res",
|
||||||
|
// 8 bits for "clk_seq_low",
|
||||||
|
// two most significant bits holds zero and one for variant DCE1.1
|
||||||
|
$data[8] = chr(ord($data[8]) & 0x3f | 0x80); // set bits 6-7 to 10
|
||||||
|
// 5-7: 48 bits for "node"
|
||||||
|
|
||||||
|
return vsprintf('%s%s-%s-%s-%s-%s%s%s', str_split(bin2hex($data), 4));
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* TODO: make this a proper uniq ID creation
|
* creates a uniq id based on lengths
|
||||||
* add uuidv4 subcall to the uuid function too
|
|
||||||
* creates a uniq id
|
|
||||||
*
|
*
|
||||||
* @param string $type uniq id type, currently md5 or sha256 allowed
|
* @param int|string $length Either length in int, or fallback type for length
|
||||||
* if not set will use DEFAULT_HASH if set
|
* for string type md5 (32), sha256 (64)
|
||||||
* @return string uniq id
|
* STANDARD_HASH_LONG: ripemd160 (40)
|
||||||
|
* STANDARD_HASH_SHORT: adler32 (8)
|
||||||
|
* It is recommended to use the integer
|
||||||
|
* @param bool $force_length [default=false] if set to true and we have
|
||||||
|
* uneven length, then we shorten to this length
|
||||||
|
* @return string Uniq id
|
||||||
*/
|
*/
|
||||||
public static function uniqId(string $type = ''): string
|
public static function uniqId(
|
||||||
{
|
int|string $length = self::DEFAULT_UNNIQ_ID_LENGTH,
|
||||||
$uniq_id = '';
|
bool $force_length = false
|
||||||
switch ($type) {
|
): string {
|
||||||
|
if (is_int($length)) {
|
||||||
|
return self::uniqIdL($length, $force_length);
|
||||||
|
}
|
||||||
|
switch ($length) {
|
||||||
case 'md5':
|
case 'md5':
|
||||||
$uniq_id = md5(uniqid((string)rand(), true));
|
$length = 32;
|
||||||
break;
|
break;
|
||||||
case self::DEFAULT_HASH:
|
case 'sha256':
|
||||||
$uniq_id = hash(self::DEFAULT_HASH, uniqid((string)rand(), true));
|
$length = 64;
|
||||||
break;
|
break;
|
||||||
case self::STANDARD_HASH_LONG:
|
case self::STANDARD_HASH_LONG:
|
||||||
$uniq_id = hash(self::STANDARD_HASH_LONG, uniqid((string)rand(), true));
|
$length = 40;
|
||||||
break;
|
break;
|
||||||
case self::STANDARD_HASH_SHORT:
|
case self::STANDARD_HASH_SHORT:
|
||||||
$uniq_id = hash(self::STANDARD_HASH_SHORT, uniqid((string)rand(), true));
|
$length = 8;
|
||||||
break;
|
break;
|
||||||
default:
|
default:
|
||||||
// if not empty, check if in valid list
|
$length = 64;
|
||||||
if (
|
|
||||||
!empty($type) &&
|
|
||||||
in_array($type, hash_algos())
|
|
||||||
) {
|
|
||||||
$hash = $type;
|
|
||||||
} else {
|
|
||||||
// fallback to default hash type if none set or invalid
|
|
||||||
$hash = self::DEFAULT_HASH;
|
|
||||||
}
|
|
||||||
$uniq_id = hash($hash, uniqid((string)rand(), true));
|
|
||||||
break;
|
break;
|
||||||
}
|
}
|
||||||
return $uniq_id;
|
return self::uniqIdL($length);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
|||||||
@@ -39,38 +39,40 @@ class ArrayIO extends \CoreLibs\DB\IO
|
|||||||
{
|
{
|
||||||
// main calss variables
|
// main calss variables
|
||||||
/** @var array<mixed> */
|
/** @var array<mixed> */
|
||||||
public $table_array; // the array from the table to work on
|
public array $table_array; // the array from the table to work on
|
||||||
/** @var string */
|
/** @var string */
|
||||||
public $table_name; // the table_name
|
public string $table_name; // the table_name
|
||||||
/** @var string */
|
/** @var string */
|
||||||
public $pk_name = ''; // the primary key from this table
|
public string $pk_name = ''; // the primary key from this table
|
||||||
/** @var int|string|null */
|
/** @var int|string|null */
|
||||||
public $pk_id; // the PK id
|
public int|string|null $pk_id; // the PK id
|
||||||
// security values
|
// security values
|
||||||
/** @var int base acl for current page */
|
/** @var int base acl for current page */
|
||||||
private $base_acl_level = 0;
|
private int $base_acl_level = 0;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* constructor for the array io class, set the
|
* constructor for the array io class, set the
|
||||||
* primary key name automatically (from array)
|
* primary key name automatically (from array)
|
||||||
*
|
*
|
||||||
* @param array<mixed> $db_config db connection config
|
* phpcs:ignore
|
||||||
|
* @param array{db_name:string,db_user:string,db_pass:string,db_host:string,db_port:int,db_schema:string,db_encoding:string,db_type:string,db_ssl:string,db_convert_type?:string[]} $db_config db connection config
|
||||||
* @param array<mixed> $table_array table array config
|
* @param array<mixed> $table_array table array config
|
||||||
* @param string $table_name table name string
|
* @param string $table_name table name string
|
||||||
* @param \CoreLibs\Debug\Logging|null $log Logging class, default set if not set
|
* @param \CoreLibs\Logging\Logging $log Logging class
|
||||||
* @param int $base_acl_level Set base acl level, if needed
|
* @param int $base_acl_level Set base acl level, if needed
|
||||||
* @param int $acl_admin Flag if this is an admin ACL access level
|
* @param int $acl_admin Flag if this is an admin ACL access level
|
||||||
|
* @throws \RuntimeException Missing table array or table name entry
|
||||||
*/
|
*/
|
||||||
public function __construct(
|
public function __construct(
|
||||||
array $db_config,
|
array $db_config,
|
||||||
array $table_array,
|
array $table_array,
|
||||||
string $table_name,
|
string $table_name,
|
||||||
\CoreLibs\Debug\Logging $log = null,
|
\CoreLibs\Logging\Logging $log,
|
||||||
int $base_acl_level = 0,
|
int $base_acl_level = 0,
|
||||||
int $acl_admin = 0
|
int $acl_admin = 0
|
||||||
) {
|
) {
|
||||||
// instance db_io class
|
// instance db_io class
|
||||||
parent::__construct($db_config, $log ?? new \CoreLibs\Debug\Logging());
|
parent::__construct($db_config, $log);
|
||||||
// more error vars for this class
|
// more error vars for this class
|
||||||
$this->error_string['1999'] = 'No table array or table name set';
|
$this->error_string['1999'] = 'No table array or table name set';
|
||||||
$this->error_string['1021'] = 'No Primary Key given';
|
$this->error_string['1021'] = 'No Primary Key given';
|
||||||
@@ -82,6 +84,7 @@ class ArrayIO extends \CoreLibs\DB\IO
|
|||||||
// error abort if no table array or no table name
|
// error abort if no table array or no table name
|
||||||
if (empty($table_array) || empty($table_name)) {
|
if (empty($table_array) || empty($table_name)) {
|
||||||
$this->__dbError(1999, false, 'MAJOR ERROR: Core settings missing');
|
$this->__dbError(1999, false, 'MAJOR ERROR: Core settings missing');
|
||||||
|
throw new \RuntimeException('MAJOR ERROR: Core settings missing', 1999);
|
||||||
}
|
}
|
||||||
|
|
||||||
// set primary key for given table_array
|
// set primary key for given table_array
|
||||||
@@ -137,7 +140,7 @@ class ArrayIO extends \CoreLibs\DB\IO
|
|||||||
* @param string $text any html encoded string
|
* @param string $text any html encoded string
|
||||||
* @return string decoded html string
|
* @return string decoded html string
|
||||||
*/
|
*/
|
||||||
public function convertData($text): string
|
public function convertData(string $text): string
|
||||||
{
|
{
|
||||||
$text = str_replace('<b>', '<b>', $text);
|
$text = str_replace('<b>', '<b>', $text);
|
||||||
$text = str_replace('</b>', '</b>', $text);
|
$text = str_replace('</b>', '</b>', $text);
|
||||||
@@ -156,7 +159,7 @@ class ArrayIO extends \CoreLibs\DB\IO
|
|||||||
* @param string $text encoded html string
|
* @param string $text encoded html string
|
||||||
* @return string decoded html string
|
* @return string decoded html string
|
||||||
*/
|
*/
|
||||||
public function convertEntities($text): string
|
public function convertEntities(string $text): string
|
||||||
{
|
{
|
||||||
$text = str_replace('<', '<', $text);
|
$text = str_replace('<', '<', $text);
|
||||||
$text = str_replace('>', '>', $text);
|
$text = str_replace('>', '>', $text);
|
||||||
@@ -172,7 +175,7 @@ class ArrayIO extends \CoreLibs\DB\IO
|
|||||||
* @param bool $write write to error message, default false
|
* @param bool $write write to error message, default false
|
||||||
* @return string the array data as html string entry
|
* @return string the array data as html string entry
|
||||||
*/
|
*/
|
||||||
public function dbDumpArray($write = false): string
|
public function dbDumpArray(bool $write = false): string
|
||||||
{
|
{
|
||||||
reset($this->table_array);
|
reset($this->table_array);
|
||||||
$string = '';
|
$string = '';
|
||||||
@@ -192,7 +195,7 @@ class ArrayIO extends \CoreLibs\DB\IO
|
|||||||
*
|
*
|
||||||
* @return bool true if pk value is set, else false
|
* @return bool true if pk value is set, else false
|
||||||
*/
|
*/
|
||||||
public function dbCheckPkSet()
|
public function dbCheckPkSet(): bool
|
||||||
{
|
{
|
||||||
// if pk_id is set, overrule ...
|
// if pk_id is set, overrule ...
|
||||||
if ($this->pk_id) {
|
if ($this->pk_id) {
|
||||||
@@ -210,10 +213,10 @@ class ArrayIO extends \CoreLibs\DB\IO
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* resets the whole array values
|
* resets the whole array values
|
||||||
* @param boolean $reset_pk true if we want to reset the pk too
|
* @param bool $reset_pk true if we want to reset the pk too
|
||||||
* @return void has no return
|
* @return void has no return
|
||||||
*/
|
*/
|
||||||
public function dbResetArray($reset_pk = false): void
|
public function dbResetArray(bool $reset_pk = false): void
|
||||||
{
|
{
|
||||||
reset($this->table_array);
|
reset($this->table_array);
|
||||||
foreach (array_keys($this->table_array) as $column) {
|
foreach (array_keys($this->table_array) as $column) {
|
||||||
@@ -230,10 +233,10 @@ class ArrayIO extends \CoreLibs\DB\IO
|
|||||||
*
|
*
|
||||||
* @param array<mixed> $table_array optional override for table array set
|
* @param array<mixed> $table_array optional override for table array set
|
||||||
* set this as new table array too
|
* set this as new table array too
|
||||||
* @param boolean $acl_limit [false], if set to true, well do ACL limit check
|
* @param bool $acl_limit [false], if set to true, well do ACL limit check
|
||||||
* @return array<mixed> returns the table array that was deleted
|
* @return array<mixed> returns the table array that was deleted
|
||||||
*/
|
*/
|
||||||
public function dbDelete($table_array = [], $acl_limit = false)
|
public function dbDelete(array $table_array = [], bool $acl_limit = false): array
|
||||||
{
|
{
|
||||||
// is array and has values, override set and set new
|
// is array and has values, override set and set new
|
||||||
if (is_array($table_array) && count($table_array)) {
|
if (is_array($table_array) && count($table_array)) {
|
||||||
@@ -243,7 +246,7 @@ class ArrayIO extends \CoreLibs\DB\IO
|
|||||||
return $this->table_array;
|
return $this->table_array;
|
||||||
}
|
}
|
||||||
if ($acl_limit === true && $this->base_acl_level < 100) {
|
if ($acl_limit === true && $this->base_acl_level < 100) {
|
||||||
$this->log->debug('DB DELETE ERROR', 'ACL Limit on, Delete, '
|
$this->log->error('DB DELETE ERROR: ACL Limit on, Delete, '
|
||||||
. 'but base ACL level of 100 not met: ' . $this->base_acl_level);
|
. 'but base ACL level of 100 not met: ' . $this->base_acl_level);
|
||||||
return $this->table_array;
|
return $this->table_array;
|
||||||
}
|
}
|
||||||
@@ -294,12 +297,12 @@ class ArrayIO extends \CoreLibs\DB\IO
|
|||||||
/**
|
/**
|
||||||
* reads one row into the array
|
* reads one row into the array
|
||||||
*
|
*
|
||||||
* @param boolean $edit on true convert data, else as is
|
* @param bool $edit on true convert data, else as is
|
||||||
* @param array<mixed> $table_array optional table array, overwrites
|
* @param array<mixed> $table_array optional table array, overwrites
|
||||||
* internal set array
|
* internal set array
|
||||||
* @return array<mixed> set table array with values
|
* @return array<mixed> set table array with values
|
||||||
*/
|
*/
|
||||||
public function dbRead($edit = false, $table_array = [])
|
public function dbRead(bool $edit = false, array $table_array = []): array
|
||||||
{
|
{
|
||||||
// if array give, overrules internal array
|
// if array give, overrules internal array
|
||||||
if (is_array($table_array) && count($table_array)) {
|
if (is_array($table_array) && count($table_array)) {
|
||||||
@@ -381,9 +384,9 @@ class ArrayIO extends \CoreLibs\DB\IO
|
|||||||
/**
|
/**
|
||||||
* writes one set into DB or updates one set (if PK exists)
|
* writes one set into DB or updates one set (if PK exists)
|
||||||
*
|
*
|
||||||
* @param boolean $addslashes old convert entities and set set escape
|
* @param bool $addslashes old convert entities and set set escape
|
||||||
* @param array<mixed> $table_array optional table array, overwrites internal one
|
* @param array<mixed> $table_array optional table array, overwrites internal one
|
||||||
* @param boolean $acl_limit [false], if set to true, well do ACL limit check
|
* @param bool $acl_limit [false], if set to true, well do ACL limit check
|
||||||
* @return array<mixed> table array or null
|
* @return array<mixed> table array or null
|
||||||
*/
|
*/
|
||||||
public function dbWrite(
|
public function dbWrite(
|
||||||
@@ -391,7 +394,7 @@ class ArrayIO extends \CoreLibs\DB\IO
|
|||||||
array $table_array = [],
|
array $table_array = [],
|
||||||
bool $acl_limit = false
|
bool $acl_limit = false
|
||||||
): array {
|
): array {
|
||||||
if (is_array($table_array) && count($table_array)) {
|
if (count($table_array)) {
|
||||||
$this->table_array = $table_array;
|
$this->table_array = $table_array;
|
||||||
}
|
}
|
||||||
// PK ID check
|
// PK ID check
|
||||||
@@ -406,7 +409,7 @@ class ArrayIO extends \CoreLibs\DB\IO
|
|||||||
}
|
}
|
||||||
// early abort for new write with not enough ACL level
|
// early abort for new write with not enough ACL level
|
||||||
if ($insert && $acl_limit === true && $this->base_acl_level < 100) {
|
if ($insert && $acl_limit === true && $this->base_acl_level < 100) {
|
||||||
$this->log->debug('DB WRITE ERROR', 'ACL Limit on, Insert, '
|
$this->log->error('DB WRITE ERROR: ACL Limit on, Insert, '
|
||||||
. 'but base ACL level of 100 not met: ' . $this->base_acl_level);
|
. 'but base ACL level of 100 not met: ' . $this->base_acl_level);
|
||||||
return $this->table_array;
|
return $this->table_array;
|
||||||
}
|
}
|
||||||
@@ -475,13 +478,12 @@ class ArrayIO extends \CoreLibs\DB\IO
|
|||||||
$this->table_array[$column]['type'] != 'view' &&
|
$this->table_array[$column]['type'] != 'view' &&
|
||||||
strlen($column) > 0 &&
|
strlen($column) > 0 &&
|
||||||
// no acl limiter
|
// no acl limiter
|
||||||
($acl_limit === false ||
|
|
||||||
(
|
(
|
||||||
|
$acl_limit === false ||
|
||||||
// acl limit is true, min edit must be at larger than set
|
// acl limit is true, min edit must be at larger than set
|
||||||
$acl_limit === true &&
|
|
||||||
$this->base_acl_level >=
|
$this->base_acl_level >=
|
||||||
($this->table_array[$column]['min_edit_acl'] ?? 100)
|
($this->table_array[$column]['min_edit_acl'] ?? 100)
|
||||||
))
|
)
|
||||||
) {
|
) {
|
||||||
// for password use hidden value if main is not set
|
// for password use hidden value if main is not set
|
||||||
if (
|
if (
|
||||||
@@ -528,7 +530,7 @@ class ArrayIO extends \CoreLibs\DB\IO
|
|||||||
}
|
}
|
||||||
$q_data .= $_value;
|
$q_data .= $_value;
|
||||||
} elseif (isset($this->table_array[$column]['bool'])) {
|
} elseif (isset($this->table_array[$column]['bool'])) {
|
||||||
// boolean storeage (reverse check on ifset)
|
// bool storage (reverse check on ifset)
|
||||||
$q_data .= "'" . $this->dbBoolean($this->table_array[$column]['value'], true) . "'";
|
$q_data .= "'" . $this->dbBoolean($this->table_array[$column]['value'], true) . "'";
|
||||||
} elseif (
|
} elseif (
|
||||||
isset($this->table_array[$column]['interval']) ||
|
isset($this->table_array[$column]['interval']) ||
|
||||||
@@ -580,7 +582,7 @@ class ArrayIO extends \CoreLibs\DB\IO
|
|||||||
} // while ...
|
} // while ...
|
||||||
|
|
||||||
if (empty($q_data)) {
|
if (empty($q_data)) {
|
||||||
$this->log->debug('DB WRITE ERROR', 'No data to write, possible through ACL');
|
$this->log->error('DB WRITE ERROR: No data to write, possible through ACL');
|
||||||
return $this->table_array;
|
return $this->table_array;
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -588,7 +590,7 @@ class ArrayIO extends \CoreLibs\DB\IO
|
|||||||
// get it at the end, cause now we can be more sure of no double IDs, etc
|
// get it at the end, cause now we can be more sure of no double IDs, etc
|
||||||
reset($this->table_array);
|
reset($this->table_array);
|
||||||
// create select part & addition FK part
|
// create select part & addition FK part
|
||||||
foreach ($this->table_array as $column => $data_array) {
|
foreach (array_keys($this->table_array) as $column) {
|
||||||
// check FK ...
|
// check FK ...
|
||||||
if (
|
if (
|
||||||
isset($this->table_array[$column]['fk']) &&
|
isset($this->table_array[$column]['fk']) &&
|
||||||
|
|||||||
1669
src/DB/IO.php
1669
src/DB/IO.php
File diff suppressed because it is too large
Load Diff
63
src/DB/Options/Convert.php
Normal file
63
src/DB/Options/Convert.php
Normal file
@@ -0,0 +1,63 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
/**
|
||||||
|
* AUTOR: Clemens Schwaighofer
|
||||||
|
* CREATED: 2023/6/9
|
||||||
|
* DESCRIPTION:
|
||||||
|
* DB Options for convert type
|
||||||
|
*
|
||||||
|
* off: no conversion (all string)
|
||||||
|
* on: int/bool only
|
||||||
|
* json: json/jsonb to array
|
||||||
|
* numeric: any numeric or float to float
|
||||||
|
* bytes: decode bytea to string
|
||||||
|
*/
|
||||||
|
|
||||||
|
declare(strict_types=1);
|
||||||
|
|
||||||
|
namespace CoreLibs\DB\Options;
|
||||||
|
|
||||||
|
enum Convert: int
|
||||||
|
{
|
||||||
|
/** do not convert */
|
||||||
|
case off = 0;
|
||||||
|
/** convert only int/bool */
|
||||||
|
case on = 1;
|
||||||
|
/** also convert json to php array */
|
||||||
|
case json = 2;
|
||||||
|
/** also convert any float/real/numeric to php float */
|
||||||
|
case numeric = 4;
|
||||||
|
/** also decode bytea string to php string */
|
||||||
|
case bytea = 8;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* get internal name from string value
|
||||||
|
*
|
||||||
|
* @param non-empty-string $name
|
||||||
|
* @return self
|
||||||
|
*/
|
||||||
|
public static function fromName(string $name): self
|
||||||
|
{
|
||||||
|
return match ($name) {
|
||||||
|
'Off', 'off', 'OFF', 'convert_off', 'CONVERT_OFF' => self::off,
|
||||||
|
'On', 'on', 'ON', 'convert_on', 'CONVERT_ON' => self::on,
|
||||||
|
'Json', 'json', 'JSON', 'convert_json', 'CONVERT_JSON' => self::json,
|
||||||
|
'Numeric', 'numeric', 'NUMERIC', 'convert_numeric', 'CONVERT_NUMERIC' => self::numeric,
|
||||||
|
'Bytea', 'bytea', 'BYTEA', 'convert_bytea', 'CONVERT_BYTEA' => self::bytea,
|
||||||
|
default => self::off,
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get internal name from int value
|
||||||
|
*
|
||||||
|
* @param int $value
|
||||||
|
* @return self
|
||||||
|
*/
|
||||||
|
public static function fromValue(int $value): self
|
||||||
|
{
|
||||||
|
return self::from($value);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// __END__
|
||||||
@@ -6,7 +6,7 @@
|
|||||||
|
|
||||||
declare(strict_types=1);
|
declare(strict_types=1);
|
||||||
|
|
||||||
namespace CoreLibs\DB\SQL\SqlInterface;
|
namespace CoreLibs\DB\SQL\Interface;
|
||||||
|
|
||||||
interface SqlFunctions
|
interface SqlFunctions
|
||||||
{
|
{
|
||||||
@@ -21,33 +21,42 @@ interface SqlFunctions
|
|||||||
* Undocumented function
|
* Undocumented function
|
||||||
*
|
*
|
||||||
* @param string $query
|
* @param string $query
|
||||||
* @return object|resource|bool
|
* @return \PgSql\Result|false
|
||||||
*/
|
*/
|
||||||
public function __dbQuery(string $query);
|
public function __dbQuery(string $query): \PgSql\Result|false;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Undocumented function
|
* Undocumented function
|
||||||
*
|
*
|
||||||
* @param string $query
|
* @param string $query
|
||||||
* @param array<mixed> $params
|
* @param array<mixed> $params
|
||||||
* @return object|resource|bool
|
* @return \PgSql\Result|false
|
||||||
*/
|
*/
|
||||||
public function __dbQueryParams(string $query, array $params);
|
public function __dbQueryParams(string $query, array $params): \PgSql\Result|false;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Undocumented function
|
* Undocumented function
|
||||||
*
|
*
|
||||||
* @param string $query
|
* @param string $query
|
||||||
* @return boolean
|
* @return bool
|
||||||
*/
|
*/
|
||||||
public function __dbSendQuery(string $query): bool;
|
public function __dbSendQuery(string $query): bool;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Undocumented function
|
* Undocumented function
|
||||||
*
|
*
|
||||||
* @return object|resource|bool
|
* @param string $query
|
||||||
|
* @param array<mixed> $params
|
||||||
|
* @return bool
|
||||||
*/
|
*/
|
||||||
public function __dbGetResult();
|
public function __dbSendQueryParams(string $query, array $params): bool;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Undocumented function
|
||||||
|
*
|
||||||
|
* @return \PgSql\Result|false
|
||||||
|
*/
|
||||||
|
public function __dbGetResult(): \PgSql\Result|false;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Undocumented function
|
* Undocumented function
|
||||||
@@ -61,85 +70,112 @@ interface SqlFunctions
|
|||||||
*
|
*
|
||||||
* @param string $name
|
* @param string $name
|
||||||
* @param string $query
|
* @param string $query
|
||||||
* @return object|resource|bool
|
* @return \PgSql\Result|false
|
||||||
*/
|
*/
|
||||||
public function __dbPrepare(string $name, string $query);
|
public function __dbPrepare(string $name, string $query): \PgSql\Result|false;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Undocumented function
|
* Undocumented function
|
||||||
*
|
*
|
||||||
* @param string $name
|
* @param string $name
|
||||||
* @param array<mixed> $data
|
* @param array<mixed> $data
|
||||||
* @return object|resource|bool
|
* @return \PgSql\Result|false
|
||||||
*/
|
*/
|
||||||
public function __dbExecute(string $name, array $data);
|
public function __dbExecute(string $name, array $data): \PgSql\Result|false;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Undocumented function
|
* Undocumented function
|
||||||
*
|
*
|
||||||
* @param object|resource|bool $cursor
|
* @param string $name
|
||||||
* @return integer
|
* @param string $query
|
||||||
|
* @return bool
|
||||||
*/
|
*/
|
||||||
public function __dbNumRows($cursor): int;
|
public function __dbSendPrepare(string $name, string $query): bool;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Undocumented function
|
* Undocumented function
|
||||||
*
|
*
|
||||||
* @param object|resource|bool $cursor
|
* @param string $name
|
||||||
* @return integer
|
* @param array<mixed> $params
|
||||||
|
* @return bool
|
||||||
*/
|
*/
|
||||||
public function __dbNumFields($cursor): int;
|
public function __dbSendExecute(string $name, array $params): bool;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Undocumented function
|
* Undocumented function
|
||||||
*
|
*
|
||||||
* @param object|resource|bool $cursor
|
* @param \PgSql\Result|false $cursor
|
||||||
|
* @return int
|
||||||
|
*/
|
||||||
|
public function __dbNumRows(\PgSql\Result|false $cursor): int;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Undocumented function
|
||||||
|
*
|
||||||
|
* @param \PgSql\Result|false $cursor
|
||||||
|
* @return int
|
||||||
|
*/
|
||||||
|
public function __dbNumFields(\PgSql\Result|false $cursor): int;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Undocumented function
|
||||||
|
*
|
||||||
|
* @param \PgSql\Result|false $cursor
|
||||||
* @param int $i
|
* @param int $i
|
||||||
* @return string|bool
|
* @return string|false
|
||||||
*/
|
*/
|
||||||
public function __dbFieldName($cursor, int $i);
|
public function __dbFieldName(\PgSql\Result|false $cursor, int $i): string|false;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Undocumented function
|
* Undocumented function
|
||||||
*
|
*
|
||||||
* @param object|resource|bool $cursor
|
* @param \PgSql\Result|false $cursor
|
||||||
|
* @param int $i
|
||||||
|
* @return string|false
|
||||||
|
*/
|
||||||
|
public function __dbFieldType(\PgSql\Result|false $cursor, int $i): string|false;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Undocumented function
|
||||||
|
*
|
||||||
|
* @param \PgSql\Result|false $cursor
|
||||||
* @param int $result_type
|
* @param int $result_type
|
||||||
* @return array<mixed>|bool
|
* @return array<mixed>|bool
|
||||||
*/
|
*/
|
||||||
public function __dbFetchArray($cursor, int $result_type = PGSQL_BOTH);
|
public function __dbFetchArray(\PgSql\Result|false $cursor, int $result_type = PGSQL_BOTH);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Undocumented function
|
* Undocumented function
|
||||||
*
|
*
|
||||||
* @param boolean $assoc_type
|
* @param bool $assoc_type
|
||||||
* @return integer
|
* @return int
|
||||||
*/
|
*/
|
||||||
public function __dbResultType(bool $assoc_type = true): int;
|
public function __dbResultType(bool $assoc_type = true): int;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Undocumented function
|
* Undocumented function
|
||||||
*
|
*
|
||||||
* @param object|resource|bool $cursor
|
* @param \PgSql\Result|false $cursor
|
||||||
* @return array<mixed>|bool
|
* @return array<mixed>|bool
|
||||||
*/
|
*/
|
||||||
public function __dbFetchAll($cursor);
|
public function __dbFetchAll(\PgSql\Result|false $cursor): array|bool;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Undocumented function
|
* Undocumented function
|
||||||
*
|
*
|
||||||
* @param object|resource|bool $cursor
|
* @param \PgSql\Result|false $cursor
|
||||||
* @return integer
|
* @return int
|
||||||
*/
|
*/
|
||||||
public function __dbAffectedRows($cursor): int;
|
public function __dbAffectedRows(\PgSql\Result|false $cursor): int;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Undocumented function
|
* Undocumented function
|
||||||
*
|
*
|
||||||
* @param string $query
|
* @param string $query
|
||||||
* @param string|null $pk_name
|
* @param string|null $pk_name
|
||||||
* @return string|integer|false
|
* @return string|int|false
|
||||||
*/
|
*/
|
||||||
public function __dbInsertId(string $query, ?string $pk_name);
|
public function __dbInsertId(string $query, ?string $pk_name): string|int|false;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Undocumented function
|
* Undocumented function
|
||||||
@@ -148,7 +184,7 @@ interface SqlFunctions
|
|||||||
* @param string $schema
|
* @param string $schema
|
||||||
* @return string|bool
|
* @return string|bool
|
||||||
*/
|
*/
|
||||||
public function __dbPrimaryKey(string $table, string $schema = '');
|
public function __dbPrimaryKey(string $table, string $schema = ''): string|bool;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Undocumented function
|
* Undocumented function
|
||||||
@@ -157,9 +193,9 @@ interface SqlFunctions
|
|||||||
* @param string $db_user
|
* @param string $db_user
|
||||||
* @param string $db_pass
|
* @param string $db_pass
|
||||||
* @param string $db_name
|
* @param string $db_name
|
||||||
* @param integer $db_port
|
* @param int $db_port
|
||||||
* @param string $db_ssl
|
* @param string $db_ssl
|
||||||
* @return object|resource|bool
|
* @return \PgSql\Connection|false
|
||||||
*/
|
*/
|
||||||
public function __dbConnect(
|
public function __dbConnect(
|
||||||
string $db_host,
|
string $db_host,
|
||||||
@@ -168,24 +204,31 @@ interface SqlFunctions
|
|||||||
string $db_name,
|
string $db_name,
|
||||||
int $db_port,
|
int $db_port,
|
||||||
string $db_ssl = 'allow'
|
string $db_ssl = 'allow'
|
||||||
);
|
): \PgSql\Connection|false;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Undocumented function
|
* Undocumented function
|
||||||
*
|
*
|
||||||
* @param object|resource|bool $cursor
|
* @return array{0:string,1:string}
|
||||||
* @return string
|
|
||||||
*/
|
*/
|
||||||
public function __dbPrintError($cursor = false): string;
|
public function __dbPrintLastError(): array;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Undocumented function
|
||||||
|
*
|
||||||
|
* @param \PgSql\Result|false $cursor
|
||||||
|
* @return array{0:string,1:string}
|
||||||
|
*/
|
||||||
|
public function __dbPrintError(\PgSql\Result|false $cursor = false): array;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Undocumented function
|
* Undocumented function
|
||||||
*
|
*
|
||||||
* @param string $table
|
* @param string $table
|
||||||
* @param boolean $extended
|
* @param bool $extended
|
||||||
* @return array<mixed>|bool
|
* @return array<mixed>|bool
|
||||||
*/
|
*/
|
||||||
public function __dbMetaData(string $table, $extended = true);
|
public function __dbMetaData(string $table, bool $extended = true): array|bool;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Undocumented function
|
* Undocumented function
|
||||||
@@ -193,7 +236,7 @@ interface SqlFunctions
|
|||||||
* @param string|int|float|bool $string
|
* @param string|int|float|bool $string
|
||||||
* @return string
|
* @return string
|
||||||
*/
|
*/
|
||||||
public function __dbEscapeString($string): string;
|
public function __dbEscapeString(string|int|float|bool $string): string;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Undocumented function
|
* Undocumented function
|
||||||
@@ -201,7 +244,7 @@ interface SqlFunctions
|
|||||||
* @param string|int|float|bool $string
|
* @param string|int|float|bool $string
|
||||||
* @return string
|
* @return string
|
||||||
*/
|
*/
|
||||||
public function __dbEscapeLiteral($string): string;
|
public function __dbEscapeLiteral(string|int|float|bool $string): string;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Undocumented function
|
* Undocumented function
|
||||||
@@ -230,15 +273,15 @@ interface SqlFunctions
|
|||||||
/**
|
/**
|
||||||
* Undocumented function
|
* Undocumented function
|
||||||
*
|
*
|
||||||
* @return boolean
|
* @return bool
|
||||||
*/
|
*/
|
||||||
public function __dbConnectionBusy(): bool;
|
public function __dbConnectionBusy(): bool;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Undocumented function
|
* Undocumented function
|
||||||
*
|
*
|
||||||
* @param integer $timeout_seconds
|
* @param int $timeout_seconds
|
||||||
* @return boolean
|
* @return bool
|
||||||
*/
|
*/
|
||||||
public function __dbConnectionBusySocketWait(int $timeout_seconds = 3): bool;
|
public function __dbConnectionBusySocketWait(int $timeout_seconds = 3): bool;
|
||||||
|
|
||||||
@@ -253,8 +296,8 @@ interface SqlFunctions
|
|||||||
* Undocumented function
|
* Undocumented function
|
||||||
*
|
*
|
||||||
* @param string $array_text
|
* @param string $array_text
|
||||||
* @param integer $start
|
* @param int $start
|
||||||
* @param integer|null $end
|
* @param int|null $end
|
||||||
* @return array<mixed>|null
|
* @return array<mixed>|null
|
||||||
*/
|
*/
|
||||||
public function __dbArrayParse(
|
public function __dbArrayParse(
|
||||||
@@ -275,7 +318,7 @@ interface SqlFunctions
|
|||||||
* Undocumented function
|
* Undocumented function
|
||||||
*
|
*
|
||||||
* @param string $db_schema
|
* @param string $db_schema
|
||||||
* @return integer
|
* @return int
|
||||||
*/
|
*/
|
||||||
public function __dbSetSchema(string $db_schema): int;
|
public function __dbSetSchema(string $db_schema): int;
|
||||||
|
|
||||||
@@ -290,7 +333,7 @@ interface SqlFunctions
|
|||||||
* Undocumented function
|
* Undocumented function
|
||||||
*
|
*
|
||||||
* @param string $db_encoding
|
* @param string $db_encoding
|
||||||
* @return integer
|
* @return int
|
||||||
*/
|
*/
|
||||||
public function __dbSetEncoding(string $db_encoding): int;
|
public function __dbSetEncoding(string $db_encoding): int;
|
||||||
|
|
||||||
@@ -33,7 +33,11 @@
|
|||||||
* pg_affected_rows (*)
|
* pg_affected_rows (*)
|
||||||
* pg_fetch_array
|
* pg_fetch_array
|
||||||
* pg_query
|
* pg_query
|
||||||
|
* pg_query_params
|
||||||
* pg_send_query
|
* pg_send_query
|
||||||
|
* pg_send_query_params
|
||||||
|
* pg_send_prepare
|
||||||
|
* pg_send_execute
|
||||||
* pg_get_result
|
* pg_get_result
|
||||||
* pg_connection_busy
|
* pg_connection_busy
|
||||||
* pg_close
|
* pg_close
|
||||||
@@ -50,14 +54,14 @@ namespace CoreLibs\DB\SQL;
|
|||||||
// below no ignore is needed if we want to use PgSql interface checks with PHP 8.0
|
// below no ignore is needed if we want to use PgSql interface checks with PHP 8.0
|
||||||
// as main system. Currently all @var sets are written as object
|
// as main system. Currently all @var sets are written as object
|
||||||
/** @#phan-file-suppress PhanUndeclaredTypeProperty,PhanUndeclaredTypeParameter,PhanUndeclaredTypeReturnType */
|
/** @#phan-file-suppress PhanUndeclaredTypeProperty,PhanUndeclaredTypeParameter,PhanUndeclaredTypeReturnType */
|
||||||
|
/** @phan-file-suppress PhanTypeMismatchArgumentInternal, PhanTypeMismatchReturn */
|
||||||
|
|
||||||
class PgSQL implements \CoreLibs\DB\SQL\SqlInterface\SqlFunctions
|
class PgSQL implements Interface\SqlFunctions
|
||||||
{
|
{
|
||||||
/** @var string */
|
/** @var string */
|
||||||
private $last_error_query;
|
private string $last_error_query;
|
||||||
// NOTE for PHP 8.1 this is no longer a resource
|
/** @var \PgSql\Connection|false */
|
||||||
/** @var object|resource|bool */ // replace object with PgSql\Connection
|
private \PgSql\Connection|false $dbh = false;
|
||||||
private $dbh;
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* queries last error query and returns true or false if error was set
|
* queries last error query and returns true or false if error was set
|
||||||
@@ -77,12 +81,12 @@ class PgSQL implements \CoreLibs\DB\SQL\SqlInterface\SqlFunctions
|
|||||||
* wrapper for pg_query, catches error and stores it in class var
|
* wrapper for pg_query, catches error and stores it in class var
|
||||||
*
|
*
|
||||||
* @param string $query Query string
|
* @param string $query Query string
|
||||||
* @return object|resource|bool query result (PgSql\Result)
|
* @return \PgSql\Result|false query result
|
||||||
*/
|
*/
|
||||||
public function __dbQuery(string $query)
|
public function __dbQuery(string $query): \PgSql\Result|false
|
||||||
{
|
{
|
||||||
$this->last_error_query = '';
|
$this->last_error_query = '';
|
||||||
if ($this->dbh === false || is_bool($this->dbh)) {
|
if (is_bool($this->dbh)) {
|
||||||
return false;
|
return false;
|
||||||
}
|
}
|
||||||
// read out the query status and save the query if needed
|
// read out the query status and save the query if needed
|
||||||
@@ -94,18 +98,17 @@ class PgSQL implements \CoreLibs\DB\SQL\SqlInterface\SqlFunctions
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Proposed
|
* wrapper for pg_query_params for queries in the style of
|
||||||
* wrapperf or pg_query_params for queries in the style of
|
|
||||||
* SELECT foo FROM bar WHERE foobar = $1
|
* SELECT foo FROM bar WHERE foobar = $1
|
||||||
*
|
*
|
||||||
* @param string $query Query string with placeholders $1, ..
|
* @param string $query Query string with placeholders $1, ..
|
||||||
* @param array<mixed> $params Matching parameters for each placerhold
|
* @param array<mixed> $params Matching parameters for each placerhold
|
||||||
* @return object|resource|bool Query result (PgSql\Result)
|
* @return \PgSql\Result|false Query result
|
||||||
*/
|
*/
|
||||||
public function __dbQueryParams(string $query, array $params)
|
public function __dbQueryParams(string $query, array $params): \PgSql\Result|false
|
||||||
{
|
{
|
||||||
$this->last_error_query = '';
|
$this->last_error_query = '';
|
||||||
if ($this->dbh === false || is_bool($this->dbh)) {
|
if (is_bool($this->dbh)) {
|
||||||
return false;
|
return false;
|
||||||
}
|
}
|
||||||
// parse query and get all $n entries
|
// parse query and get all $n entries
|
||||||
@@ -126,22 +129,38 @@ class PgSQL implements \CoreLibs\DB\SQL\SqlInterface\SqlFunctions
|
|||||||
*/
|
*/
|
||||||
public function __dbSendQuery(string $query): bool
|
public function __dbSendQuery(string $query): bool
|
||||||
{
|
{
|
||||||
if ($this->dbh === false || is_bool($this->dbh)) {
|
if (is_bool($this->dbh)) {
|
||||||
return false;
|
return false;
|
||||||
}
|
}
|
||||||
$result = pg_send_query($this->dbh, $query);
|
$result = pg_send_query($this->dbh, $query);
|
||||||
return $result ? true : false;
|
return $result ? true : false;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* sends an async query to the server with params
|
||||||
|
*
|
||||||
|
* @param string $query Query string with placeholders $1, ..
|
||||||
|
* @param array<mixed> $params Matching parameters for each placerhold
|
||||||
|
* @return bool true/false Query sent successful status
|
||||||
|
*/
|
||||||
|
public function __dbSendQueryParams(string $query, array $params): bool
|
||||||
|
{
|
||||||
|
if (is_bool($this->dbh)) {
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
$result = pg_send_query_params($this->dbh, $query, $params);
|
||||||
|
return $result ? true : false;
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* wrapper for pg_get_result
|
* wrapper for pg_get_result
|
||||||
*
|
*
|
||||||
* @return object|resource|bool resource handler or false for error (PgSql\Result)
|
* @return \PgSql\Result|false resource handler or false for error
|
||||||
*/
|
*/
|
||||||
public function __dbGetResult()
|
public function __dbGetResult(): \PgSql\Result|false
|
||||||
{
|
{
|
||||||
$this->last_error_query = '';
|
$this->last_error_query = '';
|
||||||
if ($this->dbh === false || is_bool($this->dbh)) {
|
if (is_bool($this->dbh)) {
|
||||||
return false;
|
return false;
|
||||||
}
|
}
|
||||||
$result = pg_get_result($this->dbh);
|
$result = pg_get_result($this->dbh);
|
||||||
@@ -161,7 +180,7 @@ class PgSQL implements \CoreLibs\DB\SQL\SqlInterface\SqlFunctions
|
|||||||
*/
|
*/
|
||||||
public function __dbClose(): void
|
public function __dbClose(): void
|
||||||
{
|
{
|
||||||
if ($this->dbh === false || is_bool($this->dbh)) {
|
if (is_bool($this->dbh)) {
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
if (pg_connection_status($this->dbh) === PGSQL_CONNECTION_OK) {
|
if (pg_connection_status($this->dbh) === PGSQL_CONNECTION_OK) {
|
||||||
@@ -175,12 +194,12 @@ class PgSQL implements \CoreLibs\DB\SQL\SqlInterface\SqlFunctions
|
|||||||
*
|
*
|
||||||
* @param string $name statement name
|
* @param string $name statement name
|
||||||
* @param string $query query string
|
* @param string $query query string
|
||||||
* @return object|resource|bool prepare statement handler or
|
* @return \PgSql\Result|false prepare statement handler or
|
||||||
* false for error (PgSql\Result)
|
* false for error
|
||||||
*/
|
*/
|
||||||
public function __dbPrepare(string $name, string $query)
|
public function __dbPrepare(string $name, string $query): \PgSql\Result|false
|
||||||
{
|
{
|
||||||
if ($this->dbh === false || is_bool($this->dbh)) {
|
if (is_bool($this->dbh)) {
|
||||||
return false;
|
return false;
|
||||||
}
|
}
|
||||||
$result = pg_prepare($this->dbh, $name, $query);
|
$result = pg_prepare($this->dbh, $name, $query);
|
||||||
@@ -195,11 +214,11 @@ class PgSQL implements \CoreLibs\DB\SQL\SqlInterface\SqlFunctions
|
|||||||
*
|
*
|
||||||
* @param string $name statement name
|
* @param string $name statement name
|
||||||
* @param array<mixed> $data data array
|
* @param array<mixed> $data data array
|
||||||
* @return object|resource|bool returns status or false for error (PgSql\Result)
|
* @return \PgSql\Result|false returns status or false for error
|
||||||
*/
|
*/
|
||||||
public function __dbExecute(string $name, array $data)
|
public function __dbExecute(string $name, array $data): \PgSql\Result|false
|
||||||
{
|
{
|
||||||
if ($this->dbh === false || is_bool($this->dbh)) {
|
if (is_bool($this->dbh)) {
|
||||||
return false;
|
return false;
|
||||||
}
|
}
|
||||||
$result = pg_execute($this->dbh, $name, $data);
|
$result = pg_execute($this->dbh, $name, $data);
|
||||||
@@ -209,15 +228,47 @@ class PgSQL implements \CoreLibs\DB\SQL\SqlInterface\SqlFunctions
|
|||||||
return $result;
|
return $result;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Asnyc send for a prepared statement
|
||||||
|
*
|
||||||
|
* @param string $name
|
||||||
|
* @param string $query
|
||||||
|
* @return bool
|
||||||
|
*/
|
||||||
|
public function __dbSendPrepare(string $name, string $query): bool
|
||||||
|
{
|
||||||
|
if (is_bool($this->dbh)) {
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
$result = pg_send_prepare($this->dbh, $name, $query);
|
||||||
|
return $result ? true : false;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Asnyc ssend for a prepared statement execution
|
||||||
|
*
|
||||||
|
* @param string $name
|
||||||
|
* @param array<mixed> $params
|
||||||
|
* @return bool
|
||||||
|
*/
|
||||||
|
public function __dbSendExecute(string $name, array $params): bool
|
||||||
|
{
|
||||||
|
if (is_bool($this->dbh)) {
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
$result = pg_send_execute($this->dbh, $name, $params);
|
||||||
|
return $result ? true : false;
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* wrapper for pg_num_rows
|
* wrapper for pg_num_rows
|
||||||
*
|
*
|
||||||
* @param object|resource|bool $cursor cursor PgSql\Result (former resource)
|
* @param \PgSql\Result|false $cursor cursor
|
||||||
* @return int number of rows, -1 on error
|
* @return int number of rows, -1 on error
|
||||||
*/
|
*/
|
||||||
public function __dbNumRows($cursor): int
|
public function __dbNumRows(\PgSql\Result|false $cursor): int
|
||||||
{
|
{
|
||||||
if ($cursor === false || is_bool($cursor)) {
|
if (is_bool($cursor)) {
|
||||||
return -1;
|
return -1;
|
||||||
}
|
}
|
||||||
return pg_num_rows($cursor);
|
return pg_num_rows($cursor);
|
||||||
@@ -226,12 +277,12 @@ class PgSQL implements \CoreLibs\DB\SQL\SqlInterface\SqlFunctions
|
|||||||
/**
|
/**
|
||||||
* wrapper for pg_num_fields
|
* wrapper for pg_num_fields
|
||||||
*
|
*
|
||||||
* @param object|resource|bool $cursor cursor PgSql\Result (former resource)
|
* @param \PgSql\Result|false $cursor cursor
|
||||||
* @return int number for fields in result, -1 on error
|
* @return int number for fields in result, -1 on error
|
||||||
*/
|
*/
|
||||||
public function __dbNumFields($cursor): int
|
public function __dbNumFields(\PgSql\Result|false $cursor): int
|
||||||
{
|
{
|
||||||
if ($cursor === false || is_bool($cursor)) {
|
if (is_bool($cursor)) {
|
||||||
return -1;
|
return -1;
|
||||||
}
|
}
|
||||||
return pg_num_fields($cursor);
|
return pg_num_fields($cursor);
|
||||||
@@ -240,29 +291,44 @@ class PgSQL implements \CoreLibs\DB\SQL\SqlInterface\SqlFunctions
|
|||||||
/**
|
/**
|
||||||
* wrapper for pg_field_name
|
* wrapper for pg_field_name
|
||||||
*
|
*
|
||||||
* @param object|resource|bool $cursor cursor PgSql\Result (former resource)
|
* @param \PgSql\Result|false $cursor cursor
|
||||||
* @param int $i field position
|
* @param int $i field position
|
||||||
* @return string|bool name or false on error
|
* @return string|false name or false on error
|
||||||
*/
|
*/
|
||||||
public function __dbFieldName($cursor, int $i)
|
public function __dbFieldName(\PgSql\Result|false $cursor, int $i): string|false
|
||||||
{
|
{
|
||||||
if ($cursor === false || is_bool($cursor)) {
|
if (is_bool($cursor)) {
|
||||||
return false;
|
return false;
|
||||||
}
|
}
|
||||||
return pg_field_name($cursor, $i);
|
return pg_field_name($cursor, $i);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* wrapper for pg_field_name
|
||||||
|
*
|
||||||
|
* @param \PgSql\Result|false $cursor cursor
|
||||||
|
* @param int $i field position
|
||||||
|
* @return string|false field type name or false
|
||||||
|
*/
|
||||||
|
public function __dbFieldType(\PgSql\Result|false $cursor, int $i): string|false
|
||||||
|
{
|
||||||
|
if (is_bool($cursor)) {
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
return pg_field_type($cursor, $i);
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* wrapper for pg_fetch_array
|
* wrapper for pg_fetch_array
|
||||||
* if through/true false, use __dbResultType(true)
|
* if through/true false, use __dbResultType(true)
|
||||||
*
|
*
|
||||||
* @param object|resource|bool $cursor cursor PgSql\Result (former resource)
|
* @param \PgSql\Result|false $cursor cursor
|
||||||
* @param int $result_type result type as int number
|
* @param int $result_type result type as int number
|
||||||
* @return array<mixed>|bool array result data or false on end/error
|
* @return array<mixed>|false array result data or false on end/error
|
||||||
*/
|
*/
|
||||||
public function __dbFetchArray($cursor, int $result_type = PGSQL_BOTH)
|
public function __dbFetchArray(\PgSql\Result|false $cursor, int $result_type = PGSQL_BOTH): array|false
|
||||||
{
|
{
|
||||||
if ($cursor === false || is_bool($cursor)) {
|
if (is_bool($cursor)) {
|
||||||
return false;
|
return false;
|
||||||
}
|
}
|
||||||
// result type is passed on as is [should be checked]
|
// result type is passed on as is [should be checked]
|
||||||
@@ -287,12 +353,12 @@ class PgSQL implements \CoreLibs\DB\SQL\SqlInterface\SqlFunctions
|
|||||||
/**
|
/**
|
||||||
* wrapper for pg_fetch_all
|
* wrapper for pg_fetch_all
|
||||||
*
|
*
|
||||||
* @param object|resource|bool $cursor cursor PgSql\Result (former resource)
|
* @param \PgSql\Result|false $cursor cursor
|
||||||
* @return array<mixed>|bool data array or false for end/error
|
* @return array<mixed>|false data array or false for end/error
|
||||||
*/
|
*/
|
||||||
public function __dbFetchAll($cursor)
|
public function __dbFetchAll(\PgSql\Result|false $cursor): array|false
|
||||||
{
|
{
|
||||||
if ($cursor === false || is_bool($cursor)) {
|
if (is_bool($cursor)) {
|
||||||
return false;
|
return false;
|
||||||
}
|
}
|
||||||
return pg_fetch_all($cursor);
|
return pg_fetch_all($cursor);
|
||||||
@@ -301,12 +367,12 @@ class PgSQL implements \CoreLibs\DB\SQL\SqlInterface\SqlFunctions
|
|||||||
/**
|
/**
|
||||||
* wrapper for pg_affected_rows
|
* wrapper for pg_affected_rows
|
||||||
*
|
*
|
||||||
* @param object|resource|bool $cursor cursor PgSql\Result (former resource)
|
* @param \PgSql\Result|false $cursor cursor
|
||||||
* @return int affected rows, 0 for none, -1 for error
|
* @return int affected rows, 0 for none, -1 for error
|
||||||
*/
|
*/
|
||||||
public function __dbAffectedRows($cursor): int
|
public function __dbAffectedRows(\PgSql\Result|false $cursor): int
|
||||||
{
|
{
|
||||||
if ($cursor === false || is_bool($cursor)) {
|
if (is_bool($cursor)) {
|
||||||
return -1;
|
return -1;
|
||||||
}
|
}
|
||||||
return pg_affected_rows($cursor);
|
return pg_affected_rows($cursor);
|
||||||
@@ -323,7 +389,7 @@ class PgSQL implements \CoreLibs\DB\SQL\SqlInterface\SqlFunctions
|
|||||||
* @param string|null $pk_name primary key name, if '' then auto detect
|
* @param string|null $pk_name primary key name, if '' then auto detect
|
||||||
* @return string|int|false primary key value
|
* @return string|int|false primary key value
|
||||||
*/
|
*/
|
||||||
public function __dbInsertId(string $query, ?string $pk_name)
|
public function __dbInsertId(string $query, ?string $pk_name): string|int|false
|
||||||
{
|
{
|
||||||
// only if an insert has been done
|
// only if an insert has been done
|
||||||
if (preg_match("/^insert /i", $query)) {
|
if (preg_match("/^insert /i", $query)) {
|
||||||
@@ -371,7 +437,7 @@ class PgSQL implements \CoreLibs\DB\SQL\SqlInterface\SqlFunctions
|
|||||||
* @param string $schema optional schema name, '' for default
|
* @param string $schema optional schema name, '' for default
|
||||||
* @return string|bool primary key name or false if not found
|
* @return string|bool primary key name or false if not found
|
||||||
*/
|
*/
|
||||||
public function __dbPrimaryKey(string $table, string $schema = '')
|
public function __dbPrimaryKey(string $table, string $schema = ''): string|bool
|
||||||
{
|
{
|
||||||
if ($table) {
|
if ($table) {
|
||||||
// check if schema set is different from schema given,
|
// check if schema set is different from schema given,
|
||||||
@@ -426,7 +492,7 @@ class PgSQL implements \CoreLibs\DB\SQL\SqlInterface\SqlFunctions
|
|||||||
* @param string $db_name databse name
|
* @param string $db_name databse name
|
||||||
* @param integer $db_port port (int, 5432 is default)
|
* @param integer $db_port port (int, 5432 is default)
|
||||||
* @param string $db_ssl SSL (allow is default)
|
* @param string $db_ssl SSL (allow is default)
|
||||||
* @return object|resource|bool db handler PgSql\Connection or false on error
|
* @return \PgSql\Connection|false db handler or false on error
|
||||||
*/
|
*/
|
||||||
public function __dbConnect(
|
public function __dbConnect(
|
||||||
string $db_host,
|
string $db_host,
|
||||||
@@ -435,7 +501,7 @@ class PgSQL implements \CoreLibs\DB\SQL\SqlInterface\SqlFunctions
|
|||||||
string $db_name,
|
string $db_name,
|
||||||
int $db_port,
|
int $db_port,
|
||||||
string $db_ssl = 'allow'
|
string $db_ssl = 'allow'
|
||||||
) {
|
): \PgSql\Connection|false {
|
||||||
if (empty($db_name)) {
|
if (empty($db_name)) {
|
||||||
return false;
|
return false;
|
||||||
}
|
}
|
||||||
@@ -466,30 +532,51 @@ class PgSQL implements \CoreLibs\DB\SQL\SqlInterface\SqlFunctions
|
|||||||
return $this->dbh;
|
return $this->dbh;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Returns last error for active cursor
|
||||||
|
*
|
||||||
|
* @return array{0:string,1:string} prefix, error string
|
||||||
|
*/
|
||||||
|
public function __dbPrintLastError(): array
|
||||||
|
{
|
||||||
|
if (is_bool($this->dbh)) {
|
||||||
|
return ['', ''];
|
||||||
|
}
|
||||||
|
if (!empty($error_message = pg_last_error($this->dbh))) {
|
||||||
|
return [
|
||||||
|
'-PostgreSQL-Error-Last-',
|
||||||
|
$error_message
|
||||||
|
];
|
||||||
|
}
|
||||||
|
return ['', ''];
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* reads the last error for this cursor and returns
|
* reads the last error for this cursor and returns
|
||||||
* html formatted string with error name
|
* html formatted string with error name
|
||||||
*
|
*
|
||||||
* @param bool|object|resource $cursor cursor PgSql\Result (former resource)
|
* @param \PgSql\Result|false $cursor cursor
|
||||||
* or null
|
* or null
|
||||||
* @return string error string
|
* @return array{0:string,1:string} prefix, error string
|
||||||
*/
|
*/
|
||||||
public function __dbPrintError($cursor = false): string
|
public function __dbPrintError(\PgSql\Result|false $cursor = false): array
|
||||||
{
|
{
|
||||||
if ($this->dbh === false || is_bool($this->dbh)) {
|
if (is_bool($this->dbh)) {
|
||||||
return '';
|
return ['', ''];
|
||||||
}
|
}
|
||||||
// run the query again for the error result here
|
// run the query again for the error result here
|
||||||
if (($cursor === false || is_bool($cursor)) && $this->last_error_query) {
|
if ((is_bool($cursor)) && $this->last_error_query) {
|
||||||
pg_send_query($this->dbh, $this->last_error_query);
|
pg_send_query($this->dbh, $this->last_error_query);
|
||||||
$this->last_error_query = '';
|
$this->last_error_query = '';
|
||||||
$cursor = pg_get_result($this->dbh);
|
$cursor = pg_get_result($this->dbh);
|
||||||
}
|
}
|
||||||
if ($cursor && !is_bool($cursor) && $error_str = pg_result_error($cursor)) {
|
if ($cursor && $error_str = pg_result_error($cursor)) {
|
||||||
return '-PostgreSQL-Error- '
|
return [
|
||||||
. $error_str;
|
'-PostgreSQL-Error-',
|
||||||
|
$error_str
|
||||||
|
];
|
||||||
} else {
|
} else {
|
||||||
return '';
|
return ['', ''];
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -500,9 +587,9 @@ class PgSQL implements \CoreLibs\DB\SQL\SqlInterface\SqlFunctions
|
|||||||
* @param bool $extended show extended info (default true)
|
* @param bool $extended show extended info (default true)
|
||||||
* @return array<mixed>|bool array data for the table info or false on error
|
* @return array<mixed>|bool array data for the table info or false on error
|
||||||
*/
|
*/
|
||||||
public function __dbMetaData(string $table, $extended = true)
|
public function __dbMetaData(string $table, bool $extended = true): array|bool
|
||||||
{
|
{
|
||||||
if ($this->dbh === false || is_bool($this->dbh)) {
|
if (is_bool($this->dbh)) {
|
||||||
return false;
|
return false;
|
||||||
}
|
}
|
||||||
// needs to prefixed with @ or it throws a warning on not existing table
|
// needs to prefixed with @ or it throws a warning on not existing table
|
||||||
@@ -515,9 +602,9 @@ class PgSQL implements \CoreLibs\DB\SQL\SqlInterface\SqlFunctions
|
|||||||
* @param string|int|float|bool $string any string/int/float/bool
|
* @param string|int|float|bool $string any string/int/float/bool
|
||||||
* @return string excaped string
|
* @return string excaped string
|
||||||
*/
|
*/
|
||||||
public function __dbEscapeString($string): string
|
public function __dbEscapeString(string|int|float|bool $string): string
|
||||||
{
|
{
|
||||||
if ($this->dbh === false || is_bool($this->dbh)) {
|
if (is_bool($this->dbh)) {
|
||||||
return '';
|
return '';
|
||||||
}
|
}
|
||||||
return pg_escape_string($this->dbh, (string)$string);
|
return pg_escape_string($this->dbh, (string)$string);
|
||||||
@@ -531,9 +618,9 @@ class PgSQL implements \CoreLibs\DB\SQL\SqlInterface\SqlFunctions
|
|||||||
* @param string|int|float|bool $string any string/int/float/bool
|
* @param string|int|float|bool $string any string/int/float/bool
|
||||||
* @return string excaped string including quites
|
* @return string excaped string including quites
|
||||||
*/
|
*/
|
||||||
public function __dbEscapeLiteral($string): string
|
public function __dbEscapeLiteral(string|int|float|bool $string): string
|
||||||
{
|
{
|
||||||
if ($this->dbh === false || is_bool($this->dbh)) {
|
if (is_bool($this->dbh)) {
|
||||||
return (string)'';
|
return (string)'';
|
||||||
}
|
}
|
||||||
// for phpstan, thinks this is string|false?
|
// for phpstan, thinks this is string|false?
|
||||||
@@ -549,7 +636,7 @@ class PgSQL implements \CoreLibs\DB\SQL\SqlInterface\SqlFunctions
|
|||||||
*/
|
*/
|
||||||
public function __dbEscapeIdentifier(string $string): string
|
public function __dbEscapeIdentifier(string $string): string
|
||||||
{
|
{
|
||||||
if ($this->dbh === false || is_bool($this->dbh)) {
|
if (is_bool($this->dbh)) {
|
||||||
return '';
|
return '';
|
||||||
}
|
}
|
||||||
// for phpstan, thinks this is string|false?
|
// for phpstan, thinks this is string|false?
|
||||||
@@ -564,7 +651,7 @@ class PgSQL implements \CoreLibs\DB\SQL\SqlInterface\SqlFunctions
|
|||||||
*/
|
*/
|
||||||
public function __dbEscapeBytea(string $data): string
|
public function __dbEscapeBytea(string $data): string
|
||||||
{
|
{
|
||||||
if ($this->dbh === false || is_bool($this->dbh)) {
|
if (is_bool($this->dbh)) {
|
||||||
return '';
|
return '';
|
||||||
}
|
}
|
||||||
return pg_escape_bytea($this->dbh, $data);
|
return pg_escape_bytea($this->dbh, $data);
|
||||||
@@ -584,11 +671,12 @@ class PgSQL implements \CoreLibs\DB\SQL\SqlInterface\SqlFunctions
|
|||||||
/**
|
/**
|
||||||
* wrapper for pg_connection_busy
|
* wrapper for pg_connection_busy
|
||||||
*
|
*
|
||||||
* @return bool True if connection is busy, False if not or no db connection at all
|
* @return bool True if connection is busy
|
||||||
|
* False if not or no db connection at all
|
||||||
*/
|
*/
|
||||||
public function __dbConnectionBusy(): bool
|
public function __dbConnectionBusy(): bool
|
||||||
{
|
{
|
||||||
if ($this->dbh === false || is_bool($this->dbh)) {
|
if (is_bool($this->dbh)) {
|
||||||
return false;
|
return false;
|
||||||
}
|
}
|
||||||
return pg_connection_busy($this->dbh);
|
return pg_connection_busy($this->dbh);
|
||||||
@@ -597,13 +685,13 @@ class PgSQL implements \CoreLibs\DB\SQL\SqlInterface\SqlFunctions
|
|||||||
/**
|
/**
|
||||||
* Experimental wrapper with scoket timetout
|
* Experimental wrapper with scoket timetout
|
||||||
*
|
*
|
||||||
* @param integer $timeout_seconds Wait how many seconds on timeout
|
* @param integer $timeout_seconds Wait how many seconds on timeout
|
||||||
* @return boolean True if connection is busy, or false on
|
* @return bool True if connection is busy, or false on
|
||||||
* not busy or no db connection at all
|
* not busy or no db connection at all
|
||||||
*/
|
*/
|
||||||
public function __dbConnectionBusySocketWait(int $timeout_seconds = 3): bool
|
public function __dbConnectionBusySocketWait(int $timeout_seconds = 3): bool
|
||||||
{
|
{
|
||||||
if ($this->dbh === false || is_bool($this->dbh)) {
|
if (is_bool($this->dbh)) {
|
||||||
return false;
|
return false;
|
||||||
}
|
}
|
||||||
$busy = pg_connection_busy($this->dbh);
|
$busy = pg_connection_busy($this->dbh);
|
||||||
@@ -626,14 +714,14 @@ class PgSQL implements \CoreLibs\DB\SQL\SqlInterface\SqlFunctions
|
|||||||
* On default 'version' will be stripped of any space attached info
|
* On default 'version' will be stripped of any space attached info
|
||||||
* eg 13.5 (other info) will return only 13.5
|
* eg 13.5 (other info) will return only 13.5
|
||||||
*
|
*
|
||||||
* @param string $parameter Parameter string to extract from array
|
* @param string $parameter Parameter string to extract from array
|
||||||
* @param boolean $strip If parameter is server strip out on default
|
* @param bool $strip If parameter is server strip out on default
|
||||||
* Set to false to get original string AS is
|
* Set to false to get original string AS is
|
||||||
* @return string The parameter value
|
* @return string The parameter value
|
||||||
*/
|
*/
|
||||||
public function __dbVersionInfo(string $parameter, bool $strip = true): string
|
public function __dbVersionInfo(string $parameter, bool $strip = true): string
|
||||||
{
|
{
|
||||||
if ($this->dbh === false || is_bool($this->dbh)) {
|
if (is_bool($this->dbh)) {
|
||||||
return '';
|
return '';
|
||||||
}
|
}
|
||||||
// extract element
|
// extract element
|
||||||
@@ -655,7 +743,7 @@ class PgSQL implements \CoreLibs\DB\SQL\SqlInterface\SqlFunctions
|
|||||||
*/
|
*/
|
||||||
public function __dbVersionInfoParameterList(): array
|
public function __dbVersionInfoParameterList(): array
|
||||||
{
|
{
|
||||||
if ($this->dbh === false || is_bool($this->dbh)) {
|
if (is_bool($this->dbh)) {
|
||||||
return [];
|
return [];
|
||||||
}
|
}
|
||||||
return array_keys(pg_version($this->dbh));
|
return array_keys(pg_version($this->dbh));
|
||||||
@@ -670,7 +758,7 @@ class PgSQL implements \CoreLibs\DB\SQL\SqlInterface\SqlFunctions
|
|||||||
*/
|
*/
|
||||||
public function __dbVersion(): string
|
public function __dbVersion(): string
|
||||||
{
|
{
|
||||||
if ($this->dbh === false || is_bool($this->dbh)) {
|
if (is_bool($this->dbh)) {
|
||||||
return '';
|
return '';
|
||||||
}
|
}
|
||||||
// array has client, protocol, server, we just return server stripped
|
// array has client, protocol, server, we just return server stripped
|
||||||
@@ -762,9 +850,9 @@ class PgSQL implements \CoreLibs\DB\SQL\SqlInterface\SqlFunctions
|
|||||||
* @param string $parameter Parameter to query
|
* @param string $parameter Parameter to query
|
||||||
* @return string|bool Settings value as string
|
* @return string|bool Settings value as string
|
||||||
*/
|
*/
|
||||||
public function __dbParameter(string $parameter)
|
public function __dbParameter(string $parameter): string|bool
|
||||||
{
|
{
|
||||||
if ($this->dbh === false || is_bool($this->dbh)) {
|
if (is_bool($this->dbh)) {
|
||||||
return false;
|
return false;
|
||||||
}
|
}
|
||||||
if (empty($parameter)) {
|
if (empty($parameter)) {
|
||||||
|
|||||||
@@ -12,9 +12,9 @@ namespace CoreLibs\Debug;
|
|||||||
class FileWriter
|
class FileWriter
|
||||||
{
|
{
|
||||||
/** @var string */
|
/** @var string */
|
||||||
private static $debug_filename = 'debug_file.log'; // where to write output
|
private static string $debug_filename = 'debug_file.log'; // where to write output
|
||||||
/** @var string */
|
/** @var string */
|
||||||
private static $debug_folder;
|
private static string $debug_folder;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Set a debug log folder, if not set BASE+LOG folders are set
|
* Set a debug log folder, if not set BASE+LOG folders are set
|
||||||
@@ -63,7 +63,7 @@ class FileWriter
|
|||||||
*
|
*
|
||||||
* @param string $string string to write to the file
|
* @param string $string string to write to the file
|
||||||
* @param boolean $enter default true, if set adds a linebreak \n at the end
|
* @param boolean $enter default true, if set adds a linebreak \n at the end
|
||||||
* @return bool True for log written, false for not wirrten
|
* @return bool True for log written, false for not written
|
||||||
*/
|
*/
|
||||||
public static function fdebug(string $string, bool $enter = true): bool
|
public static function fdebug(string $string, bool $enter = true): bool
|
||||||
{
|
{
|
||||||
@@ -75,6 +75,11 @@ class FileWriter
|
|||||||
empty(self::$debug_folder) &&
|
empty(self::$debug_folder) &&
|
||||||
defined('BASE') && defined('LOG')
|
defined('BASE') && defined('LOG')
|
||||||
) {
|
) {
|
||||||
|
/** @deprecated Do not use this anymore, define path with festFolder */
|
||||||
|
trigger_error(
|
||||||
|
'fsetFolder must be set first. Setting via LOG_FILE_ID and LOG constants is deprecated',
|
||||||
|
E_USER_DEPRECATED
|
||||||
|
);
|
||||||
self::$debug_folder = BASE . LOG;
|
self::$debug_folder = BASE . LOG;
|
||||||
}
|
}
|
||||||
if (!is_writeable(self::$debug_folder)) {
|
if (!is_writeable(self::$debug_folder)) {
|
||||||
|
|||||||
@@ -1,880 +1,26 @@
|
|||||||
<?php
|
<?php
|
||||||
|
|
||||||
/*
|
/*
|
||||||
* Debug support functions
|
* This is a wrapper placeholder for
|
||||||
*
|
* \CoreLibs\Logging\Logger
|
||||||
* These are if there is any debug to print out at all at the end
|
|
||||||
* debug_output_all - general yes no
|
|
||||||
* It's recommended to use the method "debug_for" to turn on of the array vars
|
|
||||||
* debug_output - turn on for one level (Array)
|
|
||||||
* debug_output_not - turn off for one level (array)
|
|
||||||
*
|
|
||||||
* Print out the debug at thend of the html
|
|
||||||
* echo_output_all
|
|
||||||
* echo_output
|
|
||||||
* echo_output_not
|
|
||||||
*
|
|
||||||
* Write debug to file
|
|
||||||
* print_output_all
|
|
||||||
* print_output
|
|
||||||
* print_output_not
|
|
||||||
*/
|
*/
|
||||||
|
|
||||||
declare(strict_types=1);
|
declare(strict_types=1);
|
||||||
|
|
||||||
namespace CoreLibs\Debug;
|
namespace CoreLibs\Debug;
|
||||||
|
|
||||||
use CoreLibs\Debug\Support;
|
/**
|
||||||
use CoreLibs\Create\Uids;
|
* @deprecated Use \CoreLibs\Logger\Logging
|
||||||
use CoreLibs\Get\System;
|
*/
|
||||||
use CoreLibs\Convert\Html;
|
class Logging extends \CoreLibs\Logging\Logging
|
||||||
|
|
||||||
class Logging
|
|
||||||
{
|
{
|
||||||
// options
|
|
||||||
/** @var array<mixed> */
|
|
||||||
private $options = [];
|
|
||||||
// page and host name
|
|
||||||
/** @var string */
|
|
||||||
private $page_name;
|
|
||||||
/** @var string */
|
|
||||||
private $host_name;
|
|
||||||
/** @var int */
|
|
||||||
private $host_port;
|
|
||||||
// internal error reporting vars
|
|
||||||
/** @var array<mixed> */
|
|
||||||
private $error_msg = []; // the "connection" to the outside errors
|
|
||||||
// debug output prefix
|
|
||||||
/** @var string */
|
|
||||||
private $error_msg_prefix = ''; // prefix to the error string (the class name)
|
|
||||||
// debug flags
|
|
||||||
/** @var array<mixed> */
|
|
||||||
private $debug_output = []; // if this is true, show debug on desconstructor
|
|
||||||
/** @var array<mixed> */
|
|
||||||
private $debug_output_not = [];
|
|
||||||
/** @var bool */
|
|
||||||
private $debug_output_all = false;
|
|
||||||
/** @var array<mixed> */
|
|
||||||
private $echo_output = []; // errors: echo out, default is 1
|
|
||||||
/** @var array<mixed> */
|
|
||||||
private $echo_output_not = [];
|
|
||||||
/** @var bool */
|
|
||||||
private $echo_output_all = false;
|
|
||||||
/** @var array<mixed> */
|
|
||||||
private $print_output = []; // errors: print to file, default is 0
|
|
||||||
/** @var array<mixed> */
|
|
||||||
private $print_output_not = [];
|
|
||||||
/** @var bool */
|
|
||||||
private $print_output_all = false;
|
|
||||||
// debug flags/settings
|
|
||||||
/** @var string */
|
|
||||||
private $running_uid = ''; // unique ID set on class init and used in logging as prefix
|
|
||||||
// log file name
|
|
||||||
/** @var string */
|
|
||||||
private $log_folder = '';
|
|
||||||
/** @var string */
|
|
||||||
private $log_file_name_ext = 'log'; // use this for date rotate
|
|
||||||
/** @var string */
|
|
||||||
private $log_file_name = '';
|
|
||||||
/** @var int */
|
|
||||||
private $log_max_filesize = 0; // set in kilobytes
|
|
||||||
/** @var string */
|
|
||||||
private $log_print_file = 'error_msg##LOGID####LEVEL####CLASS####PAGENAME####DATE##';
|
|
||||||
/** @var string */
|
|
||||||
private $log_file_unique_id; // a unique ID set only once for call derived from this class
|
|
||||||
/** @var string */
|
|
||||||
private $log_file_date = ''; // Y-m-d file in file name
|
|
||||||
/** @var bool */
|
|
||||||
private $log_print_file_date = true; // if set add Y-m-d and do automatic daily rotation
|
|
||||||
/** @var string */
|
|
||||||
private $log_file_id = ''; // a alphanumeric name that has to be set as global definition
|
|
||||||
/** @var bool */
|
|
||||||
private $log_per_level = false; // set, it will split per level (first parameter in debug call)
|
|
||||||
/** @var bool */
|
|
||||||
private $log_per_class = false; // set, will split log per class
|
|
||||||
/** @var bool */
|
|
||||||
private $log_per_page = false; // set, will split log per called file
|
|
||||||
/** @var bool */
|
|
||||||
private $log_per_run = false; // create a new log file per run (time stamp + unique ID)
|
|
||||||
// script running time
|
|
||||||
/** @var float */
|
|
||||||
private $script_starttime;
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Init logger
|
|
||||||
*
|
|
||||||
* global vars that can be used
|
|
||||||
* - BASE
|
|
||||||
* - LOG
|
|
||||||
* - LOG_FILE_ID
|
|
||||||
* options array layout
|
|
||||||
* - log_folder:
|
|
||||||
* - print_file_date:
|
|
||||||
* - file_id:
|
|
||||||
* - unique_id:
|
|
||||||
* - log_per_level:
|
|
||||||
* - log_per_class:
|
|
||||||
* - log_per_page:
|
|
||||||
* - log_per_run:
|
|
||||||
* - debug_all:
|
|
||||||
* - echo_all:
|
|
||||||
* - print_all:
|
|
||||||
* - debug (array):
|
|
||||||
* - echo (array):
|
|
||||||
* - print (array):
|
|
||||||
* - debug_not (array):
|
|
||||||
* - echo_not (array):
|
|
||||||
* - print_not (array):
|
|
||||||
*
|
*
|
||||||
* @param array<mixed> $options Array with settings options
|
* @param array<mixed> $options Array with settings options
|
||||||
*/
|
*/
|
||||||
public function __construct(array $options = [])
|
public function __construct(array $options = [])
|
||||||
{
|
{
|
||||||
// copy the options over
|
parent::__construct($options);
|
||||||
$this->options = $options;
|
|
||||||
// set log folder from options
|
|
||||||
$this->log_folder = $this->options['log_folder'] ?? '';
|
|
||||||
// legacy flow, check must set constants
|
|
||||||
if (empty($this->log_folder) && defined('BASE') && defined('LOG')) {
|
|
||||||
// make sure this is writeable, else skip
|
|
||||||
$this->log_folder = BASE . LOG;
|
|
||||||
}
|
|
||||||
// fallback + notice
|
|
||||||
if (empty($this->log_folder)) {
|
|
||||||
/* trigger_error(
|
|
||||||
'options or constant not set or folder not writable. fallback to: ' . getcwd(),
|
|
||||||
E_USER_NOTICE
|
|
||||||
); */
|
|
||||||
$this->log_folder = getcwd() . DIRECTORY_SEPARATOR;
|
|
||||||
}
|
|
||||||
// if folder is not writeable, abort
|
|
||||||
if (!is_writeable($this->log_folder)) {
|
|
||||||
trigger_error(
|
|
||||||
'Folder: ' . $this->log_folder . ' is not writeable for logging',
|
|
||||||
E_USER_ERROR
|
|
||||||
);
|
|
||||||
}
|
|
||||||
// check if log_folder has a trailing /
|
|
||||||
if (substr($this->log_folder, -1, 1) != DIRECTORY_SEPARATOR) {
|
|
||||||
$this->log_folder .= DIRECTORY_SEPARATOR;
|
|
||||||
}
|
|
||||||
// running time start for script
|
|
||||||
$this->script_starttime = microtime(true);
|
|
||||||
// set per run UID for logging
|
|
||||||
$this->running_uid = Uids::uniqIdShort();
|
|
||||||
// set the page name
|
|
||||||
$this->page_name = System::getPageName();
|
|
||||||
// set host name
|
|
||||||
list($this->host_name , $this->host_port) = System::getHostName();
|
|
||||||
// add port to host name if not port 80
|
|
||||||
if ($this->host_port != 80) {
|
|
||||||
$this->host_name .= ':' . $this->host_port;
|
|
||||||
}
|
|
||||||
|
|
||||||
// can be overridden with basicSetLogFileId later
|
|
||||||
if (!empty($this->options['file_id'])) {
|
|
||||||
$this->setLogId($this->options['file_id']);
|
|
||||||
} elseif (!empty($GLOBALS['LOG_FILE_ID'])) {
|
|
||||||
// legacy flow, should be removed and only set via options
|
|
||||||
$this->setLogId($GLOBALS['LOG_FILE_ID']);
|
|
||||||
// TODO trigger deprecation error
|
|
||||||
// trigger_error(
|
|
||||||
// 'Debug\Logging: Do not use globals LOG_FILE_ID to set log id for Logging',
|
|
||||||
// E_USER_DEPRECATED
|
|
||||||
// );
|
|
||||||
} elseif (defined('LOG_FILE_ID')) {
|
|
||||||
// legacy flow, should be removed and only set via options
|
|
||||||
$this->setLogId(LOG_FILE_ID);
|
|
||||||
// trigger deprecation error
|
|
||||||
// trigger_error(
|
|
||||||
// 'Debug\Logging: Do not use constant LOG_FILE_ID to set log id for Logging',
|
|
||||||
// E_USER_DEPRECATED
|
|
||||||
// );
|
|
||||||
}
|
|
||||||
|
|
||||||
// init the log levels
|
|
||||||
$this->initLogLevels();
|
|
||||||
}
|
|
||||||
|
|
||||||
// *** PRIVATE ***
|
|
||||||
|
|
||||||
/**
|
|
||||||
* init the basic log levels based on global set variables
|
|
||||||
*
|
|
||||||
* @return void
|
|
||||||
*/
|
|
||||||
private function initLogLevels(): void
|
|
||||||
{
|
|
||||||
// if given via parameters, only for all
|
|
||||||
// globals overrule given settings, for one (array), eg $ECHO['db'] = 1;
|
|
||||||
foreach (['debug', 'echo', 'print'] as $type) {
|
|
||||||
// include or exclude (off) from output
|
|
||||||
foreach (['on', 'off'] as $flag) {
|
|
||||||
$in_type = $type;
|
|
||||||
if ($flag == 'off') {
|
|
||||||
$in_type .= '_not';
|
|
||||||
}
|
|
||||||
$up_type = strtoupper($in_type);
|
|
||||||
if (
|
|
||||||
isset($this->options[$in_type]) &&
|
|
||||||
is_array($this->options[$in_type])
|
|
||||||
) {
|
|
||||||
$this->setLogLevel($type, $flag, $this->options[$in_type]);
|
|
||||||
} elseif (
|
|
||||||
isset($GLOBALS[$up_type]) &&
|
|
||||||
is_array($GLOBALS[$up_type])
|
|
||||||
) {
|
|
||||||
// TODO trigger deprecation error
|
|
||||||
$this->setLogLevel($type, $flag, $GLOBALS[$up_type]);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// TODO remove all $GLOBALS call and only use options
|
|
||||||
// all overrule
|
|
||||||
$this->setLogLevelAll(
|
|
||||||
'debug',
|
|
||||||
$this->options['debug_all'] ??
|
|
||||||
// for user login, should be handled outside like globals
|
|
||||||
$_SESSION['DEBUG_ALL'] ??
|
|
||||||
$GLOBALS['DEBUG_ALL'] ??
|
|
||||||
false
|
|
||||||
);
|
|
||||||
$this->setLogLevelAll(
|
|
||||||
'print',
|
|
||||||
$this->options['print_all'] ??
|
|
||||||
// for user login, should be handled outside like globals
|
|
||||||
$_SESSION['DEBUG_ALL'] ??
|
|
||||||
$GLOBALS['PRINT_ALL'] ??
|
|
||||||
false
|
|
||||||
);
|
|
||||||
$this->setLogLevelAll(
|
|
||||||
'echo',
|
|
||||||
$this->options['echo_all'] ??
|
|
||||||
$GLOBALS['ECHO_ALL'] ??
|
|
||||||
false
|
|
||||||
);
|
|
||||||
|
|
||||||
// GLOBAL rules for log writing
|
|
||||||
// add file date is default on
|
|
||||||
$this->setGetLogPrintFileDate(
|
|
||||||
$this->options['print_file_date'] ??
|
|
||||||
$GLOBALS['LOG_PRINT_FILE_DATE'] ??
|
|
||||||
true
|
|
||||||
);
|
|
||||||
// all other logging file name flags are off
|
|
||||||
$this->setLogPer(
|
|
||||||
'level',
|
|
||||||
$this->options['per_level'] ??
|
|
||||||
$GLOBALS['LOG_PER_LEVEL'] ??
|
|
||||||
false
|
|
||||||
);
|
|
||||||
$this->setLogPer(
|
|
||||||
'class',
|
|
||||||
$this->options['per_class'] ??
|
|
||||||
$GLOBALS['LOG_PER_CLASS'] ??
|
|
||||||
false
|
|
||||||
);
|
|
||||||
$this->setLogPer(
|
|
||||||
'page',
|
|
||||||
$this->options['per_page'] ??
|
|
||||||
$GLOBALS['LOG_PER_PAGE'] ??
|
|
||||||
false
|
|
||||||
);
|
|
||||||
$this->setLogPer(
|
|
||||||
'run',
|
|
||||||
$this->options['per_run'] ??
|
|
||||||
$GLOBALS['LOG_PER_RUN'] ??
|
|
||||||
false
|
|
||||||
);
|
|
||||||
// set log per date
|
|
||||||
if ($this->setGetLogPrintFileDate()) {
|
|
||||||
$this->log_file_date = date('Y-m-d');
|
|
||||||
}
|
|
||||||
// set per run ID
|
|
||||||
if ($this->log_per_run) {
|
|
||||||
$this->setLogUniqueId();
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* checks if we have a need to work on certain debug output
|
|
||||||
* Needs debug/echo/print ad target for which of the debug flag groups we check
|
|
||||||
* also needs level string to check in the per level output flag check.
|
|
||||||
* In case we have invalid target it will return false
|
|
||||||
*
|
|
||||||
* @param string $target target group to check debug/echo/print
|
|
||||||
* @param string $level level to check in detailed level flag
|
|
||||||
* @return bool true on access allowed or false on no access
|
|
||||||
*/
|
|
||||||
private function doDebugTrigger(string $target, string $level): bool
|
|
||||||
{
|
|
||||||
$access = false;
|
|
||||||
// check if we do debug, echo or print
|
|
||||||
if (
|
|
||||||
(
|
|
||||||
$this->getLogLevel($target, 'on', $level) ||
|
|
||||||
$this->getLogLevelAll($target)
|
|
||||||
) &&
|
|
||||||
!$this->getLogLevel($target, 'off', $level)
|
|
||||||
) {
|
|
||||||
$access = true;
|
|
||||||
}
|
|
||||||
return $access;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* writes error msg data to file for current level
|
|
||||||
*
|
|
||||||
* @param string $level the level to write
|
|
||||||
* @param string $error_string error string to write
|
|
||||||
* @return bool True if message written, FAlse if not
|
|
||||||
*/
|
|
||||||
private function writeErrorMsg(string $level, string $error_string): bool
|
|
||||||
{
|
|
||||||
// only write if write is requested
|
|
||||||
if (
|
|
||||||
!($this->doDebugTrigger('debug', $level) &&
|
|
||||||
$this->doDebugTrigger('print', $level))
|
|
||||||
) {
|
|
||||||
return false;
|
|
||||||
}
|
|
||||||
|
|
||||||
// init base file path
|
|
||||||
$fn = $this->log_folder . $this->log_print_file . '.' . $this->log_file_name_ext;
|
|
||||||
// log ID prefix settings, if not valid, replace with empty
|
|
||||||
if (!empty($this->log_file_id)) {
|
|
||||||
$rpl_string = '_' . $this->log_file_id;
|
|
||||||
} else {
|
|
||||||
$rpl_string = '';
|
|
||||||
}
|
|
||||||
$fn = str_replace('##LOGID##', $rpl_string, $fn); // log id (like a log file prefix)
|
|
||||||
|
|
||||||
if ($this->log_per_run) {
|
|
||||||
$rpl_string = '_' . $this->log_file_unique_id; // add 8 char unique string
|
|
||||||
} elseif ($this->setGetLogPrintFileDate()) {
|
|
||||||
$rpl_string = '_' . $this->log_file_date; // add date to file
|
|
||||||
} else {
|
|
||||||
$rpl_string = '';
|
|
||||||
}
|
|
||||||
$fn = str_replace('##DATE##', $rpl_string, $fn); // create output filename
|
|
||||||
|
|
||||||
// write per level
|
|
||||||
$rpl_string = !$this->log_per_level ? '' :
|
|
||||||
// normalize level, replace all non alphanumeric characters with -
|
|
||||||
'_' . (
|
|
||||||
// if return is only - then set error string
|
|
||||||
preg_match(
|
|
||||||
"/^-+$/",
|
|
||||||
$level_string = preg_replace("/[^A-Za-z0-9-_]/", '-', $level) ?? ''
|
|
||||||
) ?
|
|
||||||
'INVALID-LEVEL-STRING' :
|
|
||||||
$level_string
|
|
||||||
);
|
|
||||||
$fn = str_replace('##LEVEL##', $rpl_string, $fn); // create output filename
|
|
||||||
// set per class, but don't use get_class as we will only get self
|
|
||||||
$rpl_string = !$this->log_per_class ? '' : '_'
|
|
||||||
// set sub class settings
|
|
||||||
. str_replace('\\', '-', Support::getCallerClass());
|
|
||||||
$fn = str_replace('##CLASS##', $rpl_string, $fn); // create output filename
|
|
||||||
|
|
||||||
// if request to write to one file
|
|
||||||
$rpl_string = !$this->log_per_page ?
|
|
||||||
'' :
|
|
||||||
'_' . System::getPageName(System::NO_EXTENSION);
|
|
||||||
$fn = str_replace('##PAGENAME##', $rpl_string, $fn); // create output filename
|
|
||||||
|
|
||||||
// write to file
|
|
||||||
// first check if max file size is is set and file is bigger
|
|
||||||
if (
|
|
||||||
$this->log_max_filesize > 0 &&
|
|
||||||
((filesize($fn) / 1024) > $this->log_max_filesize)
|
|
||||||
) {
|
|
||||||
// for easy purpose, rename file only to attach timestamp, nur sequence numbering
|
|
||||||
rename($fn, $fn . '.' . date("YmdHis"));
|
|
||||||
}
|
|
||||||
$this->log_file_name = $fn;
|
|
||||||
$fp = fopen($this->log_file_name, 'a');
|
|
||||||
if ($fp !== false) {
|
|
||||||
fwrite($fp, $error_string);
|
|
||||||
fclose($fp);
|
|
||||||
return true;
|
|
||||||
} else {
|
|
||||||
echo "<!-- could not open file: " . $this->log_file_name . " //-->";
|
|
||||||
return false;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// *** PUBLIC ***
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Temporary method to read all class variables for testing purpose
|
|
||||||
*
|
|
||||||
* @param string $name what variable to return
|
|
||||||
* @return mixed can be anything, bool, string, int, array
|
|
||||||
*/
|
|
||||||
public function getSetting(string $name) //:mixed DOES not work with PHP 7.4
|
|
||||||
{
|
|
||||||
// for debug purpose only
|
|
||||||
return $this->{$name};
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* sets the internal log file prefix id
|
|
||||||
* string must be a alphanumeric string
|
|
||||||
* if non valid string is given it returns the previous set one only
|
|
||||||
*
|
|
||||||
* @param string $string log file id string value
|
|
||||||
* @return string returns the set log file id string
|
|
||||||
* @deprecated Use $log->setLogId()
|
|
||||||
*/
|
|
||||||
public function basicSetLogId(string $string): string
|
|
||||||
{
|
|
||||||
return $this->setLogId($string);
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* sets the internal log file prefix id
|
|
||||||
* string must be a alphanumeric string
|
|
||||||
* if non valid string is given it returns the previous set one only
|
|
||||||
*
|
|
||||||
* @param string $string log file id string value
|
|
||||||
* @return string returns the set log file id string
|
|
||||||
*/
|
|
||||||
public function setLogId(string $string): string
|
|
||||||
{
|
|
||||||
if (preg_match("/^[\w\-]+$/", $string)) {
|
|
||||||
$this->log_file_id = $string;
|
|
||||||
}
|
|
||||||
return $this->log_file_id;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* return current set log file id
|
|
||||||
* @return string
|
|
||||||
*/
|
|
||||||
public function getLogId(): string
|
|
||||||
{
|
|
||||||
return $this->log_file_id;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* old name for setLogLevel
|
|
||||||
*
|
|
||||||
* @param string $type debug, echo, print
|
|
||||||
* @param string $flag on/off
|
|
||||||
* array $array of levels to turn on/off debug
|
|
||||||
* @return bool Return false if type or flag is invalid
|
|
||||||
* @deprecated Use setLogLevel
|
|
||||||
*/
|
|
||||||
public function debugFor(string $type, string $flag): bool
|
|
||||||
{
|
|
||||||
/** @phan-suppress-next-line PhanTypeMismatchArgumentReal, PhanParamTooFew @phpstan-ignore-next-line */
|
|
||||||
return $this->setLogLevel(...[func_get_args()]);
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* set log level settings for All types
|
|
||||||
* if invalid type, skip
|
|
||||||
*
|
|
||||||
* @param string $type Type to get: debug, echo, print
|
|
||||||
* @param bool $set True or False
|
|
||||||
* @return bool Return false if type invalid
|
|
||||||
*/
|
|
||||||
public function setLogLevelAll(string $type, bool $set): bool
|
|
||||||
{
|
|
||||||
// skip set if not valid
|
|
||||||
if (!in_array($type, ['debug', 'echo', 'print'])) {
|
|
||||||
return false;
|
|
||||||
}
|
|
||||||
$this->{$type . '_output_all'} = $set;
|
|
||||||
return true;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* get the current log level setting for All level blocks
|
|
||||||
*
|
|
||||||
* @param string $type Type to get: debug, echo, print
|
|
||||||
* @return bool False on failure, or the boolean flag from the all var
|
|
||||||
*/
|
|
||||||
public function getLogLevelAll(string $type): bool
|
|
||||||
{
|
|
||||||
// type check for debug/echo/print
|
|
||||||
if (!in_array($type, ['debug', 'echo', 'print'])) {
|
|
||||||
return false;
|
|
||||||
}
|
|
||||||
return $this->{$type . '_output_all'};
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* passes list of level names, to turn on debug
|
|
||||||
* eg $foo->debugFor('print', 'on', ['LOG', 'DEBUG', 'INFO']);
|
|
||||||
*
|
|
||||||
* @param string $type debug, echo, print
|
|
||||||
* @param string $flag on/off
|
|
||||||
* @param array<mixed> $debug_on Array of levels to turn on/off debug
|
|
||||||
* To turn off a level set 'Level' => false,
|
|
||||||
* If not set, switches to on
|
|
||||||
* @return bool Return false if type or flag invalid
|
|
||||||
* also false if debug array is empty
|
|
||||||
*/
|
|
||||||
public function setLogLevel(string $type, string $flag, array $debug_on): bool
|
|
||||||
{
|
|
||||||
// abort if not valid type
|
|
||||||
if (!in_array($type, ['debug', 'echo', 'print'])) {
|
|
||||||
return false;
|
|
||||||
}
|
|
||||||
// invalid flag type
|
|
||||||
if (!in_array($flag, ['on', 'off'])) {
|
|
||||||
return false;
|
|
||||||
}
|
|
||||||
if (count($debug_on) >= 1) {
|
|
||||||
foreach ($debug_on as $level => $set) {
|
|
||||||
$switch = $type . '_output' . ($flag == 'off' ? '_not' : '');
|
|
||||||
if (!is_bool($set)) {
|
|
||||||
$level = $set;
|
|
||||||
$set = true;
|
|
||||||
}
|
|
||||||
$this->{$switch}[$level] = $set;
|
|
||||||
}
|
|
||||||
} else {
|
|
||||||
return false;
|
|
||||||
}
|
|
||||||
return true;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* return the log level for the array type normal and not (disable)
|
|
||||||
*
|
|
||||||
* @param string $type debug, echo, print
|
|
||||||
* @param string $flag on/off
|
|
||||||
* @param string|null $level if not null then check if this array entry is set
|
|
||||||
* else return false
|
|
||||||
* @return bool|array<mixed> if $level is null, return array, else boolean true/false
|
|
||||||
*/
|
|
||||||
public function getLogLevel(string $type, string $flag, ?string $level = null)
|
|
||||||
{
|
|
||||||
// abort if not valid type
|
|
||||||
if (!in_array($type, ['debug', 'echo', 'print'])) {
|
|
||||||
return false;
|
|
||||||
}
|
|
||||||
// invalid flag type
|
|
||||||
if (!in_array($flag, ['on', 'off'])) {
|
|
||||||
return false;
|
|
||||||
}
|
|
||||||
$switch = $type . '_output' . ($flag == 'off' ? '_not' : '');
|
|
||||||
// log level direct check must be not null or not empty string
|
|
||||||
if (!empty($level)) {
|
|
||||||
return $this->{$switch}[$level] ?? false;
|
|
||||||
}
|
|
||||||
// array
|
|
||||||
return $this->{$switch};
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* set flags for per log level type
|
|
||||||
* - level: set per sub group level
|
|
||||||
* - class: split by class
|
|
||||||
* - page: split per page called
|
|
||||||
* - run: for each run
|
|
||||||
*
|
|
||||||
* @param string $type Type to get: level, class, page, run
|
|
||||||
* @param bool $set True or False
|
|
||||||
* @return bool Return false if type invalid
|
|
||||||
*/
|
|
||||||
public function setLogPer(string $type, bool $set): bool
|
|
||||||
{
|
|
||||||
if (!in_array($type, ['level', 'class', 'page', 'run'])) {
|
|
||||||
return false;
|
|
||||||
}
|
|
||||||
$this->{'log_per_' . $type} = $set;
|
|
||||||
// if per run set unique id
|
|
||||||
if ($type == 'run' && $set == true) {
|
|
||||||
$this->setLogUniqueId();
|
|
||||||
}
|
|
||||||
return true;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* return current set log per flag in bool
|
|
||||||
*
|
|
||||||
* @param string $type Type to get: level, class, page, run
|
|
||||||
* @return bool True of false for turned on or off
|
|
||||||
*/
|
|
||||||
public function getLogPer(string $type): bool
|
|
||||||
{
|
|
||||||
if (!in_array($type, ['level', 'class', 'page', 'run'])) {
|
|
||||||
return false;
|
|
||||||
}
|
|
||||||
return $this->{'log_per_' . $type};
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Sets a unique id based on current date (y/m/d, h:i:s) and a unique id (8 chars)
|
|
||||||
* if override is set to true it will be newly set, else if already set nothing changes
|
|
||||||
*
|
|
||||||
* @param bool $override True to force new set
|
|
||||||
* @return void
|
|
||||||
*/
|
|
||||||
public function setLogUniqueId(bool $override = false): void
|
|
||||||
{
|
|
||||||
if (!$this->log_file_unique_id || $override == true) {
|
|
||||||
$this->log_file_unique_id =
|
|
||||||
date('Y-m-d_His') . '_U_'
|
|
||||||
. substr(hash('sha1', uniqid((string)mt_rand(), true)), 0, 8);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Return current set log file unique id,
|
|
||||||
* empty string for not set
|
|
||||||
*
|
|
||||||
* @return string
|
|
||||||
*/
|
|
||||||
public function getLogUniqueId(): string
|
|
||||||
{
|
|
||||||
return $this->log_file_unique_id;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Set or get the log file date extension flag
|
|
||||||
* if null or empty parameter gets current flag
|
|
||||||
*
|
|
||||||
* @param boolean|null $set Set the date suffix for log files
|
|
||||||
* If set to null return current set
|
|
||||||
* @return boolean Current set flag
|
|
||||||
*/
|
|
||||||
public function setGetLogPrintFileDate(?bool $set = null): bool
|
|
||||||
{
|
|
||||||
if ($set !== null) {
|
|
||||||
$this->log_print_file_date = $set;
|
|
||||||
}
|
|
||||||
return $this->log_print_file_date;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Return current set log file name
|
|
||||||
*
|
|
||||||
* @return string Filename set set after the last time debug was called
|
|
||||||
*/
|
|
||||||
public function getLogFileName(): string
|
|
||||||
{
|
|
||||||
return $this->log_file_name;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* A replacement for the \CoreLibs\Debug\Support::printAr
|
|
||||||
* But this does not wrap it in <pre></pre>
|
|
||||||
* It uses some special code sets so we can convert that to pre flags
|
|
||||||
* for echo output {##HTMLPRE##} ... {##/HTMLPRE##}
|
|
||||||
* Do not use this without using it in a string in debug function
|
|
||||||
*
|
|
||||||
* @param array<mixed> $a Array to format
|
|
||||||
* @return string print_r formated
|
|
||||||
*/
|
|
||||||
public function prAr(array $a): string
|
|
||||||
{
|
|
||||||
return '##HTMLPRE##' . print_r($a, true) . '##/HTMLPRE##';
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Convert bool value to string value
|
|
||||||
*
|
|
||||||
* @param bool $bool Bool value to be transformed
|
|
||||||
* @param string $true Override default string 'true'
|
|
||||||
* @param string $false Override default string 'false'
|
|
||||||
* @return string $true or $false string for true/false bool
|
|
||||||
*/
|
|
||||||
public function prBl(
|
|
||||||
bool $bool,
|
|
||||||
string $true = 'true',
|
|
||||||
string $false = 'false'
|
|
||||||
): string {
|
|
||||||
return $bool ? $true : $false;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* write debug data to error_msg array
|
|
||||||
*
|
|
||||||
* @param string $level id for error message, groups messages together
|
|
||||||
* @param string $string the actual error message
|
|
||||||
* @param bool $strip default on false, if set to true,
|
|
||||||
* all html tags will be stripped and <br> changed to \n
|
|
||||||
* this is only used for debug output
|
|
||||||
* @param string $prefix Attach some block before $string.
|
|
||||||
* Will not be stripped even
|
|
||||||
* when strip is true
|
|
||||||
* if strip is false, recommended to add that to $string
|
|
||||||
* @return bool True if logged, false if not logged
|
|
||||||
*/
|
|
||||||
public function debug(
|
|
||||||
string $level,
|
|
||||||
string $string,
|
|
||||||
bool $strip = false,
|
|
||||||
string $prefix = ''
|
|
||||||
): bool {
|
|
||||||
$status = false;
|
|
||||||
// must be debug on and either echo or print on
|
|
||||||
if (
|
|
||||||
!$this->doDebugTrigger('debug', $level) ||
|
|
||||||
(
|
|
||||||
// if debug is on, either print or echo must be set to on
|
|
||||||
!$this->doDebugTrigger('print', $level) &&
|
|
||||||
!$this->doDebugTrigger('echo', $level)
|
|
||||||
)
|
|
||||||
) {
|
|
||||||
return $status;
|
|
||||||
}
|
|
||||||
// get the last class entry and wrie that
|
|
||||||
$class = Support::getCallerClass();
|
|
||||||
// get timestamp
|
|
||||||
$timestamp = Support::printTime();
|
|
||||||
// same string put for print (no html data inside)
|
|
||||||
// write to file if set
|
|
||||||
$status = $this->writeErrorMsg(
|
|
||||||
$level,
|
|
||||||
'[' . $timestamp . '] '
|
|
||||||
. '[' . $this->host_name . '] '
|
|
||||||
. '[' . System::getPageName(System::FULL_PATH) . '] '
|
|
||||||
. '[' . $this->running_uid . '] '
|
|
||||||
. '{' . $class . '} '
|
|
||||||
. '<' . $level . '> - '
|
|
||||||
// strip the htmlpre special tags if exist
|
|
||||||
. str_replace(
|
|
||||||
['##HTMLPRE##', '##/HTMLPRE##'],
|
|
||||||
'',
|
|
||||||
// if stripping all html, etc is requested, only for write error msg
|
|
||||||
($strip ?
|
|
||||||
// find any <br> and replace them with \n
|
|
||||||
// strip rest of html elements (base only)
|
|
||||||
preg_replace(
|
|
||||||
"/(<\/?)(\w+)([^>]*>)/",
|
|
||||||
'',
|
|
||||||
str_replace('<br>', "\n", $prefix . $string)
|
|
||||||
) :
|
|
||||||
$prefix . $string
|
|
||||||
) ?: ''
|
|
||||||
)
|
|
||||||
. "\n"
|
|
||||||
);
|
|
||||||
// write to error level msg array if there is an echo request
|
|
||||||
if ($this->doDebugTrigger('echo', $level)) {
|
|
||||||
// init if not set
|
|
||||||
if (!isset($this->error_msg[$level])) {
|
|
||||||
$this->error_msg[$level] = [];
|
|
||||||
}
|
|
||||||
// HTML string
|
|
||||||
$this->error_msg[$level][] = '<div>'
|
|
||||||
. '[<span style="font-weight: bold; color: #5e8600;">' . $timestamp . '</span>] '
|
|
||||||
. '[<span style="font-weight: bold; color: #c56c00;">' . $level . '</span>] '
|
|
||||||
. '[<span style="color: #b000ab;">' . $this->host_name . '</span>] '
|
|
||||||
. '[<span style="color: #08b369;">' . $this->page_name . '</span>] '
|
|
||||||
. '[<span style="color: #0062A2;">' . $this->running_uid . '</span>] '
|
|
||||||
. '{<span style="font-style: italic; color: #928100;">' . $class . '</span>} - '
|
|
||||||
// as is prefix, allow HTML
|
|
||||||
. $prefix
|
|
||||||
// we replace special HTMLPRE with <pre> entries
|
|
||||||
. str_replace(
|
|
||||||
['##HTMLPRE##', '##/HTMLPRE##'],
|
|
||||||
['<pre>', '</pre>'],
|
|
||||||
Html::htmlent($string)
|
|
||||||
)
|
|
||||||
. "</div><!--#BR#-->";
|
|
||||||
$status = true;
|
|
||||||
}
|
|
||||||
return $status;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* for ECHO ON only
|
|
||||||
* returns error data as string so it can be echoed out
|
|
||||||
*
|
|
||||||
* @param string $header_prefix prefix string for header
|
|
||||||
* @return string error msg for all levels
|
|
||||||
*/
|
|
||||||
public function printErrorMsg(string $header_prefix = ''): string
|
|
||||||
{
|
|
||||||
$string_output = '';
|
|
||||||
// if not debug && echo on, do not return anything
|
|
||||||
if (
|
|
||||||
!$this->getLogLevelAll('debug') ||
|
|
||||||
!$this->getLogLevelAll('echo')
|
|
||||||
) {
|
|
||||||
return $string_output;
|
|
||||||
}
|
|
||||||
if ($this->error_msg_prefix) {
|
|
||||||
$header_prefix = $this->error_msg_prefix;
|
|
||||||
}
|
|
||||||
$script_end = microtime(true) - $this->script_starttime;
|
|
||||||
foreach ($this->error_msg as $level => $temp_debug_output) {
|
|
||||||
if ($this->doDebugTrigger('debug', $level)) {
|
|
||||||
if ($this->doDebugTrigger('echo', $level)) {
|
|
||||||
$string_output .= '<div style="font-size: 12px;">'
|
|
||||||
. '[<span style="font-style: italic; color: #c56c00;">' . $level . '</span>] '
|
|
||||||
. ($header_prefix ? "<b>**** " . Html::htmlent($header_prefix) . " ****</br>\n" : '')
|
|
||||||
. '</div>'
|
|
||||||
. join('', $temp_debug_output);
|
|
||||||
} // echo it out
|
|
||||||
} // do printout
|
|
||||||
} // for each level
|
|
||||||
// create the output wrapper around
|
|
||||||
// so we have a nice formated output per class
|
|
||||||
if ($string_output) {
|
|
||||||
$string_prefix = '<div style="text-align: left; padding: 5px; font-size: 10px; '
|
|
||||||
. 'font-family: sans-serif; border-top: 1px solid black; '
|
|
||||||
. 'border-bottom: 1px solid black; margin: 10px 0 10px 0; '
|
|
||||||
. 'background-color: white; color: black;">'
|
|
||||||
. '<div style="font-size: 12px;">{<span style="font-style: italic; color: #928100;">'
|
|
||||||
. Support::getCallerClass() . '</span>}</div>';
|
|
||||||
$string_output = $string_prefix . $string_output
|
|
||||||
. '<div><span style="font-style: italic; color: #108db3;">Script Run Time:</span> '
|
|
||||||
. $script_end . '</div>'
|
|
||||||
. '</div>';
|
|
||||||
}
|
|
||||||
// }
|
|
||||||
return $string_output;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* for ECHO ON only
|
|
||||||
* unsests the error message array
|
|
||||||
* can be used if writing is primary to file
|
|
||||||
* if no level given resets all
|
|
||||||
*
|
|
||||||
* @param string $level optional level
|
|
||||||
* @return void has no return
|
|
||||||
*/
|
|
||||||
public function resetErrorMsg(string $level = ''): void
|
|
||||||
{
|
|
||||||
if (!$level) {
|
|
||||||
$this->error_msg = [];
|
|
||||||
} elseif (isset($this->error_msg[$level])) {
|
|
||||||
unset($this->error_msg[$level]);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* for ECHO ON only
|
|
||||||
* Get current error message array
|
|
||||||
*
|
|
||||||
* @return array<mixed> error messages collected
|
|
||||||
*/
|
|
||||||
public function getErrorMsg(): array
|
|
||||||
{
|
|
||||||
return $this->error_msg;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* for ECHO ON only
|
|
||||||
* merges the given error array with the one from this class
|
|
||||||
* only merges visible ones
|
|
||||||
*
|
|
||||||
* @param array<mixed> $error_msg error array
|
|
||||||
* @return void has no return
|
|
||||||
*/
|
|
||||||
public function mergeErrors(array $error_msg = []): void
|
|
||||||
{
|
|
||||||
array_push($this->error_msg, ...$error_msg);
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
911
src/Debug/LoggingLegacy.php
Normal file
911
src/Debug/LoggingLegacy.php
Normal file
@@ -0,0 +1,911 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
/**
|
||||||
|
* THIS IS LEGACY LOGGING AND WILL BE FULLY REMOVED IN FUTURE VERSION.
|
||||||
|
* use \CoreLibs\Logger\Logging instead
|
||||||
|
* for the need to reference old:
|
||||||
|
* use CoreLibs\Debug\LoggingLegacy as Logging;
|
||||||
|
*/
|
||||||
|
|
||||||
|
/*
|
||||||
|
* Debug support functions
|
||||||
|
*
|
||||||
|
* These are if there is any debug to print out at all at the end
|
||||||
|
* debug_output_all - general yes no
|
||||||
|
* It's recommended to use the method "debug_for" to turn on of the array vars
|
||||||
|
* debug_output - turn on for one level (Array)
|
||||||
|
* debug_output_not - turn off for one level (array)
|
||||||
|
*
|
||||||
|
* Print out the debug at thend of the html
|
||||||
|
* echo_output_all
|
||||||
|
* echo_output
|
||||||
|
* echo_output_not
|
||||||
|
*
|
||||||
|
* Write debug to file
|
||||||
|
* print_output_all
|
||||||
|
* print_output
|
||||||
|
* print_output_not
|
||||||
|
*/
|
||||||
|
|
||||||
|
declare(strict_types=1);
|
||||||
|
|
||||||
|
namespace CoreLibs\Debug;
|
||||||
|
|
||||||
|
use CoreLibs\Debug\Support;
|
||||||
|
use CoreLibs\Create\Uids;
|
||||||
|
use CoreLibs\Get\System;
|
||||||
|
use CoreLibs\Convert\Html;
|
||||||
|
|
||||||
|
class LoggingLegacy
|
||||||
|
{
|
||||||
|
// options
|
||||||
|
/** @var array<mixed> */
|
||||||
|
private $options = [];
|
||||||
|
// page and host name
|
||||||
|
/** @var string */
|
||||||
|
private $page_name;
|
||||||
|
/** @var string */
|
||||||
|
private $host_name;
|
||||||
|
/** @var int */
|
||||||
|
private $host_port;
|
||||||
|
// internal error reporting vars
|
||||||
|
/** @var array<mixed> */
|
||||||
|
private $error_msg = []; // the "connection" to the outside errors
|
||||||
|
// debug output prefix
|
||||||
|
/** @var string */
|
||||||
|
private $error_msg_prefix = ''; // prefix to the error string (the class name)
|
||||||
|
|
||||||
|
// debug flags/settings
|
||||||
|
/** @var string */
|
||||||
|
private $running_uid = ''; // unique ID set on class init and used in logging as prefix
|
||||||
|
// log file name
|
||||||
|
/** @var string */
|
||||||
|
private $log_folder = '';
|
||||||
|
/** @var string */
|
||||||
|
private $log_file_name_ext = 'log'; // use this for date rotate
|
||||||
|
/** @var string */
|
||||||
|
private $log_file_name = '';
|
||||||
|
/** @var int */
|
||||||
|
private $log_max_filesize = 0; // set in kilobytes
|
||||||
|
/** @var string */
|
||||||
|
private $log_print_file = 'error_msg{LOGID}{LEVEL}{CLASS}{PAGENAME}{DATE_RUNID}';
|
||||||
|
/** @var string */
|
||||||
|
private $log_file_unique_id; // a unique ID set only once for call derived from this class
|
||||||
|
/** @var string */
|
||||||
|
private $log_file_date = ''; // Y-m-d file in file name
|
||||||
|
/** @var bool */
|
||||||
|
private $log_print_file_date = true; // if set add Y-m-d and do automatic daily rotation
|
||||||
|
/** @var string */
|
||||||
|
private $log_file_id = ''; // a alphanumeric name that has to be set as global definition
|
||||||
|
/** @var bool */
|
||||||
|
private $log_per_level = false; // set, it will split per level (first parameter in debug call)
|
||||||
|
/** @var bool */
|
||||||
|
private $log_per_class = false; // set, will split log per class
|
||||||
|
/** @var bool */
|
||||||
|
private $log_per_page = false; // set, will split log per called file
|
||||||
|
/** @var bool */
|
||||||
|
private $log_per_run = false; // create a new log file per run (time stamp + unique ID)
|
||||||
|
// script running time
|
||||||
|
/** @var float */
|
||||||
|
private $script_starttime;
|
||||||
|
|
||||||
|
/** @var string[] current log levels */
|
||||||
|
private $log_levels = ['debug', 'echo', 'print'];
|
||||||
|
/** @var string[] log group per what for writing to file */
|
||||||
|
private $log_grouping = ['level', 'class', 'page', 'run'];
|
||||||
|
|
||||||
|
// debug flags [they must exist or we get a warning]
|
||||||
|
/** @var array<mixed> */
|
||||||
|
private $debug_output = []; // if this is true, show debug on desconstructor
|
||||||
|
/** @var array<mixed> */
|
||||||
|
private $debug_output_not = [];
|
||||||
|
/** @var bool */
|
||||||
|
private $debug_output_all = false;
|
||||||
|
/** @var array<mixed> */
|
||||||
|
private $echo_output = []; // errors: echo out, default is 1
|
||||||
|
/** @var array<mixed> */
|
||||||
|
private $echo_output_not = [];
|
||||||
|
/** @var bool */
|
||||||
|
private $echo_output_all = false;
|
||||||
|
/** @var array<mixed> */
|
||||||
|
private $print_output = []; // errors: print to file, default is 0
|
||||||
|
/** @var array<mixed> */
|
||||||
|
private $print_output_not = [];
|
||||||
|
/** @var bool */
|
||||||
|
private $print_output_all = false;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Init logger
|
||||||
|
*
|
||||||
|
* global vars that can be used
|
||||||
|
* - BASE
|
||||||
|
* - LOG
|
||||||
|
* - LOG_FILE_ID
|
||||||
|
* options array layout
|
||||||
|
* - log_folder:
|
||||||
|
* - file_id:
|
||||||
|
* - unique_id:
|
||||||
|
* - print_file_date:
|
||||||
|
* - log_per_level:
|
||||||
|
* - log_per_class:
|
||||||
|
* - log_per_page:
|
||||||
|
* - log_per_run:
|
||||||
|
* - debug_all:
|
||||||
|
* - echo_all:
|
||||||
|
* - print_all:
|
||||||
|
* - debug (array):
|
||||||
|
* - echo (array):
|
||||||
|
* - print (array):
|
||||||
|
* - debug_not (array):
|
||||||
|
* - echo_not (array):
|
||||||
|
* - print_not (array):
|
||||||
|
*
|
||||||
|
* @param array<mixed> $options Array with settings options
|
||||||
|
*/
|
||||||
|
public function __construct(array $options = [])
|
||||||
|
{
|
||||||
|
// copy the options over
|
||||||
|
$this->options = $options;
|
||||||
|
// set log folder from options
|
||||||
|
$this->log_folder = $this->options['log_folder'] ?? '';
|
||||||
|
// legacy flow, check must set constants
|
||||||
|
if (empty($this->log_folder) && defined('BASE') && defined('LOG')) {
|
||||||
|
/** @deprecated Do not use this anymore, define path on class load */
|
||||||
|
trigger_error(
|
||||||
|
'options: log_folder must be set. Setting via BASE and LOG constants is deprecated',
|
||||||
|
E_USER_DEPRECATED
|
||||||
|
);
|
||||||
|
// make sure this is writeable, else skip
|
||||||
|
$this->log_folder = BASE . LOG;
|
||||||
|
}
|
||||||
|
// fallback + notice
|
||||||
|
if (empty($this->log_folder)) {
|
||||||
|
/* trigger_error(
|
||||||
|
'options or constant not set or folder not writable. fallback to: ' . getcwd(),
|
||||||
|
E_USER_NOTICE
|
||||||
|
); */
|
||||||
|
$this->log_folder = getcwd() . DIRECTORY_SEPARATOR;
|
||||||
|
}
|
||||||
|
// if folder is not writeable, abort
|
||||||
|
if (!is_writeable($this->log_folder)) {
|
||||||
|
trigger_error(
|
||||||
|
'Folder: ' . $this->log_folder . ' is not writeable for logging',
|
||||||
|
E_USER_ERROR
|
||||||
|
);
|
||||||
|
}
|
||||||
|
// check if log_folder has a trailing /
|
||||||
|
if (substr($this->log_folder, -1, 1) != DIRECTORY_SEPARATOR) {
|
||||||
|
$this->log_folder .= DIRECTORY_SEPARATOR;
|
||||||
|
}
|
||||||
|
// running time start for script
|
||||||
|
$this->script_starttime = microtime(true);
|
||||||
|
// set per run UID for logging
|
||||||
|
$this->running_uid = Uids::uniqIdShort();
|
||||||
|
// set the page name
|
||||||
|
$this->page_name = System::getPageName();
|
||||||
|
// set host name
|
||||||
|
list($this->host_name , $this->host_port) = System::getHostName();
|
||||||
|
// add port to host name if not port 80
|
||||||
|
if ($this->host_port != 80) {
|
||||||
|
$this->host_name .= ':' . $this->host_port;
|
||||||
|
}
|
||||||
|
|
||||||
|
// can be overridden with basicSetLogFileId later
|
||||||
|
if (!empty($this->options['file_id'])) {
|
||||||
|
$this->setLogId($this->options['file_id']);
|
||||||
|
} elseif (!empty($GLOBALS['LOG_FILE_ID'])) {
|
||||||
|
/** @deprecated Do not use this anymore, define file_id on class load */
|
||||||
|
trigger_error(
|
||||||
|
'options: file_id must be set. Setting via LOG_FILE_ID global variable is deprecated',
|
||||||
|
E_USER_DEPRECATED
|
||||||
|
);
|
||||||
|
// legacy flow, should be removed and only set via options
|
||||||
|
$this->setLogId($GLOBALS['LOG_FILE_ID']);
|
||||||
|
// TODO trigger deprecation error
|
||||||
|
// trigger_error(
|
||||||
|
// 'Debug\Logging: Do not use globals LOG_FILE_ID to set log id for Logging',
|
||||||
|
// E_USER_DEPRECATED
|
||||||
|
// );
|
||||||
|
} elseif (defined('LOG_FILE_ID')) {
|
||||||
|
/** @deprecated Do not use this anymore, define file_id on class load */
|
||||||
|
trigger_error(
|
||||||
|
'options: file_id must be set. Setting via LOG_FILE_ID constant is deprecated',
|
||||||
|
E_USER_DEPRECATED
|
||||||
|
);
|
||||||
|
// legacy flow, should be removed and only set via options
|
||||||
|
$this->setLogId((string)LOG_FILE_ID);
|
||||||
|
// trigger deprecation error
|
||||||
|
// trigger_error(
|
||||||
|
// 'Debug\Logging: Do not use constant LOG_FILE_ID to set log id for Logging',
|
||||||
|
// E_USER_DEPRECATED
|
||||||
|
// );
|
||||||
|
}
|
||||||
|
|
||||||
|
// init the log levels
|
||||||
|
$this->initLogLevels();
|
||||||
|
}
|
||||||
|
|
||||||
|
// *** PRIVATE ***
|
||||||
|
|
||||||
|
/**
|
||||||
|
* init the basic log levels based on global set variables
|
||||||
|
*
|
||||||
|
* @return void
|
||||||
|
*/
|
||||||
|
private function initLogLevels(): void
|
||||||
|
{
|
||||||
|
// if given via parameters, only for all
|
||||||
|
// globals overrule given settings, for one (array), eg $ECHO['db'] = 1;
|
||||||
|
foreach ($this->log_levels as $type) {
|
||||||
|
// include or exclude (off) from output
|
||||||
|
foreach (['on', 'off'] as $flag) {
|
||||||
|
$in_type = $type;
|
||||||
|
if ($flag == 'off') {
|
||||||
|
$in_type .= '_not';
|
||||||
|
}
|
||||||
|
$up_type = strtoupper($in_type);
|
||||||
|
if (
|
||||||
|
isset($this->options[$in_type]) &&
|
||||||
|
is_array($this->options[$in_type])
|
||||||
|
) {
|
||||||
|
$this->setLogLevel($type, $flag, $this->options[$in_type]);
|
||||||
|
} elseif (
|
||||||
|
isset($GLOBALS[$up_type]) &&
|
||||||
|
is_array($GLOBALS[$up_type])
|
||||||
|
) {
|
||||||
|
// TODO trigger deprecation error
|
||||||
|
$this->setLogLevel($type, $flag, $GLOBALS[$up_type]);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// TODO remove all $GLOBALS call and only use options
|
||||||
|
// all overrule
|
||||||
|
$this->setLogLevelAll(
|
||||||
|
'debug',
|
||||||
|
$this->options['debug_all'] ??
|
||||||
|
// for user login, should be handled outside like globals
|
||||||
|
$_SESSION['DEBUG_ALL'] ?? // DEPRECATED
|
||||||
|
$GLOBALS['DEBUG_ALL'] ?? // DEPRECATED
|
||||||
|
false
|
||||||
|
);
|
||||||
|
$this->setLogLevelAll(
|
||||||
|
'print',
|
||||||
|
$this->options['print_all'] ??
|
||||||
|
// for user login, should be handled outside like globals
|
||||||
|
$_SESSION['DEBUG_ALL'] ?? // DEPRECATED
|
||||||
|
$GLOBALS['PRINT_ALL'] ?? // DEPRECATED
|
||||||
|
false
|
||||||
|
);
|
||||||
|
$this->setLogLevelAll(
|
||||||
|
'echo',
|
||||||
|
$this->options['echo_all'] ??
|
||||||
|
$GLOBALS['ECHO_ALL'] ?? // DEPRECATED
|
||||||
|
false
|
||||||
|
);
|
||||||
|
|
||||||
|
// GLOBAL rules for log writing
|
||||||
|
// add file date is default on
|
||||||
|
$this->setGetLogPrintFileDate(
|
||||||
|
$this->options['print_file_date'] ??
|
||||||
|
$GLOBALS['LOG_PRINT_FILE_DATE'] ?? // DEPRECATED
|
||||||
|
true
|
||||||
|
);
|
||||||
|
// all other logging file name flags are off
|
||||||
|
$this->setLogPer(
|
||||||
|
'level',
|
||||||
|
$this->options['per_level'] ??
|
||||||
|
$GLOBALS['LOG_PER_LEVEL'] ?? // DEPRECATED
|
||||||
|
false
|
||||||
|
);
|
||||||
|
$this->setLogPer(
|
||||||
|
'class',
|
||||||
|
$this->options['per_class'] ??
|
||||||
|
$GLOBALS['LOG_PER_CLASS'] ?? // DEPRECATED
|
||||||
|
false
|
||||||
|
);
|
||||||
|
$this->setLogPer(
|
||||||
|
'page',
|
||||||
|
$this->options['per_page'] ??
|
||||||
|
$GLOBALS['LOG_PER_PAGE'] ?? // DEPRECATED
|
||||||
|
false
|
||||||
|
);
|
||||||
|
$this->setLogPer(
|
||||||
|
'run',
|
||||||
|
$this->options['per_run'] ??
|
||||||
|
$GLOBALS['LOG_PER_RUN'] ?? // DEPRECATED
|
||||||
|
false
|
||||||
|
);
|
||||||
|
// set log per date
|
||||||
|
if ($this->setGetLogPrintFileDate()) {
|
||||||
|
$this->log_file_date = date('Y-m-d');
|
||||||
|
}
|
||||||
|
// set per run ID
|
||||||
|
if ($this->log_per_run) {
|
||||||
|
$this->setLogUniqueId();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* checks if we have a need to work on certain debug output
|
||||||
|
* Needs debug/echo/print ad target for which of the debug flag groups we check
|
||||||
|
* also needs level string to check in the per level output flag check.
|
||||||
|
* In case we have invalid target it will return false
|
||||||
|
*
|
||||||
|
* @param string $target target group to check debug/echo/print
|
||||||
|
* @param string $level level to check in detailed level flag
|
||||||
|
* @return bool true on access allowed or false on no access
|
||||||
|
*/
|
||||||
|
private function doDebugTrigger(string $target, string $level): bool
|
||||||
|
{
|
||||||
|
$access = false;
|
||||||
|
// check if we do debug, echo or print
|
||||||
|
if (
|
||||||
|
(
|
||||||
|
$this->getLogLevel($target, 'on', $level) ||
|
||||||
|
$this->getLogLevelAll($target)
|
||||||
|
) &&
|
||||||
|
!$this->getLogLevel($target, 'off', $level)
|
||||||
|
) {
|
||||||
|
$access = true;
|
||||||
|
}
|
||||||
|
return $access;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* writes error msg data to file for current level
|
||||||
|
*
|
||||||
|
* @param string $level the level to write
|
||||||
|
* @param string $error_string error string to write
|
||||||
|
* @return bool True if message written, False if not
|
||||||
|
*/
|
||||||
|
private function writeErrorMsg(string $level, string $error_string): bool
|
||||||
|
{
|
||||||
|
// only write if write is requested
|
||||||
|
if (
|
||||||
|
!($this->doDebugTrigger('debug', $level) &&
|
||||||
|
$this->doDebugTrigger('print', $level))
|
||||||
|
) {
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
|
// init base file path
|
||||||
|
$fn = $this->log_folder . $this->log_print_file . '.' . $this->log_file_name_ext;
|
||||||
|
// log ID prefix settings, if not valid, replace with empty
|
||||||
|
if (!empty($this->log_file_id)) {
|
||||||
|
$rpl_string = '_' . $this->log_file_id;
|
||||||
|
} else {
|
||||||
|
$rpl_string = '';
|
||||||
|
}
|
||||||
|
$fn = str_replace('{LOGID}', $rpl_string, $fn); // log id (like a log file prefix)
|
||||||
|
|
||||||
|
// if run id, we auto add ymd, so we ignore the log file date
|
||||||
|
if ($this->log_per_run) {
|
||||||
|
$rpl_string = '_' . $this->log_file_unique_id; // add 8 char unique string
|
||||||
|
} elseif ($this->setGetLogPrintFileDate()) {
|
||||||
|
$rpl_string = '_' . $this->log_file_date; // add date to file
|
||||||
|
} else {
|
||||||
|
$rpl_string = '';
|
||||||
|
}
|
||||||
|
$fn = str_replace('{DATE_RUNID}', $rpl_string, $fn); // create output filename
|
||||||
|
|
||||||
|
// write per level
|
||||||
|
$rpl_string = !$this->log_per_level ? '' :
|
||||||
|
// normalize level, replace all non alphanumeric characters with -
|
||||||
|
'_' . (
|
||||||
|
// if return is only - then set error string
|
||||||
|
preg_match(
|
||||||
|
"/^-+$/",
|
||||||
|
$level_string = preg_replace("/[^A-Za-z0-9-_]/", '-', $level) ?? ''
|
||||||
|
) ?
|
||||||
|
'INVALID-LEVEL-STRING' :
|
||||||
|
$level_string
|
||||||
|
);
|
||||||
|
$fn = str_replace('{LEVEL}', $rpl_string, $fn); // create output filename
|
||||||
|
// set per class, but don't use get_class as we will only get self
|
||||||
|
$rpl_string = !$this->log_per_class ? '' : '_'
|
||||||
|
// set sub class settings
|
||||||
|
. str_replace('\\', '-', Support::getCallerTopLevelClass());
|
||||||
|
$fn = str_replace('{CLASS}', $rpl_string, $fn); // create output filename
|
||||||
|
|
||||||
|
// if request to write to one file
|
||||||
|
$rpl_string = !$this->log_per_page ?
|
||||||
|
'' :
|
||||||
|
'_' . System::getPageName(System::NO_EXTENSION);
|
||||||
|
$fn = str_replace('{PAGENAME}', $rpl_string, $fn); // create output filename
|
||||||
|
|
||||||
|
// write to file
|
||||||
|
// first check if max file size is is set and file is bigger
|
||||||
|
if (
|
||||||
|
$this->log_max_filesize > 0 &&
|
||||||
|
((filesize($fn) / 1024) > $this->log_max_filesize)
|
||||||
|
) {
|
||||||
|
// for easy purpose, rename file only to attach timestamp, nur sequence numbering
|
||||||
|
rename($fn, $fn . '.' . date("YmdHis"));
|
||||||
|
}
|
||||||
|
$this->log_file_name = $fn;
|
||||||
|
$fp = fopen($this->log_file_name, 'a');
|
||||||
|
if ($fp !== false) {
|
||||||
|
fwrite($fp, $error_string);
|
||||||
|
fclose($fp);
|
||||||
|
return true;
|
||||||
|
} else {
|
||||||
|
echo "<!-- could not open file: " . $this->log_file_name . " //-->";
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// *** PUBLIC ***
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Temporary method to read all class variables for testing purpose
|
||||||
|
*
|
||||||
|
* @param string $name what variable to return
|
||||||
|
* @return mixed can be anything, bool, string, int, array
|
||||||
|
*/
|
||||||
|
public function getSetting(string $name): mixed
|
||||||
|
{
|
||||||
|
// for debug purpose only
|
||||||
|
return $this->{$name};
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* sets the internal log file prefix id
|
||||||
|
* string must be a alphanumeric string
|
||||||
|
* if non valid string is given it returns the previous set one only
|
||||||
|
*
|
||||||
|
* @param string $string log file id string value
|
||||||
|
* @return string returns the set log file id string
|
||||||
|
* @deprecated Use $log->setLogId()
|
||||||
|
*/
|
||||||
|
public function basicSetLogId(string $string): string
|
||||||
|
{
|
||||||
|
return $this->setLogId($string);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* sets the internal log file prefix id
|
||||||
|
* string must be a alphanumeric string
|
||||||
|
* if non valid string is given it returns the previous set one only
|
||||||
|
*
|
||||||
|
* @param string $string log file id string value
|
||||||
|
* @return string returns the set log file id string
|
||||||
|
*/
|
||||||
|
public function setLogId(string $string): string
|
||||||
|
{
|
||||||
|
if (preg_match("/^[\w\-]+$/", $string)) {
|
||||||
|
$this->log_file_id = $string;
|
||||||
|
}
|
||||||
|
return $this->log_file_id;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* return current set log file id
|
||||||
|
* @return string
|
||||||
|
*/
|
||||||
|
public function getLogId(): string
|
||||||
|
{
|
||||||
|
return $this->log_file_id;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* old name for setLogLevel
|
||||||
|
*
|
||||||
|
* @param string $type debug, echo, print
|
||||||
|
* @param string $flag on/off
|
||||||
|
* array $array of levels to turn on/off debug
|
||||||
|
* @return bool Return false if type or flag is invalid
|
||||||
|
* @deprecated Use setLogLevel
|
||||||
|
*/
|
||||||
|
public function debugFor(string $type, string $flag): bool
|
||||||
|
{
|
||||||
|
/** @phan-suppress-next-line PhanTypeMismatchArgumentReal, PhanParamTooFew @phpstan-ignore-next-line */
|
||||||
|
return $this->setLogLevel(...[func_get_args()]);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* set log level settings for All types
|
||||||
|
* if invalid type, skip
|
||||||
|
*
|
||||||
|
* @param string $type Type to get: debug, echo, print
|
||||||
|
* @param bool $set True or False
|
||||||
|
* @return bool Return false if type invalid
|
||||||
|
*/
|
||||||
|
public function setLogLevelAll(string $type, bool $set): bool
|
||||||
|
{
|
||||||
|
// skip set if not valid
|
||||||
|
if (!in_array($type, $this->log_levels)) {
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
$this->{$type . '_output_all'} = $set;
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* get the current log level setting for All level blocks
|
||||||
|
*
|
||||||
|
* @param string $type Type to get: debug, echo, print
|
||||||
|
* @return bool False on failure, or the boolean flag from the all var
|
||||||
|
*/
|
||||||
|
public function getLogLevelAll(string $type): bool
|
||||||
|
{
|
||||||
|
// type check for debug/echo/print
|
||||||
|
if (!in_array($type, $this->log_levels)) {
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
return $this->{$type . '_output_all'};
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* passes list of level names, to turn on debug
|
||||||
|
* eg $foo->debugFor('print', 'on', ['LOG', 'DEBUG', 'INFO']);
|
||||||
|
*
|
||||||
|
* @param string $type debug, echo, print
|
||||||
|
* @param string $flag on/off
|
||||||
|
* @param array<mixed> $debug_on Array of levels to turn on/off debug
|
||||||
|
* To turn off a level set 'Level' => false,
|
||||||
|
* If not set, switches to on
|
||||||
|
* @return bool Return false if type or flag invalid
|
||||||
|
* also false if debug array is empty
|
||||||
|
*/
|
||||||
|
public function setLogLevel(string $type, string $flag, array $debug_on): bool
|
||||||
|
{
|
||||||
|
// abort if not valid type
|
||||||
|
if (!in_array($type, $this->log_levels)) {
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
// invalid flag type
|
||||||
|
if (!in_array($flag, ['on', 'off'])) {
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
if (count($debug_on) >= 1) {
|
||||||
|
foreach ($debug_on as $level => $set) {
|
||||||
|
$switch = $type . '_output' . ($flag == 'off' ? '_not' : '');
|
||||||
|
if (!is_bool($set)) {
|
||||||
|
$level = $set;
|
||||||
|
$set = true;
|
||||||
|
}
|
||||||
|
$this->{$switch}[$level] = $set;
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* return the log level for the array type normal and not (disable)
|
||||||
|
*
|
||||||
|
* @param string $type debug, echo, print
|
||||||
|
* @param string $flag on/off
|
||||||
|
* @param string|null $level if not null then check if this array entry is set
|
||||||
|
* else return false
|
||||||
|
* @return array<mixed>|bool if $level is null, return array, else boolean true/false
|
||||||
|
*/
|
||||||
|
public function getLogLevel(string $type, string $flag, ?string $level = null): array|bool
|
||||||
|
{
|
||||||
|
// abort if not valid type
|
||||||
|
if (!in_array($type, $this->log_levels)) {
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
// invalid flag type
|
||||||
|
if (!in_array($flag, ['on', 'off'])) {
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
$switch = $type . '_output' . ($flag == 'off' ? '_not' : '');
|
||||||
|
// log level direct check must be not null or not empty string
|
||||||
|
if (!empty($level)) {
|
||||||
|
return $this->{$switch}[$level] ?? false;
|
||||||
|
}
|
||||||
|
// array
|
||||||
|
return $this->{$switch};
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* set flags for per log level type
|
||||||
|
* - level: set per sub group level
|
||||||
|
* - class: split by class
|
||||||
|
* - page: split per page called
|
||||||
|
* - run: for each run
|
||||||
|
*
|
||||||
|
* @param string $type Type to get: level, class, page, run
|
||||||
|
* @param bool $set True or False
|
||||||
|
* @return bool Return false if type invalid
|
||||||
|
*/
|
||||||
|
public function setLogPer(string $type, bool $set): bool
|
||||||
|
{
|
||||||
|
if (!in_array($type, $this->log_grouping)) {
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
$this->{'log_per_' . $type} = $set;
|
||||||
|
// if per run set unique id
|
||||||
|
if ($type == 'run' && $set == true) {
|
||||||
|
$this->setLogUniqueId();
|
||||||
|
}
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* return current set log per flag in bool
|
||||||
|
*
|
||||||
|
* @param string $type Type to get: level, class, page, run
|
||||||
|
* @return bool True of false for turned on or off
|
||||||
|
*/
|
||||||
|
public function getLogPer(string $type): bool
|
||||||
|
{
|
||||||
|
if (!in_array($type, $this->log_grouping)) {
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
return $this->{'log_per_' . $type};
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Sets a unique id based on current date (y/m/d, h:i:s) and a unique id (8 chars)
|
||||||
|
* if override is set to true it will be newly set, else if already set nothing changes
|
||||||
|
*
|
||||||
|
* @param bool $override True to force new set
|
||||||
|
* @return void
|
||||||
|
*/
|
||||||
|
public function setLogUniqueId(bool $override = false): void
|
||||||
|
{
|
||||||
|
if (!$this->log_file_unique_id || $override == true) {
|
||||||
|
$this->log_file_unique_id =
|
||||||
|
date('Y-m-d_His') . '_U_'
|
||||||
|
. substr(hash('sha1', uniqid((string)mt_rand(), true)), 0, 8);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Return current set log file unique id,
|
||||||
|
* empty string for not set
|
||||||
|
*
|
||||||
|
* @return string
|
||||||
|
*/
|
||||||
|
public function getLogUniqueId(): string
|
||||||
|
{
|
||||||
|
return $this->log_file_unique_id;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Set or get the log file date extension flag
|
||||||
|
* if null or empty parameter gets current flag
|
||||||
|
*
|
||||||
|
* @param boolean|null $set Set the date suffix for log files
|
||||||
|
* If set to null return current set
|
||||||
|
* @return boolean Current set flag
|
||||||
|
*/
|
||||||
|
public function setGetLogPrintFileDate(?bool $set = null): bool
|
||||||
|
{
|
||||||
|
if ($set !== null) {
|
||||||
|
$this->log_print_file_date = $set;
|
||||||
|
}
|
||||||
|
return $this->log_print_file_date;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Return current set log file name
|
||||||
|
*
|
||||||
|
* @return string Filename set set after the last time debug was called
|
||||||
|
*/
|
||||||
|
public function getLogFileName(): string
|
||||||
|
{
|
||||||
|
return $this->log_file_name;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* A replacement for the \CoreLibs\Debug\Support::printAr
|
||||||
|
* But this does not wrap it in <pre></pre>
|
||||||
|
* It uses some special code sets so we can convert that to pre flags
|
||||||
|
* for echo output {##HTMLPRE##} ... {##/HTMLPRE##}
|
||||||
|
* Do not use this without using it in a string in debug function
|
||||||
|
*
|
||||||
|
* @param array<mixed> $a Array to format
|
||||||
|
* @return string print_r formated
|
||||||
|
*/
|
||||||
|
public function prAr(array $a): string
|
||||||
|
{
|
||||||
|
return '##HTMLPRE##' . print_r($a, true) . '##/HTMLPRE##';
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Convert bool value to string value
|
||||||
|
*
|
||||||
|
* @param bool $bool Bool value to be transformed
|
||||||
|
* @param string $true Override default string 'true'
|
||||||
|
* @param string $false Override default string 'false'
|
||||||
|
* @return string $true or $false string for true/false bool
|
||||||
|
*/
|
||||||
|
public function prBl(
|
||||||
|
bool $bool,
|
||||||
|
string $true = 'true',
|
||||||
|
string $false = 'false'
|
||||||
|
): string {
|
||||||
|
return $bool ? $true : $false;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* write debug data to error_msg array
|
||||||
|
*
|
||||||
|
* @param string $level id for error message, groups messages together
|
||||||
|
* @param string $string the actual error message
|
||||||
|
* @param bool $strip default on false, if set to true,
|
||||||
|
* all html tags will be stripped and <br> changed to \n
|
||||||
|
* this is only used for debug output
|
||||||
|
* @param string $prefix Attach some block before $string.
|
||||||
|
* Will not be stripped even
|
||||||
|
* when strip is true
|
||||||
|
* if strip is false, recommended to add that to $string
|
||||||
|
* @return bool True if logged, false if not logged
|
||||||
|
*/
|
||||||
|
public function debug(
|
||||||
|
string $level,
|
||||||
|
string $string,
|
||||||
|
bool $strip = false,
|
||||||
|
string $prefix = ''
|
||||||
|
): bool {
|
||||||
|
$status = false;
|
||||||
|
// must be debug on and either echo or print on
|
||||||
|
if (
|
||||||
|
!$this->doDebugTrigger('debug', $level) ||
|
||||||
|
(
|
||||||
|
// if debug is on, either print or echo must be set to on
|
||||||
|
!$this->doDebugTrigger('print', $level) &&
|
||||||
|
!$this->doDebugTrigger('echo', $level)
|
||||||
|
)
|
||||||
|
) {
|
||||||
|
return $status;
|
||||||
|
}
|
||||||
|
// get the last class entry and wrie that
|
||||||
|
$class = Support::getCallerTopLevelClass();
|
||||||
|
// get timestamp
|
||||||
|
$timestamp = Support::printTime();
|
||||||
|
// same string put for print (no html data inside)
|
||||||
|
// write to file if set
|
||||||
|
$status = $this->writeErrorMsg(
|
||||||
|
$level,
|
||||||
|
'[' . $timestamp . '] '
|
||||||
|
. '[' . $this->host_name . '] '
|
||||||
|
. '[' . System::getPageName(System::FULL_PATH) . '] '
|
||||||
|
. '[' . $this->running_uid . '] '
|
||||||
|
. '{' . $class . '} '
|
||||||
|
. '<' . $level . '> - '
|
||||||
|
// strip the htmlpre special tags if exist
|
||||||
|
. str_replace(
|
||||||
|
['##HTMLPRE##', '##/HTMLPRE##'],
|
||||||
|
'',
|
||||||
|
// if stripping all html, etc is requested, only for write error msg
|
||||||
|
($strip ?
|
||||||
|
// find any <br> and replace them with \n
|
||||||
|
// strip rest of html elements (base only)
|
||||||
|
preg_replace(
|
||||||
|
"/(<\/?)(\w+)([^>]*>)/",
|
||||||
|
'',
|
||||||
|
str_replace('<br>', "\n", $prefix . $string)
|
||||||
|
) :
|
||||||
|
$prefix . $string
|
||||||
|
) ?: ''
|
||||||
|
)
|
||||||
|
. "\n"
|
||||||
|
);
|
||||||
|
// write to error level msg array if there is an echo request
|
||||||
|
if ($this->doDebugTrigger('echo', $level)) {
|
||||||
|
// init if not set
|
||||||
|
if (!isset($this->error_msg[$level])) {
|
||||||
|
$this->error_msg[$level] = [];
|
||||||
|
}
|
||||||
|
// HTML string
|
||||||
|
$this->error_msg[$level][] = '<div>'
|
||||||
|
. '[<span style="font-weight: bold; color: #5e8600;">' . $timestamp . '</span>] '
|
||||||
|
. '[<span style="font-weight: bold; color: #c56c00;">' . $level . '</span>] '
|
||||||
|
. '[<span style="color: #b000ab;">' . $this->host_name . '</span>] '
|
||||||
|
. '[<span style="color: #08b369;">' . $this->page_name . '</span>] '
|
||||||
|
. '[<span style="color: #0062A2;">' . $this->running_uid . '</span>] '
|
||||||
|
. '{<span style="font-style: italic; color: #928100;">' . $class . '</span>} - '
|
||||||
|
// as is prefix, allow HTML
|
||||||
|
. $prefix
|
||||||
|
// we replace special HTMLPRE with <pre> entries
|
||||||
|
. str_replace(
|
||||||
|
['##HTMLPRE##', '##/HTMLPRE##'],
|
||||||
|
['<pre>', '</pre>'],
|
||||||
|
Html::htmlent($string)
|
||||||
|
)
|
||||||
|
. "</div><!--#BR#-->";
|
||||||
|
$status = true;
|
||||||
|
}
|
||||||
|
return $status;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* for ECHO ON only
|
||||||
|
* returns error data as string so it can be echoed out
|
||||||
|
*
|
||||||
|
* @param string $header_prefix prefix string for header
|
||||||
|
* @return string error msg for all levels
|
||||||
|
*/
|
||||||
|
public function printErrorMsg(string $header_prefix = ''): string
|
||||||
|
{
|
||||||
|
$string_output = '';
|
||||||
|
// if not debug && echo on, do not return anything
|
||||||
|
if (
|
||||||
|
!$this->getLogLevelAll('debug') ||
|
||||||
|
!$this->getLogLevelAll('echo')
|
||||||
|
) {
|
||||||
|
return $string_output;
|
||||||
|
}
|
||||||
|
if ($this->error_msg_prefix) {
|
||||||
|
$header_prefix = $this->error_msg_prefix;
|
||||||
|
}
|
||||||
|
$script_end = microtime(true) - $this->script_starttime;
|
||||||
|
foreach ($this->error_msg as $level => $temp_debug_output) {
|
||||||
|
if ($this->doDebugTrigger('debug', $level)) {
|
||||||
|
if ($this->doDebugTrigger('echo', $level)) {
|
||||||
|
$string_output .= '<div style="font-size: 12px;">'
|
||||||
|
. '[<span style="font-style: italic; color: #c56c00;">' . $level . '</span>] '
|
||||||
|
. ($header_prefix ? "<b>**** " . Html::htmlent($header_prefix) . " ****</br>\n" : '')
|
||||||
|
. '</div>'
|
||||||
|
. join('', $temp_debug_output);
|
||||||
|
} // echo it out
|
||||||
|
} // do printout
|
||||||
|
} // for each level
|
||||||
|
// create the output wrapper around
|
||||||
|
// so we have a nice formated output per class
|
||||||
|
if ($string_output) {
|
||||||
|
$string_prefix = '<div style="text-align: left; padding: 5px; font-size: 10px; '
|
||||||
|
. 'font-family: sans-serif; border-top: 1px solid black; '
|
||||||
|
. 'border-bottom: 1px solid black; margin: 10px 0 10px 0; '
|
||||||
|
. 'background-color: white; color: black;">'
|
||||||
|
. '<div style="font-size: 12px;">{<span style="font-style: italic; color: #928100;">'
|
||||||
|
. Support::getCallerTopLevelClass() . '</span>}</div>';
|
||||||
|
$string_output = $string_prefix . $string_output
|
||||||
|
. '<div><span style="font-style: italic; color: #108db3;">Script Run Time:</span> '
|
||||||
|
. $script_end . '</div>'
|
||||||
|
. '</div>';
|
||||||
|
}
|
||||||
|
// }
|
||||||
|
return $string_output;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* for ECHO ON only
|
||||||
|
* unsests the error message array
|
||||||
|
* can be used if writing is primary to file
|
||||||
|
* if no level given resets all
|
||||||
|
*
|
||||||
|
* @param string $level optional level
|
||||||
|
* @return void has no return
|
||||||
|
*/
|
||||||
|
public function resetErrorMsg(string $level = ''): void
|
||||||
|
{
|
||||||
|
if (!$level) {
|
||||||
|
$this->error_msg = [];
|
||||||
|
} elseif (isset($this->error_msg[$level])) {
|
||||||
|
unset($this->error_msg[$level]);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* for ECHO ON only
|
||||||
|
* Get current error message array
|
||||||
|
*
|
||||||
|
* @return array<mixed> error messages collected
|
||||||
|
*/
|
||||||
|
public function getErrorMsg(): array
|
||||||
|
{
|
||||||
|
return $this->error_msg;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* for ECHO ON only
|
||||||
|
* merges the given error array with the one from this class
|
||||||
|
* only merges visible ones
|
||||||
|
*
|
||||||
|
* @param array<mixed> $error_msg error array
|
||||||
|
* @return void has no return
|
||||||
|
*/
|
||||||
|
public function mergeErrors(array $error_msg = []): void
|
||||||
|
{
|
||||||
|
array_push($this->error_msg, ...$error_msg);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// __END__
|
||||||
@@ -13,13 +13,13 @@ use CoreLibs\Convert\Byte;
|
|||||||
class MemoryUsage
|
class MemoryUsage
|
||||||
{
|
{
|
||||||
/** @var int */
|
/** @var int */
|
||||||
private static $start_memory = 0;
|
private static int $start_memory = 0;
|
||||||
/** @var int */
|
/** @var int */
|
||||||
private static $set_memory = 0;
|
private static int $set_memory = 0;
|
||||||
/** @var int */
|
/** @var int */
|
||||||
private static $previous_memory = 0;
|
private static int $previous_memory = 0;
|
||||||
/** @var bool */
|
/** @var bool */
|
||||||
private static $debug_memory = false;
|
private static bool $debug_memory = false;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* set memory flag, or return set memory flag
|
* set memory flag, or return set memory flag
|
||||||
|
|||||||
@@ -12,18 +12,18 @@ class RunningTime
|
|||||||
{
|
{
|
||||||
// hr
|
// hr
|
||||||
/** @var float */
|
/** @var float */
|
||||||
private static $hr_start_time;
|
private static float $hr_start_time;
|
||||||
/** @var float */
|
/** @var float */
|
||||||
private static $hr_end_time;
|
private static float $hr_end_time;
|
||||||
/** @var float */
|
/** @var float */
|
||||||
private static $hr_last_time;
|
private static float $hr_last_time;
|
||||||
// normal
|
// normal
|
||||||
/** @var float */
|
/** @var float */
|
||||||
private static $start_time;
|
private static float $start_time;
|
||||||
/** @var float */
|
/** @var float */
|
||||||
private static $end_time;
|
private static float $end_time;
|
||||||
/** @var string */
|
/** @var string */
|
||||||
private static $running_time_string;
|
private static string $running_time_string;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* sub calculation for running time based on out time.
|
* sub calculation for running time based on out time.
|
||||||
@@ -79,7 +79,7 @@ class RunningTime
|
|||||||
public static function hrRunningTime(string $out_time = 'ms'): float
|
public static function hrRunningTime(string $out_time = 'ms'): float
|
||||||
{
|
{
|
||||||
// if start time not set, set start time
|
// if start time not set, set start time
|
||||||
if (!self::$hr_start_time) {
|
if (empty(self::$hr_start_time)) {
|
||||||
self::$hr_start_time = hrtime(true);
|
self::$hr_start_time = hrtime(true);
|
||||||
self::$hr_last_time = self::$hr_start_time;
|
self::$hr_last_time = self::$hr_start_time;
|
||||||
$run_time = 0;
|
$run_time = 0;
|
||||||
@@ -137,7 +137,7 @@ class RunningTime
|
|||||||
list($micro, $timestamp) = explode(' ', microtime());
|
list($micro, $timestamp) = explode(' ', microtime());
|
||||||
$running_time = 0;
|
$running_time = 0;
|
||||||
// set start & end time
|
// set start & end time
|
||||||
if (!self::$start_time) {
|
if (empty(self::$start_time)) {
|
||||||
// always reset running time string on first call
|
// always reset running time string on first call
|
||||||
self::$running_time_string = '';
|
self::$running_time_string = '';
|
||||||
self::$start_time = ((float)$micro + (float)$timestamp);
|
self::$start_time = ((float)$micro + (float)$timestamp);
|
||||||
@@ -149,7 +149,7 @@ class RunningTime
|
|||||||
self::$running_time_string .= date('Y-m-d H:i:s', (int)$timestamp);
|
self::$running_time_string .= date('Y-m-d H:i:s', (int)$timestamp);
|
||||||
self::$running_time_string .= ' ' . $micro . ($simple ? ', ' : '<br>');
|
self::$running_time_string .= ' ' . $micro . ($simple ? ', ' : '<br>');
|
||||||
// if both are set
|
// if both are set
|
||||||
if (self::$start_time && self::$end_time) {
|
if (!empty(self::$start_time) && !empty(self::$end_time)) {
|
||||||
$running_time = self::$end_time - self::$start_time;
|
$running_time = self::$end_time - self::$start_time;
|
||||||
self::$running_time_string .= ($simple ? 'Run: ' : "<b>Script running time</b>: ") . $running_time . " s";
|
self::$running_time_string .= ($simple ? 'Run: ' : "<b>Script running time</b>: ") . $running_time . " s";
|
||||||
// reset start & end time after run
|
// reset start & end time after run
|
||||||
|
|||||||
@@ -21,7 +21,7 @@ class Support
|
|||||||
*/
|
*/
|
||||||
public static function printTime(int $set_microtime = -1): string
|
public static function printTime(int $set_microtime = -1): string
|
||||||
{
|
{
|
||||||
list($microtime, $timestamp) = explode(' ', microtime());
|
[$microtime, $timestamp] = explode(' ', microtime());
|
||||||
$string = date("Y-m-d H:i:s", (int)$timestamp);
|
$string = date("Y-m-d H:i:s", (int)$timestamp);
|
||||||
// if microtime flag is -1 no round, if 0, no microtime, if >= 1, round that size
|
// if microtime flag is -1 no round, if 0, no microtime, if >= 1, round that size
|
||||||
if ($set_microtime == -1) {
|
if ($set_microtime == -1) {
|
||||||
@@ -34,31 +34,43 @@ class Support
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* prints a html formatted (pre) array
|
* prints a html formatted (pre) data
|
||||||
*
|
*
|
||||||
* @param array<mixed> $array any array
|
* @param mixed $data any data
|
||||||
* @param bool $no_html set to true to use ##HTMLPRE##
|
* @param bool $no_html default add <pre>
|
||||||
* @return string formatted array for output with <pre> tag added
|
* @return string formatted array for output with <pre> tag added
|
||||||
*/
|
*/
|
||||||
public static function printAr(array $array, bool $no_html = false): string
|
public static function printAr(mixed $data, bool $no_html = false): string
|
||||||
{
|
{
|
||||||
if ($no_html === false) {
|
return $no_html ?
|
||||||
return "<pre>" . print_r($array, true) . "</pre>";
|
print_r($data, true) :
|
||||||
} else {
|
'<pre>' . print_r($data, true) . '</pre>';
|
||||||
return '##HTMLPRE##' . print_r($array, true) . '##/HTMLPRE##';
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* alternate name for printAr function
|
* alternate name for printAr function
|
||||||
*
|
*
|
||||||
* @param array<mixed> $array any array
|
* @param mixed $data any array
|
||||||
* @param bool $no_html set to true to use ##HTMLPRE##
|
* @param bool $no_html default add <pre>
|
||||||
* @return string formatted array for output with <pre> tag added
|
* @return string formatted array for output with <pre> tag added
|
||||||
*/
|
*/
|
||||||
public static function printArray(array $array, bool $no_html = false): string
|
public static function printArray(mixed $data, bool $no_html = false): string
|
||||||
{
|
{
|
||||||
return self::printAr($array, $no_html);
|
return self::printAr($data, $no_html);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* A replacement for the \CoreLibs\Debug\Support::printAr
|
||||||
|
* But this does not wrap it in <pre></pre>
|
||||||
|
* Do not use this without using it in a string in debug function
|
||||||
|
* Note: for full data debug dumps use Support::dumpVar()
|
||||||
|
*
|
||||||
|
* @param mixed $data Data to print
|
||||||
|
* @return string print_r formated
|
||||||
|
*/
|
||||||
|
public static function prAr(mixed $data): string
|
||||||
|
{
|
||||||
|
return self::printAr($data, true);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -66,21 +78,42 @@ class Support
|
|||||||
* if $name is set prefix with nae
|
* if $name is set prefix with nae
|
||||||
* default true: true, false: false
|
* default true: true, false: false
|
||||||
*
|
*
|
||||||
* @param bool $bool Variable to convert
|
* @param bool $bool Variable to convert
|
||||||
* @param string $name [default: ''] Prefix name
|
* @param string $name [=''] Prefix name
|
||||||
* @param string $true [default: true] True string
|
* @param string $true [='true'] True string
|
||||||
* @param string $false [default: false] False string
|
* @param string $false [='false'] False string
|
||||||
* @return string String with converted bool text for debug
|
* @param bool $no_html [=false] if true do not print html
|
||||||
|
* @return string String with converted bool text for debug
|
||||||
*/
|
*/
|
||||||
public static function printBool(
|
public static function printBool(
|
||||||
bool $bool,
|
bool $bool,
|
||||||
string $name = '',
|
string $name = '',
|
||||||
string $true = 'true',
|
string $true = 'true',
|
||||||
|
string $false = 'false',
|
||||||
|
bool $no_html = false,
|
||||||
|
): string {
|
||||||
|
return
|
||||||
|
(!empty($name) ?
|
||||||
|
($no_html ?
|
||||||
|
$name : '<b>' . $name . '</b>') . ': '
|
||||||
|
: '')
|
||||||
|
. ($bool ? $true : $false);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Convert bool value to string value. Short name alias for printBool
|
||||||
|
*
|
||||||
|
* @param bool $bool Bool value to be transformed
|
||||||
|
* @param string $true [='true'] Override default string 'true'
|
||||||
|
* @param string $false [=false'] Override default string 'false'
|
||||||
|
* @return string $true or $false string for true/false bool
|
||||||
|
*/
|
||||||
|
public static function prBl(
|
||||||
|
bool $bool,
|
||||||
|
string $true = 'true',
|
||||||
string $false = 'false'
|
string $false = 'false'
|
||||||
): string {
|
): string {
|
||||||
$string = (!empty($name) ? '<b>' . $name . '</b>: ' : '')
|
return self::printBool($bool, '', $true, $false, true);
|
||||||
. ($bool ? $true : $false);
|
|
||||||
return $string;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -89,9 +122,10 @@ class Support
|
|||||||
* if object return get_class
|
* if object return get_class
|
||||||
* for array use printAr function, can be controlled with no_html for
|
* for array use printAr function, can be controlled with no_html for
|
||||||
* Debug\Logging compatible output
|
* Debug\Logging compatible output
|
||||||
|
* Recommended to use Support::dumpVar()
|
||||||
*
|
*
|
||||||
* @param mixed $mixed
|
* @param mixed $mixed
|
||||||
* @param bool $no_html set to true to use ##HTMLPRE##or html escape
|
* @param bool $no_html set to true to strip <pre> tags
|
||||||
* @return string
|
* @return string
|
||||||
*/
|
*/
|
||||||
public static function printToString(mixed $mixed, bool $no_html = false): string
|
public static function printToString(mixed $mixed, bool $no_html = false): string
|
||||||
@@ -120,26 +154,141 @@ class Support
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* if there is a need to find out which parent method called a child method,
|
* Dumps var data and returns it as string
|
||||||
* eg for debugging, this function does this
|
* var_dump based
|
||||||
|
* Recommended debug output
|
||||||
*
|
*
|
||||||
* call this method in the child method and you get the parent function that called
|
* @param mixed $data Anything
|
||||||
* @param int $level debug level, default 1
|
* @param bool $no_html [=false] If true strip all html tags
|
||||||
* @return ?string null or the function that called the function
|
* (for text print)
|
||||||
* where this method is called
|
* @return string A text string
|
||||||
*/
|
*/
|
||||||
public static function getCallerMethod(int $level = 1): ?string
|
public static function dumpVar(
|
||||||
|
mixed $data,
|
||||||
|
bool $no_html = false,
|
||||||
|
): string {
|
||||||
|
// dump data
|
||||||
|
ob_start();
|
||||||
|
var_dump($data);
|
||||||
|
$debug_dump = ob_get_clean() ?: '[FAILED TO GET var_dump() data]';
|
||||||
|
// check if the original caller is dV, if yes, up the caller level for
|
||||||
|
// the file line get by 1, so we get file + pos from the dV call and
|
||||||
|
// not this call
|
||||||
|
$caller_level = 1;
|
||||||
|
$caller_list = self::getCallerMethodList();
|
||||||
|
if ($caller_list[0] == 'dV') {
|
||||||
|
$caller_level = 2;
|
||||||
|
}
|
||||||
|
// we need to strip the string in <small></small that is
|
||||||
|
// "path ... CoreLibs/Debug/Support.php:<number>:
|
||||||
|
// and replace it with the caller methods and location
|
||||||
|
$caller_file_number = self::getCallerFileLine($caller_level);
|
||||||
|
$debug_dump = preg_replace(
|
||||||
|
'|<small>(/.*:\d+:)</small>|',
|
||||||
|
'<small>' . $caller_file_number . ':</small>',
|
||||||
|
$debug_dump
|
||||||
|
) ?? $debug_dump; // in case of failure keep original
|
||||||
|
// if strip is ture, remove all HTML tags and convert any html entities back
|
||||||
|
return $no_html ?
|
||||||
|
str_replace(
|
||||||
|
// things to replace in the string if set
|
||||||
|
['>', '<', ' ', ' '],
|
||||||
|
['>', '<', "\r", "\n"],
|
||||||
|
strip_tags($debug_dump)
|
||||||
|
) :
|
||||||
|
$debug_dump;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* exports (dumps) var, in more printable design, but without detail info
|
||||||
|
*
|
||||||
|
* @param mixed $data Anything
|
||||||
|
* @param bool $no_html [=false] If true true do not add <pre> tags
|
||||||
|
* @return string A text string
|
||||||
|
*/
|
||||||
|
public static function exportVar(mixed $data, bool $no_html = false): string
|
||||||
|
{
|
||||||
|
return $no_html ?
|
||||||
|
var_export($data, true) :
|
||||||
|
'<pre>' . var_export($data, true) . '</pre>';
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Return file name and line number where this was called
|
||||||
|
* One level up
|
||||||
|
*
|
||||||
|
* @param int $level [=1] trace level
|
||||||
|
* @return string|null null or file name:line number
|
||||||
|
*/
|
||||||
|
public static function getCallerFileLine(int $level = 1): ?string
|
||||||
{
|
{
|
||||||
$traces = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS);
|
$traces = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS);
|
||||||
// print \CoreLibs\Debug\Support::printAr($traces);
|
// print \CoreLibs\Debug\Support::printAr($traces);
|
||||||
// We should check from top down if unset?
|
// We should check from top down if unset?
|
||||||
// sets the start point here, and in level two (the sub call) we find this
|
// sets the start point here, and in level two (the sub call) we find this
|
||||||
|
if (isset($traces[$level])) {
|
||||||
|
return ($traces[$level]['file'] ?? $traces[$level]['function'])
|
||||||
|
. ':' . ($traces[$level]['line'] ?? '-');
|
||||||
|
}
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* if there is a need to find out which parent method called a child method,
|
||||||
|
* eg for debugging, this function does this
|
||||||
|
*
|
||||||
|
* call this method in the child method and you get the parent function that called
|
||||||
|
* @param int $level [=1] trace level
|
||||||
|
* @return string|null null or the function that called the function
|
||||||
|
* where this method is called
|
||||||
|
*/
|
||||||
|
public static function getCallerMethod(int $level = 1): ?string
|
||||||
|
{
|
||||||
|
$traces = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS);
|
||||||
|
// print "getCallerMethod:<br>" . \CoreLibs\Debug\Support::printAr($traces);
|
||||||
|
// We should check from top down if unset?
|
||||||
|
// sets the start point here, and in level two (the sub call) we find this
|
||||||
if (isset($traces[$level])) {
|
if (isset($traces[$level])) {
|
||||||
return $traces[$level]['function'];
|
return $traces[$level]['function'];
|
||||||
}
|
}
|
||||||
return null;
|
return null;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* get the class that first called it and skip the base class
|
||||||
|
* Companion method to getCallerMethod
|
||||||
|
*
|
||||||
|
* @param int $level [=1] trace level
|
||||||
|
* @return ?string null if class not found
|
||||||
|
*/
|
||||||
|
public static function getCallerClass(int $level = 1): ?string
|
||||||
|
{
|
||||||
|
$traces = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS);
|
||||||
|
// print "getCallerClass:<br>" . \CoreLibs\Debug\Support::printAr($traces);
|
||||||
|
if (isset($traces[$level])) {
|
||||||
|
return $traces[$level]['class'] ?? null;
|
||||||
|
}
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Returns class and method together
|
||||||
|
*
|
||||||
|
* @param int $level [=1] travel level
|
||||||
|
* @return string|null null if trace level not found, else namespace class and method
|
||||||
|
*/
|
||||||
|
public static function getCallerClassMethod(int $level = 1): ?string
|
||||||
|
{
|
||||||
|
$traces = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS);
|
||||||
|
// print "getCallerClass:<br>" . \CoreLibs\Debug\Support::printAr($traces);
|
||||||
|
if (isset($traces[$level])) {
|
||||||
|
return ($traces[$level]['class'] ?? '-')
|
||||||
|
. ($traces[$level]['type'] ?? '')
|
||||||
|
. $traces[$level]['function'];
|
||||||
|
}
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Returns array with all methods in the call stack in the order so that last
|
* Returns array with all methods in the call stack in the order so that last
|
||||||
* called is last in order
|
* called is last in order
|
||||||
@@ -169,25 +318,21 @@ class Support
|
|||||||
* Is mostly used in debug log statements to get the class where the debug
|
* Is mostly used in debug log statements to get the class where the debug
|
||||||
* was called
|
* was called
|
||||||
* gets top level class
|
* gets top level class
|
||||||
* loops over the debug backtrace until if finds the first class (from the end)
|
* loops over the debug backtrace until if finds the first class (from the end)
|
||||||
*
|
*
|
||||||
* @return string Class name with namespace
|
* @return string Class name with namespace
|
||||||
*/
|
*/
|
||||||
public static function getCallerClass(): string
|
public static function getCallerTopLevelClass(): string
|
||||||
{
|
{
|
||||||
$backtrace = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS);
|
$traces = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS);
|
||||||
// ?? [['class' => get_called_class()]];
|
// print "getCallerClass:<br>" . \CoreLibs\Debug\Support::printAr($traces);
|
||||||
// TODO make sure that this doesn't loop forver
|
|
||||||
$class = null;
|
$class = null;
|
||||||
while ($class === null && count($backtrace) > 0) {
|
// reverse and stop at first set class, this is the top level one
|
||||||
// if current is
|
foreach (array_reverse($traces) as $trace) {
|
||||||
// [function] => debug
|
$class = $trace['class'] ?? null;
|
||||||
// [class] => CoreLibs\Debug\Logging
|
if (!empty($class)) {
|
||||||
// then return
|
break;
|
||||||
// (OUTSIDE) because it was not called from a class method
|
}
|
||||||
// or return file name
|
|
||||||
$get_class = array_pop($backtrace);
|
|
||||||
$class = $get_class['class'] ?? null;
|
|
||||||
}
|
}
|
||||||
// on null or empty return empty string
|
// on null or empty return empty string
|
||||||
return empty($class) ? '' : $class;
|
return empty($class) ? '' : $class;
|
||||||
|
|||||||
@@ -4,6 +4,8 @@ declare(strict_types=1);
|
|||||||
|
|
||||||
namespace CoreLibs\Get;
|
namespace CoreLibs\Get;
|
||||||
|
|
||||||
|
// NOTE: it is recommended to use gullvek\dotenv instead which is a copy of this
|
||||||
|
|
||||||
class DotEnv
|
class DotEnv
|
||||||
{
|
{
|
||||||
/** @var string constant comment char, set to # */
|
/** @var string constant comment char, set to # */
|
||||||
@@ -29,11 +31,17 @@ class DotEnv
|
|||||||
* 1 for file loadable, no data or data already loaded
|
* 1 for file loadable, no data or data already loaded
|
||||||
* 2 for file not readable or open failed
|
* 2 for file not readable or open failed
|
||||||
* 3 for file not found
|
* 3 for file not found
|
||||||
|
* @deprecated Use composer package gullevek\dotenv instead -> \gullevek\dotenv\DotEnv::readEnvFile(...)
|
||||||
*/
|
*/
|
||||||
public static function readEnvFile(
|
public static function readEnvFile(
|
||||||
string $path = __DIR__,
|
string $path = __DIR__,
|
||||||
string $env_file = '.env'
|
string $env_file = '.env'
|
||||||
): int {
|
): int {
|
||||||
|
trigger_error(
|
||||||
|
'\CoreLibs\Get\DotEnv is deprecated in favor for '
|
||||||
|
. 'composer package gullevek\dotenv which is a copy of this',
|
||||||
|
E_USER_DEPRECATED
|
||||||
|
);
|
||||||
// default -1;
|
// default -1;
|
||||||
$status = -1;
|
$status = -1;
|
||||||
$env_file_target = $path . DIRECTORY_SEPARATOR . $env_file;
|
$env_file_target = $path . DIRECTORY_SEPARATOR . $env_file;
|
||||||
|
|||||||
@@ -1,42 +0,0 @@
|
|||||||
<?php
|
|
||||||
|
|
||||||
declare(strict_types=1);
|
|
||||||
|
|
||||||
namespace CoreLibs\Get;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @deprecated use \CoreLibs\Get\DotEnv instead
|
|
||||||
*/
|
|
||||||
class ReadEnvFile
|
|
||||||
{
|
|
||||||
/**
|
|
||||||
* parses .env file
|
|
||||||
*
|
|
||||||
* Rules for .env file
|
|
||||||
* variable is any alphanumeric string followed by = on the same line
|
|
||||||
* content starts with the first non space part
|
|
||||||
* strings can be contained in "
|
|
||||||
* strings MUST be contained in " if they are multiline
|
|
||||||
* if string starts with " it will match until another " is found
|
|
||||||
* anything AFTER " is ignored
|
|
||||||
* if there are two variables with the same name only the first is used
|
|
||||||
* variables are case sensitive
|
|
||||||
*
|
|
||||||
* @param string $path Folder to file, default is __DIR__
|
|
||||||
* @param string $env_file What file to load, default is .env
|
|
||||||
* @return int -1 other error
|
|
||||||
* 0 for success full load
|
|
||||||
* 1 for file loadable, but no data inside
|
|
||||||
* 2 for file not readable or open failed
|
|
||||||
* 3 for file not found
|
|
||||||
* @deprecated Use \CoreLibs\Get\DotEnv::readEnvFile() instead
|
|
||||||
*/
|
|
||||||
public static function readEnvFile(
|
|
||||||
string $path = __DIR__,
|
|
||||||
string $env_file = '.env'
|
|
||||||
): int {
|
|
||||||
return \CoreLibs\Get\DotEnv::readEnvFile($path, $env_file);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// __END__
|
|
||||||
@@ -54,14 +54,15 @@ class System
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* get the host name without the port as given by the SELF var
|
* get the host name without the port as given by the SELF var
|
||||||
|
* if no host name found will set to NOHOST:0
|
||||||
*
|
*
|
||||||
* @return array<mixed> host name/port name
|
* @return array{string,int} host name/port number
|
||||||
*/
|
*/
|
||||||
public static function getHostName(): array
|
public static function getHostName(): array
|
||||||
{
|
{
|
||||||
$host = $_SERVER['HTTP_HOST'] ?? 'NOHOST:NOPORT';
|
$host = $_SERVER['HTTP_HOST'] ?? 'NOHOST:0';
|
||||||
list($host_name, $port) = array_pad(explode(':', $host), 2, self::DEFAULT_PORT);
|
[$host_name, $port] = array_pad(explode(':', $host), 2, self::DEFAULT_PORT);
|
||||||
return [$host_name, $port];
|
return [$host_name, (int)$port];
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
|||||||
@@ -29,9 +29,9 @@ namespace CoreLibs\Language\Core;
|
|||||||
class CachedFileReader extends \CoreLibs\Language\Core\StringReader
|
class CachedFileReader extends \CoreLibs\Language\Core\StringReader
|
||||||
{
|
{
|
||||||
/** @var int */
|
/** @var int */
|
||||||
public $error = 0;
|
public int $error = 0;
|
||||||
/** @var string */
|
/** @var string */
|
||||||
public $fd_str = '';
|
public string $fd_str = '';
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Undocumented function
|
* Undocumented function
|
||||||
|
|||||||
@@ -27,13 +27,13 @@ namespace CoreLibs\Language\Core;
|
|||||||
class FileReader
|
class FileReader
|
||||||
{
|
{
|
||||||
/** @var int */
|
/** @var int */
|
||||||
public $fr_pos;
|
public int $fr_pos;
|
||||||
/** @var resource|bool */
|
/** @var resource|bool */
|
||||||
public $fr_fd;
|
public mixed $fr_fd; // no resource type yet
|
||||||
/** @var int */
|
/** @var int */
|
||||||
public $fr_length;
|
public int $fr_length;
|
||||||
/** @var int */
|
/** @var int */
|
||||||
public $error = 0;
|
public int $error = 0;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* file read constructor
|
* file read constructor
|
||||||
|
|||||||
@@ -41,31 +41,31 @@ class GetTextReader
|
|||||||
{
|
{
|
||||||
// public:
|
// public:
|
||||||
/** @var int */
|
/** @var int */
|
||||||
public $error = 0; // public variable that holds error code (0 if no error)
|
public int $error = 0; // public variable that holds error code (0 if no error)
|
||||||
|
|
||||||
// private:
|
// private:
|
||||||
/** @var int */
|
/** @var int */
|
||||||
private $BYTEORDER = 0; // 0: low endian, 1: big endian
|
private int $BYTEORDER = 0; // 0: low endian, 1: big endian
|
||||||
/** @var FileReader */
|
/** @var FileReader */
|
||||||
private $STREAM;
|
private FileReader $STREAM;
|
||||||
/** @var bool */
|
/** @var bool */
|
||||||
private $short_circuit = false;
|
private bool $short_circuit = false;
|
||||||
/** @var bool */
|
/** @var bool */
|
||||||
private $enable_cache = false;
|
private bool $enable_cache = false;
|
||||||
/** @var int */
|
/** @var int */
|
||||||
private $originals = 0; // offset of original table
|
private int $originals = 0; // offset of original table
|
||||||
/** @var int */
|
/** @var int */
|
||||||
private $translations = 0; // offset of translation table
|
private int $translations = 0; // offset of translation table
|
||||||
/** @var string */
|
/** @var string */
|
||||||
private $pluralheader = ''; // cache header field for plural forms
|
private string $pluralheader = ''; // cache header field for plural forms
|
||||||
/** @var int */
|
/** @var int */
|
||||||
private $total = 0; // total string count
|
private int $total = 0; // total string count
|
||||||
/** @var array<mixed>|null */
|
/** @var array<mixed>|null */
|
||||||
private $table_originals = null; // table for original strings (offsets)
|
private array|null $table_originals = null; // table for original strings (offsets)
|
||||||
/** @var array<mixed>|null */
|
/** @var array<mixed>|null */
|
||||||
private $table_translations = null; // table for translated strings (offsets)
|
private array|null $table_translations = null; // table for translated strings (offsets)
|
||||||
/** @var array<mixed> */
|
/** @var array<mixed> */
|
||||||
private $cache_translations = []; // original -> translation mapping
|
private array $cache_translations = []; // original -> translation mapping
|
||||||
|
|
||||||
/* Methods */
|
/* Methods */
|
||||||
|
|
||||||
@@ -122,7 +122,7 @@ class GetTextReader
|
|||||||
* @param bool $enable_cache Enable or disable caching
|
* @param bool $enable_cache Enable or disable caching
|
||||||
* of strings (default on)
|
* of strings (default on)
|
||||||
*/
|
*/
|
||||||
public function __construct($Reader, bool $enable_cache = true)
|
public function __construct(FileReader|bool $Reader, bool $enable_cache = true)
|
||||||
{
|
{
|
||||||
// If there isn't a StreamReader, turn on short circuit mode.
|
// If there isn't a StreamReader, turn on short circuit mode.
|
||||||
if ((!is_object($Reader) && !$Reader) || (is_object($Reader) && $Reader->error)) {
|
if ((!is_object($Reader) && !$Reader) || (is_object($Reader) && $Reader->error)) {
|
||||||
|
|||||||
@@ -27,9 +27,9 @@ namespace CoreLibs\Language\Core;
|
|||||||
class StringReader
|
class StringReader
|
||||||
{
|
{
|
||||||
/** @var int */
|
/** @var int */
|
||||||
public $sr_pos;
|
public int $sr_pos;
|
||||||
/** @var string */
|
/** @var string */
|
||||||
public $sr_str;
|
public string $sr_str;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* constructor for string reader
|
* constructor for string reader
|
||||||
|
|||||||
@@ -1,127 +0,0 @@
|
|||||||
<?php
|
|
||||||
|
|
||||||
/*
|
|
||||||
* deprecated function calls
|
|
||||||
* Language\Encoding::__mbMimeEncode -> Convert\MimeEncode::__mbMimeEncode
|
|
||||||
* Langauge\Encoding::checkConvertEncoding -> Check\Encoding::checkConvertEncoding
|
|
||||||
* Langauge\Encoding::setErrorChar -> Check\Encoding::setErrorChar
|
|
||||||
* Langauge\Encoding::getErrorChar -> Check\Encoding::getErrorChar
|
|
||||||
* Langauge\Encoding::convertEncoding -> Convert\Encoding::convertEncoding
|
|
||||||
*/
|
|
||||||
|
|
||||||
declare(strict_types=1);
|
|
||||||
|
|
||||||
namespace CoreLibs\Language;
|
|
||||||
|
|
||||||
class Encoding
|
|
||||||
{
|
|
||||||
/**
|
|
||||||
* wrapper function for mb mime convert
|
|
||||||
* for correct conversion with long strings
|
|
||||||
*
|
|
||||||
* @param string $string string to encode
|
|
||||||
* @param string $encoding target encoding
|
|
||||||
* @param string $line_break default line break is \r\n
|
|
||||||
* @return string encoded string
|
|
||||||
* @deprecated Use \CoreLibs\Convert\MimeEncode::__mbMimeEncode();
|
|
||||||
*/
|
|
||||||
public static function __mbMimeEncode(
|
|
||||||
string $string,
|
|
||||||
string $encoding,
|
|
||||||
string $line_break = "\r\n"
|
|
||||||
): string {
|
|
||||||
return \CoreLibs\Convert\MimeEncode::__mbMimeEncode($string, $encoding, $line_break);
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* set error char
|
|
||||||
*
|
|
||||||
* @param string|int|null $string The character to use to represent
|
|
||||||
* error chars
|
|
||||||
* "long" for long, "none" for none
|
|
||||||
* or a valid code point in int
|
|
||||||
* like 0x2234 (8756, ∴)
|
|
||||||
* default character is ? (63)
|
|
||||||
* if null is set then "none"
|
|
||||||
* @return void
|
|
||||||
* @deprecated Use \CoreLibs\Check\Encoding::setErrorChar();
|
|
||||||
*/
|
|
||||||
public static function setErrorChar($string): void
|
|
||||||
{
|
|
||||||
\CoreLibs\Check\Encoding::setErrorChar($string);
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* get the current set error character
|
|
||||||
*
|
|
||||||
* @param bool $return_substitute_func if set to true return the set
|
|
||||||
* character from the php function
|
|
||||||
* directly
|
|
||||||
* @return string|int Set error character
|
|
||||||
* @deprecated Use \CoreLibs\Check\Encoding::getErrorChar();
|
|
||||||
*/
|
|
||||||
public static function getErrorChar(bool $return_substitute_func = false)
|
|
||||||
{
|
|
||||||
return \CoreLibs\Check\Encoding::getErrorChar($return_substitute_func);
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* test if a string can be safely convert between encodings.
|
|
||||||
* mostly utf8 to shift jis
|
|
||||||
* the default compare has a possibility of failure, especially with windows
|
|
||||||
* it is recommended to the following in the script which uses this method:
|
|
||||||
* mb_substitute_character(0x2234);
|
|
||||||
* $class->mb_error_char = '∴';
|
|
||||||
* if check to Shift JIS
|
|
||||||
* if check to ISO-2022-JP
|
|
||||||
* if check to ISO-2022-JP-MS
|
|
||||||
* set three dots (∴) as wrong character for correct convert error detect
|
|
||||||
* (this char is used, because it is one of the least used ones)
|
|
||||||
*
|
|
||||||
* @param string $string string to test
|
|
||||||
* @param string $from_encoding encoding of string to test
|
|
||||||
* @param string $to_encoding target encoding
|
|
||||||
* @return bool|array<string> false if no error or
|
|
||||||
* array with failed characters
|
|
||||||
* @deprecated Use \CoreLibs\Check\Encoding::checkConvertEncoding();
|
|
||||||
*/
|
|
||||||
public static function checkConvertEncoding(
|
|
||||||
string $string,
|
|
||||||
string $from_encoding,
|
|
||||||
string $to_encoding
|
|
||||||
) {
|
|
||||||
return \CoreLibs\Check\Encoding::checkConvertEncoding($string, $from_encoding, $to_encoding);
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* detects the source encoding of the string and if doesn't match
|
|
||||||
* to the given target encoding it convert is
|
|
||||||
* if source encoding is set and auto check is true (default) a second
|
|
||||||
* check is done so that the source string encoding actually matches
|
|
||||||
* will be skipped if source encoding detection is ascii
|
|
||||||
*
|
|
||||||
* @param string $string string to convert
|
|
||||||
* @param string $to_encoding target encoding
|
|
||||||
* @param string $source_encoding optional source encoding, will try to auto detect
|
|
||||||
* @param bool $auto_check default true, if source encoding is set
|
|
||||||
* check that the source is actually matching
|
|
||||||
* to what we sav the source is
|
|
||||||
* @return string encoding converted string
|
|
||||||
* @deprecated Use \CoreLibs\Convert\Encoding::convertEncoding();
|
|
||||||
*/
|
|
||||||
public static function convertEncoding(
|
|
||||||
string $string,
|
|
||||||
string $to_encoding,
|
|
||||||
string $source_encoding = '',
|
|
||||||
bool $auto_check = true
|
|
||||||
): string {
|
|
||||||
return \CoreLibs\Convert\Encoding::convertEncoding(
|
|
||||||
$string,
|
|
||||||
$to_encoding,
|
|
||||||
$source_encoding,
|
|
||||||
$auto_check
|
|
||||||
);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// __END__
|
|
||||||
@@ -14,12 +14,14 @@ class GetLocale
|
|||||||
/**
|
/**
|
||||||
* returns locale, lang, domain, encoding, path
|
* returns locale, lang, domain, encoding, path
|
||||||
* from either parameter set or from sessions/config variables
|
* from either parameter set or from sessions/config variables
|
||||||
|
* NOTE: named constant usage is deprecated and will be removed in future
|
||||||
*
|
*
|
||||||
* @param string|null $locale override auto detect
|
* @param string|null $locale override auto detect
|
||||||
* @param string|null $domain override domain
|
* @param string|null $domain override domain
|
||||||
* @param string|null $encoding override encoding
|
* @param string|null $encoding override encoding
|
||||||
* @param string|null $path override path
|
* @param string|null $path override path
|
||||||
* @return array<string,string> locale, domain, encoding, path
|
* @return array<string,string> locale, domain, encoding, path
|
||||||
|
* @deprecated use GetLocale::setLocaleSession(...) instead
|
||||||
*/
|
*/
|
||||||
public static function setLocale(
|
public static function setLocale(
|
||||||
?string $locale = null,
|
?string $locale = null,
|
||||||
@@ -27,6 +29,10 @@ class GetLocale
|
|||||||
?string $encoding = null,
|
?string $encoding = null,
|
||||||
?string $path = null
|
?string $path = null
|
||||||
): array {
|
): array {
|
||||||
|
trigger_error(
|
||||||
|
'Use \CoreLibs\Language\GetLocale::setLocaleSession(...) instead',
|
||||||
|
E_USER_DEPRECATED
|
||||||
|
);
|
||||||
// locale must match at least basic rules
|
// locale must match at least basic rules
|
||||||
if (
|
if (
|
||||||
empty($locale) ||
|
empty($locale) ||
|
||||||
@@ -36,6 +42,10 @@ class GetLocale
|
|||||||
// parse from session (logged in)
|
// parse from session (logged in)
|
||||||
$locale = $_SESSION['DEFAULT_LOCALE'];
|
$locale = $_SESSION['DEFAULT_LOCALE'];
|
||||||
} else {
|
} else {
|
||||||
|
trigger_error(
|
||||||
|
'setLocale: Unset $locale or unset SESSION locale is deprecated',
|
||||||
|
E_USER_DEPRECATED
|
||||||
|
);
|
||||||
// else parse from site locale
|
// else parse from site locale
|
||||||
$locale = defined('SITE_LOCALE') && !empty(SITE_LOCALE) ?
|
$locale = defined('SITE_LOCALE') && !empty(SITE_LOCALE) ?
|
||||||
SITE_LOCALE :
|
SITE_LOCALE :
|
||||||
@@ -50,8 +60,16 @@ class GetLocale
|
|||||||
empty($domain) ||
|
empty($domain) ||
|
||||||
!preg_match("/^\w+$/", $domain)
|
!preg_match("/^\w+$/", $domain)
|
||||||
) {
|
) {
|
||||||
// if no domain is set, fall back to content path
|
if (!empty($_SESSION['DEFAULT_DOMAIN'])) {
|
||||||
$domain = str_replace('/', '', CONTENT_PATH);
|
$domain = $_SESSION['DEFAULT_DOMAIN'];
|
||||||
|
} else {
|
||||||
|
trigger_error(
|
||||||
|
'setLocale: Unset $domain is deprecated',
|
||||||
|
E_USER_DEPRECATED
|
||||||
|
);
|
||||||
|
// if no domain is set, fall back to content path
|
||||||
|
$domain = str_replace(DIRECTORY_SEPARATOR, '', CONTENT_PATH);
|
||||||
|
}
|
||||||
}
|
}
|
||||||
// check that override encoding matches locale encoding
|
// check that override encoding matches locale encoding
|
||||||
// if locale encoding is set
|
// if locale encoding is set
|
||||||
@@ -71,6 +89,10 @@ class GetLocale
|
|||||||
// else set from session
|
// else set from session
|
||||||
$encoding = $_SESSION['DEFAULT_CHARSET'];
|
$encoding = $_SESSION['DEFAULT_CHARSET'];
|
||||||
} else {
|
} else {
|
||||||
|
trigger_error(
|
||||||
|
'setLocale: Short $locale with unset $encoding or unset SESSION encoding is deprecated',
|
||||||
|
E_USER_DEPRECATED
|
||||||
|
);
|
||||||
// else set from site encoding
|
// else set from site encoding
|
||||||
$encoding = defined('SITE_ENCODING') && !empty(SITE_ENCODING) ?
|
$encoding = defined('SITE_ENCODING') && !empty(SITE_ENCODING) ?
|
||||||
SITE_ENCODING :
|
SITE_ENCODING :
|
||||||
@@ -85,7 +107,15 @@ class GetLocale
|
|||||||
empty($path) ||
|
empty($path) ||
|
||||||
!is_dir($path)
|
!is_dir($path)
|
||||||
) {
|
) {
|
||||||
$path = BASE . INCLUDES . LOCALE;
|
if (!empty($_SESSION['LOCALE_PATH'])) {
|
||||||
|
$path = $_SESSION['LOCALE_PATH'];
|
||||||
|
} else {
|
||||||
|
trigger_error(
|
||||||
|
'setLocale: Unset $path is deprecated',
|
||||||
|
E_USER_DEPRECATED
|
||||||
|
);
|
||||||
|
$path = BASE . INCLUDES . LOCALE;
|
||||||
|
}
|
||||||
}
|
}
|
||||||
// extract lang & country from locale string, else set to en
|
// extract lang & country from locale string, else set to en
|
||||||
if (
|
if (
|
||||||
@@ -112,6 +142,113 @@ class GetLocale
|
|||||||
'path' => $path,
|
'path' => $path,
|
||||||
];
|
];
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* NOTE: For getting the login info via login class use ->loginGetLocale()
|
||||||
|
*
|
||||||
|
* Set locale from session or from override parameters
|
||||||
|
* This is the prefered version to setLocale
|
||||||
|
* It usese the following SESSION VARIABLES
|
||||||
|
* DEFAULT_LOCALE
|
||||||
|
* DEFAULT_DOMAIN
|
||||||
|
* DEFAULT_CHARSET (should be set from DEFAULT_LOCALE)
|
||||||
|
* LOCALE_PATH
|
||||||
|
* in the return array, null set invalid information
|
||||||
|
*
|
||||||
|
* @param string $locale override locale
|
||||||
|
* @param string $domain override domain
|
||||||
|
* @param string $encoding override encoding
|
||||||
|
* @param string $path override path
|
||||||
|
* @return array<string,string> locale, domain, encoding, path
|
||||||
|
* @return array<string,string|null> Return list of set locale information
|
||||||
|
* @deprecated This version will be removed in a future version use ACL\Login->loginGetLocale() instead
|
||||||
|
*/
|
||||||
|
public static function setLocaleFromSession(
|
||||||
|
string $locale,
|
||||||
|
string $domain,
|
||||||
|
string $encoding,
|
||||||
|
string $path
|
||||||
|
): array {
|
||||||
|
// locale must match at least basic rules
|
||||||
|
if (
|
||||||
|
!empty($_SESSION['DEFAULT_LOCALE']) &&
|
||||||
|
preg_match("/^[-A-Za-z0-9_.@]+$/", $_SESSION['DEFAULT_LOCALE'])
|
||||||
|
) {
|
||||||
|
// parse from session (logged in)
|
||||||
|
$locale = $_SESSION['DEFAULT_LOCALE'];
|
||||||
|
} elseif (
|
||||||
|
empty($locale) ||
|
||||||
|
!preg_match("/^[-A-Za-z0-9_.@]+$/", $locale)
|
||||||
|
) {
|
||||||
|
$locale = null;
|
||||||
|
}
|
||||||
|
// if domain is set, must be alphanumeric, if not unset
|
||||||
|
if (
|
||||||
|
!empty($_SESSION['DEFAULT_DOMAIN']) &&
|
||||||
|
preg_match("/^\w+$/", $_SESSION['DEFAULT_DOMAIN'])
|
||||||
|
) {
|
||||||
|
$domain = $_SESSION['DEFAULT_DOMAIN'];
|
||||||
|
} elseif (
|
||||||
|
empty($domain) ||
|
||||||
|
!preg_match("/^\w+$/", $domain)
|
||||||
|
) {
|
||||||
|
$domain = null;
|
||||||
|
}
|
||||||
|
// check that override encoding matches locale encoding
|
||||||
|
// if locale encoding is set
|
||||||
|
preg_match('/(?:\\.(?P<charset>[-A-Za-z0-9_]+))/', $locale ?? '', $matches);
|
||||||
|
$locale_encoding = $matches['charset'] ?? null;
|
||||||
|
if (!empty($locale_encoding)) {
|
||||||
|
$encoding = strtoupper($locale_encoding);
|
||||||
|
} elseif (
|
||||||
|
!empty($_SESSION['DEFAULT_CHARSET']) &&
|
||||||
|
preg_match("/^[-A-Za-z0-9_]+$/", $_SESSION['DEFAULT_CHARSET'])
|
||||||
|
) {
|
||||||
|
$encoding = $_SESSION['DEFAULT_CHARSET'];
|
||||||
|
} elseif (
|
||||||
|
empty($encoding) ||
|
||||||
|
// not valid encoding
|
||||||
|
!preg_match("/^[-A-Za-z0-9_]+$/", $encoding)
|
||||||
|
) {
|
||||||
|
$encoding = null;
|
||||||
|
}
|
||||||
|
// path checks if set, if not valid path unset to default BASE path
|
||||||
|
if (
|
||||||
|
!empty($_SESSION['LOCALE_PATH']) &&
|
||||||
|
is_dir($_SESSION['LOCALE_PATH'])
|
||||||
|
) {
|
||||||
|
$path = $_SESSION['LOCALE_PATH'];
|
||||||
|
} elseif (
|
||||||
|
empty($path) ||
|
||||||
|
!is_dir($path)
|
||||||
|
) {
|
||||||
|
$path = null;
|
||||||
|
}
|
||||||
|
// extract lang & country from locale string, else set to en
|
||||||
|
if (
|
||||||
|
preg_match(
|
||||||
|
// lang
|
||||||
|
'/^(?P<lang>[a-z]{2,3})'
|
||||||
|
// country code
|
||||||
|
. '(?:_(?P<country>[A-Z]{2}))?/',
|
||||||
|
$locale ?? '',
|
||||||
|
$matches
|
||||||
|
)
|
||||||
|
) {
|
||||||
|
$lang = ($matches['lang'] ?? 'en')
|
||||||
|
// add country only if set
|
||||||
|
. (!empty($matches['country']) ? '_' . $matches['country'] : '');
|
||||||
|
} else {
|
||||||
|
$lang = null;
|
||||||
|
}
|
||||||
|
return [
|
||||||
|
'locale' => $locale,
|
||||||
|
'lang' => $lang,
|
||||||
|
'domain' => $domain,
|
||||||
|
'encoding' => $encoding,
|
||||||
|
'path' => $path,
|
||||||
|
];
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// __END__
|
// __END__
|
||||||
|
|||||||
@@ -32,65 +32,87 @@ use CoreLibs\Language\Core\GetTextReader;
|
|||||||
|
|
||||||
class L10n
|
class L10n
|
||||||
{
|
{
|
||||||
|
/** @var string the default fallback encoding if nothing is set */
|
||||||
|
public const DEFAULT_CHARSET = 'UTF-8';
|
||||||
/** @var string the current locale */
|
/** @var string the current locale */
|
||||||
private $locale = '';
|
private string $locale = '';
|
||||||
/** @var string the SET locale as WHERE the domain file is */
|
/** @var string the SET locale as WHERE the domain file is */
|
||||||
private $locale_set = '';
|
private string $locale_set = '';
|
||||||
/** @var string the default selected/active domain */
|
/** @var string the default selected/active domain */
|
||||||
private $domain = '';
|
private string $domain = '';
|
||||||
|
/** @var string encoding, as from locale or set from outside */
|
||||||
|
private string $override_encoding = self::DEFAULT_CHARSET;
|
||||||
|
/** @var string encoding set during the parse Locale */
|
||||||
|
private string $encoding = '';
|
||||||
/** @var array<string,array<string,GetTextReader>> locale > domain = translator */
|
/** @var array<string,array<string,GetTextReader>> locale > domain = translator */
|
||||||
private $domains = [];
|
private array $domains = [];
|
||||||
/** @var array<string,string> bound paths for domains */
|
/** @var array<string,string> bound paths for domains */
|
||||||
private $paths = ['' => './'];
|
private array $paths = ['' => './'];
|
||||||
|
|
||||||
// files
|
// files
|
||||||
/** @var string the full path to the mo file to loaded */
|
/** @var string the full path to the mo file to loaded */
|
||||||
private $mofile = '';
|
private string $mofile = '';
|
||||||
/** @var string base path to search level */
|
/** @var string base path to search level */
|
||||||
private $base_locale_path = '';
|
private string $base_locale_path = '';
|
||||||
/** @var string dynamic set path to where the mo file is actually */
|
/** @var string dynamic set path to where the mo file is actually */
|
||||||
private $base_content_path = '';
|
private string $base_content_path = '';
|
||||||
|
|
||||||
// errors
|
// errors
|
||||||
/** @var bool if load of mo file was unsuccessful */
|
/** @var bool if load of mo file was unsuccessful */
|
||||||
private $load_failure = false;
|
private bool $load_failure = false;
|
||||||
|
|
||||||
// object holders
|
// object holders
|
||||||
/** @var FileReader|bool reader class for file reading, false for short circuit */
|
/** @var FileReader|bool reader class for file reading, false for short circuit */
|
||||||
private $input = false;
|
private FileReader|bool $input = false;
|
||||||
/** @var GetTextReader reader class for MO data */
|
/** @var GetTextReader reader class for MO data */
|
||||||
private $l10n;
|
private GetTextReader|null $l10n = null;
|
||||||
/**
|
/**
|
||||||
* @static
|
* @static
|
||||||
* @var L10n self class
|
* @var L10n self class
|
||||||
*/
|
*/
|
||||||
private static $instance;
|
private static L10n $instance;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* class constructor call for language getstring
|
* class constructor call for language getstring
|
||||||
* if locale is not empty will load translation
|
* if locale is not empty will load translation
|
||||||
* else getTranslator needs to be called
|
* else getTranslator needs to be called
|
||||||
*
|
*
|
||||||
* @param string $locale language name, default empty string
|
* @param string $locale language name, default empty string
|
||||||
* will return self instance
|
* will return self instance
|
||||||
* @param string $domain override CONTENT_PATH . $encoding name for mo file
|
* @param string $domain override CONTENT_PATH . $encoding name for mo file
|
||||||
* @param string $path path, if empty fallback on default internal path
|
* @param string $path path, if empty fallback on default internal path
|
||||||
|
* @param string $encoding Optional encoding, should be set if locale has
|
||||||
|
* no encoding, defaults to UTF-8
|
||||||
*/
|
*/
|
||||||
public function __construct(
|
public function __construct(
|
||||||
string $locale = '',
|
string $locale = '',
|
||||||
string $domain = '',
|
string $domain = '',
|
||||||
string $path = ''
|
string $path = '',
|
||||||
|
string $encoding = ''
|
||||||
) {
|
) {
|
||||||
// auto load language only if at least locale and domain is set
|
// auto load language only if at least locale and domain is set
|
||||||
if (!empty($locale) && !empty($domain)) {
|
// New: path must be set too, or we fall through
|
||||||
|
if (!empty($locale) && !empty($domain) && empty($path)) {
|
||||||
|
/** @deprecated if locale and domain are set, path must be set too */
|
||||||
|
trigger_error(
|
||||||
|
'Empty path parameter is no longer allowed if locale and domain are set',
|
||||||
|
E_USER_DEPRECATED
|
||||||
|
);
|
||||||
|
}
|
||||||
|
if (!empty($locale) && !empty($domain) && !empty($path)) {
|
||||||
// check hack if domain and path is switched
|
// check hack if domain and path is switched
|
||||||
// Note this can be removed in future versions
|
// Note this can be removed in future versions
|
||||||
if (strstr($domain, DIRECTORY_SEPARATOR) !== false) {
|
if (strstr($domain, DIRECTORY_SEPARATOR) !== false) {
|
||||||
|
/** @deprecated domain must be 2nd and path must be third parameter */
|
||||||
|
trigger_error(
|
||||||
|
'L10n constructor parameter switch is no longer supported. domain is 2nd, path is 3rd parameter',
|
||||||
|
E_USER_DEPRECATED
|
||||||
|
);
|
||||||
$_domain = $path;
|
$_domain = $path;
|
||||||
$path = $domain;
|
$path = $domain;
|
||||||
$domain = $_domain;
|
$domain = $_domain;
|
||||||
}
|
}
|
||||||
$this->getTranslator($locale, $domain, $path);
|
$this->getTranslator($locale, $domain, $path, $encoding);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -102,7 +124,6 @@ class L10n
|
|||||||
*/
|
*/
|
||||||
public static function getInstance(): L10n
|
public static function getInstance(): L10n
|
||||||
{
|
{
|
||||||
/** @phpstan-ignore-next-line */
|
|
||||||
if (empty(self::$instance)) {
|
if (empty(self::$instance)) {
|
||||||
self::$instance = new self();
|
self::$instance = new self();
|
||||||
}
|
}
|
||||||
@@ -122,15 +143,17 @@ class L10n
|
|||||||
/**
|
/**
|
||||||
* loads the mo file base on path, locale and domain set
|
* loads the mo file base on path, locale and domain set
|
||||||
*
|
*
|
||||||
* @param string $locale language name (optional), fallback is en
|
* @param string $locale language name, if not set, try previous set
|
||||||
* @param string $domain override CONTENT_PATH . $encoding name for mo file
|
* @param string $domain set name for mo file, if not set, try previous set
|
||||||
* @param string $path path, if empty fallback on default internal path
|
* @param string $path path, if not set try to get from paths array, else self
|
||||||
|
* @param string $override_encoding if locale does not env encoding set, use this one
|
||||||
* @return GetTextReader the main gettext reader object
|
* @return GetTextReader the main gettext reader object
|
||||||
*/
|
*/
|
||||||
public function getTranslator(
|
public function getTranslator(
|
||||||
string $locale = '',
|
string $locale = '',
|
||||||
string $domain = '',
|
string $domain = '',
|
||||||
string $path = ''
|
string $path = '',
|
||||||
|
string $override_encoding = '',
|
||||||
): GetTextReader {
|
): GetTextReader {
|
||||||
// set local if not from parameter
|
// set local if not from parameter
|
||||||
if (empty($locale)) {
|
if (empty($locale)) {
|
||||||
@@ -140,11 +163,16 @@ class L10n
|
|||||||
if (empty($domain)) {
|
if (empty($domain)) {
|
||||||
$domain = $this->domain;
|
$domain = $this->domain;
|
||||||
}
|
}
|
||||||
|
// override encoding for unset
|
||||||
|
if (!empty($override_encoding)) {
|
||||||
|
$this->override_encoding = $override_encoding;
|
||||||
|
}
|
||||||
// store old settings
|
// store old settings
|
||||||
$old_mofile = $this->mofile;
|
$old_mofile = $this->mofile;
|
||||||
$old_lang = $this->locale;
|
$old_lang = $this->locale;
|
||||||
$old_lang_set = $this->locale_set;
|
$old_lang_set = $this->locale_set;
|
||||||
$old_domain = $this->domain;
|
$old_domain = $this->domain;
|
||||||
|
$old_encoding = $this->encoding;
|
||||||
$old_base_locale_path = $this->base_locale_path;
|
$old_base_locale_path = $this->base_locale_path;
|
||||||
$old_base_content_path = $this->base_content_path;
|
$old_base_content_path = $this->base_content_path;
|
||||||
|
|
||||||
@@ -160,6 +188,11 @@ class L10n
|
|||||||
} elseif (
|
} elseif (
|
||||||
defined('BASE') && defined('INCLUDES') && defined('LOCALE')
|
defined('BASE') && defined('INCLUDES') && defined('LOCALE')
|
||||||
) {
|
) {
|
||||||
|
/** @deprecated Do not use this anymore, define path on class load */
|
||||||
|
trigger_error(
|
||||||
|
'parameter $path must be set. Setting via BASE, INCLUDES and LOCALE constants is deprecated',
|
||||||
|
E_USER_DEPRECATED
|
||||||
|
);
|
||||||
// set fallback base path if constant set
|
// set fallback base path if constant set
|
||||||
$this->base_locale_path = BASE . INCLUDES . LOCALE;
|
$this->base_locale_path = BASE . INCLUDES . LOCALE;
|
||||||
} else {
|
} else {
|
||||||
@@ -168,6 +201,7 @@ class L10n
|
|||||||
// now we loop over lang compositions to get the base path
|
// now we loop over lang compositions to get the base path
|
||||||
// then we check
|
// then we check
|
||||||
$locales = $this->listLocales($locale);
|
$locales = $this->listLocales($locale);
|
||||||
|
$encoding = $this->getEncodingFromLocale($locale);
|
||||||
foreach ($locales as $_locale) {
|
foreach ($locales as $_locale) {
|
||||||
$this->base_content_path = $_locale . DIRECTORY_SEPARATOR
|
$this->base_content_path = $_locale . DIRECTORY_SEPARATOR
|
||||||
. 'LC_MESSAGES' . DIRECTORY_SEPARATOR;
|
. 'LC_MESSAGES' . DIRECTORY_SEPARATOR;
|
||||||
@@ -184,6 +218,7 @@ class L10n
|
|||||||
if (is_readable($this->mofile)) {
|
if (is_readable($this->mofile)) {
|
||||||
// locale and domain current wanted
|
// locale and domain current wanted
|
||||||
$this->locale = $locale;
|
$this->locale = $locale;
|
||||||
|
$this->encoding = $encoding;
|
||||||
$this->domain = $domain;
|
$this->domain = $domain;
|
||||||
// set empty domains path with current locale
|
// set empty domains path with current locale
|
||||||
if (empty($this->domains[$locale])) {
|
if (empty($this->domains[$locale])) {
|
||||||
@@ -207,6 +242,7 @@ class L10n
|
|||||||
$this->mofile = $old_mofile;
|
$this->mofile = $old_mofile;
|
||||||
$this->locale = $old_lang;
|
$this->locale = $old_lang;
|
||||||
$this->locale_set = $old_lang_set;
|
$this->locale_set = $old_lang_set;
|
||||||
|
$this->encoding = $old_encoding;
|
||||||
$this->domain = $old_domain;
|
$this->domain = $old_domain;
|
||||||
$this->base_locale_path = $old_base_locale_path;
|
$this->base_locale_path = $old_base_locale_path;
|
||||||
$this->base_content_path = $old_base_content_path;
|
$this->base_content_path = $old_base_content_path;
|
||||||
@@ -216,6 +252,13 @@ class L10n
|
|||||||
// dummy
|
// dummy
|
||||||
$this->l10n = new GetTextReader($this->input);
|
$this->l10n = new GetTextReader($this->input);
|
||||||
}
|
}
|
||||||
|
// if this is still null here, we abort
|
||||||
|
if ($this->l10n === null) {
|
||||||
|
throw new \RuntimeException(
|
||||||
|
"Could not create CoreLibs\Language\Core\GetTextReader object",
|
||||||
|
E_USER_ERROR
|
||||||
|
);
|
||||||
|
}
|
||||||
return $this->l10n;
|
return $this->l10n;
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -240,6 +283,40 @@ class L10n
|
|||||||
return $this->l10n;
|
return $this->l10n;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Extract encoding from Locale, or fallback to override one if not set
|
||||||
|
*
|
||||||
|
* @param string $locale
|
||||||
|
* @return string
|
||||||
|
*/
|
||||||
|
private function getEncodingFromLocale(string $locale): string
|
||||||
|
{
|
||||||
|
// extract charset from $locale
|
||||||
|
// if not set get override encoding
|
||||||
|
preg_match('/(?:\\.(?P<charset>[-A-Za-z0-9_]+))/', $locale, $matches);
|
||||||
|
return $matches['charset'] ?? $this->override_encoding;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get the local as array same to the GetLocale::setLocale return
|
||||||
|
* This does not set from outside, but only what is set in the l10n class
|
||||||
|
*
|
||||||
|
* @return array{locale: string, lang: string, lang_short: string, domain: string, encoding: string, path: string}
|
||||||
|
*/
|
||||||
|
public function getLocaleAsArray(): array
|
||||||
|
{
|
||||||
|
$locale = L10n::parseLocale($this->getLocale());
|
||||||
|
return [
|
||||||
|
'locale' => $this->getLocale(),
|
||||||
|
'lang' => ($locale['lang'] ?? '')
|
||||||
|
. (!empty($locale['country']) ? '_' . $locale['country'] : ''),
|
||||||
|
'lang_short' => $locale['lang'] ?? '',
|
||||||
|
'domain' => $this->getDomain(),
|
||||||
|
'encoding' => $this->getEncoding(),
|
||||||
|
'path' => $this->getBaseLocalePath(),
|
||||||
|
];
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* parse the locale string for further processing
|
* parse the locale string for further processing
|
||||||
*
|
*
|
||||||
@@ -478,6 +555,37 @@ class L10n
|
|||||||
return $this->locale_set;
|
return $this->locale_set;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Set override encoding
|
||||||
|
*
|
||||||
|
* @param string $encoding
|
||||||
|
* @return void
|
||||||
|
*/
|
||||||
|
public function setOverrideEncoding(string $encoding): void
|
||||||
|
{
|
||||||
|
$this->override_encoding = $encoding;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* return current set override encoding
|
||||||
|
*
|
||||||
|
* @return string
|
||||||
|
*/
|
||||||
|
public function getOverrideEncoding(): string
|
||||||
|
{
|
||||||
|
return $this->override_encoding;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Current set encoding
|
||||||
|
*
|
||||||
|
* @return string
|
||||||
|
*/
|
||||||
|
public function getEncoding(): string
|
||||||
|
{
|
||||||
|
return $this->encoding;
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* get current set language
|
* get current set language
|
||||||
*
|
*
|
||||||
@@ -571,6 +679,7 @@ class L10n
|
|||||||
// fallback passthrough
|
// fallback passthrough
|
||||||
if ($this->l10n === null) {
|
if ($this->l10n === null) {
|
||||||
echo $text;
|
echo $text;
|
||||||
|
return;
|
||||||
}
|
}
|
||||||
echo $this->l10n->translate($text);
|
echo $this->l10n->translate($text);
|
||||||
}
|
}
|
||||||
|
|||||||
107
src/Logging/Logger/Flag.php
Normal file
107
src/Logging/Logger/Flag.php
Normal file
@@ -0,0 +1,107 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
/**
|
||||||
|
* AUTOR: Clemens Schwaighofer
|
||||||
|
* CREATED: 2023/5/29
|
||||||
|
* DESCRIPTION:
|
||||||
|
* Logging options flags for output file name building
|
||||||
|
*
|
||||||
|
* per_run: and timestamp + uid will be added
|
||||||
|
* per_date: ymd will be added (per_run > per_date, cannot be used at the same time)
|
||||||
|
* per_group: for debug level, group per group id (old level)
|
||||||
|
* per_page: per file name logging
|
||||||
|
* per_class: log per class
|
||||||
|
* per_level: per logging level file split
|
||||||
|
*/
|
||||||
|
|
||||||
|
declare(strict_types=1);
|
||||||
|
|
||||||
|
namespace CoreLibs\Logging\Logger;
|
||||||
|
|
||||||
|
enum Flag: int
|
||||||
|
{
|
||||||
|
/** all off flag */
|
||||||
|
case all_off = 0;
|
||||||
|
|
||||||
|
/** write per run */
|
||||||
|
case per_run = 1;
|
||||||
|
|
||||||
|
/** write per date */
|
||||||
|
case per_date = 2;
|
||||||
|
|
||||||
|
/** was PER_LEVEL, write per group id (debug) */
|
||||||
|
case per_group = 4;
|
||||||
|
|
||||||
|
/** write per page (filename) */
|
||||||
|
case per_page = 8;
|
||||||
|
|
||||||
|
/** write per class */
|
||||||
|
case per_class = 16;
|
||||||
|
|
||||||
|
/** write per log level name */
|
||||||
|
case per_level = 32;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* get internal name from string value
|
||||||
|
*
|
||||||
|
* @param non-empty-string $name
|
||||||
|
* @return self
|
||||||
|
*/
|
||||||
|
public static function fromName(string $name): self
|
||||||
|
{
|
||||||
|
return match ($name) {
|
||||||
|
'Run', 'run', 'per_run', 'PER_RUN' => self::per_run,
|
||||||
|
'Date', 'date', 'per_date', 'PER_DATE' => self::per_date,
|
||||||
|
'Group', 'group', 'per_group', 'PER_GROUP' => self::per_group,
|
||||||
|
'Page', 'page', 'per_page', 'PER_PAGE' => self::per_page,
|
||||||
|
'Class', 'class', 'per_class', 'PER_CLASS' => self::per_class,
|
||||||
|
'Level', 'level', 'per_level', 'PER_LEVEL' => self::per_level,
|
||||||
|
default => self::all_off,
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get internal name from int value
|
||||||
|
*
|
||||||
|
* @param int $value
|
||||||
|
* @return self
|
||||||
|
*/
|
||||||
|
public static function fromValue(int $value): self
|
||||||
|
{
|
||||||
|
return self::from($value);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* convert current set level to name (upper case)
|
||||||
|
*
|
||||||
|
* @return string
|
||||||
|
*/
|
||||||
|
public function getName(): string
|
||||||
|
{
|
||||||
|
return strtoupper($this->name);
|
||||||
|
}
|
||||||
|
|
||||||
|
/** @var int[] */
|
||||||
|
public const VALUES = [
|
||||||
|
0,
|
||||||
|
1,
|
||||||
|
2,
|
||||||
|
4,
|
||||||
|
8,
|
||||||
|
16,
|
||||||
|
32,
|
||||||
|
];
|
||||||
|
|
||||||
|
/** @var string[] */
|
||||||
|
public const NAMES = [
|
||||||
|
'ALL_OFF',
|
||||||
|
'PER_RUN',
|
||||||
|
'PER_DATE',
|
||||||
|
'PER_GROUP',
|
||||||
|
'PER_PAGE',
|
||||||
|
'PER_CLASS',
|
||||||
|
'PER_LEVEL',
|
||||||
|
];
|
||||||
|
}
|
||||||
|
|
||||||
|
// __END__
|
||||||
216
src/Logging/Logger/Level.php
Normal file
216
src/Logging/Logger/Level.php
Normal file
@@ -0,0 +1,216 @@
|
|||||||
|
<?php // phpcs:disable Generic.Files.LineLength
|
||||||
|
|
||||||
|
/**
|
||||||
|
* AUTOR: Clemens Schwaighofer
|
||||||
|
* CREATED: 2023-05-25
|
||||||
|
* DESCRIPTION:
|
||||||
|
* Debug levels
|
||||||
|
*
|
||||||
|
* They are based on the Mono log ones
|
||||||
|
* FC 5424 {@see https://datatracker.ietf.org/doc/html/rfc5424}
|
||||||
|
*/
|
||||||
|
|
||||||
|
declare(strict_types=1);
|
||||||
|
|
||||||
|
namespace CoreLibs\Logging\Logger;
|
||||||
|
|
||||||
|
use Psr\Log\LogLevel;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Represents the log levels
|
||||||
|
*
|
||||||
|
* Monolog supports the logging levels described by RFC 5424 {@see https://datatracker.ietf.org/doc/html/rfc5424}
|
||||||
|
* but due to BC the severity values used internally are not 0-7.
|
||||||
|
*
|
||||||
|
* To get the level name/value out of a Level there are several options:
|
||||||
|
*
|
||||||
|
* - Use ->getName() to get the standard Monolog name which is full uppercased (e.g. "DEBUG")
|
||||||
|
* - Use ->toPsrLogLevel() to get the standard PSR-3 name which is full lowercased (e.g. "debug")
|
||||||
|
* - Use ->toRFC5424Level() to get the standard RFC 5424 value (e.g. 7 for debug, 0 for emergency)
|
||||||
|
* - Use ->name to get the enum case's name which is capitalized (e.g. "Debug")
|
||||||
|
*
|
||||||
|
* To get the internal value for filtering, if the includes/isLowerThan/isHigherThan methods are
|
||||||
|
* not enough, you can use ->value to get the enum case's integer value.
|
||||||
|
*/
|
||||||
|
enum Level: int
|
||||||
|
{
|
||||||
|
/**
|
||||||
|
* Detailed debug information
|
||||||
|
*/
|
||||||
|
case Debug = 100;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Interesting events
|
||||||
|
*
|
||||||
|
* Examples: User logs in, SQL logs.
|
||||||
|
*/
|
||||||
|
case Info = 200;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Uncommon events
|
||||||
|
*/
|
||||||
|
case Notice = 250;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Exceptional occurrences that are not errors
|
||||||
|
*
|
||||||
|
* Examples: Use of deprecated APIs, poor use of an API,
|
||||||
|
* undesirable things that are not necessarily wrong.
|
||||||
|
*/
|
||||||
|
case Warning = 300;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Runtime errors
|
||||||
|
*/
|
||||||
|
case Error = 400;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Critical conditions
|
||||||
|
*
|
||||||
|
* Example: Application component unavailable, unexpected exception.
|
||||||
|
*/
|
||||||
|
case Critical = 500;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Action must be taken immediately
|
||||||
|
*
|
||||||
|
* Example: Entire website down, database unavailable, etc.
|
||||||
|
* This should trigger the SMS alerts and wake you up.
|
||||||
|
*/
|
||||||
|
case Alert = 550;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Urgent alert.
|
||||||
|
*/
|
||||||
|
case Emergency = 600;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param value-of<self::NAMES>|LogLevel::*|'Debug'|'Info'|'Notice'|'Warning'|'Error'|'Critical'|'Alert'|'Emergency' $name
|
||||||
|
* @return static
|
||||||
|
*/
|
||||||
|
public static function fromName(string $name): self
|
||||||
|
{
|
||||||
|
return match ($name) {
|
||||||
|
'debug', 'Debug', 'DEBUG' => self::Debug,
|
||||||
|
'info', 'Info', 'INFO' => self::Info,
|
||||||
|
'notice', 'Notice', 'NOTICE' => self::Notice,
|
||||||
|
'warning', 'Warning', 'WARNING' => self::Warning,
|
||||||
|
'error', 'Error', 'ERROR' => self::Error,
|
||||||
|
'critical', 'Critical', 'CRITICAL' => self::Critical,
|
||||||
|
'alert', 'Alert', 'ALERT' => self::Alert,
|
||||||
|
'emergency', 'Emergency', 'EMERGENCY' => self::Emergency,
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param value-of<self::VALUES> $value
|
||||||
|
* @return static
|
||||||
|
*/
|
||||||
|
public static function fromValue(int $value): self
|
||||||
|
{
|
||||||
|
return self::from($value);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Returns true if the passed $level is higher or equal to $this
|
||||||
|
*/
|
||||||
|
public function includes(Level $level): bool
|
||||||
|
{
|
||||||
|
return $this->value <= $level->value;
|
||||||
|
}
|
||||||
|
|
||||||
|
public function isHigherThan(Level $level): bool
|
||||||
|
{
|
||||||
|
return $this->value > $level->value;
|
||||||
|
}
|
||||||
|
|
||||||
|
public function isLowerThan(Level $level): bool
|
||||||
|
{
|
||||||
|
return $this->value < $level->value;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Returns the monolog standardized all-capitals name of the level
|
||||||
|
*
|
||||||
|
* Use this instead of $level->name which returns the enum case name (e.g. Debug vs DEBUG if you use getName())
|
||||||
|
*
|
||||||
|
* @phan-suppress-next-line PhanTypeMismatchDeclaredReturn
|
||||||
|
* @return value-of<self::NAMES>
|
||||||
|
*/
|
||||||
|
public function getName(): string
|
||||||
|
{
|
||||||
|
return match ($this) {
|
||||||
|
self::Debug => 'DEBUG',
|
||||||
|
self::Info => 'INFO',
|
||||||
|
self::Notice => 'NOTICE',
|
||||||
|
self::Warning => 'WARNING',
|
||||||
|
self::Error => 'ERROR',
|
||||||
|
self::Critical => 'CRITICAL',
|
||||||
|
self::Alert => 'ALERT',
|
||||||
|
self::Emergency => 'EMERGENCY',
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Returns the PSR-3 level matching this instance
|
||||||
|
*
|
||||||
|
* @phpstan-return \Psr\Log\LogLevel::*
|
||||||
|
*/
|
||||||
|
public function toPsrLogLevel(): string
|
||||||
|
{
|
||||||
|
return match ($this) {
|
||||||
|
self::Debug => LogLevel::DEBUG,
|
||||||
|
self::Info => LogLevel::INFO,
|
||||||
|
self::Notice => LogLevel::NOTICE,
|
||||||
|
self::Warning => LogLevel::WARNING,
|
||||||
|
self::Error => LogLevel::ERROR,
|
||||||
|
self::Critical => LogLevel::CRITICAL,
|
||||||
|
self::Alert => LogLevel::ALERT,
|
||||||
|
self::Emergency => LogLevel::EMERGENCY,
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Returns the RFC 5424 level matching this instance
|
||||||
|
*
|
||||||
|
* @phpstan-return int<0, 7>
|
||||||
|
*/
|
||||||
|
public function toRFC5424Level(): int
|
||||||
|
{
|
||||||
|
return match ($this) {
|
||||||
|
self::Debug => 7,
|
||||||
|
self::Info => 6,
|
||||||
|
self::Notice => 5,
|
||||||
|
self::Warning => 4,
|
||||||
|
self::Error => 3,
|
||||||
|
self::Critical => 2,
|
||||||
|
self::Alert => 1,
|
||||||
|
self::Emergency => 0,
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
public const VALUES = [
|
||||||
|
100,
|
||||||
|
200,
|
||||||
|
250,
|
||||||
|
300,
|
||||||
|
400,
|
||||||
|
500,
|
||||||
|
550,
|
||||||
|
600,
|
||||||
|
];
|
||||||
|
|
||||||
|
public const NAMES = [
|
||||||
|
'DEBUG',
|
||||||
|
'INFO',
|
||||||
|
'NOTICE',
|
||||||
|
'WARNING',
|
||||||
|
'ERROR',
|
||||||
|
'CRITICAL',
|
||||||
|
'ALERT',
|
||||||
|
'EMERGENCY',
|
||||||
|
];
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
// __END__
|
||||||
1395
src/Logging/Logging.php
Normal file
1395
src/Logging/Logging.php
Normal file
File diff suppressed because it is too large
Load Diff
@@ -13,27 +13,27 @@ class Elements
|
|||||||
/**
|
/**
|
||||||
* print the date/time drop downs, used in any queue/send/insert at date/time place
|
* print the date/time drop downs, used in any queue/send/insert at date/time place
|
||||||
*
|
*
|
||||||
* @param int $year year YYYY
|
* @param int|string $year year YYYY
|
||||||
* @param int $month month m
|
* @param int|string $month month m
|
||||||
* @param int $day day d
|
* @param int|string $day day d
|
||||||
* @param int $hour hour H
|
* @param int|string $hour hour H
|
||||||
* @param int $min min i
|
* @param int|string $min min i
|
||||||
* @param string $suffix additional info printed after the date time
|
* @param string $suffix additional info printed after the date time
|
||||||
* variable in the drop down
|
* variable in the drop down
|
||||||
* also used for ID in the on change JS call
|
* also used for ID in the on change JS call
|
||||||
* @param int $min_steps default is 1 (minute), can set to anything,
|
* @param int $min_steps default is 1 (minute), can set to anything,
|
||||||
* is used as sum up from 0
|
* is used as sum up from 0
|
||||||
* @param bool $name_pos_back default false, if set to true,
|
* @param bool $name_pos_back default false, if set to true,
|
||||||
* the name will be printend after the drop down
|
* the name will be printend after the drop down
|
||||||
* and not before the drop down
|
* and not before the drop down
|
||||||
* @return string HTML formated strings for drop down lists of date and time
|
* @return string HTML formated strings for drop down lists of date and time
|
||||||
*/
|
*/
|
||||||
public static function printDateTime(
|
public static function printDateTime(
|
||||||
$year,
|
int|string $year,
|
||||||
$month,
|
int|string $month,
|
||||||
$day,
|
int|string $day,
|
||||||
$hour,
|
int|string $hour,
|
||||||
$min,
|
int|string $min,
|
||||||
string $suffix = '',
|
string $suffix = '',
|
||||||
int $min_steps = 1,
|
int $min_steps = 1,
|
||||||
bool $name_pos_back = false
|
bool $name_pos_back = false
|
||||||
|
|||||||
@@ -219,136 +219,132 @@ declare(strict_types=1);
|
|||||||
namespace CoreLibs\Output\Form;
|
namespace CoreLibs\Output\Form;
|
||||||
|
|
||||||
use CoreLibs\Get\System;
|
use CoreLibs\Get\System;
|
||||||
|
use CoreLibs\Debug\Support;
|
||||||
|
|
||||||
class Generate extends \CoreLibs\DB\Extended\ArrayIO
|
class Generate extends \CoreLibs\DB\Extended\ArrayIO
|
||||||
{
|
{
|
||||||
// for the load statetment describes which elements from
|
// for the load statetment describes which elements from
|
||||||
// the load query should be shown and i which format
|
// the load query should be shown and i which format
|
||||||
/** @var array<mixed> */
|
/** @var array<mixed> */
|
||||||
public $field_array = [];
|
public array $field_array = [];
|
||||||
/** @var string */
|
/** @var string */
|
||||||
public $load_query; // the query needed for loading a data set (one row in the table)
|
public string $load_query; // the query needed for loading a data set (one row in the table)
|
||||||
/** @var string */
|
/** @var string */
|
||||||
public $col_name; // the name of the columen (before _<type>) [used for order button]
|
public string $col_name; // the name of the columen (before _<type>) [used for order button]
|
||||||
/** @var int */
|
/** @var int */
|
||||||
public $yes; // the yes flag that triggers the template to show ALL and not only new/load
|
public int $yes = 0; // the yes flag that triggers the template to show ALL and not only new/load
|
||||||
/** @var string */
|
/** @var string */
|
||||||
public $msg; // the error msg
|
public string $msg = ''; // the error msg
|
||||||
/** @var int */
|
/** @var int */
|
||||||
public $error; // the error flag set for printing red error msg
|
public int $error = 0; // the error flag set for printing red error msg
|
||||||
/** @var int */
|
/** @var int */
|
||||||
public $warning; // warning flag, for information (saved, loaded, etc)
|
public int $warning = 0; // warning flag, for information (saved, loaded, etc)
|
||||||
/** @var string */
|
/** @var string */
|
||||||
public $archive_pk_name; // the pk name for the load select form
|
public string $archive_pk_name; // the pk name for the load select form
|
||||||
/** @var string */
|
/** @var string */
|
||||||
private $int_pk_name; // primary key, only internal usage
|
private string $int_pk_name; // primary key, only internal usage
|
||||||
/** @var array<mixed> */
|
/** @var array<mixed> */
|
||||||
public $reference_array = []; // reference arrays -> stored in $this->reference_array[$table_name] => [];
|
public array $reference_array = []; // reference arrays -> stored in $this->reference_array[$table_name] => [];
|
||||||
// NOTE: should be changed to this @var mixed[]
|
// NOTE: should be changed to this @var mixed[]
|
||||||
/** @var array<mixed> */
|
/** @var array<mixed> */
|
||||||
public $element_list; // element list for elements next to each other as a special sub group
|
public array $element_list; // element list for elements next to each other as a special sub group
|
||||||
/** @var array<mixed> */
|
/** @var array<mixed> */
|
||||||
public $table_array = [];
|
public array $table_array = [];
|
||||||
/** @var string */
|
/** @var string */
|
||||||
public $my_page_name; // the name of the page without .php extension
|
public string $my_page_name; // the name of the page without .php extension
|
||||||
/** @var bool */
|
/** @var bool */
|
||||||
public $mobile_phone = false;
|
public bool $mobile_phone = false;
|
||||||
/** @var string */
|
/** @var string */
|
||||||
public $email_regex;
|
public string $email_regex;
|
||||||
// buttons and checkboxes
|
// buttons and checkboxes
|
||||||
/** @var string */
|
/** @var string */
|
||||||
public $archive;
|
public string $archive;
|
||||||
/** @var string */
|
/** @var string */
|
||||||
public $new;
|
public string $new;
|
||||||
/** @var string */
|
/** @var string */
|
||||||
public $really_new;
|
public string $really_new;
|
||||||
/** @var string */
|
/** @var string */
|
||||||
public $delete;
|
public string $delete;
|
||||||
/** @var string */
|
/** @var string */
|
||||||
public $really_delete;
|
public string $really_delete;
|
||||||
/** @var string */
|
/** @var string */
|
||||||
public $save;
|
public string $save;
|
||||||
/** @var string */
|
/** @var string */
|
||||||
public $remove_button;
|
public string $remove_button;
|
||||||
// security values
|
// security values
|
||||||
/** @var int base acl for current page */
|
/** @var int base acl for current page */
|
||||||
private $base_acl_level = 0;
|
private int $base_acl_level = 0;
|
||||||
/** @var int admin master flag (1/0) */
|
/** @var int admin master flag (1/0) */
|
||||||
private $acl_admin = 0;
|
private int $acl_admin = 0;
|
||||||
/** @var array<mixed> */
|
/** @var array<mixed> */
|
||||||
public $security_level;
|
public array $security_level;
|
||||||
|
/** @var array<string,mixed> Login ACL */
|
||||||
|
public array $login_acl = [];
|
||||||
// layout publics
|
// layout publics
|
||||||
/** @var int */
|
/** @var int */
|
||||||
public $table_width;
|
public int $table_width = 0;
|
||||||
// internal lang & encoding vars
|
// internal lang & encoding vars
|
||||||
/** @var string */
|
/** @var string */
|
||||||
public $lang_dir = '';
|
public string $lang_dir = '';
|
||||||
/** @var string */
|
/** @var string */
|
||||||
public $lang;
|
public string $lang;
|
||||||
/** @var string */
|
/** @var string */
|
||||||
public $lang_short;
|
public string $lang_short;
|
||||||
/** @var string */
|
/** @var string */
|
||||||
public $domain;
|
public string $domain;
|
||||||
/** @var string */
|
/** @var string */
|
||||||
public $encoding;
|
public string $encoding;
|
||||||
// language
|
// language
|
||||||
/** @var \CoreLibs\Language\L10n */
|
/** @var \CoreLibs\Language\L10n */
|
||||||
public $l;
|
public \CoreLibs\Language\L10n $l;
|
||||||
// log
|
// log
|
||||||
/** @var \CoreLibs\Debug\Logging */
|
/** @var \CoreLibs\Logging\Logging */
|
||||||
public $log;
|
public \CoreLibs\Logging\Logging $log;
|
||||||
|
|
||||||
// now some default error msgs (english)
|
// now some default error msgs (english)
|
||||||
/** @var array<mixed> */
|
/** @var array<mixed> */
|
||||||
public $language_array = [];
|
public array $language_array = [];
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* construct form generator
|
* construct form generator
|
||||||
*
|
*
|
||||||
* @param array<mixed> $db_config db config array, mandatory
|
* phpcs:ignore
|
||||||
* @param \CoreLibs\Debug\Logging|null $log Logging class, null auto set
|
* @param array{db_name:string,db_user:string,db_pass:string,db_host:string,db_port:int,db_schema:string,db_encoding:string,db_type:string,db_ssl:string,db_convert_type?:string[]} $db_config db config array, mandatory
|
||||||
* @param \CoreLibs\Language\L10n|null $l10n l10n language class, null auto set
|
* @param \CoreLibs\Logging\Logging $log Logging class
|
||||||
* @param array<string,string>|null $locale locale array from ::setLocale,
|
* @param \CoreLibs\Language\L10n $l10n l10n language class
|
||||||
* null auto set
|
* @param array<string,mixed> $login_acl Login ACL array,
|
||||||
* @param array<mixed>|null $table_arrays Override table array data
|
* at least base/admin should be set
|
||||||
* instead of try to load from
|
* @param array<mixed>|null $table_arrays Override table array data
|
||||||
* include file
|
* instead of try to load from
|
||||||
* @throws \Exception 1: No table_arrays set/no class found for my page name
|
* include file
|
||||||
|
* @throws \Exception 1: No table_arrays set/no class found for my page name
|
||||||
*/
|
*/
|
||||||
public function __construct(
|
public function __construct(
|
||||||
array $db_config,
|
array $db_config,
|
||||||
?\CoreLibs\Debug\Logging $log = null,
|
\CoreLibs\Logging\Logging $log,
|
||||||
?\CoreLibs\Language\L10n $l10n = null,
|
\CoreLibs\Language\L10n $l10n,
|
||||||
?array $locale = null,
|
array $login_acl,
|
||||||
?array $table_arrays = null,
|
?array $table_arrays = null,
|
||||||
) {
|
) {
|
||||||
// init logger if not set
|
// init logger if not set
|
||||||
$this->log = $log ?? new \CoreLibs\Debug\Logging();
|
$this->log = $log;
|
||||||
// don't log per class
|
// don't log per class
|
||||||
$this->log->setLogPer('class', false);
|
$this->log->unsetLogFlag(\CoreLibs\Logging\Logger\Flag::per_class);
|
||||||
// if pass on locale is null
|
|
||||||
if ($locale === null) {
|
|
||||||
$locale = \CoreLibs\Language\GetLocale::setLocale();
|
|
||||||
}
|
|
||||||
// init the language class
|
// init the language class
|
||||||
$this->l = $l10n ?? new \CoreLibs\Language\L10n(
|
$this->l = $l10n;
|
||||||
$locale['locale'],
|
// parse and read, legacy stuff
|
||||||
$locale['domain'],
|
$locale = $this->l->getLocaleAsArray();
|
||||||
$locale['path'],
|
|
||||||
);
|
|
||||||
// legacy lang vars set
|
|
||||||
$this->encoding = $locale['encoding'];
|
$this->encoding = $locale['encoding'];
|
||||||
$this->lang = $locale['lang'];
|
$this->lang = $locale['lang'];
|
||||||
// get first part from lang
|
$this->lang_short = $locale['lang_short'];
|
||||||
$this->lang_short = explode('_', $locale['lang'])[0];
|
$this->domain = $locale['domain'];
|
||||||
$this->domain = $this->l->getDomain();
|
$this->lang_dir = $locale['path'];
|
||||||
$this->lang_dir = $this->l->getBaseLocalePath();
|
|
||||||
// load config array
|
// load config array
|
||||||
// get table array definitions for current page name
|
// get table array definitions for current page name
|
||||||
|
$this->login_acl = $login_acl;
|
||||||
// security settings
|
// security settings
|
||||||
$this->base_acl_level = (int)$_SESSION['BASE_ACL_LEVEL'];
|
$this->base_acl_level = $this->login_acl['base'] ?? 0;
|
||||||
$this->acl_admin = (int)$_SESSION['ADMIN'];
|
$this->acl_admin = $this->login_acl['admin'] ?? 0;
|
||||||
|
|
||||||
// replace any non valid variable names and set my page name
|
// replace any non valid variable names and set my page name
|
||||||
$this->my_page_name = str_replace(
|
$this->my_page_name = str_replace(
|
||||||
@@ -366,7 +362,7 @@ class Generate extends \CoreLibs\DB\Extended\ArrayIO
|
|||||||
$config_array = $table_arrays[System::getPageName(1)];
|
$config_array = $table_arrays[System::getPageName(1)];
|
||||||
} else {
|
} else {
|
||||||
// primary try to load the class
|
// primary try to load the class
|
||||||
/** @var \CoreLibs\Output\Form\TableArraysInterface|false $content_class */
|
/** @var TableArrays\Interface\TableArraysInterface|false $content_class */
|
||||||
$content_class = $this->loadTableArray();
|
$content_class = $this->loadTableArray();
|
||||||
if (is_object($content_class)) {
|
if (is_object($content_class)) {
|
||||||
$config_array = $content_class->setTableArray();
|
$config_array = $content_class->setTableArray();
|
||||||
@@ -386,7 +382,6 @@ class Generate extends \CoreLibs\DB\Extended\ArrayIO
|
|||||||
$this->base_acl_level,
|
$this->base_acl_level,
|
||||||
$this->acl_admin
|
$this->acl_admin
|
||||||
);
|
);
|
||||||
// $this->log->debug('SESSION FORM', 'sessin: ' . $this->log->prAr($_SESSION));
|
|
||||||
// here should be a check if the config_array is correct ...
|
// here should be a check if the config_array is correct ...
|
||||||
if (isset($config_array['show_fields']) && is_array($config_array['show_fields'])) {
|
if (isset($config_array['show_fields']) && is_array($config_array['show_fields'])) {
|
||||||
$this->field_array = $config_array['show_fields'];
|
$this->field_array = $config_array['show_fields'];
|
||||||
@@ -395,7 +390,7 @@ class Generate extends \CoreLibs\DB\Extended\ArrayIO
|
|||||||
$this->load_query = $config_array['load_query'];
|
$this->load_query = $config_array['load_query'];
|
||||||
}
|
}
|
||||||
if (empty($this->load_query)) {
|
if (empty($this->load_query)) {
|
||||||
$this->log->debug('INIT ERROR', 'Missing Load Query for: ' . $this->my_page_name);
|
$this->log->error('Missing Load Query for: ' . $this->my_page_name);
|
||||||
}
|
}
|
||||||
$this->archive_pk_name = 'a_' . $this->pk_name;
|
$this->archive_pk_name = 'a_' . $this->pk_name;
|
||||||
$this->col_name = str_replace('_id', '', $this->pk_name);
|
$this->col_name = str_replace('_id', '', $this->pk_name);
|
||||||
@@ -468,9 +463,9 @@ class Generate extends \CoreLibs\DB\Extended\ArrayIO
|
|||||||
/**
|
/**
|
||||||
* load table array class based on my page name converted to camel case
|
* load table array class based on my page name converted to camel case
|
||||||
* class files are in \TableArrays folder in \Output\Form
|
* class files are in \TableArrays folder in \Output\Form
|
||||||
* @return object|bool Return class object or false on failure
|
* @return TableArrays\Interface\TableArraysInterface|false Return class object or false on failure
|
||||||
*/
|
*/
|
||||||
private function loadTableArray()
|
private function loadTableArray(): TableArrays\Interface\TableArraysInterface|false
|
||||||
{
|
{
|
||||||
// note: it schould be Schemas but an original type made it to this
|
// note: it schould be Schemas but an original type made it to this
|
||||||
// this file is kept for the old usage, new one should be EditSchemas
|
// this file is kept for the old usage, new one should be EditSchemas
|
||||||
@@ -489,10 +484,10 @@ class Generate extends \CoreLibs\DB\Extended\ArrayIO
|
|||||||
$page_name_camel_case
|
$page_name_camel_case
|
||||||
);
|
);
|
||||||
try {
|
try {
|
||||||
/** @var \CoreLibs\Output\Form\TableArraysInterface|false $class */
|
/** @var TableArrays\Interface\TableArraysInterface|false $class */
|
||||||
$class = new $class_string($this);
|
$class = new $class_string($this);
|
||||||
} catch (\Throwable $t) {
|
} catch (\Throwable $t) {
|
||||||
$this->log->debug('CLASS LOAD', 'Failed loading: ' . $class_string . ' => ' . $t->getMessage());
|
$this->log->critical('CLASS LOADING: Failed loading: ' . $class_string . ' => ' . $t->getMessage());
|
||||||
return false;
|
return false;
|
||||||
}
|
}
|
||||||
if (is_object($class)) {
|
if (is_object($class)) {
|
||||||
@@ -651,7 +646,7 @@ class Generate extends \CoreLibs\DB\Extended\ArrayIO
|
|||||||
$this->base_acl_level >= $this->security_level['new']
|
$this->base_acl_level >= $this->security_level['new']
|
||||||
) {
|
) {
|
||||||
if ($this->really_new == 'yes') {
|
if ($this->really_new == 'yes') {
|
||||||
$this->formUnsetTablearray();
|
$this->formUnsetTableArray();
|
||||||
} else {
|
} else {
|
||||||
$this->msg .= $this->l->__('You have to select the <b>Checkbox for New</b>!<br>');
|
$this->msg .= $this->l->__('You have to select the <b>Checkbox for New</b>!<br>');
|
||||||
$this->error = 2;
|
$this->error = 2;
|
||||||
@@ -731,9 +726,6 @@ class Generate extends \CoreLibs\DB\Extended\ArrayIO
|
|||||||
empty($this->table_array['protected']['value']) &&
|
empty($this->table_array['protected']['value']) &&
|
||||||
!$this->error
|
!$this->error
|
||||||
) {
|
) {
|
||||||
if (!is_array($element_list)) {
|
|
||||||
$element_list = [];
|
|
||||||
}
|
|
||||||
for ($i = 0, $i_max = count($element_list); $i < $i_max; $i++) {
|
for ($i = 0, $i_max = count($element_list); $i < $i_max; $i++) {
|
||||||
// $this->log->debug('form_error', 'Array: '
|
// $this->log->debug('form_error', 'Array: '
|
||||||
// . is_array($this->element_list[$element_list[$i]]['read_data']) . ' | '
|
// . is_array($this->element_list[$element_list[$i]]['read_data']) . ' | '
|
||||||
@@ -837,7 +829,7 @@ class Generate extends \CoreLibs\DB\Extended\ArrayIO
|
|||||||
return $return_array;
|
return $return_array;
|
||||||
}
|
}
|
||||||
if (empty($this->load_query)) {
|
if (empty($this->load_query)) {
|
||||||
$this->log->debug('LOAD LIST ERROR', 'Missing load list query');
|
$this->log->error('Missing load list query');
|
||||||
return $return_array;
|
return $return_array;
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -1964,7 +1956,7 @@ class Generate extends \CoreLibs\DB\Extended\ArrayIO
|
|||||||
if ($this->table_array[$key]['value']) {
|
if ($this->table_array[$key]['value']) {
|
||||||
// use the better new passwordSet instead of crypt based
|
// use the better new passwordSet instead of crypt based
|
||||||
$this->table_array[$key]['value'] =
|
$this->table_array[$key]['value'] =
|
||||||
\CoreLibs\Check\Password::passwordSet($this->table_array[$key]['value']);
|
\CoreLibs\Security\Password::passwordSet($this->table_array[$key]['value']);
|
||||||
$this->table_array[$key]['HIDDEN_value'] = $this->table_array[$key]['value'];
|
$this->table_array[$key]['HIDDEN_value'] = $this->table_array[$key]['value'];
|
||||||
} else {
|
} else {
|
||||||
// $this->table_array[$key]['HIDDEN_value'] =
|
// $this->table_array[$key]['HIDDEN_value'] =
|
||||||
@@ -2294,11 +2286,9 @@ class Generate extends \CoreLibs\DB\Extended\ArrayIO
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
if (is_array($hidden_array)) {
|
reset($hidden_array);
|
||||||
reset($hidden_array);
|
foreach ($hidden_array as $key => $value) {
|
||||||
foreach ($hidden_array as $key => $value) {
|
$hidden[] = ['key' => $key, 'value' => $value];
|
||||||
$hidden[] = ['key' => $key, 'value' => $value];
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
return $hidden;
|
return $hidden;
|
||||||
}
|
}
|
||||||
@@ -2629,8 +2619,8 @@ class Generate extends \CoreLibs\DB\Extended\ArrayIO
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
// add lost error ones
|
// add lost error ones
|
||||||
$this->log->debug('ERROR', 'P: ' . $data['prefix'] . ', '
|
$this->log->error('P: ' . $data['prefix'] . ', '
|
||||||
. $this->log->prAr($_POST['ERROR'][$data['prefix']] ?? []));
|
. Support::prAr($_POST['ERROR'][$data['prefix']] ?? []));
|
||||||
if ($this->error && !empty($_POST['ERROR'][$data['prefix']])) {
|
if ($this->error && !empty($_POST['ERROR'][$data['prefix']])) {
|
||||||
$prfx = $data['prefix']; // short
|
$prfx = $data['prefix']; // short
|
||||||
$_post_data = [];
|
$_post_data = [];
|
||||||
|
|||||||
@@ -4,10 +4,10 @@ declare(strict_types=1);
|
|||||||
|
|
||||||
namespace CoreLibs\Output\Form\TableArrays;
|
namespace CoreLibs\Output\Form\TableArrays;
|
||||||
|
|
||||||
class EditAccess implements \CoreLibs\Output\Form\TableArraysInterface
|
class EditAccess implements Interface\TableArraysInterface
|
||||||
{
|
{
|
||||||
/** @var \CoreLibs\Output\Form\Generate */
|
/** @var \CoreLibs\Output\Form\Generate */
|
||||||
private $form;
|
private \CoreLibs\Output\Form\Generate $form;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* constructor
|
* constructor
|
||||||
@@ -87,7 +87,9 @@ class EditAccess implements \CoreLibs\Output\Form\TableArraysInterface
|
|||||||
],
|
],
|
||||||
],
|
],
|
||||||
'table_name' => 'edit_access',
|
'table_name' => 'edit_access',
|
||||||
"load_query" => "SELECT edit_access_id, name FROM edit_access ORDER BY name",
|
"load_query" => "SELECT edit_access_id, name "
|
||||||
|
. "FROM edit_access "
|
||||||
|
. "ORDER BY name",
|
||||||
'show_fields' => [
|
'show_fields' => [
|
||||||
[
|
[
|
||||||
'name' => 'name'
|
'name' => 'name'
|
||||||
|
|||||||
@@ -4,10 +4,10 @@ declare(strict_types=1);
|
|||||||
|
|
||||||
namespace CoreLibs\Output\Form\TableArrays;
|
namespace CoreLibs\Output\Form\TableArrays;
|
||||||
|
|
||||||
class EditGroups implements \CoreLibs\Output\Form\TableArraysInterface
|
class EditGroups implements Interface\TableArraysInterface
|
||||||
{
|
{
|
||||||
/** @var \CoreLibs\Output\Form\Generate */
|
/** @var \CoreLibs\Output\Form\Generate */
|
||||||
private $form;
|
private \CoreLibs\Output\Form\Generate $form;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* constructor
|
* constructor
|
||||||
@@ -55,14 +55,19 @@ class EditGroups implements \CoreLibs\Output\Form\TableArraysInterface
|
|||||||
'mandatory' => 1,
|
'mandatory' => 1,
|
||||||
'int' => 1,
|
'int' => 1,
|
||||||
'type' => 'drop_down_db',
|
'type' => 'drop_down_db',
|
||||||
'query' => "SELECT edit_access_right_id, name FROM edit_access_right ORDER BY level"
|
'query' => "SELECT edit_access_right_id, name "
|
||||||
|
. "FROM edit_access_right "
|
||||||
|
. "ORDER BY level"
|
||||||
],
|
],
|
||||||
'edit_scheme_id' => [
|
'edit_scheme_id' => [
|
||||||
'value' => $_POST['edit_scheme_id'] ?? '',
|
'value' => $_POST['edit_scheme_id'] ?? '',
|
||||||
'output_name' => 'Group Scheme',
|
'output_name' => 'Group Scheme',
|
||||||
'int_null' => 1,
|
'int_null' => 1,
|
||||||
'type' => 'drop_down_db',
|
'type' => 'drop_down_db',
|
||||||
'query' => "SELECT edit_scheme_id, name FROM edit_scheme WHERE enabled = 1 ORDER BY name"
|
'query' => "SELECT edit_scheme_id, name "
|
||||||
|
. "FROM edit_scheme "
|
||||||
|
. "WHERE enabled = 1 "
|
||||||
|
. "ORDER BY name"
|
||||||
],
|
],
|
||||||
'additional_acl' => [
|
'additional_acl' => [
|
||||||
'value' => $_POST['additional_acl'] ?? '',
|
'value' => $_POST['additional_acl'] ?? '',
|
||||||
@@ -73,7 +78,9 @@ class EditGroups implements \CoreLibs\Output\Form\TableArraysInterface
|
|||||||
'cols' => 60
|
'cols' => 60
|
||||||
],
|
],
|
||||||
],
|
],
|
||||||
'load_query' => "SELECT edit_group_id, name, enabled FROM edit_group ORDER BY name",
|
'load_query' => "SELECT edit_group_id, name, enabled "
|
||||||
|
. "FROM edit_group "
|
||||||
|
. "ORDER BY name",
|
||||||
'table_name' => 'edit_group',
|
'table_name' => 'edit_group',
|
||||||
'show_fields' => [
|
'show_fields' => [
|
||||||
[
|
[
|
||||||
@@ -115,7 +122,9 @@ class EditGroups implements \CoreLibs\Output\Form\TableArraysInterface
|
|||||||
'output_name' => 'Access Level',
|
'output_name' => 'Access Level',
|
||||||
'int' => 1,
|
'int' => 1,
|
||||||
'preset' => 1, // first of the select
|
'preset' => 1, // first of the select
|
||||||
'query' => "SELECT edit_access_right_id, name FROM edit_access_right ORDER BY level"
|
'query' => "SELECT edit_access_right_id, name "
|
||||||
|
. "FROM edit_access_right "
|
||||||
|
. "ORDER BY level"
|
||||||
],
|
],
|
||||||
'edit_page_id' => [
|
'edit_page_id' => [
|
||||||
'int' => 1,
|
'int' => 1,
|
||||||
|
|||||||
@@ -4,10 +4,10 @@ declare(strict_types=1);
|
|||||||
|
|
||||||
namespace CoreLibs\Output\Form\TableArrays;
|
namespace CoreLibs\Output\Form\TableArrays;
|
||||||
|
|
||||||
class EditLanguages implements \CoreLibs\Output\Form\TableArraysInterface
|
class EditLanguages implements Interface\TableArraysInterface
|
||||||
{
|
{
|
||||||
/** @var \CoreLibs\Output\Form\Generate */
|
/** @var \CoreLibs\Output\Form\Generate */
|
||||||
private $form;
|
private \CoreLibs\Output\Form\Generate $form;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* constructor
|
* constructor
|
||||||
|
|||||||
@@ -4,10 +4,10 @@ declare(strict_types=1);
|
|||||||
|
|
||||||
namespace CoreLibs\Output\Form\TableArrays;
|
namespace CoreLibs\Output\Form\TableArrays;
|
||||||
|
|
||||||
class EditMenuGroup implements \CoreLibs\Output\Form\TableArraysInterface
|
class EditMenuGroup implements Interface\TableArraysInterface
|
||||||
{
|
{
|
||||||
/** @var \CoreLibs\Output\Form\Generate */
|
/** @var \CoreLibs\Output\Form\Generate */
|
||||||
private $form;
|
private \CoreLibs\Output\Form\Generate $form;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* constructor
|
* constructor
|
||||||
@@ -55,7 +55,9 @@ class EditMenuGroup implements \CoreLibs\Output\Form\TableArraysInterface
|
|||||||
],
|
],
|
||||||
],
|
],
|
||||||
'table_name' => 'edit_menu_group',
|
'table_name' => 'edit_menu_group',
|
||||||
'load_query' => "SELECT edit_menu_group_id, name FROM edit_menu_group ORDER BY name",
|
'load_query' => "SELECT edit_menu_group_id, name "
|
||||||
|
. "FROM edit_menu_group "
|
||||||
|
. "ORDER BY name",
|
||||||
'show_fields' => [
|
'show_fields' => [
|
||||||
[
|
[
|
||||||
'name' => 'name'
|
'name' => 'name'
|
||||||
|
|||||||
@@ -4,10 +4,10 @@ declare(strict_types=1);
|
|||||||
|
|
||||||
namespace CoreLibs\Output\Form\TableArrays;
|
namespace CoreLibs\Output\Form\TableArrays;
|
||||||
|
|
||||||
class EditPages implements \CoreLibs\Output\Form\TableArraysInterface
|
class EditPages implements Interface\TableArraysInterface
|
||||||
{
|
{
|
||||||
/** @var \CoreLibs\Output\Form\Generate */
|
/** @var \CoreLibs\Output\Form\Generate */
|
||||||
private $form;
|
private \CoreLibs\Output\Form\Generate $form;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* constructor
|
* constructor
|
||||||
@@ -140,7 +140,10 @@ class EditPages implements \CoreLibs\Output\Form\TableArraysInterface
|
|||||||
],
|
],
|
||||||
],
|
],
|
||||||
'load_query' => "SELECT edit_page_id, "
|
'load_query' => "SELECT edit_page_id, "
|
||||||
. "CASE WHEN hostname IS NOT NULL THEN hostname ELSE ''::VARCHAR END || filename AS filename, "
|
. "CASE "
|
||||||
|
. "WHEN hostname IS NOT NULL THEN hostname "
|
||||||
|
. "ELSE ''::VARCHAR "
|
||||||
|
. "END || filename AS filename, "
|
||||||
. "name, online, menu, popup "
|
. "name, online, menu, popup "
|
||||||
. "FROM edit_page "
|
. "FROM edit_page "
|
||||||
. "ORDER BY order_number",
|
. "ORDER BY order_number",
|
||||||
@@ -178,7 +181,8 @@ class EditPages implements \CoreLibs\Output\Form\TableArraysInterface
|
|||||||
'select_size' => 10,
|
'select_size' => 10,
|
||||||
'selected' => $_POST['edit_visible_group_id'] ?? '',
|
'selected' => $_POST['edit_visible_group_id'] ?? '',
|
||||||
'query' => "SELECT edit_visible_group_id, 'Name: ' || name || ', ' || 'Flag: ' || flag "
|
'query' => "SELECT edit_visible_group_id, 'Name: ' || name || ', ' || 'Flag: ' || flag "
|
||||||
. "FROM edit_visible_group ORDER BY name"
|
. "FROM edit_visible_group "
|
||||||
|
. "ORDER BY name"
|
||||||
],
|
],
|
||||||
'edit_menu_group' => [
|
'edit_menu_group' => [
|
||||||
'table_name' => 'edit_page_menu_group',
|
'table_name' => 'edit_page_menu_group',
|
||||||
@@ -188,7 +192,8 @@ class EditPages implements \CoreLibs\Output\Form\TableArraysInterface
|
|||||||
'select_size' => 10,
|
'select_size' => 10,
|
||||||
'selected' => $_POST['edit_menu_group_id'] ?? '',
|
'selected' => $_POST['edit_menu_group_id'] ?? '',
|
||||||
'query' => "SELECT edit_menu_group_id, 'Name: ' || name || ', ' || 'Flag: ' || flag "
|
'query' => "SELECT edit_menu_group_id, 'Name: ' || name || ', ' || 'Flag: ' || flag "
|
||||||
. "FROM edit_menu_group ORDER BY order_number"
|
. "FROM edit_menu_group "
|
||||||
|
. "ORDER BY order_number"
|
||||||
],
|
],
|
||||||
],
|
],
|
||||||
'element_list' => [
|
'element_list' => [
|
||||||
@@ -259,7 +264,9 @@ class EditPages implements \CoreLibs\Output\Form\TableArraysInterface
|
|||||||
'output_name' => 'Access Level',
|
'output_name' => 'Access Level',
|
||||||
'int' => 1,
|
'int' => 1,
|
||||||
'preset' => 1, // first of the select
|
'preset' => 1, // first of the select
|
||||||
'query' => "SELECT edit_access_right_id, name FROM edit_access_right ORDER BY level"
|
'query' => "SELECT edit_access_right_id, name "
|
||||||
|
. "FROM edit_access_right "
|
||||||
|
. "ORDER BY level"
|
||||||
],
|
],
|
||||||
'edit_page_content_id' => [
|
'edit_page_content_id' => [
|
||||||
'type' => 'hidden',
|
'type' => 'hidden',
|
||||||
|
|||||||
@@ -4,10 +4,10 @@ declare(strict_types=1);
|
|||||||
|
|
||||||
namespace CoreLibs\Output\Form\TableArrays;
|
namespace CoreLibs\Output\Form\TableArrays;
|
||||||
|
|
||||||
class EditSchemas implements \CoreLibs\Output\Form\TableArraysInterface
|
class EditSchemas implements Interface\TableArraysInterface
|
||||||
{
|
{
|
||||||
/** @var \CoreLibs\Output\Form\Generate */
|
/** @var \CoreLibs\Output\Form\Generate */
|
||||||
private $form;
|
private \CoreLibs\Output\Form\Generate $form;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* constructor
|
* constructor
|
||||||
@@ -68,7 +68,9 @@ class EditSchemas implements \CoreLibs\Output\Form\TableArraysInterface
|
|||||||
],
|
],
|
||||||
],
|
],
|
||||||
'table_name' => 'edit_scheme',
|
'table_name' => 'edit_scheme',
|
||||||
'load_query' => "SELECT edit_scheme_id, name, enabled FROM edit_scheme ORDER BY name",
|
'load_query' => "SELECT edit_scheme_id, name, enabled "
|
||||||
|
. "FROM edit_scheme "
|
||||||
|
. "ORDER BY name",
|
||||||
'show_fields' => [
|
'show_fields' => [
|
||||||
[
|
[
|
||||||
'name' => 'name'
|
'name' => 'name'
|
||||||
|
|||||||
@@ -4,10 +4,10 @@ declare(strict_types=1);
|
|||||||
|
|
||||||
namespace CoreLibs\Output\Form\TableArrays;
|
namespace CoreLibs\Output\Form\TableArrays;
|
||||||
|
|
||||||
class EditUsers implements \CoreLibs\Output\Form\TableArraysInterface
|
class EditUsers implements Interface\TableArraysInterface
|
||||||
{
|
{
|
||||||
/** @var \CoreLibs\Output\Form\Generate */
|
/** @var \CoreLibs\Output\Form\Generate */
|
||||||
private $form;
|
private \CoreLibs\Output\Form\Generate $form;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* constructor
|
* constructor
|
||||||
@@ -274,7 +274,7 @@ class EditUsers implements \CoreLibs\Output\Form\TableArraysInterface
|
|||||||
'type' => 'drop_down_db',
|
'type' => 'drop_down_db',
|
||||||
'query' => "SELECT edit_language_id, long_name "
|
'query' => "SELECT edit_language_id, long_name "
|
||||||
. "FROM edit_language "
|
. "FROM edit_language "
|
||||||
. "WHERE enabled = 1"
|
. "WHERE enabled = 1 "
|
||||||
. "ORDER BY order_number",
|
. "ORDER BY order_number",
|
||||||
'min_edit_acl' => '100',
|
'min_edit_acl' => '100',
|
||||||
'min_show_acl' => '100',
|
'min_show_acl' => '100',
|
||||||
@@ -284,7 +284,10 @@ class EditUsers implements \CoreLibs\Output\Form\TableArraysInterface
|
|||||||
'output_name' => 'Scheme',
|
'output_name' => 'Scheme',
|
||||||
'int_null' => 1,
|
'int_null' => 1,
|
||||||
'type' => 'drop_down_db',
|
'type' => 'drop_down_db',
|
||||||
'query' => "SELECT edit_scheme_id, name FROM edit_scheme WHERE enabled = 1 ORDER BY name",
|
'query' => "SELECT edit_scheme_id, name "
|
||||||
|
. "FROM edit_scheme "
|
||||||
|
. "WHERE enabled = 1 "
|
||||||
|
. "ORDER BY name",
|
||||||
'min_edit_acl' => '100',
|
'min_edit_acl' => '100',
|
||||||
'min_show_acl' => '100',
|
'min_show_acl' => '100',
|
||||||
],
|
],
|
||||||
@@ -293,7 +296,10 @@ class EditUsers implements \CoreLibs\Output\Form\TableArraysInterface
|
|||||||
'output_name' => 'Group',
|
'output_name' => 'Group',
|
||||||
'int' => 1,
|
'int' => 1,
|
||||||
'type' => 'drop_down_db',
|
'type' => 'drop_down_db',
|
||||||
'query' => "SELECT edit_group_id, name FROM edit_group WHERE enabled = 1 ORDER BY name",
|
'query' => "SELECT edit_group_id, name "
|
||||||
|
. "FROM edit_group "
|
||||||
|
. "WHERE enabled = 1 "
|
||||||
|
. "ORDER BY name",
|
||||||
'mandatory' => 1,
|
'mandatory' => 1,
|
||||||
'min_edit_acl' => '100',
|
'min_edit_acl' => '100',
|
||||||
'min_show_acl' => '100',
|
'min_show_acl' => '100',
|
||||||
@@ -304,7 +310,9 @@ class EditUsers implements \CoreLibs\Output\Form\TableArraysInterface
|
|||||||
'mandatory' => 1,
|
'mandatory' => 1,
|
||||||
'int' => 1,
|
'int' => 1,
|
||||||
'type' => 'drop_down_db',
|
'type' => 'drop_down_db',
|
||||||
'query' => "SELECT edit_access_right_id, name FROM edit_access_right ORDER BY level",
|
'query' => "SELECT edit_access_right_id, name "
|
||||||
|
. "FROM edit_access_right "
|
||||||
|
. "ORDER BY level",
|
||||||
'min_edit_acl' => '100',
|
'min_edit_acl' => '100',
|
||||||
'min_show_acl' => '100',
|
'min_show_acl' => '100',
|
||||||
],
|
],
|
||||||
@@ -434,7 +442,9 @@ class EditUsers implements \CoreLibs\Output\Form\TableArraysInterface
|
|||||||
'output_name' => 'Access Level',
|
'output_name' => 'Access Level',
|
||||||
'preset' => 1, // first of the select
|
'preset' => 1, // first of the select
|
||||||
'int' => 1,
|
'int' => 1,
|
||||||
'query' => "SELECT edit_access_right_id, name FROM edit_access_right ORDER BY level"
|
'query' => "SELECT edit_access_right_id, name "
|
||||||
|
. "FROM edit_access_right "
|
||||||
|
. "ORDER BY level"
|
||||||
],
|
],
|
||||||
'edit_default' => [
|
'edit_default' => [
|
||||||
'type' => 'radio_group',
|
'type' => 'radio_group',
|
||||||
|
|||||||
@@ -4,10 +4,10 @@ declare(strict_types=1);
|
|||||||
|
|
||||||
namespace CoreLibs\Output\Form\TableArrays;
|
namespace CoreLibs\Output\Form\TableArrays;
|
||||||
|
|
||||||
class EditVisibleGroup implements \CoreLibs\Output\Form\TableArraysInterface
|
class EditVisibleGroup implements Interface\TableArraysInterface
|
||||||
{
|
{
|
||||||
/** @var \CoreLibs\Output\Form\Generate */
|
/** @var \CoreLibs\Output\Form\Generate */
|
||||||
private $form;
|
private \CoreLibs\Output\Form\Generate $form;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* constructor
|
* constructor
|
||||||
@@ -48,7 +48,9 @@ class EditVisibleGroup implements \CoreLibs\Output\Form\TableArraysInterface
|
|||||||
],
|
],
|
||||||
],
|
],
|
||||||
'table_name' => 'edit_visible_group',
|
'table_name' => 'edit_visible_group',
|
||||||
'load_query' => "SELECT edit_visible_group_id, name FROM edit_visible_group ORDER BY name",
|
'load_query' => "SELECT edit_visible_group_id, name "
|
||||||
|
. "FROM edit_visible_group "
|
||||||
|
. "ORDER BY name",
|
||||||
'show_fields' => [
|
'show_fields' => [
|
||||||
[
|
[
|
||||||
'name' => 'name'
|
'name' => 'name'
|
||||||
|
|||||||
@@ -2,7 +2,7 @@
|
|||||||
|
|
||||||
declare(strict_types=1);
|
declare(strict_types=1);
|
||||||
|
|
||||||
namespace CoreLibs\Output\Form;
|
namespace CoreLibs\Output\Form\TableArrays\Interface;
|
||||||
|
|
||||||
interface TableArraysInterface
|
interface TableArraysInterface
|
||||||
{
|
{
|
||||||
@@ -12,6 +12,7 @@ class Image
|
|||||||
{
|
{
|
||||||
/**
|
/**
|
||||||
* converts picture to a thumbnail with max x and max y size
|
* converts picture to a thumbnail with max x and max y size
|
||||||
|
* TOOD: needs mandatory options for ImageMagic convert, paths, etc folders
|
||||||
*
|
*
|
||||||
* @param string $pic source image file with or without path
|
* @param string $pic source image file with or without path
|
||||||
* @param int $size_x maximum size width
|
* @param int $size_x maximum size width
|
||||||
@@ -22,7 +23,8 @@ class Image
|
|||||||
* if empty ROOT is choosen
|
* if empty ROOT is choosen
|
||||||
* @param string $cache_source cache path, if not given TMP is used
|
* @param string $cache_source cache path, if not given TMP is used
|
||||||
* @param bool $clear_cache if set to true, will create thumb all the tame
|
* @param bool $clear_cache if set to true, will create thumb all the tame
|
||||||
* @return string|bool thumbnail name, or false for error
|
* @return string thumbnail name
|
||||||
|
* @throws \RuntimeException no ImageMagick convert command found
|
||||||
*/
|
*/
|
||||||
public static function createThumbnail(
|
public static function createThumbnail(
|
||||||
string $pic,
|
string $pic,
|
||||||
@@ -32,14 +34,15 @@ class Image
|
|||||||
string $path = '',
|
string $path = '',
|
||||||
string $cache_source = '',
|
string $cache_source = '',
|
||||||
bool $clear_cache = false
|
bool $clear_cache = false
|
||||||
) {
|
): string {
|
||||||
// get image type flags
|
// get image type flags
|
||||||
$image_types = [
|
$image_types = [
|
||||||
|
0 => 'UNKOWN-IMAGE',
|
||||||
1 => 'gif',
|
1 => 'gif',
|
||||||
2 => 'jpg',
|
2 => 'jpg',
|
||||||
3 => 'png'
|
3 => 'png'
|
||||||
];
|
];
|
||||||
$return_data = false;
|
$return_data = '';
|
||||||
$CONVERT = '';
|
$CONVERT = '';
|
||||||
// if CONVERT is not defined, abort
|
// if CONVERT is not defined, abort
|
||||||
/** @phan-suppress-next-line PhanUndeclaredConstant */
|
/** @phan-suppress-next-line PhanUndeclaredConstant */
|
||||||
@@ -47,7 +50,7 @@ class Image
|
|||||||
/** @phan-suppress-next-line PhanUndeclaredConstant */
|
/** @phan-suppress-next-line PhanUndeclaredConstant */
|
||||||
$CONVERT = CONVERT;
|
$CONVERT = CONVERT;
|
||||||
} else {
|
} else {
|
||||||
return $return_data;
|
throw new \RuntimeException('CONVERT set binary is not executable or CONVERT is not defined');
|
||||||
}
|
}
|
||||||
if (!empty($cache_source)) {
|
if (!empty($cache_source)) {
|
||||||
$tmp_src = $cache_source;
|
$tmp_src = $cache_source;
|
||||||
@@ -67,72 +70,7 @@ class Image
|
|||||||
$pic = $tmp[(count($tmp) - 1)];
|
$pic = $tmp[(count($tmp) - 1)];
|
||||||
}
|
}
|
||||||
// does this picture exist and is it a picture
|
// does this picture exist and is it a picture
|
||||||
if (file_exists($filename) && is_file($filename)) {
|
if (!file_exists($filename) || !is_file($filename)) {
|
||||||
[$width, $height, $type] = getimagesize($filename) ?: [];
|
|
||||||
$convert_prefix = '';
|
|
||||||
$create_file = false;
|
|
||||||
$delete_filename = '';
|
|
||||||
// check if we can skip the PDF creation: if we have size, if do not have type, we assume type png
|
|
||||||
if (!$type && is_numeric($size_x) && is_numeric($size_y)) {
|
|
||||||
$check_thumb = $tmp_src . 'thumb_' . $pic . '_' . $size_x . 'x' . $size_y . '.' . $image_types[3];
|
|
||||||
if (!is_file($check_thumb)) {
|
|
||||||
$create_file = true;
|
|
||||||
} else {
|
|
||||||
$type = 3;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
// if type is not in the list, but returns as PDF, we need to convert to JPEG before
|
|
||||||
if (!$type) {
|
|
||||||
$output = [];
|
|
||||||
$return = null;
|
|
||||||
// is this a PDF, if no, return from here with nothing
|
|
||||||
$convert_prefix = 'png:';
|
|
||||||
# TEMP convert to PNG, we then override the file name
|
|
||||||
$convert_string = $CONVERT . ' ' . $filename . ' ' . $convert_prefix . $filename . '_TEMP';
|
|
||||||
$status = exec($convert_string, $output, $return);
|
|
||||||
$filename .= '_TEMP';
|
|
||||||
// for delete, in case we need to glob
|
|
||||||
$delete_filename = $filename;
|
|
||||||
// find file, if we can't find base name, use -0 as the first one (ignore other pages in multiple ones)
|
|
||||||
if (!is_file($filename)) {
|
|
||||||
$filename .= '-0';
|
|
||||||
}
|
|
||||||
[$width, $height, $type] = getimagesize($filename) ?: [];
|
|
||||||
}
|
|
||||||
// if no size given, set size to original
|
|
||||||
if (!$size_x || $size_x < 1 || !is_numeric($size_x)) {
|
|
||||||
$size_x = $width;
|
|
||||||
}
|
|
||||||
if (!$size_y || $size_y < 1 || !is_numeric($size_y)) {
|
|
||||||
$size_y = $height;
|
|
||||||
}
|
|
||||||
$thumb = 'thumb_' . $pic . '_' . $size_x . 'x' . $size_y . '.' . $image_types[$type];
|
|
||||||
$thumbnail = $tmp_src . $thumb;
|
|
||||||
// check if we already have this picture converted
|
|
||||||
if (!is_file($thumbnail) || $clear_cache == true) {
|
|
||||||
// convert the picture
|
|
||||||
if ($width > $size_x) {
|
|
||||||
$convert_string = $CONVERT . ' -geometry ' . $size_x . 'x ' . $filename . ' ' . $thumbnail;
|
|
||||||
$status = exec($convert_string, $output, $return);
|
|
||||||
// get the size of the converted data, if converted
|
|
||||||
if (is_file($thumbnail)) {
|
|
||||||
[$width, $height, $type] = getimagesize($thumbnail) ?: [];
|
|
||||||
}
|
|
||||||
}
|
|
||||||
if ($height > $size_y) {
|
|
||||||
$convert_string = $CONVERT . ' -geometry x' . $size_y . ' ' . $filename . ' ' . $thumbnail;
|
|
||||||
$status = exec($convert_string, $output, $return);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
if (!is_file($thumbnail)) {
|
|
||||||
copy($filename, $thumbnail);
|
|
||||||
}
|
|
||||||
$return_data = $thumb;
|
|
||||||
// if we have a delete filename, delete here with glob
|
|
||||||
if ($delete_filename) {
|
|
||||||
array_map('unlink', glob($delete_filename . '*') ?: []);
|
|
||||||
}
|
|
||||||
} else {
|
|
||||||
if (!empty($dummy) && strstr($dummy, '/') === false) {
|
if (!empty($dummy) && strstr($dummy, '/') === false) {
|
||||||
// check if we have the "dummy" image flag set
|
// check if we have the "dummy" image flag set
|
||||||
$filename = PICTURES . ICONS . strtoupper($dummy) . ".png";
|
$filename = PICTURES . ICONS . strtoupper($dummy) . ".png";
|
||||||
@@ -140,11 +78,77 @@ class Image
|
|||||||
if (!empty($dummy) && file_exists($filename) && is_file($filename)) {
|
if (!empty($dummy) && file_exists($filename) && is_file($filename)) {
|
||||||
$return_data = $filename;
|
$return_data = $filename;
|
||||||
} else {
|
} else {
|
||||||
$return_data = false;
|
throw new \Exception('Could not set dummy return file: ' . $dummy . ' in ' . $filename);
|
||||||
}
|
}
|
||||||
} else {
|
} else {
|
||||||
$filename = $dummy;
|
$return_data = $dummy;
|
||||||
}
|
}
|
||||||
|
return $return_data;
|
||||||
|
}
|
||||||
|
// resize image
|
||||||
|
[$width, $height, $type] = getimagesize($filename) ?: [0, 0, 0];
|
||||||
|
$convert_prefix = '';
|
||||||
|
$create_file = false;
|
||||||
|
$delete_filename = '';
|
||||||
|
// check if we can skip the PDF creation: if we have size, if do not have type, we assume type png
|
||||||
|
if (!$type) {
|
||||||
|
$check_thumb = $tmp_src . 'thumb_' . $pic . '_' . $size_x . 'x' . $size_y . '.' . $image_types[3];
|
||||||
|
if (!is_file($check_thumb)) {
|
||||||
|
$create_file = true;
|
||||||
|
} else {
|
||||||
|
$type = 3;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
// if type is not in the list, but returns as PDF, we need to convert to JPEG before
|
||||||
|
if (!$type) {
|
||||||
|
$output = [];
|
||||||
|
$return = null;
|
||||||
|
// is this a PDF, if no, return from here with nothing
|
||||||
|
$convert_prefix = 'png:';
|
||||||
|
# TEMP convert to PNG, we then override the file name
|
||||||
|
$convert_string = $CONVERT . ' ' . $filename . ' ' . $convert_prefix . $filename . '_TEMP';
|
||||||
|
$status = exec($convert_string, $output, $return);
|
||||||
|
$filename .= '_TEMP';
|
||||||
|
// for delete, in case we need to glob
|
||||||
|
$delete_filename = $filename;
|
||||||
|
// find file, if we can't find base name, use -0 as the first one (ignore other pages in multiple ones)
|
||||||
|
if (!is_file($filename)) {
|
||||||
|
$filename .= '-0';
|
||||||
|
}
|
||||||
|
[$width, $height, $type] = getimagesize($filename) ?: [0, 0, 0];
|
||||||
|
}
|
||||||
|
// if no size given, set size to original
|
||||||
|
if (!$size_x || $size_x < 1) {
|
||||||
|
$size_x = $width;
|
||||||
|
}
|
||||||
|
if (!$size_y || $size_y < 1) {
|
||||||
|
$size_y = $height;
|
||||||
|
}
|
||||||
|
$thumb = 'thumb_' . $pic . '_' . $size_x . 'x' . $size_y . '.' . $image_types[$type];
|
||||||
|
$thumbnail = $tmp_src . $thumb;
|
||||||
|
// check if we already have this picture converted
|
||||||
|
if (!is_file($thumbnail) || $clear_cache == true) {
|
||||||
|
// convert the picture
|
||||||
|
if ($width > $size_x) {
|
||||||
|
$convert_string = $CONVERT . ' -geometry ' . $size_x . 'x ' . $filename . ' ' . $thumbnail;
|
||||||
|
$status = exec($convert_string, $output, $return);
|
||||||
|
// get the size of the converted data, if converted
|
||||||
|
if (is_file($thumbnail)) {
|
||||||
|
[$width, $height, $type] = getimagesize($thumbnail) ?: [0, 0, 0];
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if ($height > $size_y) {
|
||||||
|
$convert_string = $CONVERT . ' -geometry x' . $size_y . ' ' . $filename . ' ' . $thumbnail;
|
||||||
|
$status = exec($convert_string, $output, $return);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if (!is_file($thumbnail)) {
|
||||||
|
copy($filename, $thumbnail);
|
||||||
|
}
|
||||||
|
$return_data = $thumb;
|
||||||
|
// if we have a delete filename, delete here with glob
|
||||||
|
if ($delete_filename) {
|
||||||
|
array_map('unlink', glob($delete_filename . '*') ?: []);
|
||||||
}
|
}
|
||||||
return $return_data;
|
return $return_data;
|
||||||
}
|
}
|
||||||
@@ -158,262 +162,304 @@ class Image
|
|||||||
* if both are set, those are the max sizes (aspect ration is always ekpt)
|
* if both are set, those are the max sizes (aspect ration is always ekpt)
|
||||||
* - if path is not given will cache folder for current path set
|
* - if path is not given will cache folder for current path set
|
||||||
*
|
*
|
||||||
* @param string $filename source file name with full path
|
* @param string $filename source file name with full path
|
||||||
* @param int $thumb_width thumbnail width
|
* @param int $thumb_width thumbnail width
|
||||||
* @param int $thumb_height thumbnail height
|
* @param int $thumb_height thumbnail height
|
||||||
* @param string|null $thumbnail_path altnerative path for thumbnails
|
* @param string|null $cache_folder path for thumbnail cache
|
||||||
* @param bool $create_dummy if we encounter an invalid file
|
* @param string|null $web_folder frontend path for output
|
||||||
* create a dummy image file and return it
|
* @param bool $create_dummy if we encounter an invalid file
|
||||||
* @param bool $use_cache default to true, set to false to skip
|
* create a dummy image file and return it
|
||||||
* creating new image if exists
|
* @param bool $use_cache default to true, set to false to skip
|
||||||
* @param bool $high_quality default to true, uses sample version,
|
* creating new image if exists
|
||||||
* set to false to not use (default true)
|
* @param bool $high_quality default to true, uses sample version,
|
||||||
* to use quick but less nice version
|
* set to false to not use (default true)
|
||||||
* @param int $jpeg_quality default 80, set image quality for jpeg only
|
* to use quick but less nice version
|
||||||
* @return string|bool thumbnail with path
|
* @param int $jpeg_quality default 80, set image quality for jpeg only
|
||||||
|
* @return string thumbnail with path
|
||||||
|
* @throws \UnexpectedValueException input values for filename or cache_folder are wrong
|
||||||
|
* @throws \RuntimeException convert (gd) failed
|
||||||
*/
|
*/
|
||||||
public static function createThumbnailSimple(
|
public static function createThumbnailSimple(
|
||||||
string $filename,
|
string $filename,
|
||||||
int $thumb_width = 0,
|
int $thumb_width = 0,
|
||||||
int $thumb_height = 0,
|
int $thumb_height = 0,
|
||||||
?string $thumbnail_path = null,
|
?string $cache_folder = null, // will be not null in future
|
||||||
|
?string $web_folder = null,
|
||||||
bool $create_dummy = true,
|
bool $create_dummy = true,
|
||||||
bool $use_cache = true,
|
bool $use_cache = true,
|
||||||
bool $high_quality = true,
|
bool $high_quality = true,
|
||||||
int $jpeg_quality = 80
|
int $jpeg_quality = 80
|
||||||
) {
|
): string {
|
||||||
$thumbnail = false;
|
$thumbnail = false;
|
||||||
|
$exception_message = 'Could not create thumbnail';
|
||||||
// $this->debug('IMAGE PREPARE', "FILE: $filename (exists "
|
// $this->debug('IMAGE PREPARE', "FILE: $filename (exists "
|
||||||
// .(string)file_exists($filename)."), WIDTH: $thumb_width, HEIGHT: $thumb_height");
|
// .(string)file_exists($filename)."), WIDTH: $thumb_width, HEIGHT: $thumb_height");
|
||||||
// check that input image exists and is either jpeg or png
|
|
||||||
// also fail if the basic CACHE folder does not exist at all
|
|
||||||
if (
|
if (
|
||||||
file_exists($filename) &&
|
$cache_folder === null ||
|
||||||
is_dir(BASE . LAYOUT . CONTENT_PATH . CACHE) &&
|
$web_folder === null
|
||||||
is_writable(BASE . LAYOUT . CONTENT_PATH . CACHE)
|
|
||||||
) {
|
) {
|
||||||
// $this->debug('IMAGE PREPARE', "FILENAME OK, THUMB WIDTH/HEIGHT OK");
|
/** @deprecated Do use cache folder and web folder parameters */
|
||||||
[$inc_width, $inc_height, $img_type] = getimagesize($filename) ?: [];
|
trigger_error(
|
||||||
$thumbnail_write_path = null;
|
'params $cache_folder and $web_folder must be set. Setting via constants is deprecated',
|
||||||
$thumbnail_web_path = null;
|
E_USER_DEPRECATED
|
||||||
// path set first
|
);
|
||||||
if (
|
// NOTE: we need to depracte this
|
||||||
$img_type == IMAGETYPE_JPEG ||
|
$cache_folder = BASE . LAYOUT . CONTENT_PATH . CACHE . IMAGES;
|
||||||
$img_type == IMAGETYPE_PNG ||
|
$web_folder = LAYOUT . CACHE . IMAGES;
|
||||||
$create_dummy === true
|
if (!is_dir($cache_folder)) {
|
||||||
) {
|
if (false === mkdir($cache_folder)) {
|
||||||
// $this->debug('IMAGE PREPARE', "IMAGE TYPE OK: ".$inc_width.'x'.$inc_height);
|
$cache_folder = BASE . LAYOUT . CONTENT_PATH . CACHE;
|
||||||
// set thumbnail paths
|
$web_folder = LAYOUT . CACHE;
|
||||||
$thumbnail_write_path = BASE . LAYOUT . CONTENT_PATH . CACHE . IMAGES;
|
|
||||||
$thumbnail_web_path = LAYOUT . CACHE . IMAGES;
|
|
||||||
// if images folder in cache does not exist create it, if failed, fall back to base cache folder
|
|
||||||
if (!is_dir($thumbnail_write_path)) {
|
|
||||||
if (false === mkdir($thumbnail_write_path)) {
|
|
||||||
$thumbnail_write_path = BASE . LAYOUT . CONTENT_PATH . CACHE;
|
|
||||||
$thumbnail_web_path = LAYOUT . CACHE;
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
// do resize or fall back on dummy run
|
}
|
||||||
if (
|
// check that input image exists and is either jpeg or png
|
||||||
$img_type == IMAGETYPE_JPEG ||
|
// also fail if the basic CACHE folder does not exist at all
|
||||||
$img_type == IMAGETYPE_PNG
|
if (!file_exists($filename)) {
|
||||||
) {
|
// return $thumbnail;
|
||||||
// if missing width or height in thumb, use the set one
|
throw new \UnexpectedValueException('Missing image file: ' . $filename);
|
||||||
if ($thumb_width == 0) {
|
}
|
||||||
$thumb_width = $inc_width;
|
if (!is_dir($cache_folder)) {
|
||||||
}
|
// return $thumbnail;
|
||||||
if ($thumb_height == 0) {
|
throw new \UnexpectedValueException('Cache folder is not a directory: ' . $cache_folder);
|
||||||
$thumb_height = $inc_height;
|
}
|
||||||
}
|
if (!is_writable($cache_folder)) {
|
||||||
// check resize parameters
|
// return $thumbnail;
|
||||||
if ($inc_width > $thumb_width || $inc_height > $thumb_height) {
|
throw new \UnexpectedValueException('Cache folder is not writeable: ' . $cache_folder);
|
||||||
$thumb_width_r = 0;
|
}
|
||||||
$thumb_height_r = 0;
|
// $this->debug('IMAGE PREPARE', "FILENAME OK, THUMB WIDTH/HEIGHT OK");
|
||||||
// we need to keep the aspect ration on longest side
|
[$inc_width, $inc_height, $img_type] = getimagesize($filename) ?: [0, 0, null];
|
||||||
if (
|
$thumbnail_write_path = null;
|
||||||
($inc_height > $inc_width &&
|
$thumbnail_web_path = null;
|
||||||
// and the height is bigger than thumb set
|
// path set first
|
||||||
$inc_height > $thumb_height) ||
|
if (
|
||||||
// or the height is smaller or equal width
|
$img_type == IMAGETYPE_JPEG ||
|
||||||
// but the width for the thumb is equal to the image height
|
$img_type == IMAGETYPE_PNG ||
|
||||||
($inc_height <= $inc_width &&
|
$create_dummy === true
|
||||||
$inc_width == $thumb_width
|
) {
|
||||||
)
|
// $this->debug('IMAGE PREPARE', "IMAGE TYPE OK: ".$inc_width.'x'.$inc_height);
|
||||||
) {
|
// set thumbnail paths
|
||||||
// $this->debug('IMAGE PREPARE', 'HEIGHT > WIDTH');
|
$thumbnail_write_path = $cache_folder;
|
||||||
$ratio = $inc_height / $thumb_height;
|
$thumbnail_web_path = $web_folder;
|
||||||
$thumb_width_r = (int)ceil($inc_width / $ratio);
|
}
|
||||||
$thumb_height_r = $thumb_height;
|
// do resize or fall back on dummy run
|
||||||
} else {
|
if (
|
||||||
// $this->debug('IMAGE PREPARE', 'WIDTH > HEIGHT');
|
$img_type == IMAGETYPE_JPEG ||
|
||||||
$ratio = $inc_width / $thumb_width;
|
$img_type == IMAGETYPE_PNG
|
||||||
$thumb_width_r = $thumb_width;
|
) {
|
||||||
$thumb_height_r = (int)ceil($inc_height / $ratio);
|
// if missing width or height in thumb, use the set one
|
||||||
}
|
if ($thumb_width == 0) {
|
||||||
// $this->debug('IMAGE PREPARE', "Ratio: $ratio, Target size $thumb_width_r x $thumb_height_r");
|
$thumb_width = $inc_width;
|
||||||
// set output thumbnail name
|
}
|
||||||
$thumbnail = 'thumb-' . pathinfo($filename)['filename'] . '-'
|
if ($thumb_height == 0) {
|
||||||
. $thumb_width_r . 'x' . $thumb_height_r;
|
$thumb_height = $inc_height;
|
||||||
if (
|
}
|
||||||
$use_cache === false ||
|
// check resize parameters
|
||||||
!file_exists($thumbnail_write_path . $thumbnail)
|
if ($inc_width > $thumb_width || $inc_height > $thumb_height) {
|
||||||
) {
|
$thumb_width_r = 0;
|
||||||
// image, copy source image, offset in image, source x/y, new size, source image size
|
$thumb_height_r = 0;
|
||||||
$thumb = imagecreatetruecolor($thumb_width_r, $thumb_height_r);
|
// we need to keep the aspect ration on longest side
|
||||||
if ($thumb === false) {
|
if (
|
||||||
return false;
|
($inc_height > $inc_width &&
|
||||||
}
|
// and the height is bigger than thumb set
|
||||||
if ($img_type == IMAGETYPE_PNG) {
|
$inc_height > $thumb_height) ||
|
||||||
$imagecolorallocatealpha = imagecolorallocatealpha($thumb, 0, 0, 0, 127);
|
// or the height is smaller or equal width
|
||||||
if ($imagecolorallocatealpha === false) {
|
// but the width for the thumb is equal to the image height
|
||||||
return false;
|
($inc_height <= $inc_width &&
|
||||||
}
|
$inc_width == $thumb_width
|
||||||
// preservere transaprency
|
)
|
||||||
imagecolortransparent(
|
) {
|
||||||
$thumb,
|
// $this->debug('IMAGE PREPARE', 'HEIGHT > WIDTH');
|
||||||
$imagecolorallocatealpha
|
$ratio = $inc_height / $thumb_height;
|
||||||
);
|
$thumb_width_r = (int)ceil($inc_width / $ratio);
|
||||||
imagealphablending($thumb, false);
|
$thumb_height_r = $thumb_height;
|
||||||
imagesavealpha($thumb, true);
|
|
||||||
}
|
|
||||||
$source = null;
|
|
||||||
switch ($img_type) {
|
|
||||||
case IMAGETYPE_JPEG:
|
|
||||||
$source = imagecreatefromjpeg($filename);
|
|
||||||
break;
|
|
||||||
case IMAGETYPE_PNG:
|
|
||||||
$source = imagecreatefrompng($filename);
|
|
||||||
break;
|
|
||||||
}
|
|
||||||
// check that we have a source image resource
|
|
||||||
if ($source !== null && $source !== false) {
|
|
||||||
// resize no shift
|
|
||||||
if ($high_quality === true) {
|
|
||||||
imagecopyresized(
|
|
||||||
$thumb,
|
|
||||||
$source,
|
|
||||||
0,
|
|
||||||
0,
|
|
||||||
0,
|
|
||||||
0,
|
|
||||||
$thumb_width_r,
|
|
||||||
$thumb_height_r,
|
|
||||||
$inc_width,
|
|
||||||
$inc_height
|
|
||||||
);
|
|
||||||
} else {
|
|
||||||
imagecopyresampled(
|
|
||||||
$thumb,
|
|
||||||
$source,
|
|
||||||
0,
|
|
||||||
0,
|
|
||||||
0,
|
|
||||||
0,
|
|
||||||
$thumb_width_r,
|
|
||||||
$thumb_height_r,
|
|
||||||
$inc_width,
|
|
||||||
$inc_height
|
|
||||||
);
|
|
||||||
}
|
|
||||||
// write file
|
|
||||||
switch ($img_type) {
|
|
||||||
case IMAGETYPE_JPEG:
|
|
||||||
imagejpeg($thumb, $thumbnail_write_path . $thumbnail, $jpeg_quality);
|
|
||||||
break;
|
|
||||||
case IMAGETYPE_PNG:
|
|
||||||
imagepng($thumb, $thumbnail_write_path . $thumbnail);
|
|
||||||
break;
|
|
||||||
}
|
|
||||||
// free up resources (in case we are called in a loop)
|
|
||||||
imagedestroy($source);
|
|
||||||
imagedestroy($thumb);
|
|
||||||
} else {
|
|
||||||
$thumbnail = false;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
} else {
|
} else {
|
||||||
// we just copy over the image as is, we never upscale
|
// $this->debug('IMAGE PREPARE', 'WIDTH > HEIGHT');
|
||||||
$thumbnail = 'thumb-' . pathinfo($filename)['filename'] . '-' . $inc_width . 'x' . $inc_height;
|
$ratio = $inc_width / $thumb_width;
|
||||||
if (
|
$thumb_width_r = $thumb_width;
|
||||||
$use_cache === false ||
|
$thumb_height_r = (int)ceil($inc_height / $ratio);
|
||||||
!file_exists($thumbnail_write_path . $thumbnail)
|
|
||||||
) {
|
|
||||||
copy($filename, $thumbnail_write_path . $thumbnail);
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
// add output path
|
// $this->debug('IMAGE PREPARE', "Ratio: $ratio, Target size $thumb_width_r x $thumb_height_r");
|
||||||
if ($thumbnail !== false) {
|
// set output thumbnail name
|
||||||
$thumbnail = $thumbnail_web_path . $thumbnail;
|
$thumbnail = 'thumb-' . pathinfo($filename)['filename'] . '-'
|
||||||
}
|
. $thumb_width_r . 'x' . $thumb_height_r;
|
||||||
} elseif ($create_dummy === true) {
|
|
||||||
// create dummy image in the thumbnail size
|
|
||||||
// if one side is missing, use the other side to create a square
|
|
||||||
if (!$thumb_width) {
|
|
||||||
$thumb_width = $thumb_height;
|
|
||||||
}
|
|
||||||
if (!$thumb_height) {
|
|
||||||
$thumb_height = $thumb_width;
|
|
||||||
}
|
|
||||||
// do we have an image already?
|
|
||||||
$thumbnail = 'thumb-' . pathinfo($filename)['filename'] . '-' . $thumb_width . 'x' . $thumb_height;
|
|
||||||
if (
|
if (
|
||||||
$use_cache === false ||
|
$use_cache === false ||
|
||||||
!file_exists($thumbnail_write_path . $thumbnail)
|
!file_exists($thumbnail_write_path . $thumbnail)
|
||||||
) {
|
) {
|
||||||
// if both are unset, set to 250
|
// image, copy source image, offset in image, source x/y, new size, source image size
|
||||||
if ($thumb_height == 0) {
|
$thumb = imagecreatetruecolor($thumb_width_r, $thumb_height_r);
|
||||||
$thumb_height = 250;
|
|
||||||
}
|
|
||||||
if ($thumb_width == 0) {
|
|
||||||
$thumb_width = 250;
|
|
||||||
}
|
|
||||||
$thumb = imagecreatetruecolor($thumb_width, $thumb_height);
|
|
||||||
if ($thumb === false) {
|
if ($thumb === false) {
|
||||||
return false;
|
throw new \RuntimeException(
|
||||||
|
'imagecreatetruecolor failed: ' . $thumbnail . ', ' . $filename,
|
||||||
|
1
|
||||||
|
);
|
||||||
}
|
}
|
||||||
// add outside border px = 5% (rounded up)
|
if ($img_type == IMAGETYPE_PNG) {
|
||||||
// eg 50px -> 2.5px
|
$imagecolorallocatealpha = imagecolorallocatealpha($thumb, 0, 0, 0, 127);
|
||||||
$gray = imagecolorallocate($thumb, 200, 200, 200);
|
if ($imagecolorallocatealpha === false) {
|
||||||
$white = imagecolorallocate($thumb, 255, 255, 255);
|
throw new \RuntimeException(
|
||||||
if ($gray === false || $white === false) {
|
'imagecolorallocatealpha failed: ' . $thumbnail . ', ' . $filename,
|
||||||
return false;
|
2
|
||||||
|
);
|
||||||
|
}
|
||||||
|
// preservere transaprency
|
||||||
|
imagecolortransparent(
|
||||||
|
$thumb,
|
||||||
|
$imagecolorallocatealpha
|
||||||
|
);
|
||||||
|
imagealphablending($thumb, false);
|
||||||
|
imagesavealpha($thumb, true);
|
||||||
}
|
}
|
||||||
// fill gray background
|
$source = null;
|
||||||
imagefill($thumb, 0, 0, $gray);
|
switch ($img_type) {
|
||||||
// now create rectangle
|
case IMAGETYPE_JPEG:
|
||||||
if (imagesx($thumb) < imagesy($thumb)) {
|
$source = imagecreatefromjpeg($filename);
|
||||||
$width = (int)round(imagesx($thumb) / 100 * 5);
|
break;
|
||||||
|
case IMAGETYPE_PNG:
|
||||||
|
$source = imagecreatefrompng($filename);
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
// check that we have a source image resource
|
||||||
|
if ($source !== null && $source !== false) {
|
||||||
|
// resize no shift
|
||||||
|
if ($high_quality === true) {
|
||||||
|
imagecopyresized(
|
||||||
|
$thumb,
|
||||||
|
$source,
|
||||||
|
0,
|
||||||
|
0,
|
||||||
|
0,
|
||||||
|
0,
|
||||||
|
$thumb_width_r,
|
||||||
|
$thumb_height_r,
|
||||||
|
$inc_width,
|
||||||
|
$inc_height
|
||||||
|
);
|
||||||
|
} else {
|
||||||
|
imagecopyresampled(
|
||||||
|
$thumb,
|
||||||
|
$source,
|
||||||
|
0,
|
||||||
|
0,
|
||||||
|
0,
|
||||||
|
0,
|
||||||
|
$thumb_width_r,
|
||||||
|
$thumb_height_r,
|
||||||
|
$inc_width,
|
||||||
|
$inc_height
|
||||||
|
);
|
||||||
|
}
|
||||||
|
// write file
|
||||||
|
switch ($img_type) {
|
||||||
|
case IMAGETYPE_JPEG:
|
||||||
|
imagejpeg($thumb, $thumbnail_write_path . $thumbnail, $jpeg_quality);
|
||||||
|
break;
|
||||||
|
case IMAGETYPE_PNG:
|
||||||
|
imagepng($thumb, $thumbnail_write_path . $thumbnail);
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
// free up resources (in case we are called in a loop)
|
||||||
|
imagedestroy($source);
|
||||||
|
imagedestroy($thumb);
|
||||||
} else {
|
} else {
|
||||||
$width = (int)round(imagesy($thumb) / 100 * 5);
|
throw new \RuntimeException(
|
||||||
|
'Invalid source image file. Only JPEG/PNG are allowed: ' . $filename,
|
||||||
|
3
|
||||||
|
);
|
||||||
}
|
}
|
||||||
imagefilledrectangle(
|
|
||||||
$thumb,
|
|
||||||
0 + $width,
|
|
||||||
0 + $width,
|
|
||||||
imagesx($thumb) - $width,
|
|
||||||
imagesy($thumb) - $width,
|
|
||||||
$white
|
|
||||||
);
|
|
||||||
// add "No valid images source"
|
|
||||||
// OR add circle
|
|
||||||
// * find center
|
|
||||||
// * width/height is 75% of size - border
|
|
||||||
// smaller size is taken
|
|
||||||
$base_width = imagesx($thumb) > imagesy($thumb) ? imagesy($thumb) : imagesx($thumb);
|
|
||||||
// get 75% width
|
|
||||||
$cross_width = (int)round((($base_width - ($width * 2)) / 100 * 75) / 2);
|
|
||||||
$center_x = (int)round(imagesx($thumb) / 2);
|
|
||||||
$center_y = (int)round(imagesy($thumb) / 2);
|
|
||||||
imagefilledellipse($thumb, $center_x, $center_y, $cross_width, $cross_width, $gray);
|
|
||||||
// find top left and bottom left for first line
|
|
||||||
imagepng($thumb, $thumbnail_write_path . $thumbnail);
|
|
||||||
}
|
}
|
||||||
// add web path
|
} else {
|
||||||
|
// we just copy over the image as is, we never upscale
|
||||||
|
$thumbnail = 'thumb-' . pathinfo($filename)['filename'] . '-' . $inc_width . 'x' . $inc_height;
|
||||||
|
if (
|
||||||
|
$use_cache === false ||
|
||||||
|
!file_exists($thumbnail_write_path . $thumbnail)
|
||||||
|
) {
|
||||||
|
copy($filename, $thumbnail_write_path . $thumbnail);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
// add output path
|
||||||
|
if ($thumbnail !== false) {
|
||||||
$thumbnail = $thumbnail_web_path . $thumbnail;
|
$thumbnail = $thumbnail_web_path . $thumbnail;
|
||||||
}
|
}
|
||||||
|
} elseif ($create_dummy === true) {
|
||||||
|
// create dummy image in the thumbnail size
|
||||||
|
// if one side is missing, use the other side to create a square
|
||||||
|
if (!$thumb_width) {
|
||||||
|
$thumb_width = $thumb_height;
|
||||||
|
}
|
||||||
|
if (!$thumb_height) {
|
||||||
|
$thumb_height = $thumb_width;
|
||||||
|
}
|
||||||
|
// do we have an image already?
|
||||||
|
$thumbnail = 'thumb-' . pathinfo($filename)['filename'] . '-' . $thumb_width . 'x' . $thumb_height;
|
||||||
|
if (
|
||||||
|
$use_cache === false ||
|
||||||
|
!file_exists($thumbnail_write_path . $thumbnail)
|
||||||
|
) {
|
||||||
|
// if both are unset, set to 250
|
||||||
|
if ($thumb_height == 0) {
|
||||||
|
$thumb_height = 250;
|
||||||
|
}
|
||||||
|
if ($thumb_width == 0) {
|
||||||
|
$thumb_width = 250;
|
||||||
|
}
|
||||||
|
$thumb = imagecreatetruecolor($thumb_width, $thumb_height);
|
||||||
|
if ($thumb === false) {
|
||||||
|
throw new \RuntimeException(
|
||||||
|
'imagecreatetruecolor dummy failed: ' . $thumbnail . ', ' . $filename,
|
||||||
|
3
|
||||||
|
);
|
||||||
|
}
|
||||||
|
// add outside border px = 5% (rounded up)
|
||||||
|
// eg 50px -> 2.5px
|
||||||
|
$gray = imagecolorallocate($thumb, 200, 200, 200);
|
||||||
|
$white = imagecolorallocate($thumb, 255, 255, 255);
|
||||||
|
if ($gray === false || $white === false) {
|
||||||
|
throw new \RuntimeException(
|
||||||
|
'imagecolorallocate/imagecolorallocate dummy failed: ' . $thumbnail . ', ' . $filename,
|
||||||
|
2
|
||||||
|
);
|
||||||
|
}
|
||||||
|
// fill gray background
|
||||||
|
imagefill($thumb, 0, 0, $gray);
|
||||||
|
// now create rectangle
|
||||||
|
if (imagesx($thumb) < imagesy($thumb)) {
|
||||||
|
$width = (int)round(imagesx($thumb) / 100 * 5);
|
||||||
|
} else {
|
||||||
|
$width = (int)round(imagesy($thumb) / 100 * 5);
|
||||||
|
}
|
||||||
|
imagefilledrectangle(
|
||||||
|
$thumb,
|
||||||
|
0 + $width,
|
||||||
|
0 + $width,
|
||||||
|
imagesx($thumb) - $width,
|
||||||
|
imagesy($thumb) - $width,
|
||||||
|
$white
|
||||||
|
);
|
||||||
|
// add "No valid images source"
|
||||||
|
// OR add circle
|
||||||
|
// * find center
|
||||||
|
// * width/height is 75% of size - border
|
||||||
|
// smaller size is taken
|
||||||
|
$base_width = imagesx($thumb) > imagesy($thumb) ? imagesy($thumb) : imagesx($thumb);
|
||||||
|
// get 75% width
|
||||||
|
$cross_width = (int)round((($base_width - ($width * 2)) / 100 * 75) / 2);
|
||||||
|
$center_x = (int)round(imagesx($thumb) / 2);
|
||||||
|
$center_y = (int)round(imagesy($thumb) / 2);
|
||||||
|
imagefilledellipse($thumb, $center_x, $center_y, $cross_width, $cross_width, $gray);
|
||||||
|
// find top left and bottom left for first line
|
||||||
|
imagepng($thumb, $thumbnail_write_path . $thumbnail);
|
||||||
|
}
|
||||||
|
// add web path
|
||||||
|
$thumbnail = $thumbnail_web_path . $thumbnail;
|
||||||
}
|
}
|
||||||
// either return false or the thumbnail name + output path web
|
// if still false -> throw exception
|
||||||
|
if ($thumbnail === false) {
|
||||||
|
throw new \RuntimeException($exception_message);
|
||||||
|
}
|
||||||
|
// else return the thumbnail name + output path web
|
||||||
return $thumbnail;
|
return $thumbnail;
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -425,13 +471,13 @@ class Image
|
|||||||
* @param string $filename path + filename to rotate. This file must be writeable
|
* @param string $filename path + filename to rotate. This file must be writeable
|
||||||
* @return void
|
* @return void
|
||||||
*/
|
*/
|
||||||
public static function correctImageOrientation($filename): void
|
public static function correctImageOrientation(string $filename): void
|
||||||
{
|
{
|
||||||
// function exists & file is writeable, else do nothing
|
// function exists & file is writeable, else do nothing
|
||||||
if (!function_exists('exif_read_data') || !is_writeable($filename)) {
|
if (!function_exists('exif_read_data') || !is_writeable($filename)) {
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
[$inc_width, $inc_height, $img_type] = getimagesize($filename) ?: [];
|
[$inc_width, $inc_height, $img_type] = getimagesize($filename) ?: [0, 0, null];
|
||||||
// add @ to avoid "file not supported error"
|
// add @ to avoid "file not supported error"
|
||||||
$exif = @exif_read_data($filename);
|
$exif = @exif_read_data($filename);
|
||||||
$orientation = null;
|
$orientation = null;
|
||||||
|
|||||||
@@ -23,13 +23,13 @@ class ProgressBar
|
|||||||
// private vars
|
// private vars
|
||||||
|
|
||||||
/** @var string */
|
/** @var string */
|
||||||
public $code; // unique code
|
public string $code; // unique code
|
||||||
/** @var string */
|
/** @var string */
|
||||||
public $status = 'new'; // current status (new,show,hide)
|
public string $status = 'new'; // current status (new,show,hide)
|
||||||
/** @var float|int */
|
/** @var float|int */
|
||||||
public $step = 0; // current step
|
public float|int $step = 0; // current step
|
||||||
/** @var array<string,null|int|float> */
|
/** @var array<string,null|int|float> */
|
||||||
public $position = [ // current bar position
|
public array $position = [ // current bar position
|
||||||
'left' => null,
|
'left' => null,
|
||||||
'top' => null,
|
'top' => null,
|
||||||
'width' => null,
|
'width' => null,
|
||||||
@@ -37,43 +37,43 @@ class ProgressBar
|
|||||||
];
|
];
|
||||||
|
|
||||||
/** @var int */
|
/** @var int */
|
||||||
public $clear_buffer_size = 1; // we need to send this before the lfush to get browser output
|
public int $clear_buffer_size = 1; // we need to send this before the lfush to get browser output
|
||||||
/** @var int */
|
/** @var int */
|
||||||
public $clear_buffer_size_init = 1024 * 1024; // if I don't send that junk, it won't send anything
|
public int $clear_buffer_size_init = 1024 * 1024; // if I don't send that junk, it won't send anything
|
||||||
|
|
||||||
// public vars
|
// public vars
|
||||||
|
|
||||||
/** @var int */
|
/** @var int */
|
||||||
public $min = 0; // minimal steps
|
public int $min = 0; // minimal steps
|
||||||
/** @var int */
|
/** @var int */
|
||||||
public $max = 100; // maximal steps
|
public int $max = 100; // maximal steps
|
||||||
|
|
||||||
/** @var int */
|
/** @var int */
|
||||||
public $left = 5; // bar position from left
|
public int $left = 5; // bar position from left
|
||||||
/** @var int */
|
/** @var int */
|
||||||
public $top = 5; // bar position from top
|
public int $top = 5; // bar position from top
|
||||||
/** @var int */
|
/** @var int */
|
||||||
public $width = 300; // bar width
|
public int $width = 300; // bar width
|
||||||
/** @var int */
|
/** @var int */
|
||||||
public $height = 25; // bar height
|
public int $height = 25; // bar height
|
||||||
/** @var int */
|
/** @var int */
|
||||||
public $pedding = 0; // bar pedding
|
public int $pedding = 0; // bar pedding
|
||||||
/** @var string */
|
/** @var string */
|
||||||
public $color = '#0033ff'; // bar color
|
public string $color = '#0033ff'; // bar color
|
||||||
/** @var string */
|
/** @var string */
|
||||||
public $bgr_color = '#c0c0c0'; // bar background color
|
public string $bgr_color = '#c0c0c0'; // bar background color
|
||||||
/** @var string */
|
/** @var string */
|
||||||
public $bgr_color_master = '#ffffff'; // master div background color
|
public string $bgr_color_master = '#ffffff'; // master div background color
|
||||||
/** @var int */
|
/** @var int */
|
||||||
public $border = 1; // bar border width
|
public int $border = 1; // bar border width
|
||||||
/** @var string */
|
/** @var string */
|
||||||
public $brd_color = '#000000'; // bar border color
|
public string $brd_color = '#000000'; // bar border color
|
||||||
|
|
||||||
/** @var string */
|
/** @var string */
|
||||||
public $direction = 'right'; // direction of motion (right,left,up,down)
|
public string $direction = 'right'; // direction of motion (right,left,up,down)
|
||||||
|
|
||||||
/** @var array<string,string|bool|int> */
|
/** @var array<string,string|bool|int> */
|
||||||
public $frame = ['show' => false]; // ProgressBar Frame
|
public array $frame = ['show' => false]; // ProgressBar Frame
|
||||||
/* 'show' => false, # frame show (true/false)
|
/* 'show' => false, # frame show (true/false)
|
||||||
'left' => 200, # frame position from left
|
'left' => 200, # frame position from left
|
||||||
'top' => 100, # frame position from top
|
'top' => 100, # frame position from top
|
||||||
@@ -86,7 +86,7 @@ class ProgressBar
|
|||||||
|
|
||||||
/** @#var array{string}{string: string|int} */
|
/** @#var array{string}{string: string|int} */
|
||||||
/** @var mixed[][] */
|
/** @var mixed[][] */
|
||||||
public $label = []; // ProgressBar Labels
|
public array $label = []; // ProgressBar Labels
|
||||||
/* 'name' => [ # label name
|
/* 'name' => [ # label name
|
||||||
'type' => 'text', # label type (text,button,step,percent,crossbar)
|
'type' => 'text', # label type (text,button,step,percent,crossbar)
|
||||||
'value' => 'Please wait ...', # label value
|
'value' => 'Please wait ...', # label value
|
||||||
@@ -105,7 +105,7 @@ class ProgressBar
|
|||||||
|
|
||||||
/** @var string */
|
/** @var string */
|
||||||
// output strings
|
// output strings
|
||||||
public $prefix_message = '';
|
public string $prefix_message = '';
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* progress bar constructor
|
* progress bar constructor
|
||||||
|
|||||||
61
src/Security/CreateKey.php
Normal file
61
src/Security/CreateKey.php
Normal file
@@ -0,0 +1,61 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
/**
|
||||||
|
* very simple symmetric encryption
|
||||||
|
* better use: https://paragonie.com/project/halite
|
||||||
|
*
|
||||||
|
* this is for creating secret keys for
|
||||||
|
* Security\SymmetricEncryption
|
||||||
|
*/
|
||||||
|
|
||||||
|
declare(strict_types=1);
|
||||||
|
|
||||||
|
namespace CoreLibs\Security;
|
||||||
|
|
||||||
|
class CreateKey
|
||||||
|
{
|
||||||
|
/**
|
||||||
|
* Create a random key that is a hex string
|
||||||
|
*
|
||||||
|
* @return string Hex string key for encrypting
|
||||||
|
*/
|
||||||
|
public static function generateRandomKey(): string
|
||||||
|
{
|
||||||
|
return self::bin2hex(self::randomKey());
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* create a random string as binary to encrypt data
|
||||||
|
* to store it in clear text in some .env file use bin2hex
|
||||||
|
*
|
||||||
|
* @return string Binary string for encryption
|
||||||
|
*/
|
||||||
|
public static function randomKey(): string
|
||||||
|
{
|
||||||
|
return random_bytes(SODIUM_CRYPTO_SECRETBOX_KEYBYTES);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* convert binary key to hex string
|
||||||
|
*
|
||||||
|
* @param string $hex_key Convert binary key string to hex
|
||||||
|
* @return string
|
||||||
|
*/
|
||||||
|
public static function bin2hex(string $hex_key): string
|
||||||
|
{
|
||||||
|
return sodium_bin2hex($hex_key);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* convert hex string to binary key
|
||||||
|
*
|
||||||
|
* @param string $string_key Convery hex key string to binary
|
||||||
|
* @return string
|
||||||
|
*/
|
||||||
|
public static function hex2bin(string $string_key): string
|
||||||
|
{
|
||||||
|
return sodium_hex2bin($string_key);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// __END__
|
||||||
59
src/Security/Password.php
Normal file
59
src/Security/Password.php
Normal file
@@ -0,0 +1,59 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
/*
|
||||||
|
* core password set, check and rehash check wrapper functions
|
||||||
|
*/
|
||||||
|
|
||||||
|
declare(strict_types=1);
|
||||||
|
|
||||||
|
namespace CoreLibs\Security;
|
||||||
|
|
||||||
|
class Password
|
||||||
|
{
|
||||||
|
/**
|
||||||
|
* creates the password hash
|
||||||
|
*
|
||||||
|
* @param string $password password
|
||||||
|
* @return string hashed password
|
||||||
|
*/
|
||||||
|
public static function passwordSet(string $password): string
|
||||||
|
{
|
||||||
|
// always use the PHP default for the password
|
||||||
|
// password options ca be set in the password init,
|
||||||
|
// but should be kept as default
|
||||||
|
return password_hash($password, PASSWORD_DEFAULT);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* checks if the entered password matches the hash
|
||||||
|
*
|
||||||
|
* @param string $password password
|
||||||
|
* @param string $hash password hash
|
||||||
|
* @return bool true or false
|
||||||
|
*/
|
||||||
|
public static function passwordVerify(string $password, string $hash): bool
|
||||||
|
{
|
||||||
|
if (password_verify($password, $hash)) {
|
||||||
|
return true;
|
||||||
|
} else {
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* checks if the password needs to be rehashed
|
||||||
|
*
|
||||||
|
* @param string $hash password hash
|
||||||
|
* @return bool true or false
|
||||||
|
*/
|
||||||
|
public static function passwordRehashCheck(string $hash): bool
|
||||||
|
{
|
||||||
|
if (password_needs_rehash($hash, PASSWORD_DEFAULT)) {
|
||||||
|
return true;
|
||||||
|
} else {
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// __END__
|
||||||
99
src/Security/SymmetricEncryption.php
Normal file
99
src/Security/SymmetricEncryption.php
Normal file
@@ -0,0 +1,99 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
/**
|
||||||
|
* very simple symmetric encryption
|
||||||
|
* Better use:
|
||||||
|
* https://paragonie.com/project/halite
|
||||||
|
* https://github.com/paragonie/halite
|
||||||
|
*
|
||||||
|
* current code is just to encrypt and decrypt
|
||||||
|
*
|
||||||
|
* must use a valid encryption key created with
|
||||||
|
* Secruty\CreateKey class
|
||||||
|
*/
|
||||||
|
|
||||||
|
declare(strict_types=1);
|
||||||
|
|
||||||
|
namespace CoreLibs\Security;
|
||||||
|
|
||||||
|
use CoreLibs\Security\CreateKey;
|
||||||
|
use SodiumException;
|
||||||
|
|
||||||
|
class SymmetricEncryption
|
||||||
|
{
|
||||||
|
/**
|
||||||
|
* Encrypt a message
|
||||||
|
*
|
||||||
|
* @param string $message Message to encrypt
|
||||||
|
* @param string $key Encryption key (as hex string)
|
||||||
|
* @return string
|
||||||
|
* @throws \Exception
|
||||||
|
* @throws \RangeException
|
||||||
|
*/
|
||||||
|
public static function encrypt(string $message, string $key): string
|
||||||
|
{
|
||||||
|
try {
|
||||||
|
$key = CreateKey::hex2bin($key);
|
||||||
|
} catch (SodiumException $e) {
|
||||||
|
throw new \UnexpectedValueException('Invalid hex key');
|
||||||
|
}
|
||||||
|
if (mb_strlen($key, '8bit') !== SODIUM_CRYPTO_SECRETBOX_KEYBYTES) {
|
||||||
|
throw new \RangeException(
|
||||||
|
'Key is not the correct size (must be '
|
||||||
|
. 'SODIUM_CRYPTO_SECRETBOX_KEYBYTES bytes long).'
|
||||||
|
);
|
||||||
|
}
|
||||||
|
$nonce = random_bytes(SODIUM_CRYPTO_SECRETBOX_NONCEBYTES);
|
||||||
|
|
||||||
|
$cipher = base64_encode(
|
||||||
|
$nonce
|
||||||
|
. sodium_crypto_secretbox(
|
||||||
|
$message,
|
||||||
|
$nonce,
|
||||||
|
$key
|
||||||
|
)
|
||||||
|
);
|
||||||
|
sodium_memzero($message);
|
||||||
|
sodium_memzero($key);
|
||||||
|
return $cipher;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Decrypt a message
|
||||||
|
*
|
||||||
|
* @param string $encrypted Message encrypted with safeEncrypt()
|
||||||
|
* @param string $key Encryption key (as hex string)
|
||||||
|
* @return string
|
||||||
|
* @throws \Exception
|
||||||
|
*/
|
||||||
|
public static function decrypt(string $encrypted, string $key): string
|
||||||
|
{
|
||||||
|
try {
|
||||||
|
$key = CreateKey::hex2bin($key);
|
||||||
|
} catch (SodiumException $e) {
|
||||||
|
throw new \Exception('Invalid hex key');
|
||||||
|
}
|
||||||
|
$decoded = base64_decode($encrypted);
|
||||||
|
$nonce = mb_substr($decoded, 0, SODIUM_CRYPTO_SECRETBOX_NONCEBYTES, '8bit');
|
||||||
|
$ciphertext = mb_substr($decoded, SODIUM_CRYPTO_SECRETBOX_NONCEBYTES, null, '8bit');
|
||||||
|
|
||||||
|
$plain = false;
|
||||||
|
try {
|
||||||
|
$plain = sodium_crypto_secretbox_open(
|
||||||
|
$ciphertext,
|
||||||
|
$nonce,
|
||||||
|
$key
|
||||||
|
);
|
||||||
|
} catch (SodiumException $e) {
|
||||||
|
throw new \UnexpectedValueException('Invalid ciphertext (too short)');
|
||||||
|
}
|
||||||
|
if (!is_string($plain)) {
|
||||||
|
throw new \UnexpectedValueException('Invalid Key');
|
||||||
|
}
|
||||||
|
sodium_memzero($ciphertext);
|
||||||
|
sodium_memzero($key);
|
||||||
|
return $plain;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// __END__
|
||||||
264
src/Template/HtmlBuilder/Block.php
Normal file
264
src/Template/HtmlBuilder/Block.php
Normal file
@@ -0,0 +1,264 @@
|
|||||||
|
<?php // phpcs:disable Generic.Files.LineLength
|
||||||
|
|
||||||
|
/**
|
||||||
|
* AUTOR: Clemens Schwaighofer
|
||||||
|
* CREATED: 2023/6/1
|
||||||
|
* DESCRIPTION:
|
||||||
|
* html builder: array
|
||||||
|
* static build for array lists (not objects)
|
||||||
|
*
|
||||||
|
* Recommended to use the Object one or for speed the String Replace
|
||||||
|
*/
|
||||||
|
|
||||||
|
namespace CoreLibs\Template\HtmlBuilder;
|
||||||
|
|
||||||
|
use CoreLibs\Template\HtmlBuilder\General\Settings;
|
||||||
|
use CoreLibs\Template\HtmlBuilder\General\Error;
|
||||||
|
use CoreLibs\Template\HtmlBuilder\General\HtmlBuilderExcpetion;
|
||||||
|
|
||||||
|
class Block
|
||||||
|
{
|
||||||
|
/**
|
||||||
|
* Undocumented function
|
||||||
|
*
|
||||||
|
* @param string $tag
|
||||||
|
* @param string $id
|
||||||
|
* @param string $content
|
||||||
|
* @param array<string> $css,
|
||||||
|
* @param array<string,string> $options
|
||||||
|
* @return array{tag:string,id:string,name:string,content:string,css:array<string>,options:array<string,string>,sub:array<mixed>}
|
||||||
|
* @throws HtmlBuilderExcpetion
|
||||||
|
*/
|
||||||
|
public static function cel(
|
||||||
|
string $tag,
|
||||||
|
string $id = '',
|
||||||
|
string $content = '',
|
||||||
|
array $css = [],
|
||||||
|
array $options = []
|
||||||
|
): array {
|
||||||
|
if (!preg_match("/^[A-Za-z]+$/", $tag)) {
|
||||||
|
Error::setError(
|
||||||
|
'201',
|
||||||
|
'invalid or empty tag',
|
||||||
|
['tag' => $tag]
|
||||||
|
);
|
||||||
|
throw new HtmlBuilderExcpetion('Invalid or empty tag');
|
||||||
|
}
|
||||||
|
return [
|
||||||
|
'tag' => $tag,
|
||||||
|
'id' => $id,
|
||||||
|
'name' => $options['name'] ?? '',
|
||||||
|
'content' => $content,
|
||||||
|
'css' => $css,
|
||||||
|
'options' => $options,
|
||||||
|
'sub' => [],
|
||||||
|
];
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Search element tree for id and add
|
||||||
|
* if id is empty add at current
|
||||||
|
*
|
||||||
|
* @param array{tag:string,id:string,name:string,content:string,css:array<string>,options:array<string,string>,sub:array<mixed>} $base
|
||||||
|
* @param array{tag:string,id:string,name:string,content:string,css:array<string>,options:array<string,string>,sub:array<mixed>} $attach
|
||||||
|
* @param string $id
|
||||||
|
* @return array{tag:string,id:string,name:string,content:string,css:array<string>,options:array<string,string>,sub:array<mixed>}
|
||||||
|
*/
|
||||||
|
public static function ael(
|
||||||
|
array $base,
|
||||||
|
array $attach,
|
||||||
|
string $id = ''
|
||||||
|
): array {
|
||||||
|
// no id or matching id
|
||||||
|
if (
|
||||||
|
empty($id) ||
|
||||||
|
$base['id'] == $id
|
||||||
|
) {
|
||||||
|
self::addSub($base, $attach);
|
||||||
|
return $base;
|
||||||
|
}
|
||||||
|
// find id in 'id' in all 'sub'
|
||||||
|
foreach ($base['sub'] as $el) {
|
||||||
|
$el = self::ael($el, $attach, $id);
|
||||||
|
}
|
||||||
|
|
||||||
|
return $base;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Undocumented function
|
||||||
|
*
|
||||||
|
* @param array{tag:string,id:string,name:string,content:string,css:array<string>,options:array<string,string>,sub:array<mixed>} $base
|
||||||
|
* @param array{tag:string,id:string,name:string,content:string,css:array<string>,options:array<string,string>,sub:array<mixed>} ...$attach
|
||||||
|
* @return array{tag:string,id:string,name:string,content:string,css:array<string>,options:array<string,string>,sub:array<mixed>}
|
||||||
|
*/
|
||||||
|
public static function aelx(
|
||||||
|
array $base,
|
||||||
|
array ...$attach
|
||||||
|
): array {
|
||||||
|
$base = self::addSub($base, ...$attach);
|
||||||
|
return $base;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Undocumented function
|
||||||
|
*
|
||||||
|
* @param array{tag:string,id:string,name:string,content:string,css:array<string>,options:array<string,string>,sub:array<mixed>} $element
|
||||||
|
* @param array{tag:string,id:string,name:string,content:string,css:array<string>,options:array<string,string>,sub:array<mixed>} $sub
|
||||||
|
* @return array{tag:string,id:string,name:string,content:string,css:array<string>,options:array<string,string>,sub:array<mixed>}
|
||||||
|
*/
|
||||||
|
public static function addSub(array $element, array ...$sub): array
|
||||||
|
{
|
||||||
|
if (!isset($element['sub'])) {
|
||||||
|
$element['sub'] = [];
|
||||||
|
}
|
||||||
|
array_push($element['sub'], ...$sub);
|
||||||
|
return $element;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Undocumented function
|
||||||
|
*
|
||||||
|
* @param array{tag:string,id:string,name:string,content:string,css:array<string>,options:array<string,string>,sub:array<mixed>} $element
|
||||||
|
* @return array{tag:string,id:string,name:string,content:string,css:array<string>,options:array<string,string>,sub:array<mixed>}
|
||||||
|
*/
|
||||||
|
public static function resetSub(array $element): array
|
||||||
|
{
|
||||||
|
$element['sub'] = [];
|
||||||
|
return $element;
|
||||||
|
}
|
||||||
|
|
||||||
|
// CSS Elements
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Undocumented function
|
||||||
|
*
|
||||||
|
* @param array{tag:string,id:string,name:string,content:string,css:array<string>,options:array<string,string>,sub:array<mixed>} $element
|
||||||
|
* @param string ...$css
|
||||||
|
* @return array{tag:string,id:string,name:string,content:string,css:array<string>,options:array<string,string>,sub:array<mixed>}
|
||||||
|
*/
|
||||||
|
public static function acssel(array $element, string ...$css): array
|
||||||
|
{
|
||||||
|
$element['css'] = array_unique(array_merge($element['css'] ?? [], $css));
|
||||||
|
return $element;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Undocumented function
|
||||||
|
*
|
||||||
|
* @param array{tag:string,id:string,name:string,content:string,css:array<string>,options:array<string,string>,sub:array<mixed>} $element
|
||||||
|
* @param string ...$css
|
||||||
|
* @return array{tag:string,id:string,name:string,content:string,css:array<string>,options:array<string,string>,sub:array<mixed>}
|
||||||
|
*/
|
||||||
|
public static function rcssel(array $element, string ...$css): array
|
||||||
|
{
|
||||||
|
$element['css'] = array_diff($element['css'] ?? [], $css);
|
||||||
|
return $element;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Undocumented function
|
||||||
|
* scssel (switch) is not supported
|
||||||
|
* use rcssel -> acssel
|
||||||
|
*
|
||||||
|
* @param array{tag:string,id:string,name:string,content:string,css:array<string>,options:array<string,string>,sub:array<mixed>} $element
|
||||||
|
* @param array<string> $rcss
|
||||||
|
* @param array<string> $acss
|
||||||
|
* @return array{tag:string,id:string,name:string,content:string,css:array<string>,options:array<string,string>,sub:array<mixed>}
|
||||||
|
*/
|
||||||
|
public static function scssel(array $element, array $rcss, array $acss): array
|
||||||
|
{
|
||||||
|
return self::acssel(
|
||||||
|
self::rcssel($element, ...$rcss),
|
||||||
|
...$acss
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Undocumented function
|
||||||
|
* alias phfo
|
||||||
|
*
|
||||||
|
* @param array{tag:string,id:string,name:string,content:string,css:array<string>,options:array<string,string>,sub:array<mixed>} $tree
|
||||||
|
* @param bool $add_nl [default=false]
|
||||||
|
* @return string
|
||||||
|
*/
|
||||||
|
public static function buildHtml(array $tree, bool $add_nl = false): string
|
||||||
|
{
|
||||||
|
if (empty($tree['tag'])) {
|
||||||
|
return '';
|
||||||
|
}
|
||||||
|
// print "D01: " . microtime(true) . "<br>";
|
||||||
|
$line = '<' . $tree['tag'];
|
||||||
|
|
||||||
|
if (!empty($tree['id'])) {
|
||||||
|
$line .= ' id="' . $tree['id'] . '"';
|
||||||
|
if (in_array($tree['tag'], Settings::NAME_ELEMENTS)) {
|
||||||
|
$line .= ' name="'
|
||||||
|
. (!empty($tree['name']) ? $tree['name'] : $tree['id'])
|
||||||
|
. '"';
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if (count($tree['css'])) {
|
||||||
|
$line .= ' class="' . join(' ', $tree['css']) . '"';
|
||||||
|
}
|
||||||
|
foreach ($tree['options'] ?? [] as $key => $item) {
|
||||||
|
if (in_array($key, Settings::SKIP_OPTIONS)) {
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
$line .= ' ' . $key . '="' . $item . '"';
|
||||||
|
}
|
||||||
|
$line .= '>';
|
||||||
|
if (!empty($tree['content'])) {
|
||||||
|
$line .= $tree['content'];
|
||||||
|
}
|
||||||
|
// sub nodes
|
||||||
|
foreach ($tree['sub'] ?? [] as $sub) {
|
||||||
|
if ($add_nl === true) {
|
||||||
|
$line .= "\n";
|
||||||
|
}
|
||||||
|
$line .= self::buildHtml($sub, $add_nl);
|
||||||
|
if ($add_nl === true) {
|
||||||
|
$line .= "\n";
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// close line if needed
|
||||||
|
if (!in_array($tree['tag'], Settings::NO_CLOSE)) {
|
||||||
|
$line .= '</' . $tree['tag'] . '>';
|
||||||
|
}
|
||||||
|
|
||||||
|
return $line;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Undocumented function
|
||||||
|
* alias phfa
|
||||||
|
*
|
||||||
|
* @param array<array{tag:string,id:string,name:string,content:string,css:array<string>,options:array<string,string>,sub:array<mixed>}> $list
|
||||||
|
* @param bool $add_nl [default=false]
|
||||||
|
* @return string
|
||||||
|
*/
|
||||||
|
public static function buildHtmlFromList(array $list, bool $add_nl = false): string
|
||||||
|
{
|
||||||
|
$output = '';
|
||||||
|
foreach ($list as $el) {
|
||||||
|
$output .= self::buildHtml($el, $add_nl);
|
||||||
|
}
|
||||||
|
return $output;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Undocumented function
|
||||||
|
* wrapper for buildHtmlFromList
|
||||||
|
*
|
||||||
|
* @param array<array{tag:string,id:string,name:string,content:string,css:array<string>,options:array<string,string>,sub:array<mixed>}> $list array of Elements to build string from
|
||||||
|
* @param bool $add_nl [default=false] Optional output string line break
|
||||||
|
* @return string build html as string
|
||||||
|
*/
|
||||||
|
public static function printHtmlFromArray(array $list, bool $add_nl = false): string
|
||||||
|
{
|
||||||
|
return self::buildHtmlFromList($list, $add_nl);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// __END__
|
||||||
559
src/Template/HtmlBuilder/Element.php
Normal file
559
src/Template/HtmlBuilder/Element.php
Normal file
@@ -0,0 +1,559 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
/**
|
||||||
|
* AUTOR: Clemens Schwaighofer
|
||||||
|
* CREATED: 2023/6/1
|
||||||
|
* DESCRIPTION:
|
||||||
|
* html builder: element
|
||||||
|
* nested and connected objects
|
||||||
|
*/
|
||||||
|
|
||||||
|
declare(strict_types=1);
|
||||||
|
|
||||||
|
namespace CoreLibs\Template\HtmlBuilder;
|
||||||
|
|
||||||
|
use CoreLibs\Template\HtmlBuilder\General\Settings;
|
||||||
|
use CoreLibs\Template\HtmlBuilder\General\Error;
|
||||||
|
use CoreLibs\Template\HtmlBuilder\General\HtmlBuilderExcpetion;
|
||||||
|
|
||||||
|
class Element
|
||||||
|
{
|
||||||
|
/** @var string */
|
||||||
|
private string $tag = '';
|
||||||
|
/** @var string */
|
||||||
|
private string $id = '';
|
||||||
|
/** @var string */
|
||||||
|
private string $name = '';
|
||||||
|
/** @var string */
|
||||||
|
private string $content = '';
|
||||||
|
/** @var array<string> */
|
||||||
|
private array $css = [];
|
||||||
|
/** @var array<string,mixed> */
|
||||||
|
private array $options = [];
|
||||||
|
/** @var array<Element> list of elements */
|
||||||
|
private array $sub = [];
|
||||||
|
|
||||||
|
/**
|
||||||
|
* create new html element
|
||||||
|
*
|
||||||
|
* @param string $tag html tag (eg div, button, etc)
|
||||||
|
* @param string $id html tag id, used also for name if name
|
||||||
|
* not set in $options
|
||||||
|
* @param string $content content text inside, eg <div>Content</div>
|
||||||
|
* if sub elements exist, they are added after content
|
||||||
|
* @param array<string> $css array of css names, put style in $options
|
||||||
|
* @param array<string,string> $options Additional element options in
|
||||||
|
* key = value format
|
||||||
|
* eg: onClick => 'something();'
|
||||||
|
* id, css are skipped
|
||||||
|
* name only set on input/button
|
||||||
|
* @throws HtmlBuilderExcpetion
|
||||||
|
*/
|
||||||
|
public function __construct(
|
||||||
|
string $tag,
|
||||||
|
string $id = '',
|
||||||
|
string $content = '',
|
||||||
|
array $css = [],
|
||||||
|
array $options = []
|
||||||
|
) {
|
||||||
|
// exit if not valid tag
|
||||||
|
try {
|
||||||
|
$this->setTag($tag);
|
||||||
|
} catch (HtmlBuilderExcpetion $e) {
|
||||||
|
throw new HtmlBuilderExcpetion('Could not create Element', 0, $e);
|
||||||
|
}
|
||||||
|
$this->setId($id);
|
||||||
|
$this->setName($options['name'] ?? '');
|
||||||
|
$this->setContent($content);
|
||||||
|
$this->addCss(...$css);
|
||||||
|
$this->setOptions($options);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* set tag
|
||||||
|
*
|
||||||
|
* @param string $tag
|
||||||
|
* @return void
|
||||||
|
* @throws HtmlBuilderExcpetion
|
||||||
|
*/
|
||||||
|
public function setTag(string $tag): void
|
||||||
|
{
|
||||||
|
// tag must be letters only
|
||||||
|
if (!preg_match("/^[A-Za-z]+$/", $tag)) {
|
||||||
|
Error::setError(
|
||||||
|
'201',
|
||||||
|
'invalid or empty tag',
|
||||||
|
['tag' => $tag]
|
||||||
|
);
|
||||||
|
throw new HtmlBuilderExcpetion('Invalid or empty tag: ' . $tag);
|
||||||
|
}
|
||||||
|
$this->tag = $tag;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* get the tag name
|
||||||
|
*
|
||||||
|
* @return string HTML element tag
|
||||||
|
*/
|
||||||
|
public function getTag(): string
|
||||||
|
{
|
||||||
|
return $this->tag;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* set the element id
|
||||||
|
*
|
||||||
|
* @param string $id
|
||||||
|
* @return void
|
||||||
|
*/
|
||||||
|
public function setId(string $id): void
|
||||||
|
{
|
||||||
|
// invalid id and name check too
|
||||||
|
// be strict: [a-zA-Z0-9], -, _
|
||||||
|
// cannot start with digit, two hyphens or a hyphen with a digit:
|
||||||
|
// 0abc
|
||||||
|
// __abc
|
||||||
|
// _0abc
|
||||||
|
if (
|
||||||
|
!empty($id) &&
|
||||||
|
!preg_match("/^[A-Za-z][\w-]*$/", $id)
|
||||||
|
) {
|
||||||
|
Error::setWarning(
|
||||||
|
'202',
|
||||||
|
'possible invalid id',
|
||||||
|
['id' => $id, 'tag' => $this->getTag()]
|
||||||
|
);
|
||||||
|
// TODO: shoud throw error
|
||||||
|
}
|
||||||
|
$this->id = $id;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* get the html tag id
|
||||||
|
*
|
||||||
|
* @return string HTML element id
|
||||||
|
*/
|
||||||
|
public function getId(): string
|
||||||
|
{
|
||||||
|
return $this->id;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Set name for elements
|
||||||
|
* only for elements that need it (input/button/form)
|
||||||
|
*
|
||||||
|
* @param string $name
|
||||||
|
* @return void
|
||||||
|
*/
|
||||||
|
public function setName(string $name): void
|
||||||
|
{
|
||||||
|
if (
|
||||||
|
!empty($name) &&
|
||||||
|
!preg_match("/^[A-Za-z][\w-]*$/", $name)
|
||||||
|
) {
|
||||||
|
Error::setWarning(
|
||||||
|
'203',
|
||||||
|
'possible invalid name',
|
||||||
|
['name' => $name, 'id' => $this->getId(), 'tag' => $this->getTag()]
|
||||||
|
);
|
||||||
|
// TODO: shoud throw error
|
||||||
|
}
|
||||||
|
$this->name = $name;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* get the name if set
|
||||||
|
*
|
||||||
|
* @return string Optional HTML name (eg for input)
|
||||||
|
*/
|
||||||
|
public function getName(): string
|
||||||
|
{
|
||||||
|
return $this->name;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Set new content for element
|
||||||
|
*
|
||||||
|
* @param string $content
|
||||||
|
* @return void
|
||||||
|
*/
|
||||||
|
public function setContent(string $content): void
|
||||||
|
{
|
||||||
|
$this->content = $content;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* get the elment text content (not sub elements)
|
||||||
|
*
|
||||||
|
* @return string HTML content text as is
|
||||||
|
*/
|
||||||
|
public function getContent(): string
|
||||||
|
{
|
||||||
|
return $this->content;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* set or update options
|
||||||
|
*
|
||||||
|
* @param array<string,mixed> $options
|
||||||
|
* @return void
|
||||||
|
*/
|
||||||
|
public function setOptions(array $options): void
|
||||||
|
{
|
||||||
|
foreach ($options as $key => $value) {
|
||||||
|
if (empty($key)) {
|
||||||
|
Error::setError(
|
||||||
|
'110',
|
||||||
|
'Cannot set option with empty key',
|
||||||
|
['id' => $this->getId(), 'tag' => $this->getTag()]
|
||||||
|
);
|
||||||
|
// TODO: shoud throw error
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
// if data is null
|
||||||
|
if ($value === null) {
|
||||||
|
if (isset($this->options[$key])) {
|
||||||
|
unset($this->options[$key]);
|
||||||
|
} else {
|
||||||
|
Error::setError(
|
||||||
|
'210',
|
||||||
|
'Cannot set option with null value',
|
||||||
|
['id' => $this->getId(), 'tag' => $this->getTag()]
|
||||||
|
);
|
||||||
|
}
|
||||||
|
// TODO: shoud throw error
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
$this->options[$key] = $value;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* get the options array
|
||||||
|
* also holds "name" option
|
||||||
|
* anything like: style, javascript, value or any other html tag option
|
||||||
|
* right side can be empty but not null
|
||||||
|
*
|
||||||
|
* @return array<string,string> get options as list html option name and value
|
||||||
|
*/
|
||||||
|
public function getOptions(): array
|
||||||
|
{
|
||||||
|
return $this->options;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Sub Elements
|
||||||
|
|
||||||
|
/**
|
||||||
|
* get the sub elements (array of Elements)
|
||||||
|
*
|
||||||
|
* @return array<Element> Array of Elements (that can have sub elements)
|
||||||
|
*/
|
||||||
|
public function getSub(): array
|
||||||
|
{
|
||||||
|
return $this->sub;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* add one or many sub elements (add at the end)
|
||||||
|
*
|
||||||
|
* @param Element $sub One or many elements to add
|
||||||
|
* @return void
|
||||||
|
* @throws HtmlBuilderExcpetion
|
||||||
|
*/
|
||||||
|
public function addSub(Element ...$sub): void
|
||||||
|
{
|
||||||
|
foreach ($sub as $_sub) {
|
||||||
|
// if one of the elements is the same as this class, ignore it
|
||||||
|
// with this we avoid self reference loop
|
||||||
|
if ($_sub == $this) {
|
||||||
|
Error::setError(
|
||||||
|
'100',
|
||||||
|
'Cannot assign Element to itself, this would create an infinite loop',
|
||||||
|
['id' => $this->getId(), 'tag' => $this->getTag()]
|
||||||
|
);
|
||||||
|
throw new HtmlBuilderExcpetion('Cannot assign Element to itself, this would create an infinite loop');
|
||||||
|
}
|
||||||
|
array_push($this->sub, $_sub);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Remove an element from the sub array
|
||||||
|
* By pos in array or id set on first level
|
||||||
|
*
|
||||||
|
* @param int|string $id String id name or int pos number in array
|
||||||
|
* @return void
|
||||||
|
*/
|
||||||
|
public function removeSub(int|string $id): void
|
||||||
|
{
|
||||||
|
// find element with id and remove it
|
||||||
|
// or when number find pos in sub and remove it
|
||||||
|
if (is_int($id)) {
|
||||||
|
if (!isset($this->sub[$id])) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
unset($this->sub[$id]);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
// only on first level
|
||||||
|
foreach ($this->sub as $pos => $el) {
|
||||||
|
if (
|
||||||
|
$el->getId() === $id
|
||||||
|
) {
|
||||||
|
unset($this->sub[$pos]);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* remove all sub elements
|
||||||
|
*
|
||||||
|
* @return void
|
||||||
|
*/
|
||||||
|
public function resetSub(): void
|
||||||
|
{
|
||||||
|
$this->sub = [];
|
||||||
|
}
|
||||||
|
|
||||||
|
// CSS Elements
|
||||||
|
|
||||||
|
/**
|
||||||
|
* get the current set css elements
|
||||||
|
*
|
||||||
|
* @return array<string> list of css element entries
|
||||||
|
*/
|
||||||
|
public function getCss(): array
|
||||||
|
{
|
||||||
|
return $this->css;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* add one or many new css elements
|
||||||
|
* Note that we can chain: add/remove/reset
|
||||||
|
*
|
||||||
|
* @param string ...$css one or more css strings to add
|
||||||
|
* @return Element Current element for chaining
|
||||||
|
*/
|
||||||
|
public function addCss(string ...$css): Element
|
||||||
|
{
|
||||||
|
// should do check for empty/invalid css
|
||||||
|
$_set_css = [];
|
||||||
|
foreach ($css as $_css) {
|
||||||
|
if (empty($_css)) {
|
||||||
|
Error::setError(
|
||||||
|
'204',
|
||||||
|
'cannot have empty css string',
|
||||||
|
);
|
||||||
|
// TODO: shoud throw error
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
// -?[_A-Za-z][_A-Za-z0-9-]*
|
||||||
|
if (!preg_match("/^-?[_A-Za-z][_A-Za-z0-9-]*$/", $_css)) {
|
||||||
|
Error::setWarning(
|
||||||
|
'205',
|
||||||
|
'possible invalid css string',
|
||||||
|
['css' => $_css, 'id' => $this->id, 'tag' => $this->tag]
|
||||||
|
);
|
||||||
|
// TODO: shoud throw error
|
||||||
|
}
|
||||||
|
$_set_css[] = $_css;
|
||||||
|
}
|
||||||
|
$this->css = array_unique(array_merge($this->css, $_set_css));
|
||||||
|
return $this;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* remove one or more css elements
|
||||||
|
* Note that we can chain: add/remove/reset
|
||||||
|
*
|
||||||
|
* @param string ...$css one or more css strings to remove
|
||||||
|
* @return Element Current element for chaining
|
||||||
|
*/
|
||||||
|
public function removeCss(string ...$css): Element
|
||||||
|
{
|
||||||
|
$this->css = array_diff($this->css, $css);
|
||||||
|
return $this;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* unset all css elements
|
||||||
|
* Note that we can chain: add/remove/reset
|
||||||
|
*
|
||||||
|
* @return Element
|
||||||
|
*/
|
||||||
|
public function resetCss(): Element
|
||||||
|
{
|
||||||
|
$this->css = [];
|
||||||
|
return $this;
|
||||||
|
}
|
||||||
|
|
||||||
|
// build output from tree
|
||||||
|
|
||||||
|
/**
|
||||||
|
* build html string from the current element tree (self)
|
||||||
|
* or from the Element tree given as parameter
|
||||||
|
* if $add_nl is set then new lines are added before each sub element added
|
||||||
|
* no indet is done (tab or other)
|
||||||
|
*
|
||||||
|
* @param Element|null $tree Different Element tree to build
|
||||||
|
* if not set (null), self is used
|
||||||
|
* @param bool $add_nl [default=false] Optional output string line breaks
|
||||||
|
* @return string HTML as string
|
||||||
|
*/
|
||||||
|
public function buildHtml(Element $tree = null, bool $add_nl = false): string
|
||||||
|
{
|
||||||
|
// print "D01: " . microtime(true) . "<br>";
|
||||||
|
if ($tree === null) {
|
||||||
|
$tree = $this;
|
||||||
|
}
|
||||||
|
$line = '<' . $tree->getTag();
|
||||||
|
|
||||||
|
if ($tree->getId()) {
|
||||||
|
$line .= ' id="' . $tree->getId() . '"';
|
||||||
|
if (in_array($tree->getTag(), Settings::NAME_ELEMENTS)) {
|
||||||
|
$line .= ' name="'
|
||||||
|
. (!empty($tree->getName()) ? $tree->getName() : $tree->getId())
|
||||||
|
. '"';
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if (count($tree->getCss())) {
|
||||||
|
$line .= ' class="' . join(' ', $tree->getCss()) . '"';
|
||||||
|
}
|
||||||
|
foreach ($tree->getOptions() as $key => $item) {
|
||||||
|
// skip
|
||||||
|
if (in_array($key, Settings::SKIP_OPTIONS)) {
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
$line .= ' ' . $key . '="' . $item . '"';
|
||||||
|
}
|
||||||
|
$line .= '>';
|
||||||
|
if (strlen($tree->getContent()) > 0) {
|
||||||
|
$line .= $tree->getContent();
|
||||||
|
}
|
||||||
|
// sub nodes
|
||||||
|
foreach ($tree->getSub() as $sub) {
|
||||||
|
if ($add_nl === true) {
|
||||||
|
$line .= "\n";
|
||||||
|
}
|
||||||
|
$line .= $tree->buildHtml($sub, $add_nl);
|
||||||
|
if ($add_nl === true) {
|
||||||
|
$line .= "\n";
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// close line if needed
|
||||||
|
if (!in_array($tree->getTag(), Settings::NO_CLOSE)) {
|
||||||
|
$line .= '</' . $tree->getTag() . '>';
|
||||||
|
}
|
||||||
|
|
||||||
|
return $line;
|
||||||
|
}
|
||||||
|
|
||||||
|
// this is static
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Builds a single string from an array of elements
|
||||||
|
* a new line can be added before each new element if $add_nl is set to true
|
||||||
|
*
|
||||||
|
* @param array<Element> $list array of Elements, uses buildHtml internal
|
||||||
|
* @param bool $add_nl [default=false] Optional output string line breaks
|
||||||
|
* @return string HTML as string
|
||||||
|
*/
|
||||||
|
public static function buildHtmlFromList(array $list, bool $add_nl = false): string
|
||||||
|
{
|
||||||
|
$output = '';
|
||||||
|
foreach ($list as $el) {
|
||||||
|
if (!empty($output) && $add_nl === true) {
|
||||||
|
$output .= "\n";
|
||||||
|
}
|
||||||
|
$output .= $el->buildHtml();
|
||||||
|
}
|
||||||
|
return $output;
|
||||||
|
}
|
||||||
|
|
||||||
|
// so we can call builder statically
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Search element tree for id and add
|
||||||
|
* if id is empty add at element given in parameter $base
|
||||||
|
*
|
||||||
|
* @param Element $base Element to attach to
|
||||||
|
* @param Element $attach Element to attach (single)
|
||||||
|
* @param string $id Optional id, if empty then attached at the end
|
||||||
|
* If set will loop through ALL sub elements until
|
||||||
|
* matching id found. if not found, not added
|
||||||
|
* @return Element Element with attached sub element
|
||||||
|
*/
|
||||||
|
public static function addElementWithId(
|
||||||
|
Element $base,
|
||||||
|
Element $attach,
|
||||||
|
string $id = ''
|
||||||
|
): Element {
|
||||||
|
// no id or matching id
|
||||||
|
if (
|
||||||
|
empty($id) ||
|
||||||
|
$base->getId() == $id
|
||||||
|
) {
|
||||||
|
$base->addSub($attach);
|
||||||
|
return $base;
|
||||||
|
}
|
||||||
|
// find id in 'id' in all 'sub'
|
||||||
|
foreach ($base->getSub() as $el) {
|
||||||
|
self::addElementWithId($el, $attach, $id);
|
||||||
|
}
|
||||||
|
|
||||||
|
return $base;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* add one or more elemens to $base
|
||||||
|
*
|
||||||
|
* @param Element $base Element to attach to
|
||||||
|
* @param Element ...$attach Element or Elements to attach
|
||||||
|
* @return Element Element with attached sub elements
|
||||||
|
*/
|
||||||
|
public static function addElement(
|
||||||
|
Element $base,
|
||||||
|
Element ...$attach
|
||||||
|
): Element {
|
||||||
|
// we must make sure we do not self attach
|
||||||
|
$base->addSub(...$attach);
|
||||||
|
return $base;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Static call version for building
|
||||||
|
* not recommended to be used, rather use "Element->buildHtml()"
|
||||||
|
* wrapper for buildHtml
|
||||||
|
*
|
||||||
|
* @param ?Element $tree Element tree to build
|
||||||
|
* if not set returns empty string
|
||||||
|
* @param bool $add_nl [default=false] Optional output string line break
|
||||||
|
* @return string build html as string
|
||||||
|
* @deprecated Do not use, use Element->buildHtml() instead
|
||||||
|
*/
|
||||||
|
public static function printHtmlFromObject(Element $tree = null, bool $add_nl = false): string
|
||||||
|
{
|
||||||
|
// nothing ->bad
|
||||||
|
if ($tree === null) {
|
||||||
|
return '';
|
||||||
|
}
|
||||||
|
return $tree->buildHtml(add_nl: $add_nl);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Undocumented function
|
||||||
|
* wrapper for buildHtmlFromList
|
||||||
|
*
|
||||||
|
* @param array<Element> $list array of Elements to build string from
|
||||||
|
* @param bool $add_nl [default=false] Optional output string line break
|
||||||
|
* @return string build html as string
|
||||||
|
*/
|
||||||
|
public static function printHtmlFromArray(array $list, bool $add_nl = false): string
|
||||||
|
{
|
||||||
|
return self::buildHtmlFromList($list, $add_nl);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// __END__
|
||||||
127
src/Template/HtmlBuilder/General/Error.php
Normal file
127
src/Template/HtmlBuilder/General/Error.php
Normal file
@@ -0,0 +1,127 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
/**
|
||||||
|
* AUTOR: Clemens Schwaighofer
|
||||||
|
* CREATED: 2023/6/27
|
||||||
|
* DESCRIPTION:
|
||||||
|
* Error logging for the HtmlBuilder systs
|
||||||
|
*/
|
||||||
|
|
||||||
|
declare(strict_types=1);
|
||||||
|
|
||||||
|
namespace CoreLibs\Template\HtmlBuilder\General;
|
||||||
|
|
||||||
|
class Error
|
||||||
|
{
|
||||||
|
/** @var array<array{level:string,id:string,message:string,context:array<mixed>}> */
|
||||||
|
private static array $messages = [];
|
||||||
|
|
||||||
|
/**
|
||||||
|
* internal writer for messages
|
||||||
|
*
|
||||||
|
* @param string $level
|
||||||
|
* @param string $id
|
||||||
|
* @param string $message
|
||||||
|
* @param array<mixed> $context
|
||||||
|
* @return void
|
||||||
|
*/
|
||||||
|
private static function writeContent(
|
||||||
|
string $level,
|
||||||
|
string $id,
|
||||||
|
string $message,
|
||||||
|
array $context
|
||||||
|
): void {
|
||||||
|
self::$messages[] = [
|
||||||
|
'level' => $level,
|
||||||
|
'id' => $id,
|
||||||
|
'message' => $message,
|
||||||
|
'context' => $context,
|
||||||
|
];
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* warning collector for all internal string errors
|
||||||
|
* builds an warning with warning id, message text and array with optional content
|
||||||
|
*
|
||||||
|
* @param string $id
|
||||||
|
* @param string $message
|
||||||
|
* @param array<mixed> $context
|
||||||
|
* @return void
|
||||||
|
*/
|
||||||
|
public static function setWarning(string $id, string $message, array $context = []): void
|
||||||
|
{
|
||||||
|
self::writeContent('Warning', $id, $message, $context);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* error collector for all internal string errors
|
||||||
|
* builds an error with error id, message text and array with optional content
|
||||||
|
*
|
||||||
|
* @param string $id
|
||||||
|
* @param string $message
|
||||||
|
* @param array<mixed> $context
|
||||||
|
* @return void
|
||||||
|
*/
|
||||||
|
public static function setError(string $id, string $message, array $context = []): void
|
||||||
|
{
|
||||||
|
self::writeContent('Error', $id, $message, $context);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Return all set errors
|
||||||
|
*
|
||||||
|
* @return array<mixed>
|
||||||
|
*/
|
||||||
|
public static function getMessages(): array
|
||||||
|
{
|
||||||
|
return self::$messages;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Reset all errors
|
||||||
|
*
|
||||||
|
* @return void
|
||||||
|
*/
|
||||||
|
public static function resetMessages(): void
|
||||||
|
{
|
||||||
|
self::$messages = [];
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* internal level in message array exists check
|
||||||
|
*
|
||||||
|
* @param string $level
|
||||||
|
* @return bool
|
||||||
|
*/
|
||||||
|
private static function hasLevel(string $level): bool
|
||||||
|
{
|
||||||
|
return array_filter(
|
||||||
|
self::$messages,
|
||||||
|
function ($var) use ($level) {
|
||||||
|
return $var['level'] == $level ? true : false;
|
||||||
|
}
|
||||||
|
) === [] ? false : true;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Check if any error is set
|
||||||
|
*
|
||||||
|
* @return bool
|
||||||
|
*/
|
||||||
|
public static function hasError(): bool
|
||||||
|
{
|
||||||
|
return self::hasLevel('Error');
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Check if any warning is set
|
||||||
|
*
|
||||||
|
* @return bool
|
||||||
|
*/
|
||||||
|
public static function hasWarning(): bool
|
||||||
|
{
|
||||||
|
return self::hasLevel('Warning');
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// __END__
|
||||||
21
src/Template/HtmlBuilder/General/HtmlBuilderExcpetion.php
Normal file
21
src/Template/HtmlBuilder/General/HtmlBuilderExcpetion.php
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
/**
|
||||||
|
* AUTOR: Clemens Schwaighofer
|
||||||
|
* CREATED: 2023/6/28
|
||||||
|
* DESCRIPTION:
|
||||||
|
* Exception class for the HtmlBuilder blocks
|
||||||
|
*/
|
||||||
|
|
||||||
|
declare(strict_types=1);
|
||||||
|
|
||||||
|
namespace CoreLibs\Template\HtmlBuilder\General;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Exception class for HtmlBuilder
|
||||||
|
*/
|
||||||
|
class HtmlBuilderExcpetion extends \Exception
|
||||||
|
{
|
||||||
|
}
|
||||||
|
|
||||||
|
// __END__
|
||||||
69
src/Template/HtmlBuilder/General/Settings.php
Normal file
69
src/Template/HtmlBuilder/General/Settings.php
Normal file
@@ -0,0 +1,69 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
/**
|
||||||
|
* AUTOR: Clemens Schwaighofer
|
||||||
|
* CREATED: 2023/7/22
|
||||||
|
* DESCRIPTION:
|
||||||
|
* General settings for html elements
|
||||||
|
*/
|
||||||
|
|
||||||
|
declare(strict_types=1);
|
||||||
|
|
||||||
|
namespace CoreLibs\Template\HtmlBuilder\General;
|
||||||
|
|
||||||
|
class Settings
|
||||||
|
{
|
||||||
|
/** @var array<string> list of html elements that can have the name tag */
|
||||||
|
public const NAME_ELEMENTS = [
|
||||||
|
'button',
|
||||||
|
'fieldset',
|
||||||
|
'form',
|
||||||
|
'iframe',
|
||||||
|
'input',
|
||||||
|
'map',
|
||||||
|
'meta',
|
||||||
|
'object',
|
||||||
|
'output',
|
||||||
|
'param',
|
||||||
|
'select',
|
||||||
|
'textarea',
|
||||||
|
];
|
||||||
|
|
||||||
|
/** @var array<string> options key entries to be skipped in build */
|
||||||
|
public const SKIP_OPTIONS = [
|
||||||
|
'id',
|
||||||
|
'name',
|
||||||
|
'class',
|
||||||
|
];
|
||||||
|
|
||||||
|
/** @var array<string> html elements that don't need to be closed */
|
||||||
|
public const NO_CLOSE = [
|
||||||
|
'input',
|
||||||
|
'br',
|
||||||
|
'img',
|
||||||
|
'hr',
|
||||||
|
'area',
|
||||||
|
'col',
|
||||||
|
'keygen',
|
||||||
|
'wbr',
|
||||||
|
'track',
|
||||||
|
'source',
|
||||||
|
'param',
|
||||||
|
'command',
|
||||||
|
// only in header
|
||||||
|
'base',
|
||||||
|
'meta',
|
||||||
|
'link',
|
||||||
|
'embed',
|
||||||
|
];
|
||||||
|
|
||||||
|
/** @var array<string> invalid tags, not allowed in body */
|
||||||
|
public const NOT_IN_BODY_ALLOWED = [
|
||||||
|
'base',
|
||||||
|
'meta',
|
||||||
|
'link',
|
||||||
|
'embed', // not sure
|
||||||
|
];
|
||||||
|
}
|
||||||
|
|
||||||
|
// __END__
|
||||||
194
src/Template/HtmlBuilder/StringReplace.php
Normal file
194
src/Template/HtmlBuilder/StringReplace.php
Normal file
@@ -0,0 +1,194 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
/**
|
||||||
|
* AUTOR: Clemens Schwaighofer
|
||||||
|
* CREATED: 2023/6/23
|
||||||
|
* DESCRIPTION:
|
||||||
|
* Simeple string replace calls for elements
|
||||||
|
*/
|
||||||
|
|
||||||
|
declare(strict_types=1);
|
||||||
|
|
||||||
|
namespace CoreLibs\Template\HtmlBuilder;
|
||||||
|
|
||||||
|
use CoreLibs\Template\HtmlBuilder\General\Error;
|
||||||
|
use CoreLibs\Template\HtmlBuilder\General\HtmlBuilderExcpetion;
|
||||||
|
|
||||||
|
class StringReplace
|
||||||
|
{
|
||||||
|
/** @var array<string,string> */
|
||||||
|
private static array $elements = [];
|
||||||
|
/** @var array<string,string> */
|
||||||
|
private static array $replace = [];
|
||||||
|
|
||||||
|
/**
|
||||||
|
* load html blocks into array for repeated usage
|
||||||
|
* each array group parameter has 0: index, 1: content
|
||||||
|
* There is no content check done.
|
||||||
|
* index must be non empty (but has no fixed format)
|
||||||
|
* if same index is tried twice it will set an error and skip
|
||||||
|
*
|
||||||
|
* @param array{0:string,1:string} ...$element Elements to load
|
||||||
|
* @return void
|
||||||
|
* @throws HtmlBuilderExcpetion
|
||||||
|
*/
|
||||||
|
public static function loadElements(array ...$element): void
|
||||||
|
{
|
||||||
|
foreach ($element as $el) {
|
||||||
|
$index = $el[0] ?? '';
|
||||||
|
if (empty($index)) {
|
||||||
|
Error::setError(
|
||||||
|
'310',
|
||||||
|
'Index cannot be an empty string',
|
||||||
|
[
|
||||||
|
'element' => $index
|
||||||
|
]
|
||||||
|
);
|
||||||
|
throw new HtmlBuilderExcpetion('Index cannot be an empty string');
|
||||||
|
}
|
||||||
|
if (isset(self::$elements[$index])) {
|
||||||
|
Error::setError(
|
||||||
|
'311',
|
||||||
|
'Index already exists',
|
||||||
|
[
|
||||||
|
'element' => $index
|
||||||
|
]
|
||||||
|
);
|
||||||
|
throw new HtmlBuilderExcpetion('Index already exists: ' . $index);
|
||||||
|
}
|
||||||
|
// content check?
|
||||||
|
self::$elements[$index] = $el[1];
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* update an element at index
|
||||||
|
* can also be used to reset (empty string)
|
||||||
|
*
|
||||||
|
* @param string $index
|
||||||
|
* @param string $element
|
||||||
|
* @return void
|
||||||
|
*/
|
||||||
|
public static function updateElement(string $index, string $element): void
|
||||||
|
{
|
||||||
|
if (!isset(self::$elements[$index])) {
|
||||||
|
Error::setError(
|
||||||
|
'312',
|
||||||
|
'Index does not exists',
|
||||||
|
[
|
||||||
|
'element' => $index
|
||||||
|
]
|
||||||
|
);
|
||||||
|
throw new HtmlBuilderExcpetion('Index does not exists: ' . $index);
|
||||||
|
}
|
||||||
|
// allow empty reset
|
||||||
|
self::$elements[$index] = $element;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* get an element block at index
|
||||||
|
* if not found will return false
|
||||||
|
*
|
||||||
|
* @param string $index
|
||||||
|
* @return string
|
||||||
|
* @throws HtmlBuilderExcpetion
|
||||||
|
*/
|
||||||
|
public static function getElement(string $index): string
|
||||||
|
{
|
||||||
|
if (!isset(self::$elements[$index])) {
|
||||||
|
Error::setError('321', 'Index not found in elements', ['element' => $index]);
|
||||||
|
throw new HtmlBuilderExcpetion('Index not found in elements array: ' . $index);
|
||||||
|
}
|
||||||
|
return self::$elements[$index];
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* set a replacement block at index
|
||||||
|
* can be used for setting one block and using it agai
|
||||||
|
*
|
||||||
|
* @param string $index
|
||||||
|
* @param string $content
|
||||||
|
* @return void
|
||||||
|
*/
|
||||||
|
public static function setReplaceBlock(string $index, string $content): void
|
||||||
|
{
|
||||||
|
self::$replace[$index] = $content;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* get replacement block at index, if not found return empty and set error
|
||||||
|
*
|
||||||
|
* @param string $index
|
||||||
|
* @return string
|
||||||
|
* @throws HtmlBuilderExcpetion
|
||||||
|
*/
|
||||||
|
public static function getReplaceBlock(string $index): string
|
||||||
|
{
|
||||||
|
if (!isset(self::$replace[$index])) {
|
||||||
|
Error::setError('331', 'Index not found in replace block', ['replace' => $index]);
|
||||||
|
throw new HtmlBuilderExcpetion('Index not found in replace block array: ' . $index);
|
||||||
|
}
|
||||||
|
return self::$replace[$index];
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* build and element on an index and either returns it or also sets it
|
||||||
|
* into the replace block array
|
||||||
|
* if index not found in relement list will return false
|
||||||
|
*
|
||||||
|
* @param string $index index of set element
|
||||||
|
* @param array<string,string> $replace array of text to search (key) and replace (value) for
|
||||||
|
* @return string
|
||||||
|
* @throws HtmlBuilderExcpetion
|
||||||
|
*/
|
||||||
|
public static function buildElement(
|
||||||
|
string $index,
|
||||||
|
array $replace,
|
||||||
|
string $replace_index = ''
|
||||||
|
): string {
|
||||||
|
try {
|
||||||
|
self::getElement($index);
|
||||||
|
} catch (HtmlBuilderExcpetion $e) {
|
||||||
|
throw new HtmlBuilderExcpetion('Cannot fetch element with index: ' . $index, 0, $e);
|
||||||
|
}
|
||||||
|
if ($replace_index) {
|
||||||
|
self::setReplaceBlock(
|
||||||
|
$replace_index,
|
||||||
|
self::replaceData(self::$elements[$index], $replace)
|
||||||
|
);
|
||||||
|
return self::getReplaceBlock($replace_index);
|
||||||
|
} else {
|
||||||
|
return self::replaceData(self::$elements[$index], $replace);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* main replace entries in text string
|
||||||
|
* elements to be replaced are in {} brackets. if they are missing in the
|
||||||
|
* replace array they will be added.
|
||||||
|
* if the replace and content count is not the same then an error will be thrown
|
||||||
|
*
|
||||||
|
* @param string $data
|
||||||
|
* @param array<string,string> $replace
|
||||||
|
* @return string
|
||||||
|
* @throws HtmlBuilderExcpetion
|
||||||
|
*/
|
||||||
|
public static function replaceData(string $data, array $replace): string
|
||||||
|
{
|
||||||
|
$to_replace = array_keys($replace);
|
||||||
|
// all replace data must have {} around
|
||||||
|
array_walk($to_replace, function (&$entry) {
|
||||||
|
if (!str_starts_with($entry, '{')) {
|
||||||
|
$entry = '{' . $entry;
|
||||||
|
}
|
||||||
|
if (!str_ends_with($entry, '}')) {
|
||||||
|
$entry .= '}';
|
||||||
|
}
|
||||||
|
// do some validation?
|
||||||
|
});
|
||||||
|
// replace content
|
||||||
|
return str_replace($to_replace, array_values($replace), $data);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// __END__
|
||||||
@@ -24,134 +24,132 @@ class SmartyExtend extends \Smarty
|
|||||||
{
|
{
|
||||||
// internal translation engine
|
// internal translation engine
|
||||||
/** @var \CoreLibs\Language\L10n */
|
/** @var \CoreLibs\Language\L10n */
|
||||||
public $l10n;
|
public \CoreLibs\Language\L10n $l10n;
|
||||||
|
|
||||||
// lang & encoding
|
// lang & encoding
|
||||||
/** @var string */
|
/** @var string */
|
||||||
public $lang_dir = '';
|
public string $lang_dir = '';
|
||||||
/** @var string */
|
/** @var string */
|
||||||
public $lang;
|
public string $lang;
|
||||||
/** @var string */
|
/** @var string */
|
||||||
public $locale_set;
|
public string $lang_short;
|
||||||
/** @var string */
|
/** @var string */
|
||||||
public $lang_short;
|
public string $domain;
|
||||||
/** @var string */
|
/** @var string */
|
||||||
public $domain;
|
public string $encoding;
|
||||||
/** @var string */
|
|
||||||
public $encoding;
|
|
||||||
// page name
|
// page name
|
||||||
/** @var string */
|
/** @var string */
|
||||||
public $page_name;
|
public string $page_name;
|
||||||
|
|
||||||
// array for data parsing
|
// array for data parsing
|
||||||
/** @var array<mixed> */
|
/** @var array<mixed> */
|
||||||
public $HEADER = [];
|
public array $HEADER = [];
|
||||||
/** @var array<mixed> */
|
/** @var array<mixed> */
|
||||||
public $DATA = [];
|
public array $DATA = [];
|
||||||
/** @var array<mixed> */
|
/** @var array<mixed> */
|
||||||
public $DEBUG_DATA = [];
|
public array $DEBUG_DATA = [];
|
||||||
/** @var array<mixed> */
|
/** @var array<mixed> */
|
||||||
private $CONTENT_DATA = [];
|
private array $CONTENT_DATA = [];
|
||||||
// control vars
|
// control vars
|
||||||
/** @var bool */
|
/** @var bool */
|
||||||
public $USE_PROTOTYPE = USE_PROTOTYPE;
|
public bool $USE_PROTOTYPE = USE_PROTOTYPE;
|
||||||
/** @var bool */
|
/** @var bool */
|
||||||
public $USE_JQUERY = USE_JQUERY;
|
public bool $USE_JQUERY = USE_JQUERY;
|
||||||
/** @var bool */
|
/** @var bool */
|
||||||
public $USE_SCRIPTACULOUS = USE_SCRIPTACULOUS;
|
public bool $USE_SCRIPTACULOUS = USE_SCRIPTACULOUS;
|
||||||
// sub content input vars
|
// sub content input vars
|
||||||
/** @var bool */
|
/** @var bool */
|
||||||
public $USE_TINY_MCE = false;
|
public bool $USE_TINY_MCE = false;
|
||||||
/** @var bool */
|
/** @var bool */
|
||||||
public $JS_DATEPICKR = false;
|
public bool $JS_DATEPICKR = false;
|
||||||
/** @var bool */
|
/** @var bool */
|
||||||
public $JS_FLATPICKR = false;
|
public bool $JS_FLATPICKR = false;
|
||||||
/** @var bool */
|
/** @var bool */
|
||||||
public $JS_FILE_UPLOADER = false;
|
public bool $JS_FILE_UPLOADER = false;
|
||||||
/** @var bool */
|
/** @var bool */
|
||||||
public $DEBUG_TMPL = false;
|
public bool $DEBUG_TMPL = false;
|
||||||
/** @var bool */
|
/** @var bool */
|
||||||
public $USE_INCLUDE_TEMPLATE = false;
|
public bool $USE_INCLUDE_TEMPLATE = false;
|
||||||
// cache & compile
|
// cache & compile
|
||||||
/** @var string */
|
/** @var string */
|
||||||
public $CACHE_ID = '';
|
public string $CACHE_ID = '';
|
||||||
/** @var string */
|
/** @var string */
|
||||||
public $COMPILE_ID = '';
|
public string $COMPILE_ID = '';
|
||||||
// template vars
|
// template vars
|
||||||
/** @var string */
|
/** @var string */
|
||||||
public $MASTER_TEMPLATE_NAME;
|
public string $MASTER_TEMPLATE_NAME = '';
|
||||||
/** @var string */
|
/** @var string */
|
||||||
public $PAGE_FILE_NAME;
|
public string $PAGE_FILE_NAME = '';
|
||||||
/** @var string */
|
/** @var string */
|
||||||
public $CONTENT_INCLUDE;
|
public string $CONTENT_INCLUDE = '';
|
||||||
/** @var string */
|
/** @var string */
|
||||||
public $FORM_NAME;
|
public string $FORM_NAME = '';
|
||||||
/** @var string */
|
/** @var string */
|
||||||
public $FORM_ACTION;
|
public string $FORM_ACTION = '';
|
||||||
/** @var string */
|
/** @var string */
|
||||||
public $L_TITLE;
|
public string $L_TITLE = '';
|
||||||
/** @var string|int */
|
/** @var string|int */
|
||||||
public $PAGE_WIDTH;
|
public string|int $PAGE_WIDTH;
|
||||||
// smarty include/set var
|
// smarty include/set var
|
||||||
/** @var string */
|
/** @var string */
|
||||||
public $TEMPLATE_PATH;
|
public string $TEMPLATE_PATH = '';
|
||||||
/** @var string */
|
/** @var string */
|
||||||
public $TEMPLATE_NAME;
|
public string $TEMPLATE_NAME = '';
|
||||||
/** @var string */
|
/** @var string */
|
||||||
public $INC_TEMPLATE_NAME;
|
public string $INC_TEMPLATE_NAME = '';
|
||||||
/** @var string */
|
/** @var string */
|
||||||
public $JS_TEMPLATE_NAME;
|
public string $JS_TEMPLATE_NAME = '';
|
||||||
/** @var string */
|
/** @var string */
|
||||||
public $CSS_TEMPLATE_NAME;
|
public string $CSS_TEMPLATE_NAME = '';
|
||||||
/** @var string|null */
|
/** @var string|null */
|
||||||
public $TEMPLATE_TRANSLATE;
|
public string|null $TEMPLATE_TRANSLATE;
|
||||||
/** @var string|null */
|
/** @var string|null */
|
||||||
public $JS_TRANSLATE;
|
public string|null $JS_TRANSLATE;
|
||||||
// core group
|
// core group
|
||||||
/** @var string */
|
/** @var string */
|
||||||
public $JS_CORE_TEMPLATE_NAME;
|
public string $JS_CORE_TEMPLATE_NAME = '';
|
||||||
/** @var string */
|
/** @var string */
|
||||||
public $CSS_CORE_TEMPLATE_NAME;
|
public string $CSS_CORE_TEMPLATE_NAME = '';
|
||||||
/** @var string */
|
/** @var string */
|
||||||
public $JS_CORE_INCLUDE;
|
public string $JS_CORE_INCLUDE = '';
|
||||||
/** @var string */
|
/** @var string */
|
||||||
public $CSS_CORE_INCLUDE;
|
public string $CSS_CORE_INCLUDE = '';
|
||||||
// local names
|
// local names
|
||||||
/** @var string */
|
/** @var string */
|
||||||
public $JS_SPECIAL_TEMPLATE_NAME = '';
|
public string $JS_SPECIAL_TEMPLATE_NAME = '';
|
||||||
/** @var string */
|
/** @var string */
|
||||||
public $CSS_SPECIAL_TEMPLATE_NAME = '';
|
public string $CSS_SPECIAL_TEMPLATE_NAME = '';
|
||||||
/** @var string */
|
/** @var string */
|
||||||
public $JS_INCLUDE;
|
public string $JS_INCLUDE = '';
|
||||||
/** @var string */
|
/** @var string */
|
||||||
public $CSS_INCLUDE;
|
public string $CSS_INCLUDE = '';
|
||||||
/** @var string */
|
/** @var string */
|
||||||
public $JS_SPECIAL_INCLUDE;
|
public string $JS_SPECIAL_INCLUDE = '';
|
||||||
/** @var string */
|
/** @var string */
|
||||||
public $CSS_SPECIAL_INCLUDE;
|
public string $CSS_SPECIAL_INCLUDE = '';
|
||||||
/** @var string */
|
/** @var string */
|
||||||
public $ADMIN_JAVASCRIPT;
|
public string $ADMIN_JAVASCRIPT = '';
|
||||||
/** @var string */
|
/** @var string */
|
||||||
public $ADMIN_STYLESHEET;
|
public string $ADMIN_STYLESHEET = '';
|
||||||
/** @var string */
|
/** @var string */
|
||||||
public $FRONTEND_JAVASCRIPT;
|
public string $FRONTEND_JAVASCRIPT = '';
|
||||||
/** @var string */
|
/** @var string */
|
||||||
public $FRONTEND_STYLESHEET;
|
public string $FRONTEND_STYLESHEET = '';
|
||||||
// other smarty folder vars
|
// other smarty folder vars
|
||||||
/** @var string */
|
/** @var string */
|
||||||
public $INCLUDES;
|
public string $INCLUDES = '';
|
||||||
/** @var string */
|
/** @var string */
|
||||||
public $JAVASCRIPT;
|
public string $JAVASCRIPT = '';
|
||||||
/** @var string */
|
/** @var string */
|
||||||
public $CSS;
|
public string $CSS = '';
|
||||||
/** @var string */
|
/** @var string */
|
||||||
public $FONT;
|
public string $FONT = '';
|
||||||
/** @var string */
|
/** @var string */
|
||||||
public $PICTURES;
|
public string $PICTURES = '';
|
||||||
/** @var string */
|
/** @var string */
|
||||||
public $CACHE_PICTURES;
|
public string $CACHE_PICTURES = '';
|
||||||
/** @var string */
|
/** @var string */
|
||||||
public $CACHE_PICTURES_ROOT;
|
public string $CACHE_PICTURES_ROOT = '';
|
||||||
|
|
||||||
// constructor class, just sets the language stuff
|
// constructor class, just sets the language stuff
|
||||||
/**
|
/**
|
||||||
@@ -160,23 +158,42 @@ class SmartyExtend extends \Smarty
|
|||||||
* also registers the getvar caller plugin
|
* also registers the getvar caller plugin
|
||||||
*
|
*
|
||||||
* @param \CoreLibs\Language\L10n $l10n l10n language class
|
* @param \CoreLibs\Language\L10n $l10n l10n language class
|
||||||
* @param array<string,string> $locale locale data read from setLocale
|
* @param string|null $cache_id
|
||||||
|
* @param string|null $compile_id
|
||||||
*/
|
*/
|
||||||
public function __construct(\CoreLibs\Language\L10n $l10n, array $locale)
|
public function __construct(
|
||||||
{
|
\CoreLibs\Language\L10n $l10n,
|
||||||
|
?string $cache_id = null,
|
||||||
|
?string $compile_id = null
|
||||||
|
) {
|
||||||
|
// trigger deprecation
|
||||||
|
if (
|
||||||
|
$cache_id === null ||
|
||||||
|
$compile_id === null
|
||||||
|
) {
|
||||||
|
/** @deprecated SmartyExtend::__construct call without parameters */
|
||||||
|
trigger_error(
|
||||||
|
'Calling SmartyExtend::__construct without paramters is deprecated',
|
||||||
|
E_USER_DEPRECATED
|
||||||
|
);
|
||||||
|
}
|
||||||
|
// set variables (to be deprecated)
|
||||||
|
$cache_id = $cache_id ??
|
||||||
|
(defined('CACHE_ID') ? CACHE_ID : '');
|
||||||
|
$compile_id = $compile_id ??
|
||||||
|
(defined('COMPILE_ID') ? COMPILE_ID : '');
|
||||||
// call basic smarty
|
// call basic smarty
|
||||||
// or Smarty::__construct();
|
// or Smarty::__construct();
|
||||||
parent::__construct();
|
parent::__construct();
|
||||||
// iinit lang
|
// iinit lang
|
||||||
$this->l10n = $l10n;
|
$this->l10n = $l10n;
|
||||||
// parse and read, legacy stuff
|
// parse and read, legacy stuff
|
||||||
|
$locale = $this->l10n->getLocaleAsArray();
|
||||||
$this->encoding = $locale['encoding'];
|
$this->encoding = $locale['encoding'];
|
||||||
$this->lang = $locale['lang'];
|
$this->lang = $locale['lang'];
|
||||||
// get first part from lang
|
$this->lang_short = $locale['lang_short'];
|
||||||
$this->lang_short = explode('_', $locale['lang'])[0];
|
$this->domain = $locale['domain'];
|
||||||
$this->domain = $this->l10n->getDomain();
|
$this->lang_dir = $locale['path'];
|
||||||
$this->locale_set = $this->l10n->getLocaleSet();
|
|
||||||
$this->lang_dir = $this->l10n->getBaseLocalePath();
|
|
||||||
|
|
||||||
// opt load functions so we can use legacy init for smarty run perhaps
|
// opt load functions so we can use legacy init for smarty run perhaps
|
||||||
\CoreLibs\Language\L10n::loadFunctions();
|
\CoreLibs\Language\L10n::loadFunctions();
|
||||||
@@ -191,8 +208,8 @@ class SmartyExtend extends \Smarty
|
|||||||
$this->page_name = \CoreLibs\Get\System::getPageName();
|
$this->page_name = \CoreLibs\Get\System::getPageName();
|
||||||
|
|
||||||
// set internal settings
|
// set internal settings
|
||||||
$this->CACHE_ID = defined('CACHE_ID') ? CACHE_ID : '';
|
$this->CACHE_ID = $cache_id;
|
||||||
$this->COMPILE_ID = defined('COMPILE_ID') ? COMPILE_ID : '';
|
$this->COMPILE_ID = $compile_id;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -203,6 +220,7 @@ class SmartyExtend extends \Smarty
|
|||||||
// core CS
|
// core CS
|
||||||
$this->CSS_CORE_INCLUDE = '';
|
$this->CSS_CORE_INCLUDE = '';
|
||||||
if (
|
if (
|
||||||
|
!empty($this->CSS_CORE_TEMPLATE_NAME) &&
|
||||||
file_exists($this->CSS . $this->CSS_CORE_TEMPLATE_NAME) &&
|
file_exists($this->CSS . $this->CSS_CORE_TEMPLATE_NAME) &&
|
||||||
is_file($this->CSS . $this->CSS_CORE_TEMPLATE_NAME)
|
is_file($this->CSS . $this->CSS_CORE_TEMPLATE_NAME)
|
||||||
) {
|
) {
|
||||||
@@ -211,6 +229,7 @@ class SmartyExtend extends \Smarty
|
|||||||
// core JS
|
// core JS
|
||||||
$this->JS_CORE_INCLUDE = '';
|
$this->JS_CORE_INCLUDE = '';
|
||||||
if (
|
if (
|
||||||
|
!empty($this->JS_CORE_TEMPLATE_NAME) &&
|
||||||
file_exists($this->JAVASCRIPT . $this->JS_CORE_TEMPLATE_NAME) &&
|
file_exists($this->JAVASCRIPT . $this->JS_CORE_TEMPLATE_NAME) &&
|
||||||
is_file($this->JAVASCRIPT . $this->JS_CORE_TEMPLATE_NAME)
|
is_file($this->JAVASCRIPT . $this->JS_CORE_TEMPLATE_NAME)
|
||||||
) {
|
) {
|
||||||
@@ -256,11 +275,70 @@ class SmartyExtend extends \Smarty
|
|||||||
*
|
*
|
||||||
* @return void
|
* @return void
|
||||||
*/
|
*/
|
||||||
public function setSmartyPaths(): void
|
|
||||||
{
|
/**
|
||||||
|
* sets all internal paths and names that need to be passed on
|
||||||
|
* to the smarty template
|
||||||
|
*
|
||||||
|
* @param string|null $set_includes INCLUDES
|
||||||
|
* @param string|null $set_template_path TEMPLATE_PATH
|
||||||
|
* @param string|null $set_javascript JAVASCRIPT
|
||||||
|
* @param string|null $set_css CSS
|
||||||
|
* @param string|null $set_font FONT
|
||||||
|
* @param string|null $set_pictures PICTURES
|
||||||
|
* @param string|null $set_cache_pictures CACHE_PICTURES
|
||||||
|
* @param string|null $set_cache_pictures_root CACHE_PICTURES_ROOT
|
||||||
|
* @param string|null $set_master_template_name MASTAER_TEMPLATE_NAME
|
||||||
|
* @return void
|
||||||
|
*/
|
||||||
|
public function setSmartyPaths(
|
||||||
|
?string $set_includes = null,
|
||||||
|
?string $set_template_path = null,
|
||||||
|
?string $set_javascript = null,
|
||||||
|
?string $set_css = null,
|
||||||
|
?string $set_font = null,
|
||||||
|
?string $set_pictures = null,
|
||||||
|
?string $set_cache_pictures = null,
|
||||||
|
?string $set_cache_pictures_root = null,
|
||||||
|
?string $set_master_template_name = null,
|
||||||
|
): void {
|
||||||
|
// trigger deprecation
|
||||||
|
if (
|
||||||
|
$set_includes === null ||
|
||||||
|
$set_template_path === null ||
|
||||||
|
$set_javascript === null ||
|
||||||
|
$set_css === null ||
|
||||||
|
$set_font === null ||
|
||||||
|
$set_pictures === null ||
|
||||||
|
$set_cache_pictures === null ||
|
||||||
|
$set_cache_pictures_root === null
|
||||||
|
) {
|
||||||
|
/** @deprecated setSmartyPaths call without parameters */
|
||||||
|
trigger_error(
|
||||||
|
'Calling setSmartyPaths without paramters is deprecated',
|
||||||
|
E_USER_DEPRECATED
|
||||||
|
);
|
||||||
|
}
|
||||||
|
// set variables (to be deprecated)
|
||||||
|
$set_master_template_name = $set_master_template_name ??
|
||||||
|
(defined('MASTER_TEMPLATE_NAME') ? MASTER_TEMPLATE_NAME : '');
|
||||||
|
$set_includes = $set_includes ??
|
||||||
|
BASE . INCLUDES;
|
||||||
|
$set_template_path = $set_template_path ??
|
||||||
|
BASE . INCLUDES . TEMPLATES . CONTENT_PATH;
|
||||||
|
$set_javascript = $set_javascript ?? LAYOUT . JS;
|
||||||
|
$set_css = $set_css ?? LAYOUT . CSS;
|
||||||
|
$set_font = $set_font ?? LAYOUT . FONT;
|
||||||
|
$set_pictures = $set_pictures ?? LAYOUT . IMAGES;
|
||||||
|
$set_cache_pictures = $set_cache_pictures ?? LAYOUT . CACHE;
|
||||||
|
$set_cache_pictures_root = $set_cache_pictures_root ??
|
||||||
|
ROOT . $set_cache_pictures;
|
||||||
|
|
||||||
// master template
|
// master template
|
||||||
if (empty($this->MASTER_TEMPLATE_NAME)) {
|
if (
|
||||||
$this->MASTER_TEMPLATE_NAME = MASTER_TEMPLATE_NAME;
|
empty($this->MASTER_TEMPLATE_NAME)
|
||||||
|
) {
|
||||||
|
$this->MASTER_TEMPLATE_NAME = $set_master_template_name;
|
||||||
}
|
}
|
||||||
|
|
||||||
// set include & template names
|
// set include & template names
|
||||||
@@ -276,15 +354,15 @@ class SmartyExtend extends \Smarty
|
|||||||
$this->CSS_TEMPLATE_NAME = str_replace('.tpl', '.css', $this->CONTENT_INCLUDE);
|
$this->CSS_TEMPLATE_NAME = str_replace('.tpl', '.css', $this->CONTENT_INCLUDE);
|
||||||
|
|
||||||
// set basic template path (tmp)
|
// set basic template path (tmp)
|
||||||
$this->INCLUDES = BASE . INCLUDES; // no longer in templates, only global
|
$this->INCLUDES = $set_includes; // no longer in templates, only global
|
||||||
$this->TEMPLATE_PATH = BASE . INCLUDES . TEMPLATES . CONTENT_PATH;
|
$this->TEMPLATE_PATH = $set_template_path;
|
||||||
$this->setTemplateDir($this->TEMPLATE_PATH);
|
$this->setTemplateDir($this->TEMPLATE_PATH);
|
||||||
$this->JAVASCRIPT = LAYOUT . JS;
|
$this->JAVASCRIPT = $set_javascript;
|
||||||
$this->CSS = LAYOUT . CSS;
|
$this->CSS = $set_css;
|
||||||
$this->FONT = LAYOUT . FONT;
|
$this->FONT = $set_font;
|
||||||
$this->PICTURES = LAYOUT . IMAGES;
|
$this->PICTURES = $set_pictures;
|
||||||
$this->CACHE_PICTURES = LAYOUT . CACHE;
|
$this->CACHE_PICTURES = $set_cache_pictures;
|
||||||
$this->CACHE_PICTURES_ROOT = ROOT . $this->CACHE_PICTURES;
|
$this->CACHE_PICTURES_ROOT = $set_cache_pictures_root;
|
||||||
// check if we have an external file with the template name
|
// check if we have an external file with the template name
|
||||||
if (
|
if (
|
||||||
file_exists($this->INCLUDES . $this->INC_TEMPLATE_NAME) &&
|
file_exists($this->INCLUDES . $this->INC_TEMPLATE_NAME) &&
|
||||||
@@ -295,7 +373,7 @@ class SmartyExtend extends \Smarty
|
|||||||
// check for template include
|
// check for template include
|
||||||
if (
|
if (
|
||||||
$this->USE_INCLUDE_TEMPLATE === true &&
|
$this->USE_INCLUDE_TEMPLATE === true &&
|
||||||
!$this->TEMPLATE_NAME
|
empty($this->TEMPLATE_NAME)
|
||||||
) {
|
) {
|
||||||
$this->TEMPLATE_NAME = $this->CONTENT_INCLUDE;
|
$this->TEMPLATE_NAME = $this->CONTENT_INCLUDE;
|
||||||
// add to cache & compile id
|
// add to cache & compile id
|
||||||
@@ -305,14 +383,14 @@ class SmartyExtend extends \Smarty
|
|||||||
// set all the additional CSS/JS parths
|
// set all the additional CSS/JS parths
|
||||||
$this->setSmartCoreIncludeCssJs();
|
$this->setSmartCoreIncludeCssJs();
|
||||||
// check if template names exist
|
// check if template names exist
|
||||||
if (!$this->MASTER_TEMPLATE_NAME) {
|
if (empty($this->MASTER_TEMPLATE_NAME)) {
|
||||||
exit('MASTER TEMPLATE is not set');
|
exit('MASTER TEMPLATE is not set');
|
||||||
} elseif (!file_exists($this->getTemplateDir()[0] . DIRECTORY_SEPARATOR . $this->MASTER_TEMPLATE_NAME)) {
|
} elseif (!file_exists($this->getTemplateDir()[0] . DIRECTORY_SEPARATOR . $this->MASTER_TEMPLATE_NAME)) {
|
||||||
// abort if master template could not be found
|
// abort if master template could not be found
|
||||||
exit('MASTER TEMPLATE: ' . $this->MASTER_TEMPLATE_NAME . ' could not be found');
|
exit('MASTER TEMPLATE: ' . $this->MASTER_TEMPLATE_NAME . ' could not be found');
|
||||||
}
|
}
|
||||||
if (
|
if (
|
||||||
$this->TEMPLATE_NAME &&
|
!empty($this->TEMPLATE_NAME) &&
|
||||||
!file_exists($this->getTemplateDir()[0] . DIRECTORY_SEPARATOR . $this->TEMPLATE_NAME)
|
!file_exists($this->getTemplateDir()[0] . DIRECTORY_SEPARATOR . $this->TEMPLATE_NAME)
|
||||||
) {
|
) {
|
||||||
exit('INCLUDE TEMPLATE: ' . $this->TEMPLATE_NAME . ' could not be found');
|
exit('INCLUDE TEMPLATE: ' . $this->TEMPLATE_NAME . ' could not be found');
|
||||||
@@ -320,7 +398,7 @@ class SmartyExtend extends \Smarty
|
|||||||
// javascript translate data as template for auto translate
|
// javascript translate data as template for auto translate
|
||||||
if (empty($this->TEMPLATE_TRANSLATE)) {
|
if (empty($this->TEMPLATE_TRANSLATE)) {
|
||||||
$this->TEMPLATE_TRANSLATE = 'jsTranslate-'
|
$this->TEMPLATE_TRANSLATE = 'jsTranslate-'
|
||||||
. $this->locale_set . '.' . $this->encoding
|
. $this->l10n->getLocaleSet() . '.' . $this->encoding
|
||||||
. '.tpl';
|
. '.tpl';
|
||||||
} else {
|
} else {
|
||||||
// we assume we have some fixed set
|
// we assume we have some fixed set
|
||||||
@@ -330,22 +408,27 @@ class SmartyExtend extends \Smarty
|
|||||||
if (strpos($this->TEMPLATE_TRANSLATE, '.tpl')) {
|
if (strpos($this->TEMPLATE_TRANSLATE, '.tpl')) {
|
||||||
$this->TEMPLATE_TRANSLATE = str_replace(
|
$this->TEMPLATE_TRANSLATE = str_replace(
|
||||||
'.tpl',
|
'.tpl',
|
||||||
'-' . $this->locale_set . '.' . $this->encoding . '.tpl',
|
'-' . $this->l10n->getLocaleSet() . '.' . $this->encoding . '.tpl',
|
||||||
$this->TEMPLATE_TRANSLATE
|
$this->TEMPLATE_TRANSLATE
|
||||||
);
|
);
|
||||||
} else {
|
} else {
|
||||||
$this->TEMPLATE_TRANSLATE .= '-'
|
$this->TEMPLATE_TRANSLATE .= '-'
|
||||||
. $this->locale_set . '.' . $this->encoding
|
. $this->l10n->getLocaleSet() . '.' . $this->encoding
|
||||||
. '.tpl';
|
. '.tpl';
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
// if we can't find it, dump it
|
// if we can't find it, dump it
|
||||||
if (!file_exists($this->getTemplateDir()[0] . DIRECTORY_SEPARATOR . $this->TEMPLATE_TRANSLATE)) {
|
if (
|
||||||
|
!file_exists(
|
||||||
|
$this->getTemplateDir()[0] . DIRECTORY_SEPARATOR
|
||||||
|
. $this->TEMPLATE_TRANSLATE
|
||||||
|
)
|
||||||
|
) {
|
||||||
$this->TEMPLATE_TRANSLATE = null;
|
$this->TEMPLATE_TRANSLATE = null;
|
||||||
}
|
}
|
||||||
if (empty($this->JS_TRANSLATE)) {
|
if (empty($this->JS_TRANSLATE)) {
|
||||||
$this->JS_TRANSLATE = 'translate-'
|
$this->JS_TRANSLATE = 'translate-'
|
||||||
. $this->locale_set . '.' . $this->encoding . '.js';
|
. $this->l10n->getLocaleSet() . '.' . $this->encoding . '.js';
|
||||||
} else {
|
} else {
|
||||||
// we assume we have some fixed set
|
// we assume we have some fixed set
|
||||||
// we must add _<locale>.<encoding>
|
// we must add _<locale>.<encoding>
|
||||||
@@ -354,12 +437,12 @@ class SmartyExtend extends \Smarty
|
|||||||
if (strpos($this->JS_TRANSLATE, '.js')) {
|
if (strpos($this->JS_TRANSLATE, '.js')) {
|
||||||
$this->JS_TRANSLATE = str_replace(
|
$this->JS_TRANSLATE = str_replace(
|
||||||
'.js',
|
'.js',
|
||||||
'-' . $this->locale_set . '.' . $this->encoding . '.js',
|
'-' . $this->l10n->getLocaleSet() . '.' . $this->encoding . '.js',
|
||||||
$this->JS_TRANSLATE
|
$this->JS_TRANSLATE
|
||||||
);
|
);
|
||||||
} else {
|
} else {
|
||||||
$this->JS_TRANSLATE .= '-'
|
$this->JS_TRANSLATE .= '-'
|
||||||
. $this->locale_set . '.' . $this->encoding
|
. $this->l10n->getLocaleSet() . '.' . $this->encoding
|
||||||
. '.js';
|
. '.js';
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -374,35 +457,194 @@ class SmartyExtend extends \Smarty
|
|||||||
* wrapper call for setSmartyVars
|
* wrapper call for setSmartyVars
|
||||||
* this is for frontend type and will not set any only admin needed variables
|
* this is for frontend type and will not set any only admin needed variables
|
||||||
*
|
*
|
||||||
|
* @param array<string,string> $options list with the following value:
|
||||||
|
* compile_dir :BASE . TEMPLATES_C
|
||||||
|
* cache_dir :BASE . CACHE
|
||||||
|
* js :JS
|
||||||
|
* css :CSS
|
||||||
|
* font :FONT
|
||||||
|
* default_encoding :DEFAULT_ENCODING
|
||||||
|
* g_title :G_TITLE
|
||||||
|
* stylesheet :STYLESHEET
|
||||||
|
* javascript :JAVASCRIPT
|
||||||
|
* @param array<string,mixed> $smarty_data array of three keys
|
||||||
|
* that hold smarty set strings
|
||||||
|
* HEADER, DATA, DEBUG_DATA
|
||||||
* @return void
|
* @return void
|
||||||
*/
|
*/
|
||||||
public function setSmartyVarsFrontend(): void
|
public function setSmartyVarsFrontend(
|
||||||
{
|
array $options,
|
||||||
$this->setSmartyVars();
|
array $smarty_data
|
||||||
|
): void {
|
||||||
|
$this->setSmartyVars(
|
||||||
|
false,
|
||||||
|
$smarty_data,
|
||||||
|
null,
|
||||||
|
$options['compile_dir'] ?? null,
|
||||||
|
$options['cache_dir'] ?? null,
|
||||||
|
$options['js'] ?? null,
|
||||||
|
$options['css'] ?? null,
|
||||||
|
$options['font'] ?? null,
|
||||||
|
$options['default_encoding'] ?? null,
|
||||||
|
$options['g_title'] ?? null,
|
||||||
|
null,
|
||||||
|
null,
|
||||||
|
null,
|
||||||
|
null,
|
||||||
|
null,
|
||||||
|
$options['stylesheet'] ?? null,
|
||||||
|
$options['javascript'] ?? null
|
||||||
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* wrapper call for setSmartyVars
|
* wrapper call for setSmartyVars
|
||||||
* this is only for admin interface and will set additional variables
|
* this is only for admin interface and will set additional variables
|
||||||
|
* @param array<string,string> $options list with the following value:
|
||||||
|
* compile_dir :BASE . TEMPLATES_C
|
||||||
|
* cache_dir :BASE . CACHE
|
||||||
|
* js :JS
|
||||||
|
* css :CSS
|
||||||
|
* font :FONT
|
||||||
|
* default_encoding :DEFAULT_ENCODING
|
||||||
|
* g_title :G_TITLE
|
||||||
|
* admin_stylesheet :ADMIN_STYLESHEET
|
||||||
|
* admin_javascript :ADMIN_JAVASCRIPT
|
||||||
|
* page_width :PAGE_WIDTH
|
||||||
|
* content_path :CONTENT_PATH
|
||||||
|
* user_name :_SESSION['USER_NAME']
|
||||||
|
* @param \CoreLibs\Admin\Backend|null $cms Optinal Admin Backend for
|
||||||
|
* smarty variables merge
|
||||||
|
* @return void
|
||||||
*/
|
*/
|
||||||
public function setSmartyVarsAdmin(): void
|
public function setSmartyVarsAdmin(
|
||||||
{
|
array $options,
|
||||||
$this->setSmartyVars(true);
|
?\CoreLibs\Admin\Backend $cms = null
|
||||||
|
): void {
|
||||||
|
// if we have cms data, check for array blocks and build
|
||||||
|
$smarty_data = [];
|
||||||
|
if ($cms !== null) {
|
||||||
|
$smarty_data = [
|
||||||
|
'HEADER' => $cms->HEADER,
|
||||||
|
'DATA' => $cms->DATA,
|
||||||
|
'DEBUG_DATA' => $cms->DEBUG_DATA
|
||||||
|
];
|
||||||
|
}
|
||||||
|
$this->setSmartyVars(
|
||||||
|
true,
|
||||||
|
$smarty_data,
|
||||||
|
$cms,
|
||||||
|
$options['compile_dir'] ?? null,
|
||||||
|
$options['cache_dir'] ?? null,
|
||||||
|
$options['js'] ?? null,
|
||||||
|
$options['css'] ?? null,
|
||||||
|
$options['font'] ?? null,
|
||||||
|
$options['g_title'] ?? null,
|
||||||
|
$options['default_encoding'] ?? null,
|
||||||
|
$options['admin_stylesheet'] ?? null,
|
||||||
|
$options['admin_javascript'] ?? null,
|
||||||
|
$options['page_width'] ?? null,
|
||||||
|
$options['content_path'] ?? null,
|
||||||
|
$options['user_name'] ?? null,
|
||||||
|
null,
|
||||||
|
null
|
||||||
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* set smarty pass on variables, sub template names and finally calls the smarty parser
|
* set smarty pass on variables, sub template names and
|
||||||
|
* finally calls the smarty parser
|
||||||
*
|
*
|
||||||
* @param boolean $admin_call default false, will set admin only variables
|
* @param bool $admin_call default false
|
||||||
|
* will set admin only variables
|
||||||
|
* @param array<string,mixed> $smarty_data smarty data to merge
|
||||||
|
* @param \CoreLibs\Admin\Backend|null $cms Optinal Admin Backend for
|
||||||
|
* smarty variables merge
|
||||||
|
* @param string|null $compile_dir BASE . TEMPLATES_C
|
||||||
|
* @param string|null $cache_dir BASE . CACHE
|
||||||
|
* @param string|null $set_js JS
|
||||||
|
* @param string|null $set_css CSS
|
||||||
|
* @param string|null $set_font FONT
|
||||||
|
* @param string|null $set_default_encoding DEFAULT_ENCODING
|
||||||
|
* @param string|null $set_g_title G_TITLE
|
||||||
|
* @param string|null $set_admin_stylesheet ADMIN_STYLESHEET
|
||||||
|
* @param string|null $set_admin_javascript ADMIN_JAVASCRIPT
|
||||||
|
* @param string|null $set_page_width PAGE_WIDTH
|
||||||
|
* @param string|null $set_content_path CONTENT_PATH (only if $cms set and admin)
|
||||||
|
* @param string|null $set_user_name _SESSION['USER_NAME']
|
||||||
|
* @param string|null $set_stylesheet STYLESHEET
|
||||||
|
* @param string|null $set_javascript JAVASCRIPT
|
||||||
* @return void
|
* @return void
|
||||||
*/
|
*/
|
||||||
private function setSmartyVars($admin_call = false): void
|
private function setSmartyVars(
|
||||||
{
|
bool $admin_call,
|
||||||
/** @var \CoreLibs\Admin\Backend This is an assumption */
|
array $smarty_data = [],
|
||||||
global $cms;
|
?\CoreLibs\Admin\Backend $cms = null,
|
||||||
if (is_object($cms)) {
|
?string $compile_dir = null,
|
||||||
$this->mergeCmsSmartyVars($cms);
|
?string $cache_dir = null,
|
||||||
|
?string $set_js = null,
|
||||||
|
?string $set_css = null,
|
||||||
|
?string $set_font = null,
|
||||||
|
?string $set_default_encoding = null,
|
||||||
|
?string $set_g_title = null,
|
||||||
|
?string $set_admin_stylesheet = null,
|
||||||
|
?string $set_admin_javascript = null,
|
||||||
|
?string $set_page_width = null,
|
||||||
|
?string $set_content_path = null,
|
||||||
|
?string $set_user_name = null,
|
||||||
|
?string $set_stylesheet = null,
|
||||||
|
?string $set_javascript = null,
|
||||||
|
): void {
|
||||||
|
// trigger deprecation
|
||||||
|
if (
|
||||||
|
$compile_dir === null ||
|
||||||
|
$cache_dir === null ||
|
||||||
|
$set_css === null ||
|
||||||
|
$set_font === null ||
|
||||||
|
$set_js === null ||
|
||||||
|
$set_default_encoding === null ||
|
||||||
|
$set_g_title === null ||
|
||||||
|
(
|
||||||
|
$admin_call === true && (
|
||||||
|
$set_admin_stylesheet === null ||
|
||||||
|
$set_admin_javascript === null ||
|
||||||
|
$set_page_width === null ||
|
||||||
|
$set_user_name === null
|
||||||
|
)
|
||||||
|
) ||
|
||||||
|
(
|
||||||
|
$admin_call === false && (
|
||||||
|
$set_stylesheet === null ||
|
||||||
|
$set_javascript === null
|
||||||
|
)
|
||||||
|
) ||
|
||||||
|
(
|
||||||
|
$admin_call === true && $cms !== null && $set_content_path === null
|
||||||
|
)
|
||||||
|
) {
|
||||||
|
/** @deprecated setSmartyVars call without parameters */
|
||||||
|
trigger_error(
|
||||||
|
'Calling setSmartyVars without paramters is deprecated',
|
||||||
|
E_USER_DEPRECATED
|
||||||
|
);
|
||||||
}
|
}
|
||||||
|
// set variables (will be deprecated)
|
||||||
|
$compile_dir = $compile_dir ?? BASE . TEMPLATES_C;
|
||||||
|
$cache_dir = $cache_dir ?? BASE . CACHE;
|
||||||
|
$set_css = $set_css ?? CSS;
|
||||||
|
$set_font = $set_font ?? FONT;
|
||||||
|
$set_js = $set_js ?? JS;
|
||||||
|
$set_default_encoding = $set_default_encoding ?? DEFAULT_ENCODING;
|
||||||
|
$set_g_title = $set_g_title ?? G_TITLE;
|
||||||
|
$set_admin_stylesheet = $set_admin_stylesheet ?? ADMIN_STYLESHEET;
|
||||||
|
$set_admin_javascript = $set_admin_javascript ?? ADMIN_JAVASCRIPT;
|
||||||
|
$set_page_width = $set_page_width ?? PAGE_WIDTH;
|
||||||
|
$set_content_path = $set_content_path ?? CONTENT_PATH;
|
||||||
|
$set_stylesheet = $set_stylesheet ?? STYLESHEET;
|
||||||
|
$set_javascript = $set_javascript ?? JAVASCRIPT;
|
||||||
|
$set_user_name = $set_user_name ?? $_SESSION['USER_NAME'] ?? '';
|
||||||
|
// merge additional smarty data
|
||||||
|
$this->mergeCmsSmartyVars($smarty_data);
|
||||||
|
|
||||||
// trigger flags
|
// trigger flags
|
||||||
$this->HEADER['USE_PROTOTYPE'] = $this->USE_PROTOTYPE;
|
$this->HEADER['USE_PROTOTYPE'] = $this->USE_PROTOTYPE;
|
||||||
@@ -431,25 +673,42 @@ class SmartyExtend extends \Smarty
|
|||||||
|
|
||||||
// default CMS settings
|
// default CMS settings
|
||||||
// define all needed smarty stuff for the general HTML/page building
|
// define all needed smarty stuff for the general HTML/page building
|
||||||
$this->HEADER['CSS'] = CSS;
|
$this->HEADER['CSS'] = $set_css;
|
||||||
$this->HEADER['FONT'] = FONT;
|
$this->HEADER['FONT'] = $set_font;
|
||||||
$this->HEADER['JS'] = JS;
|
$this->HEADER['JS'] = $set_js;
|
||||||
$this->HEADER['ENCODING'] = $this->encoding;
|
$this->HEADER['ENCODING'] = $this->encoding;
|
||||||
$this->HEADER['DEFAULT_ENCODING'] = DEFAULT_ENCODING;
|
$this->HEADER['DEFAULT_ENCODING'] = $set_default_encoding;
|
||||||
|
|
||||||
// form name
|
// form name
|
||||||
$this->DATA['FORM_NAME'] = !$this->FORM_NAME ?
|
$this->DATA['FORM_NAME'] = empty($this->FORM_NAME) ?
|
||||||
str_replace('.php', '', $this->page_name) :
|
str_replace('.php', '', $this->page_name) :
|
||||||
$this->FORM_NAME;
|
$this->FORM_NAME;
|
||||||
$this->DATA['FORM_ACTION'] = $this->FORM_ACTION;
|
$this->DATA['FORM_ACTION'] = empty($this->FORM_ACTION) ?
|
||||||
|
'' :
|
||||||
|
$this->FORM_ACTION;
|
||||||
// special for admin
|
// special for admin
|
||||||
if ($admin_call === true) {
|
if ($admin_call === true) {
|
||||||
|
// depreacte call globals cms on null 4mcs
|
||||||
|
if (
|
||||||
|
$cms === null &&
|
||||||
|
isset($GLOBALS['cms'])
|
||||||
|
) {
|
||||||
|
/** @deprecated setSmartyVars globals cms is deprecated */
|
||||||
|
trigger_error(
|
||||||
|
'Calling setSmartyVars without cms parameter when needed is deprecated',
|
||||||
|
E_USER_DEPRECATED
|
||||||
|
);
|
||||||
|
}
|
||||||
|
// this is ugly
|
||||||
|
$cms = $cms ?? $GLOBALS['cms'] ?? null;
|
||||||
// set ACL extra show
|
// set ACL extra show
|
||||||
if (is_object($cms)) {
|
if ($cms instanceof \CoreLibs\Admin\Backend) {
|
||||||
$this->DATA['show_ea_extra'] = $cms->acl['show_ea_extra'] ?? false;
|
$this->DATA['show_ea_extra'] = $cms->acl['show_ea_extra'] ?? false;
|
||||||
$this->DATA['ADMIN'] = $cms->acl['admin'] ?? 0;
|
$this->DATA['ADMIN'] = $cms->acl['admin'] ?? 0;
|
||||||
// top menu
|
// top menu
|
||||||
$this->DATA['nav_menu'] = $cms->adbTopMenu();
|
$this->DATA['nav_menu'] = $cms->adbTopMenu(
|
||||||
|
$set_content_path
|
||||||
|
);
|
||||||
$this->DATA['nav_menu_count'] = count($this->DATA['nav_menu']);
|
$this->DATA['nav_menu_count'] = count($this->DATA['nav_menu']);
|
||||||
// messages = ['msg' =>, 'class' => 'error/warning/...']
|
// messages = ['msg' =>, 'class' => 'error/warning/...']
|
||||||
$this->DATA['messages'] = $cms->messages;
|
$this->DATA['messages'] = $cms->messages;
|
||||||
@@ -461,11 +720,13 @@ class SmartyExtend extends \Smarty
|
|||||||
$this->DATA['messages'] = [];
|
$this->DATA['messages'] = [];
|
||||||
}
|
}
|
||||||
// set style sheets
|
// set style sheets
|
||||||
$this->HEADER['STYLESHEET'] = $this->ADMIN_STYLESHEET ? $this->ADMIN_STYLESHEET : ADMIN_STYLESHEET;
|
$this->HEADER['STYLESHEET'] = !empty($this->ADMIN_STYLESHEET) ?
|
||||||
$this->HEADER['JAVASCRIPT'] = $this->ADMIN_JAVASCRIPT ? $this->ADMIN_JAVASCRIPT : ADMIN_JAVASCRIPT;
|
$this->ADMIN_STYLESHEET : $set_admin_stylesheet;
|
||||||
|
$this->HEADER['JAVASCRIPT'] = !empty($this->ADMIN_JAVASCRIPT) ?
|
||||||
|
$this->ADMIN_JAVASCRIPT : $set_admin_javascript;
|
||||||
// the page name
|
// the page name
|
||||||
$this->DATA['page_name'] = $this->page_name;
|
$this->DATA['page_name'] = $this->page_name;
|
||||||
$this->DATA['table_width'] = !empty($this->PAGE_WIDTH) ?: PAGE_WIDTH;
|
$this->DATA['table_width'] = !empty($this->PAGE_WIDTH) ?: $set_page_width;
|
||||||
$this->DATA['form_name'] = $this->DATA['FORM_NAME'];
|
$this->DATA['form_name'] = $this->DATA['FORM_NAME'];
|
||||||
// for tinymce special
|
// for tinymce special
|
||||||
$this->DATA['TINYMCE_LANG'] = $this->lang_short;
|
$this->DATA['TINYMCE_LANG'] = $this->lang_short;
|
||||||
@@ -474,14 +735,16 @@ class SmartyExtend extends \Smarty
|
|||||||
// debug data, if DEBUG flag is on, this data is print out
|
// debug data, if DEBUG flag is on, this data is print out
|
||||||
$this->DEBUG_DATA['DEBUG'] = $this->DEBUG_TMPL;
|
$this->DEBUG_DATA['DEBUG'] = $this->DEBUG_TMPL;
|
||||||
} else {
|
} else {
|
||||||
$this->HEADER['STYLESHEET'] = $this->FRONTEND_STYLESHEET ? $this->FRONTEND_STYLESHEET : STYLESHEET;
|
$this->HEADER['STYLESHEET'] = !empty($this->FRONTEND_STYLESHEET) ?
|
||||||
$this->HEADER['JAVASCRIPT'] = $this->FRONTEND_JAVASCRIPT ? $this->FRONTEND_JAVASCRIPT : JAVASCRIPT;
|
$this->FRONTEND_STYLESHEET : $set_stylesheet;
|
||||||
|
$this->HEADER['JAVASCRIPT'] = !empty($this->FRONTEND_JAVASCRIPT) ?
|
||||||
|
$this->FRONTEND_JAVASCRIPT : $set_javascript;
|
||||||
}
|
}
|
||||||
// html title
|
// html title
|
||||||
// set local page title
|
// set local page title
|
||||||
$this->HEADER['HTML_TITLE'] = !$this->L_TITLE ?
|
$this->HEADER['HTML_TITLE'] = empty($this->L_TITLE) ?
|
||||||
ucfirst(str_replace('_', ' ', \CoreLibs\Get\System::getPageName(1)))
|
ucfirst(str_replace('_', ' ', \CoreLibs\Get\System::getPageName(1)))
|
||||||
. (defined('G_TITLE') ? ' - ' . $this->l10n->__(G_TITLE) : '') :
|
. (!empty($set_g_title) ? '-' . $this->l10n->__($set_g_title) : '') :
|
||||||
$this->l10n->__($this->L_TITLE);
|
$this->l10n->__($this->L_TITLE);
|
||||||
|
|
||||||
// LANG
|
// LANG
|
||||||
@@ -491,7 +754,7 @@ class SmartyExtend extends \Smarty
|
|||||||
$this->DATA['JS_FLATPICKR'] = $this->JS_FLATPICKR;
|
$this->DATA['JS_FLATPICKR'] = $this->JS_FLATPICKR;
|
||||||
$this->DATA['JS_FILE_UPLOADER'] = $this->JS_FILE_UPLOADER;
|
$this->DATA['JS_FILE_UPLOADER'] = $this->JS_FILE_UPLOADER;
|
||||||
// user name
|
// user name
|
||||||
$this->DATA['USER_NAME'] = !empty($_SESSION['USER_NAME']) ? $_SESSION['USER_NAME'] : '';
|
$this->DATA['USER_NAME'] = $set_user_name;
|
||||||
// the template part to include into the body
|
// the template part to include into the body
|
||||||
$this->DATA['TEMPLATE_NAME'] = $this->TEMPLATE_NAME;
|
$this->DATA['TEMPLATE_NAME'] = $this->TEMPLATE_NAME;
|
||||||
$this->DATA['CONTENT_INCLUDE'] = $this->CONTENT_INCLUDE;
|
$this->DATA['CONTENT_INCLUDE'] = $this->CONTENT_INCLUDE;
|
||||||
@@ -499,24 +762,24 @@ class SmartyExtend extends \Smarty
|
|||||||
$this->DATA['JS_TRANSLATE'] = $this->JS_TRANSLATE ?? null;
|
$this->DATA['JS_TRANSLATE'] = $this->JS_TRANSLATE ?? null;
|
||||||
$this->DATA['PAGE_FILE_NAME'] = str_replace('.php', '', $this->page_name) . '.tpl';
|
$this->DATA['PAGE_FILE_NAME'] = str_replace('.php', '', $this->page_name) . '.tpl';
|
||||||
// render page
|
// render page
|
||||||
$this->renderSmarty();
|
$this->renderSmarty($compile_dir, $cache_dir);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* merge outside object HEADER/DATA/DEBUG_DATA vars into the smarty class
|
* merge outside object HEADER/DATA/DEBUG_DATA vars into the smarty class
|
||||||
*
|
*
|
||||||
* @param object $cms object that has header/data/debug_data
|
* @param array<string,mixed> $smarty_data array that has header/data/debug_data
|
||||||
* @return void
|
* @return void
|
||||||
*/
|
*/
|
||||||
public function mergeCmsSmartyVars(object $cms): void
|
public function mergeCmsSmartyVars(array $smarty_data): void
|
||||||
{
|
{
|
||||||
// array merge HEADER, DATA, DEBUG DATA
|
// array merge HEADER, DATA, DEBUG DATA
|
||||||
foreach (['HEADER', 'DATA', 'DEBUG_DATA'] as $ext_smarty) {
|
foreach (['HEADER', 'DATA', 'DEBUG_DATA'] as $ext_smarty) {
|
||||||
if (
|
if (
|
||||||
isset($cms->{$ext_smarty}) &&
|
isset($smarty_data[$ext_smarty]) &&
|
||||||
is_array($cms->{$ext_smarty})
|
is_array($smarty_data[$ext_smarty])
|
||||||
) {
|
) {
|
||||||
$this->{$ext_smarty} = array_merge($this->{$ext_smarty}, $cms->{$ext_smarty});
|
$this->{$ext_smarty} = array_merge($this->{$ext_smarty}, $smarty_data[$ext_smarty]);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -524,21 +787,39 @@ class SmartyExtend extends \Smarty
|
|||||||
/**
|
/**
|
||||||
* render smarty data (can be called sepparate)
|
* render smarty data (can be called sepparate)
|
||||||
*
|
*
|
||||||
|
* @param string|null $compile_dir BASE . TEMPLATES_C
|
||||||
|
* @param string|null $cache_dir BASE . CACHE
|
||||||
* @return void
|
* @return void
|
||||||
*/
|
*/
|
||||||
public function renderSmarty(): void
|
public function renderSmarty(
|
||||||
{
|
?string $compile_dir = null,
|
||||||
|
?string $cache_dir = null
|
||||||
|
): void {
|
||||||
|
// trigger deprecation
|
||||||
|
if (
|
||||||
|
$compile_dir === null ||
|
||||||
|
$cache_dir === null
|
||||||
|
) {
|
||||||
|
/** @deprecated renderSmarty call without parameters */
|
||||||
|
trigger_error(
|
||||||
|
'Calling renderSmarty without paramters is deprecated',
|
||||||
|
E_USER_DEPRECATED
|
||||||
|
);
|
||||||
|
}
|
||||||
|
// set vars (to be deprecated)
|
||||||
|
$compile_dir = $compile_dir ?? BASE . TEMPLATES_C;
|
||||||
|
$cache_dir = $cache_dir ?? BASE . CACHE;
|
||||||
// create main data array
|
// create main data array
|
||||||
$this->CONTENT_DATA = array_merge($this->HEADER, $this->DATA, $this->DEBUG_DATA);
|
$this->CONTENT_DATA = array_merge($this->HEADER, $this->DATA, $this->DEBUG_DATA);
|
||||||
// data is 1:1 mapping (all vars, values, etc)
|
// data is 1:1 mapping (all vars, values, etc)
|
||||||
foreach ($this->CONTENT_DATA as $key => $value) {
|
foreach ($this->CONTENT_DATA as $key => $value) {
|
||||||
$this->assign($key, $value);
|
$this->assign($key, $value);
|
||||||
}
|
}
|
||||||
if (is_dir(BASE . TEMPLATES_C)) {
|
if (is_dir($compile_dir)) {
|
||||||
$this->setCompileDir(BASE . TEMPLATES_C);
|
$this->setCompileDir($compile_dir);
|
||||||
}
|
}
|
||||||
if (is_dir(BASE . CACHE)) {
|
if (is_dir($cache_dir)) {
|
||||||
$this->setCacheDir(BASE . CACHE);
|
$this->setCacheDir($cache_dir);
|
||||||
}
|
}
|
||||||
$this->display(
|
$this->display(
|
||||||
$this->MASTER_TEMPLATE_NAME,
|
$this->MASTER_TEMPLATE_NAME,
|
||||||
|
|||||||
@@ -50,9 +50,22 @@ for (
|
|||||||
is_file($__DIR__PATH . $CONFIG_PATH_PREFIX . CONFIG_PATH . 'config.master.php')
|
is_file($__DIR__PATH . $CONFIG_PATH_PREFIX . CONFIG_PATH . 'config.master.php')
|
||||||
) {
|
) {
|
||||||
// load enviorment file if it exists
|
// load enviorment file if it exists
|
||||||
\CoreLibs\Get\DotEnv::readEnvFile(
|
\gullevek\dotEnv\DotEnv::readEnvFile(
|
||||||
$__DIR__PATH . $CONFIG_PATH_PREFIX . CONFIG_PATH
|
$__DIR__PATH . $CONFIG_PATH_PREFIX . CONFIG_PATH
|
||||||
);
|
);
|
||||||
|
// find trigger name "admin/" or "frontend/" in the getcwd() folder
|
||||||
|
$folder = '';
|
||||||
|
foreach (['admin', 'frontend'] as $_folder) {
|
||||||
|
if (strstr(getcwd() ?: '', DIRECTORY_SEPARATOR . $_folder)) {
|
||||||
|
$folder = $_folder;
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
// if content path is empty, fallback is default
|
||||||
|
if (empty($folder)) {
|
||||||
|
$folder = 'default';
|
||||||
|
}
|
||||||
|
define('CONTENT_PATH', $folder . DIRECTORY_SEPARATOR);
|
||||||
// load master config file that loads all other config files
|
// load master config file that loads all other config files
|
||||||
require $__DIR__PATH . $CONFIG_PATH_PREFIX . CONFIG_PATH . 'config.master.php';
|
require $__DIR__PATH . $CONFIG_PATH_PREFIX . CONFIG_PATH . 'config.master.php';
|
||||||
break;
|
break;
|
||||||
@@ -62,17 +75,5 @@ for (
|
|||||||
if (!defined('DIR')) {
|
if (!defined('DIR')) {
|
||||||
exit('Base config could not be loaded');
|
exit('Base config could not be loaded');
|
||||||
}
|
}
|
||||||
// find trigger name "admin/" or "frontend/" in the getcwd() folder
|
|
||||||
foreach (['admin', 'frontend'] as $folder) {
|
|
||||||
if (strstr(getcwd() ?: '', DIRECTORY_SEPARATOR . $folder)) {
|
|
||||||
break;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
// if content path is empty, fallback is default
|
|
||||||
/** @phpstan-ignore-next-line can be empty */
|
|
||||||
if (empty($folder)) {
|
|
||||||
$folder = 'default';
|
|
||||||
}
|
|
||||||
define('CONTENT_PATH', $folder . DIRECTORY_SEPARATOR);
|
|
||||||
|
|
||||||
// __END__
|
// __END__
|
||||||
|
|||||||
40
test/phpunit/AAASetupData/CoreLibsAAASetupDataTest.php
Normal file
40
test/phpunit/AAASetupData/CoreLibsAAASetupDataTest.php
Normal file
@@ -0,0 +1,40 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
declare(strict_types=1);
|
||||||
|
|
||||||
|
namespace tests;
|
||||||
|
|
||||||
|
use PHPUnit\Framework\TestCase;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Test base setup
|
||||||
|
* @testdox AAASetupData\AAASetupDataTest just setup BASE
|
||||||
|
*/
|
||||||
|
final class CoreLibsAAASetupDataTest extends TestCase
|
||||||
|
{
|
||||||
|
/**
|
||||||
|
* Covers nothing
|
||||||
|
*
|
||||||
|
* @testdox Just setup BASE
|
||||||
|
*
|
||||||
|
* @return void
|
||||||
|
*/
|
||||||
|
public function testSetupData(): void
|
||||||
|
{
|
||||||
|
if (!defined('BASE')) {
|
||||||
|
define(
|
||||||
|
'BASE',
|
||||||
|
str_replace('/configs', '', __DIR__)
|
||||||
|
. DIRECTORY_SEPARATOR
|
||||||
|
);
|
||||||
|
}
|
||||||
|
$this->assertEquals(
|
||||||
|
str_replace('/configs', '', __DIR__)
|
||||||
|
. DIRECTORY_SEPARATOR,
|
||||||
|
BASE,
|
||||||
|
'BASE Path set check'
|
||||||
|
);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// __END__
|
||||||
1
test/phpunit/AAASetupData/includes
Symbolic link
1
test/phpunit/AAASetupData/includes
Symbolic link
@@ -0,0 +1 @@
|
|||||||
|
../Language/includes/
|
||||||
1
test/phpunit/AAASetupData/log
Symbolic link
1
test/phpunit/AAASetupData/log
Symbolic link
@@ -0,0 +1 @@
|
|||||||
|
../Debug/log/
|
||||||
@@ -7,6 +7,14 @@ namespace tests;
|
|||||||
use PHPUnit\Framework\TestCase;
|
use PHPUnit\Framework\TestCase;
|
||||||
use PHPUnit\Framework\MockObject\MockObject;
|
use PHPUnit\Framework\MockObject\MockObject;
|
||||||
|
|
||||||
|
/*
|
||||||
|
Not yet covered tests:
|
||||||
|
- loginGetLocale
|
||||||
|
- loginGetHeaderColor
|
||||||
|
- loginGetPages
|
||||||
|
- loginGetEuid
|
||||||
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Test class for ACL\Login
|
* Test class for ACL\Login
|
||||||
* @coversDefaultClass \CoreLibs\ACL\Login
|
* @coversDefaultClass \CoreLibs\ACL\Login
|
||||||
@@ -60,13 +68,10 @@ final class CoreLibsACLLoginTest extends TestCase
|
|||||||
|
|
||||||
// logger is always needed
|
// logger is always needed
|
||||||
// define basic connection set valid and one invalid
|
// define basic connection set valid and one invalid
|
||||||
self::$log = new \CoreLibs\Debug\Logging([
|
self::$log = new \CoreLibs\Logging\Logging([
|
||||||
// 'log_folder' => __DIR__ . DIRECTORY_SEPARATOR . 'log',
|
// 'log_folder' => __DIR__ . DIRECTORY_SEPARATOR . 'log',
|
||||||
'log_folder' => DIRECTORY_SEPARATOR . 'tmp',
|
'log_folder' => DIRECTORY_SEPARATOR . 'tmp',
|
||||||
'file_id' => 'CoreLibs-ACL-Login-Test',
|
'log_file_id' => 'CoreLibs-ACL-Login-Test',
|
||||||
'debug_all' => true,
|
|
||||||
'echo_all' => false,
|
|
||||||
'print_all' => true,
|
|
||||||
]);
|
]);
|
||||||
// test database we need to connect do, if not possible this test is skipped
|
// test database we need to connect do, if not possible this test is skipped
|
||||||
self::$db = new \CoreLibs\DB\IO(
|
self::$db = new \CoreLibs\DB\IO(
|
||||||
@@ -120,8 +125,6 @@ final class CoreLibsACLLoginTest extends TestCase
|
|||||||
// define('LOGIN_DB_SCHEMA', '');
|
// define('LOGIN_DB_SCHEMA', '');
|
||||||
|
|
||||||
// SHOULD SET
|
// SHOULD SET
|
||||||
// PASSWORD_MIN_LENGTH (d9)
|
|
||||||
// PASSWORD_MAX_LENGTH (d255)
|
|
||||||
// DEFAULT_ACL_LEVEL (d80)
|
// DEFAULT_ACL_LEVEL (d80)
|
||||||
|
|
||||||
// OPT:
|
// OPT:
|
||||||
@@ -164,8 +167,10 @@ final class CoreLibsACLLoginTest extends TestCase
|
|||||||
// change_password, pw_username, pw_old_password, pw_new_password,
|
// change_password, pw_username, pw_old_password, pw_new_password,
|
||||||
// pw_new_password_confirm
|
// pw_new_password_confirm
|
||||||
// 3[session]: override session set
|
// 3[session]: override session set
|
||||||
// 4[error] : expected error code, 0 for all ok, 3000 for login page view
|
// 4[error] : expected error code, 0 for all ok, 100 for login page view
|
||||||
// note that 1000 (no db), 2000 (no session) must be tested too
|
// note that 1000 (no db), 2000 (no session), 3000 (options set error)
|
||||||
|
// must be tested too
|
||||||
|
// <1000 info, >=1000 critical error
|
||||||
// 5[return] : expected return array, eg login_error code,
|
// 5[return] : expected return array, eg login_error code,
|
||||||
// or other info data to match
|
// or other info data to match
|
||||||
$tests = [
|
$tests = [
|
||||||
@@ -177,7 +182,7 @@ final class CoreLibsACLLoginTest extends TestCase
|
|||||||
[],
|
[],
|
||||||
[],
|
[],
|
||||||
[],
|
[],
|
||||||
3000,
|
100,
|
||||||
[
|
[
|
||||||
'login_error' => 0,
|
'login_error' => 0,
|
||||||
'error_string' => 'Success: <b>No error</b>',
|
'error_string' => 'Success: <b>No error</b>',
|
||||||
@@ -195,7 +200,7 @@ final class CoreLibsACLLoginTest extends TestCase
|
|||||||
[],
|
[],
|
||||||
[],
|
[],
|
||||||
[],
|
[],
|
||||||
3000,
|
100,
|
||||||
[
|
[
|
||||||
'login_error' => 0,
|
'login_error' => 0,
|
||||||
'error_string' => 'Success: <b>No error</b>',
|
'error_string' => 'Success: <b>No error</b>',
|
||||||
@@ -218,7 +223,7 @@ final class CoreLibsACLLoginTest extends TestCase
|
|||||||
[],
|
[],
|
||||||
[],
|
[],
|
||||||
[],
|
[],
|
||||||
3000,
|
100,
|
||||||
[
|
[
|
||||||
'login_error' => 0,
|
'login_error' => 0,
|
||||||
'error_string' => 'Success: <b>No error</b>',
|
'error_string' => 'Success: <b>No error</b>',
|
||||||
@@ -261,6 +266,8 @@ final class CoreLibsACLLoginTest extends TestCase
|
|||||||
'GROUP_ACL_LEVEL' => -1,
|
'GROUP_ACL_LEVEL' => -1,
|
||||||
'PAGES_ACL_LEVEL' => [],
|
'PAGES_ACL_LEVEL' => [],
|
||||||
'USER_ACL_LEVEL' => -1,
|
'USER_ACL_LEVEL' => -1,
|
||||||
|
'USER_ADDITIONAL_ACL' => [],
|
||||||
|
'GROUP_ADDITIONAL_ACL' => [],
|
||||||
'UNIT_UID' => [
|
'UNIT_UID' => [
|
||||||
'AdminAccess' => 1,
|
'AdminAccess' => 1,
|
||||||
],
|
],
|
||||||
@@ -274,6 +281,7 @@ final class CoreLibsACLLoginTest extends TestCase
|
|||||||
'data' => [
|
'data' => [
|
||||||
'test' => 'value',
|
'test' => 'value',
|
||||||
],
|
],
|
||||||
|
'additional_acl' => []
|
||||||
],
|
],
|
||||||
],
|
],
|
||||||
// 'UNIT_DEFAULT' => '',
|
// 'UNIT_DEFAULT' => '',
|
||||||
@@ -302,7 +310,7 @@ final class CoreLibsACLLoginTest extends TestCase
|
|||||||
'login_password' => '',
|
'login_password' => '',
|
||||||
],
|
],
|
||||||
[],
|
[],
|
||||||
3000,
|
100,
|
||||||
[
|
[
|
||||||
'login_error' => 102,
|
'login_error' => 102,
|
||||||
'error_string' => '<span style="color: red;">Fatal Error:</span> '
|
'error_string' => '<span style="color: red;">Fatal Error:</span> '
|
||||||
@@ -323,7 +331,7 @@ final class CoreLibsACLLoginTest extends TestCase
|
|||||||
'login_password' => 'abc',
|
'login_password' => 'abc',
|
||||||
],
|
],
|
||||||
[],
|
[],
|
||||||
3000,
|
100,
|
||||||
[
|
[
|
||||||
'login_error' => 102,
|
'login_error' => 102,
|
||||||
'error_string' => '<span style="color: red;">Fatal Error:</span> '
|
'error_string' => '<span style="color: red;">Fatal Error:</span> '
|
||||||
@@ -344,7 +352,7 @@ final class CoreLibsACLLoginTest extends TestCase
|
|||||||
'login_password' => '',
|
'login_password' => '',
|
||||||
],
|
],
|
||||||
[],
|
[],
|
||||||
3000,
|
100,
|
||||||
[
|
[
|
||||||
'login_error' => 102,
|
'login_error' => 102,
|
||||||
'error_string' => '<span style="color: red;">Fatal Error:</span> '
|
'error_string' => '<span style="color: red;">Fatal Error:</span> '
|
||||||
@@ -365,7 +373,7 @@ final class CoreLibsACLLoginTest extends TestCase
|
|||||||
'login_password' => 'abc',
|
'login_password' => 'abc',
|
||||||
],
|
],
|
||||||
[],
|
[],
|
||||||
3000,
|
100,
|
||||||
[
|
[
|
||||||
'login_error' => 1010,
|
'login_error' => 1010,
|
||||||
'error_string' => '<span style="color: red;">Fatal Error:</span> '
|
'error_string' => '<span style="color: red;">Fatal Error:</span> '
|
||||||
@@ -389,7 +397,7 @@ final class CoreLibsACLLoginTest extends TestCase
|
|||||||
'login_password' => 'abc',
|
'login_password' => 'abc',
|
||||||
],
|
],
|
||||||
[],
|
[],
|
||||||
3000,
|
100,
|
||||||
[
|
[
|
||||||
// default password is plain text
|
// default password is plain text
|
||||||
'login_error' => 1012,
|
'login_error' => 1012,
|
||||||
@@ -415,7 +423,7 @@ final class CoreLibsACLLoginTest extends TestCase
|
|||||||
'login_password' => 'admin',
|
'login_password' => 'admin',
|
||||||
],
|
],
|
||||||
[],
|
[],
|
||||||
3000,
|
100,
|
||||||
[
|
[
|
||||||
'login_error' => 106,
|
'login_error' => 106,
|
||||||
'error_string' => '<span style="color: red;">Fatal Error:</span> '
|
'error_string' => '<span style="color: red;">Fatal Error:</span> '
|
||||||
@@ -440,7 +448,7 @@ final class CoreLibsACLLoginTest extends TestCase
|
|||||||
'login_password' => 'admin',
|
'login_password' => 'admin',
|
||||||
],
|
],
|
||||||
[],
|
[],
|
||||||
3000,
|
100,
|
||||||
[
|
[
|
||||||
'login_error' => 104,
|
'login_error' => 104,
|
||||||
'error_string' => '<span style="color: red;">Fatal Error:</span> '
|
'error_string' => '<span style="color: red;">Fatal Error:</span> '
|
||||||
@@ -465,7 +473,7 @@ final class CoreLibsACLLoginTest extends TestCase
|
|||||||
'login_password' => 'admin',
|
'login_password' => 'admin',
|
||||||
],
|
],
|
||||||
[],
|
[],
|
||||||
3000,
|
100,
|
||||||
[
|
[
|
||||||
'login_error' => 105,
|
'login_error' => 105,
|
||||||
'error_string' => '<span style="color: red;">Fatal Error:</span> '
|
'error_string' => '<span style="color: red;">Fatal Error:</span> '
|
||||||
@@ -514,7 +522,7 @@ final class CoreLibsACLLoginTest extends TestCase
|
|||||||
'login_password' => 'admin',
|
'login_password' => 'admin',
|
||||||
],
|
],
|
||||||
[],
|
[],
|
||||||
3000,
|
100,
|
||||||
[
|
[
|
||||||
'login_error' => 107,
|
'login_error' => 107,
|
||||||
'error_string' => '<span style="color: red;">Fatal Error:</span> '
|
'error_string' => '<span style="color: red;">Fatal Error:</span> '
|
||||||
@@ -568,7 +576,7 @@ final class CoreLibsACLLoginTest extends TestCase
|
|||||||
'login_password' => 'admin',
|
'login_password' => 'admin',
|
||||||
],
|
],
|
||||||
[],
|
[],
|
||||||
3000,
|
100,
|
||||||
[
|
[
|
||||||
'login_error' => 107,
|
'login_error' => 107,
|
||||||
'error_string' => '<span style="color: red;">Fatal Error:</span> '
|
'error_string' => '<span style="color: red;">Fatal Error:</span> '
|
||||||
@@ -594,7 +602,7 @@ final class CoreLibsACLLoginTest extends TestCase
|
|||||||
'login_password' => 'admin',
|
'login_password' => 'admin',
|
||||||
],
|
],
|
||||||
[],
|
[],
|
||||||
3000,
|
100,
|
||||||
[
|
[
|
||||||
'login_error' => 107,
|
'login_error' => 107,
|
||||||
'error_string' => '<span style="color: red;">Fatal Error:</span> '
|
'error_string' => '<span style="color: red;">Fatal Error:</span> '
|
||||||
@@ -619,7 +627,7 @@ final class CoreLibsACLLoginTest extends TestCase
|
|||||||
'login_password' => 'admin',
|
'login_password' => 'admin',
|
||||||
],
|
],
|
||||||
[],
|
[],
|
||||||
3000,
|
100,
|
||||||
[
|
[
|
||||||
'login_error' => 108,
|
'login_error' => 108,
|
||||||
'error_string' => '<span style="color: red;">Fatal Error:</span> '
|
'error_string' => '<span style="color: red;">Fatal Error:</span> '
|
||||||
@@ -755,7 +763,7 @@ final class CoreLibsACLLoginTest extends TestCase
|
|||||||
],
|
],
|
||||||
[],
|
[],
|
||||||
[],
|
[],
|
||||||
3000,
|
100,
|
||||||
[
|
[
|
||||||
'login_error' => 1010,
|
'login_error' => 1010,
|
||||||
'error_string' => '<span style="color: red;">Fatal Error:</span> '
|
'error_string' => '<span style="color: red;">Fatal Error:</span> '
|
||||||
@@ -847,7 +855,7 @@ final class CoreLibsACLLoginTest extends TestCase
|
|||||||
],
|
],
|
||||||
[],
|
[],
|
||||||
[],
|
[],
|
||||||
3000,
|
100,
|
||||||
[
|
[
|
||||||
'login_error' => 1101,
|
'login_error' => 1101,
|
||||||
'error_string' => '<span style="color: red;">Fatal Error:</span> '
|
'error_string' => '<span style="color: red;">Fatal Error:</span> '
|
||||||
@@ -903,7 +911,7 @@ final class CoreLibsACLLoginTest extends TestCase
|
|||||||
],
|
],
|
||||||
[],
|
[],
|
||||||
[],
|
[],
|
||||||
3000,
|
100,
|
||||||
[
|
[
|
||||||
'login_error' => 1102,
|
'login_error' => 1102,
|
||||||
'error_string' => '<span style="color: red;">Fatal Error:</span> '
|
'error_string' => '<span style="color: red;">Fatal Error:</span> '
|
||||||
@@ -959,7 +967,7 @@ final class CoreLibsACLLoginTest extends TestCase
|
|||||||
],
|
],
|
||||||
[],
|
[],
|
||||||
[],
|
[],
|
||||||
3000,
|
100,
|
||||||
[
|
[
|
||||||
'login_error' => 1102,
|
'login_error' => 1102,
|
||||||
'error_string' => '<span style="color: red;">Fatal Error:</span> '
|
'error_string' => '<span style="color: red;">Fatal Error:</span> '
|
||||||
@@ -986,7 +994,7 @@ final class CoreLibsACLLoginTest extends TestCase
|
|||||||
],
|
],
|
||||||
[],
|
[],
|
||||||
[],
|
[],
|
||||||
3000,
|
100,
|
||||||
[
|
[
|
||||||
'login_error' => 1102,
|
'login_error' => 1102,
|
||||||
'error_string' => '<span style="color: red;">Fatal Error:</span> '
|
'error_string' => '<span style="color: red;">Fatal Error:</span> '
|
||||||
@@ -1106,13 +1114,28 @@ final class CoreLibsACLLoginTest extends TestCase
|
|||||||
|
|
||||||
/** @var \CoreLibs\ACL\Login&MockObject */
|
/** @var \CoreLibs\ACL\Login&MockObject */
|
||||||
$login_mock = $this->getMockBuilder(\CoreLibs\ACL\Login::class)
|
$login_mock = $this->getMockBuilder(\CoreLibs\ACL\Login::class)
|
||||||
->setConstructorArgs([self::$db, self::$log, $session_mock, false])
|
->setConstructorArgs([
|
||||||
|
self::$db,
|
||||||
|
self::$log,
|
||||||
|
$session_mock,
|
||||||
|
[
|
||||||
|
'auto_login' => false,
|
||||||
|
'default_acl_level' => 80,
|
||||||
|
'logout_target' => '',
|
||||||
|
'site_locale' => 'en_US.UTF-8',
|
||||||
|
'site_domain' => 'admin',
|
||||||
|
'site_encoding' => 'UTF-8',
|
||||||
|
'locale_path' => __DIR__ . DIRECTORY_SEPARATOR
|
||||||
|
. 'includes' . DIRECTORY_SEPARATOR
|
||||||
|
. 'locale' . DIRECTORY_SEPARATOR,
|
||||||
|
]
|
||||||
|
])
|
||||||
->onlyMethods(['loginTerminate', 'loginReadPageName', 'loginPrintLogin'])
|
->onlyMethods(['loginTerminate', 'loginReadPageName', 'loginPrintLogin'])
|
||||||
->getMock();
|
->getMock();
|
||||||
$login_mock->expects($this->any())
|
$login_mock->expects($this->any())
|
||||||
->method('loginTerminate')
|
->method('loginTerminate')
|
||||||
->will(
|
->will(
|
||||||
$this->returnCallback(function ($code) {
|
$this->returnCallback(function ($message, $code) {
|
||||||
throw new \Exception('', $code);
|
throw new \Exception('', $code);
|
||||||
})
|
})
|
||||||
);
|
);
|
||||||
@@ -1206,7 +1229,11 @@ final class CoreLibsACLLoginTest extends TestCase
|
|||||||
$login_mock->loginSetMaxLoginErrorCount($mock_settings['max_login_error_count']);
|
$login_mock->loginSetMaxLoginErrorCount($mock_settings['max_login_error_count']);
|
||||||
// temporary wrong password
|
// temporary wrong password
|
||||||
$_POST['login_password'] = 'wrong';
|
$_POST['login_password'] = 'wrong';
|
||||||
for ($run = 1, $max_run = $login_mock->loginGetMaxLoginErrorCount(); $run <= $max_run; $run++) {
|
for (
|
||||||
|
$run = 1, $max_run = $login_mock->loginGetMaxLoginErrorCount();
|
||||||
|
$run <= $max_run;
|
||||||
|
$run++
|
||||||
|
) {
|
||||||
try {
|
try {
|
||||||
$login_mock->loginMainCall();
|
$login_mock->loginMainCall();
|
||||||
} catch (\Exception $e) {
|
} catch (\Exception $e) {
|
||||||
@@ -1454,10 +1481,10 @@ final class CoreLibsACLLoginTest extends TestCase
|
|||||||
// print "AJAX: " . $login_mock->loginGetAjaxFlag() . "\n";
|
// print "AJAX: " . $login_mock->loginGetAjaxFlag() . "\n";
|
||||||
// print "AJAX GLOBAL: " . ($GLOBALS['AJAX_PAGE'] ?? '{f}') . "\n";
|
// print "AJAX GLOBAL: " . ($GLOBALS['AJAX_PAGE'] ?? '{f}') . "\n";
|
||||||
// print "Login error expext: " . ($expected['login_error'] ?? '{0}') . "\n";
|
// print "Login error expext: " . ($expected['login_error'] ?? '{0}') . "\n";
|
||||||
// if this is 3000, then we do further error checks
|
// if this is 100, then we do further error checks
|
||||||
if (
|
if (
|
||||||
$e->getCode() == 3000 ||
|
$e->getCode() == 100 ||
|
||||||
!empty($_POST['login_exit']) && $_POST['login_exit'] == 3000
|
!empty($_POST['login_exit']) && $_POST['login_exit'] == 100
|
||||||
) {
|
) {
|
||||||
$this->assertEquals(
|
$this->assertEquals(
|
||||||
$expected['login_error'],
|
$expected['login_error'],
|
||||||
@@ -1729,7 +1756,7 @@ final class CoreLibsACLLoginTest extends TestCase
|
|||||||
],
|
],
|
||||||
20
|
20
|
||||||
],
|
],
|
||||||
'invalud search' => [
|
'invalid search' => [
|
||||||
12,
|
12,
|
||||||
'foo',
|
'foo',
|
||||||
[],
|
[],
|
||||||
@@ -1774,13 +1801,28 @@ final class CoreLibsACLLoginTest extends TestCase
|
|||||||
);
|
);
|
||||||
/** @var \CoreLibs\ACL\Login&MockObject */
|
/** @var \CoreLibs\ACL\Login&MockObject */
|
||||||
$login_mock = $this->getMockBuilder(\CoreLibs\ACL\Login::class)
|
$login_mock = $this->getMockBuilder(\CoreLibs\ACL\Login::class)
|
||||||
->setConstructorArgs([self::$db, self::$log, $session_mock, false])
|
->setConstructorArgs([
|
||||||
|
self::$db,
|
||||||
|
self::$log,
|
||||||
|
$session_mock,
|
||||||
|
[
|
||||||
|
'auto_login' => false,
|
||||||
|
'default_acl_level' => 80,
|
||||||
|
'logout_target' => '',
|
||||||
|
'site_locale' => 'en_US.UTF-8',
|
||||||
|
'site_domain' => 'admin',
|
||||||
|
'site_encoding' => 'UTF-8',
|
||||||
|
'locale_path' => __DIR__ . DIRECTORY_SEPARATOR
|
||||||
|
. 'includes' . DIRECTORY_SEPARATOR
|
||||||
|
. 'locale' . DIRECTORY_SEPARATOR,
|
||||||
|
]
|
||||||
|
])
|
||||||
->onlyMethods(['loginTerminate'])
|
->onlyMethods(['loginTerminate'])
|
||||||
->getMock();
|
->getMock();
|
||||||
$login_mock->expects($this->any())
|
$login_mock->expects($this->any())
|
||||||
->method('loginTerminate')
|
->method('loginTerminate')
|
||||||
->will(
|
->will(
|
||||||
$this->returnCallback(function ($code) {
|
$this->returnCallback(function ($message, $code) {
|
||||||
throw new \Exception('', $code);
|
throw new \Exception('', $code);
|
||||||
})
|
})
|
||||||
);
|
);
|
||||||
@@ -1873,13 +1915,28 @@ final class CoreLibsACLLoginTest extends TestCase
|
|||||||
);
|
);
|
||||||
/** @var \CoreLibs\ACL\Login&MockObject */
|
/** @var \CoreLibs\ACL\Login&MockObject */
|
||||||
$login_mock = $this->getMockBuilder(\CoreLibs\ACL\Login::class)
|
$login_mock = $this->getMockBuilder(\CoreLibs\ACL\Login::class)
|
||||||
->setConstructorArgs([self::$db, self::$log, $session_mock, false])
|
->setConstructorArgs([
|
||||||
|
self::$db,
|
||||||
|
self::$log,
|
||||||
|
$session_mock,
|
||||||
|
[
|
||||||
|
'auto_login' => false,
|
||||||
|
'default_acl_level' => 80,
|
||||||
|
'logout_target' => '',
|
||||||
|
'site_locale' => 'en_US.UTF-8',
|
||||||
|
'site_domain' => 'admin',
|
||||||
|
'site_encoding' => 'UTF-8',
|
||||||
|
'locale_path' => __DIR__ . DIRECTORY_SEPARATOR
|
||||||
|
. 'includes' . DIRECTORY_SEPARATOR
|
||||||
|
. 'locale' . DIRECTORY_SEPARATOR,
|
||||||
|
]
|
||||||
|
])
|
||||||
->onlyMethods(['loginTerminate'])
|
->onlyMethods(['loginTerminate'])
|
||||||
->getMock();
|
->getMock();
|
||||||
$login_mock->expects($this->any())
|
$login_mock->expects($this->any())
|
||||||
->method('loginTerminate')
|
->method('loginTerminate')
|
||||||
->will(
|
->will(
|
||||||
$this->returnCallback(function ($code) {
|
$this->returnCallback(function ($message, $code) {
|
||||||
throw new \Exception('', $code);
|
throw new \Exception('', $code);
|
||||||
})
|
})
|
||||||
);
|
);
|
||||||
@@ -1946,13 +2003,28 @@ final class CoreLibsACLLoginTest extends TestCase
|
|||||||
);
|
);
|
||||||
/** @var \CoreLibs\ACL\Login&MockObject */
|
/** @var \CoreLibs\ACL\Login&MockObject */
|
||||||
$login_mock = $this->getMockBuilder(\CoreLibs\ACL\Login::class)
|
$login_mock = $this->getMockBuilder(\CoreLibs\ACL\Login::class)
|
||||||
->setConstructorArgs([self::$db, self::$log, $session_mock, false])
|
->setConstructorArgs([
|
||||||
|
self::$db,
|
||||||
|
self::$log,
|
||||||
|
$session_mock,
|
||||||
|
[
|
||||||
|
'auto_login' => false,
|
||||||
|
'default_acl_level' => 80,
|
||||||
|
'logout_target' => '',
|
||||||
|
'site_locale' => 'en_US.UTF-8',
|
||||||
|
'site_domain' => 'admin',
|
||||||
|
'site_encoding' => 'UTF-8',
|
||||||
|
'locale_path' => __DIR__ . DIRECTORY_SEPARATOR
|
||||||
|
. 'includes' . DIRECTORY_SEPARATOR
|
||||||
|
. 'locale' . DIRECTORY_SEPARATOR,
|
||||||
|
]
|
||||||
|
])
|
||||||
->onlyMethods(['loginTerminate'])
|
->onlyMethods(['loginTerminate'])
|
||||||
->getMock();
|
->getMock();
|
||||||
$login_mock->expects($this->any())
|
$login_mock->expects($this->any())
|
||||||
->method('loginTerminate')
|
->method('loginTerminate')
|
||||||
->will(
|
->will(
|
||||||
$this->returnCallback(function ($code) {
|
$this->returnCallback(function ($message, $code) {
|
||||||
throw new \Exception('', $code);
|
throw new \Exception('', $code);
|
||||||
})
|
})
|
||||||
);
|
);
|
||||||
@@ -2027,13 +2099,28 @@ final class CoreLibsACLLoginTest extends TestCase
|
|||||||
);
|
);
|
||||||
/** @var \CoreLibs\ACL\Login&MockObject */
|
/** @var \CoreLibs\ACL\Login&MockObject */
|
||||||
$login_mock = $this->getMockBuilder(\CoreLibs\ACL\Login::class)
|
$login_mock = $this->getMockBuilder(\CoreLibs\ACL\Login::class)
|
||||||
->setConstructorArgs([self::$db, self::$log, $session_mock, false])
|
->setConstructorArgs([
|
||||||
|
self::$db,
|
||||||
|
self::$log,
|
||||||
|
$session_mock,
|
||||||
|
[
|
||||||
|
'auto_login' => false,
|
||||||
|
'default_acl_level' => 80,
|
||||||
|
'logout_target' => '',
|
||||||
|
'site_locale' => 'en_US.UTF-8',
|
||||||
|
'site_domain' => 'admin',
|
||||||
|
'site_encoding' => 'UTF-8',
|
||||||
|
'locale_path' => __DIR__ . DIRECTORY_SEPARATOR
|
||||||
|
. 'includes' . DIRECTORY_SEPARATOR
|
||||||
|
. 'locale' . DIRECTORY_SEPARATOR,
|
||||||
|
]
|
||||||
|
])
|
||||||
->onlyMethods(['loginTerminate'])
|
->onlyMethods(['loginTerminate'])
|
||||||
->getMock();
|
->getMock();
|
||||||
$login_mock->expects($this->any())
|
$login_mock->expects($this->any())
|
||||||
->method('loginTerminate')
|
->method('loginTerminate')
|
||||||
->will(
|
->will(
|
||||||
$this->returnCallback(function ($code) {
|
$this->returnCallback(function ($message, $code) {
|
||||||
throw new \Exception('', $code);
|
throw new \Exception('', $code);
|
||||||
})
|
})
|
||||||
);
|
);
|
||||||
1
test/phpunit/ACL/includes
Symbolic link
1
test/phpunit/ACL/includes
Symbolic link
@@ -0,0 +1 @@
|
|||||||
|
../AAASetupData/includes
|
||||||
@@ -13,6 +13,11 @@ use PHPUnit\Framework\TestCase;
|
|||||||
*/
|
*/
|
||||||
final class CoreLibsCheckColorsTest extends TestCase
|
final class CoreLibsCheckColorsTest extends TestCase
|
||||||
{
|
{
|
||||||
|
/**
|
||||||
|
* Undocumented function
|
||||||
|
*
|
||||||
|
* @return array<mixed>
|
||||||
|
*/
|
||||||
public function validateColorProvider(): array
|
public function validateColorProvider(): array
|
||||||
{
|
{
|
||||||
/*
|
/*
|
||||||
@@ -321,7 +326,7 @@ final class CoreLibsCheckColorsTest extends TestCase
|
|||||||
*/
|
*/
|
||||||
public function testValidateColorException(int $flag): void
|
public function testValidateColorException(int $flag): void
|
||||||
{
|
{
|
||||||
$this->expectException(\Exception::class);
|
$this->expectException(\UnexpectedValueException::class);
|
||||||
\CoreLibs\Check\Colors::validateColor('#ffffff', $flag);
|
\CoreLibs\Check\Colors::validateColor('#ffffff', $flag);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -31,6 +31,7 @@ final class CoreLibsCombinedArrayHandlerTest extends TestCase
|
|||||||
4,
|
4,
|
||||||
'b',
|
'b',
|
||||||
'c' => 'test',
|
'c' => 'test',
|
||||||
|
'single' => 'single',
|
||||||
'same' => 'same',
|
'same' => 'same',
|
||||||
'deep' => [
|
'deep' => [
|
||||||
'sub' => [
|
'sub' => [
|
||||||
@@ -107,6 +108,13 @@ final class CoreLibsCombinedArrayHandlerTest extends TestCase
|
|||||||
*/
|
*/
|
||||||
public function arraySearchRecursiveAllProvider(): array
|
public function arraySearchRecursiveAllProvider(): array
|
||||||
{
|
{
|
||||||
|
/*
|
||||||
|
0: $needle,
|
||||||
|
1: array $input,
|
||||||
|
2: ?string $key_search_for,
|
||||||
|
3: bool $flag,
|
||||||
|
4: array $expected
|
||||||
|
*/
|
||||||
return [
|
return [
|
||||||
'find value' => [
|
'find value' => [
|
||||||
0 => 'bar',
|
0 => 'bar',
|
||||||
@@ -172,6 +180,13 @@ final class CoreLibsCombinedArrayHandlerTest extends TestCase
|
|||||||
*/
|
*/
|
||||||
public function arraySearchSimpleProvider(): array
|
public function arraySearchSimpleProvider(): array
|
||||||
{
|
{
|
||||||
|
/*
|
||||||
|
0: array $input,
|
||||||
|
1: $key,
|
||||||
|
2: $value,
|
||||||
|
3: bool $flag,
|
||||||
|
4: bool $expected
|
||||||
|
*/
|
||||||
return [
|
return [
|
||||||
'key/value exist' => [
|
'key/value exist' => [
|
||||||
0 => self::$array,
|
0 => self::$array,
|
||||||
@@ -274,6 +289,188 @@ final class CoreLibsCombinedArrayHandlerTest extends TestCase
|
|||||||
];
|
];
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Undocumented function
|
||||||
|
*
|
||||||
|
* @return array
|
||||||
|
*/
|
||||||
|
public function arraySearchKeyProvider(): array
|
||||||
|
{
|
||||||
|
/*
|
||||||
|
0: search in array
|
||||||
|
1: search keys
|
||||||
|
2: flat flag
|
||||||
|
3: prefix flag
|
||||||
|
4: expected array
|
||||||
|
*/
|
||||||
|
return [
|
||||||
|
// single
|
||||||
|
'find single, standard' => [
|
||||||
|
0 => self::$array,
|
||||||
|
1 => ['single'],
|
||||||
|
2 => null,
|
||||||
|
3 => null,
|
||||||
|
4 => [
|
||||||
|
0 => [
|
||||||
|
'value' => 'single',
|
||||||
|
'path' => ['single'],
|
||||||
|
],
|
||||||
|
],
|
||||||
|
],
|
||||||
|
'find single, prefix' => [
|
||||||
|
0 => self::$array,
|
||||||
|
1 => ['single'],
|
||||||
|
2 => null,
|
||||||
|
3 => true,
|
||||||
|
4 => [
|
||||||
|
'single' => [
|
||||||
|
0 => [
|
||||||
|
'value' => 'single',
|
||||||
|
'path' => ['single'],
|
||||||
|
],
|
||||||
|
],
|
||||||
|
],
|
||||||
|
],
|
||||||
|
'find single, flat' => [
|
||||||
|
0 => self::$array,
|
||||||
|
1 => ['single'],
|
||||||
|
2 => true,
|
||||||
|
3 => null,
|
||||||
|
4 => [
|
||||||
|
'single',
|
||||||
|
],
|
||||||
|
],
|
||||||
|
'find single, flat, prefix' => [
|
||||||
|
0 => self::$array,
|
||||||
|
1 => ['single'],
|
||||||
|
2 => true,
|
||||||
|
3 => true,
|
||||||
|
4 => [
|
||||||
|
'single' => [
|
||||||
|
'single',
|
||||||
|
],
|
||||||
|
],
|
||||||
|
],
|
||||||
|
// not found
|
||||||
|
'not found, standard' => [
|
||||||
|
0 => self::$array,
|
||||||
|
1 => ['NOT FOUND'],
|
||||||
|
2 => null,
|
||||||
|
3 => null,
|
||||||
|
4 => [],
|
||||||
|
],
|
||||||
|
'not found, standard, prefix' => [
|
||||||
|
0 => self::$array,
|
||||||
|
1 => ['NOT FOUND'],
|
||||||
|
2 => null,
|
||||||
|
3 => true,
|
||||||
|
4 => [
|
||||||
|
'NOT FOUND' => [],
|
||||||
|
],
|
||||||
|
],
|
||||||
|
'not found, flat' => [
|
||||||
|
0 => self::$array,
|
||||||
|
1 => ['NOT FOUND'],
|
||||||
|
2 => true,
|
||||||
|
3 => null,
|
||||||
|
4 => [],
|
||||||
|
],
|
||||||
|
'not found, flat, prefix' => [
|
||||||
|
0 => self::$array,
|
||||||
|
1 => ['NOT FOUND'],
|
||||||
|
2 => true,
|
||||||
|
3 => true,
|
||||||
|
4 => [
|
||||||
|
'NOT FOUND' => [],
|
||||||
|
],
|
||||||
|
],
|
||||||
|
// multi
|
||||||
|
'multiple found, standard' => [
|
||||||
|
0 => self::$array,
|
||||||
|
1 => ['same'],
|
||||||
|
2 => null,
|
||||||
|
3 => null,
|
||||||
|
4 => [
|
||||||
|
[
|
||||||
|
'value' => 'same',
|
||||||
|
'path' => ['a', 'same', ],
|
||||||
|
],
|
||||||
|
[
|
||||||
|
'value' => 'same',
|
||||||
|
'path' => ['same', ],
|
||||||
|
],
|
||||||
|
[
|
||||||
|
'value' => 'same',
|
||||||
|
'path' => ['deep', 'sub', 'same', ],
|
||||||
|
],
|
||||||
|
]
|
||||||
|
],
|
||||||
|
'multiple found, flat' => [
|
||||||
|
0 => self::$array,
|
||||||
|
1 => ['same'],
|
||||||
|
2 => true,
|
||||||
|
3 => null,
|
||||||
|
4 => ['same', 'same', 'same', ],
|
||||||
|
],
|
||||||
|
// search with multiple
|
||||||
|
'search multiple, standard' => [
|
||||||
|
0 => self::$array,
|
||||||
|
1 => ['single', 'nested'],
|
||||||
|
2 => null,
|
||||||
|
3 => null,
|
||||||
|
4 => [
|
||||||
|
[
|
||||||
|
'value' => 'single',
|
||||||
|
'path' => ['single'],
|
||||||
|
],
|
||||||
|
[
|
||||||
|
'value' => 'bar',
|
||||||
|
'path' => ['deep', 'sub', 'nested', ],
|
||||||
|
],
|
||||||
|
],
|
||||||
|
],
|
||||||
|
'search multiple, prefix' => [
|
||||||
|
0 => self::$array,
|
||||||
|
1 => ['single', 'nested'],
|
||||||
|
2 => null,
|
||||||
|
3 => true,
|
||||||
|
4 => [
|
||||||
|
'single' => [
|
||||||
|
[
|
||||||
|
'value' => 'single',
|
||||||
|
'path' => ['single'],
|
||||||
|
],
|
||||||
|
],
|
||||||
|
'nested' => [
|
||||||
|
[
|
||||||
|
'value' => 'bar',
|
||||||
|
'path' => ['deep', 'sub', 'nested', ],
|
||||||
|
],
|
||||||
|
],
|
||||||
|
],
|
||||||
|
],
|
||||||
|
'search multiple, flat' => [
|
||||||
|
0 => self::$array,
|
||||||
|
1 => ['single', 'nested'],
|
||||||
|
2 => true,
|
||||||
|
3 => null,
|
||||||
|
4 => [
|
||||||
|
'single', 'bar',
|
||||||
|
],
|
||||||
|
],
|
||||||
|
'search multiple, flat, prefix' => [
|
||||||
|
0 => self::$array,
|
||||||
|
1 => ['single', 'nested'],
|
||||||
|
2 => true,
|
||||||
|
3 => true,
|
||||||
|
4 => [
|
||||||
|
'single' => ['single', ],
|
||||||
|
'nested' => ['bar', ],
|
||||||
|
],
|
||||||
|
],
|
||||||
|
];
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* provides array listing for the merge test
|
* provides array listing for the merge test
|
||||||
*
|
*
|
||||||
@@ -321,17 +518,20 @@ final class CoreLibsCombinedArrayHandlerTest extends TestCase
|
|||||||
return [
|
return [
|
||||||
// error <2 arguments
|
// error <2 arguments
|
||||||
'too view arguments' => [
|
'too view arguments' => [
|
||||||
|
'ArgumentCountError',
|
||||||
'arrayMergeRecursive needs two or more array arguments',
|
'arrayMergeRecursive needs two or more array arguments',
|
||||||
[1]
|
[1]
|
||||||
],
|
],
|
||||||
// error <2 arrays
|
// error <2 arrays
|
||||||
'only one array' => [
|
'only one array' => [
|
||||||
|
'ArgumentCountError',
|
||||||
'arrayMergeRecursive needs two or more array arguments',
|
'arrayMergeRecursive needs two or more array arguments',
|
||||||
[1],
|
[1],
|
||||||
true,
|
true,
|
||||||
],
|
],
|
||||||
// error element is not array
|
// error element is not array
|
||||||
'non array between array' => [
|
'non array between array' => [
|
||||||
|
'TypeError',
|
||||||
'arrayMergeRecursive encountered a non array argument',
|
'arrayMergeRecursive encountered a non array argument',
|
||||||
[1],
|
[1],
|
||||||
'string',
|
'string',
|
||||||
@@ -665,7 +865,7 @@ final class CoreLibsCombinedArrayHandlerTest extends TestCase
|
|||||||
*
|
*
|
||||||
* @param array $input
|
* @param array $input
|
||||||
* @param string|int $key
|
* @param string|int $key
|
||||||
* @param string|int $value
|
* @param string|int|bool $value
|
||||||
* @param bool $expected
|
* @param bool $expected
|
||||||
* @return void
|
* @return void
|
||||||
*/
|
*/
|
||||||
@@ -677,6 +877,44 @@ final class CoreLibsCombinedArrayHandlerTest extends TestCase
|
|||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Undocumented function
|
||||||
|
*
|
||||||
|
* @covers::arraySearchKey
|
||||||
|
* @dataProvider arraySearchKeyProvider
|
||||||
|
* @testdox arraySearchKey Search array with keys and flat: $flat, prefix: $prefix [$_dataName]
|
||||||
|
*
|
||||||
|
* @param array $input
|
||||||
|
* @param array $needles
|
||||||
|
* @param bool|null $flat
|
||||||
|
* @param bool|null $prefix
|
||||||
|
* @param array $expected
|
||||||
|
* @return void
|
||||||
|
*/
|
||||||
|
public function testArraySearchKey(
|
||||||
|
array $input,
|
||||||
|
array $needles,
|
||||||
|
?bool $flat,
|
||||||
|
?bool $prefix,
|
||||||
|
array $expected
|
||||||
|
): void {
|
||||||
|
if ($flat === null && $prefix === null) {
|
||||||
|
$result = \CoreLibs\Combined\ArrayHandler::arraySearchKey($input, $needles);
|
||||||
|
} elseif ($flat === null) {
|
||||||
|
$result = \CoreLibs\Combined\ArrayHandler::arraySearchKey($input, $needles, prefix: $prefix);
|
||||||
|
} elseif ($prefix === null) {
|
||||||
|
$result = \CoreLibs\Combined\ArrayHandler::arraySearchKey($input, $needles, flat: $flat);
|
||||||
|
} else {
|
||||||
|
$result = \CoreLibs\Combined\ArrayHandler::arraySearchKey($input, $needles, $flat, $prefix);
|
||||||
|
}
|
||||||
|
// print "E: " . print_r($expected, true) . "\n";
|
||||||
|
// print "R: " . print_r($result, true) . "\n";
|
||||||
|
$this->assertEquals(
|
||||||
|
$expected,
|
||||||
|
$result
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Undocumented function
|
* Undocumented function
|
||||||
*
|
*
|
||||||
@@ -712,19 +950,21 @@ final class CoreLibsCombinedArrayHandlerTest extends TestCase
|
|||||||
*/
|
*/
|
||||||
public function testArrayMergeRecursiveWarningA(): void
|
public function testArrayMergeRecursiveWarningA(): void
|
||||||
{
|
{
|
||||||
set_error_handler(
|
// set_error_handler(
|
||||||
static function (int $errno, string $errstr): never {
|
// static function (int $errno, string $errstr): never {
|
||||||
throw new Exception($errstr, $errno);
|
// throw new Exception($errstr, $errno);
|
||||||
},
|
// },
|
||||||
E_USER_WARNING
|
// E_USER_WARNING
|
||||||
);
|
// );
|
||||||
|
|
||||||
$arrays = func_get_args();
|
$arrays = func_get_args();
|
||||||
// first is expected warning
|
// first is expected warning
|
||||||
|
$exception = array_shift($arrays);
|
||||||
$warning = array_shift($arrays);
|
$warning = array_shift($arrays);
|
||||||
|
|
||||||
// phpunit 10.0 compatible
|
// phpunit 10.0 compatible
|
||||||
$this->expectExceptionMessage(($warning));
|
$this->expectException($exception);
|
||||||
|
$this->expectExceptionMessage($warning);
|
||||||
|
|
||||||
\CoreLibs\Combined\ArrayHandler::arrayMergeRecursive(...$arrays);
|
\CoreLibs\Combined\ArrayHandler::arrayMergeRecursive(...$arrays);
|
||||||
|
|
||||||
@@ -309,45 +309,73 @@ final class CoreLibsCombinedDateTimeTest extends TestCase
|
|||||||
'2020-12-12',
|
'2020-12-12',
|
||||||
'2021-12-12',
|
'2021-12-12',
|
||||||
-1,
|
-1,
|
||||||
|
null,
|
||||||
|
null,
|
||||||
],
|
],
|
||||||
'dates equal' => [
|
'dates equal' => [
|
||||||
'2020-12-12',
|
'2020-12-12',
|
||||||
'2020-12-12',
|
'2020-12-12',
|
||||||
0,
|
0,
|
||||||
|
null,
|
||||||
|
null,
|
||||||
],
|
],
|
||||||
'second date smaller' => [
|
'second date smaller' => [
|
||||||
'2021-12-12',
|
'2021-12-12',
|
||||||
'2020-12-12',
|
'2020-12-12',
|
||||||
1
|
1,
|
||||||
|
null,
|
||||||
|
null,
|
||||||
],
|
],
|
||||||
'dates equal with different time' => [
|
'dates equal with different time' => [
|
||||||
'2020-12-12 12:12:12',
|
'2020-12-12 12:12:12',
|
||||||
'2020-12-12 13:13:13',
|
'2020-12-12 13:13:13',
|
||||||
0,
|
0,
|
||||||
|
null,
|
||||||
|
null,
|
||||||
],
|
],
|
||||||
'invalid dates --' => [
|
'invalid dates --' => [
|
||||||
'--',
|
'--',
|
||||||
'--',
|
'--',
|
||||||
false
|
false,
|
||||||
|
'UnexpectedValueException',
|
||||||
|
1,
|
||||||
],
|
],
|
||||||
'empty dates' => [
|
'empty dates' => [
|
||||||
'',
|
'',
|
||||||
'',
|
'',
|
||||||
false
|
false,
|
||||||
|
'UnexpectedValueException',
|
||||||
|
1
|
||||||
],
|
],
|
||||||
'invalid dates' => [
|
'invalid dates' => [
|
||||||
'not a date',
|
'not a date',
|
||||||
'not a date either',
|
'not a date either',
|
||||||
false,
|
false,
|
||||||
|
'UnexpectedValueException',
|
||||||
|
2
|
||||||
|
],
|
||||||
|
'invalid end date' => [
|
||||||
|
'1990-01-01',
|
||||||
|
'not a date either',
|
||||||
|
false,
|
||||||
|
'UnexpectedValueException',
|
||||||
|
3
|
||||||
],
|
],
|
||||||
'out of bound dates' => [
|
'out of bound dates' => [
|
||||||
'1900-1-1',
|
'1900-1-1',
|
||||||
'9999-12-31',
|
'9999-12-31',
|
||||||
-1
|
-1,
|
||||||
|
null,
|
||||||
|
null,
|
||||||
]
|
]
|
||||||
];
|
];
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Undocumented function
|
||||||
|
*
|
||||||
|
* @return array<mixed>
|
||||||
|
*/
|
||||||
public function dateTimeCompareProvider(): array
|
public function dateTimeCompareProvider(): array
|
||||||
{
|
{
|
||||||
return [
|
return [
|
||||||
@@ -355,51 +383,85 @@ final class CoreLibsCombinedDateTimeTest extends TestCase
|
|||||||
'2020-12-12',
|
'2020-12-12',
|
||||||
'2021-12-12',
|
'2021-12-12',
|
||||||
-1,
|
-1,
|
||||||
|
null,
|
||||||
|
null,
|
||||||
],
|
],
|
||||||
'dates equal no timestamp' => [
|
'dates equal no timestamp' => [
|
||||||
'2020-12-12',
|
'2020-12-12',
|
||||||
'2020-12-12',
|
'2020-12-12',
|
||||||
0,
|
0,
|
||||||
|
null,
|
||||||
|
null,
|
||||||
],
|
],
|
||||||
'second date smaller no timestamp' => [
|
'second date smaller no timestamp' => [
|
||||||
'2021-12-12',
|
'2021-12-12',
|
||||||
'2020-12-12',
|
'2020-12-12',
|
||||||
1
|
1,
|
||||||
|
null,
|
||||||
|
null,
|
||||||
],
|
],
|
||||||
'date equal first time smaller' => [
|
'date equal first time smaller' => [
|
||||||
'2020-12-12 12:12:12',
|
'2020-12-12 12:12:12',
|
||||||
'2020-12-12 13:13:13',
|
'2020-12-12 13:13:13',
|
||||||
-1,
|
-1,
|
||||||
|
null,
|
||||||
|
null,
|
||||||
],
|
],
|
||||||
'date equal time equal' => [
|
'date equal time equal' => [
|
||||||
'2020-12-12 12:12:12',
|
'2020-12-12 12:12:12',
|
||||||
'2020-12-12 12:12:12',
|
'2020-12-12 12:12:12',
|
||||||
0,
|
0,
|
||||||
|
null,
|
||||||
|
null,
|
||||||
],
|
],
|
||||||
'date equal second time smaller' => [
|
'date equal second time smaller' => [
|
||||||
'2020-12-12 13:13:13',
|
'2020-12-12 13:13:13',
|
||||||
'2020-12-12 12:12:12',
|
'2020-12-12 12:12:12',
|
||||||
1,
|
1,
|
||||||
|
null,
|
||||||
|
null,
|
||||||
],
|
],
|
||||||
'valid date invalid time' => [
|
'valid date invalid time' => [
|
||||||
'2020-12-12 13:99:13',
|
'2020-12-12 13:99:13',
|
||||||
'2020-12-12 12:12:99',
|
'2020-12-12 12:12:99',
|
||||||
false,
|
false,
|
||||||
|
'UnexpectedValueException',
|
||||||
|
2
|
||||||
|
],
|
||||||
|
'valid date invalid end time' => [
|
||||||
|
'2020-12-12 13:12:13',
|
||||||
|
'2020-12-12 12:12:99',
|
||||||
|
false,
|
||||||
|
'UnexpectedValueException',
|
||||||
|
3
|
||||||
],
|
],
|
||||||
'invalid datetimes --' => [
|
'invalid datetimes --' => [
|
||||||
'--',
|
'--',
|
||||||
'--',
|
'--',
|
||||||
false,
|
false,
|
||||||
|
'UnexpectedValueException',
|
||||||
|
1
|
||||||
],
|
],
|
||||||
'empty datetimess' => [
|
'empty datetimess' => [
|
||||||
'',
|
'',
|
||||||
'',
|
'',
|
||||||
false,
|
false,
|
||||||
|
'UnexpectedValueException',
|
||||||
|
1
|
||||||
],
|
],
|
||||||
'invalid datetimes' => [
|
'invalid date times' => [
|
||||||
'not a date',
|
'not a date',
|
||||||
'not a date either',
|
'not a date either',
|
||||||
false,
|
false,
|
||||||
|
'UnexpectedValueException',
|
||||||
|
2
|
||||||
|
],
|
||||||
|
'invalid end date time' => [
|
||||||
|
'1990-01-01 12:12:12',
|
||||||
|
'not a date either',
|
||||||
|
false,
|
||||||
|
'UnexpectedValueException',
|
||||||
|
3
|
||||||
],
|
],
|
||||||
];
|
];
|
||||||
}
|
}
|
||||||
@@ -458,6 +520,47 @@ final class CoreLibsCombinedDateTimeTest extends TestCase
|
|||||||
];
|
];
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Undocumented function
|
||||||
|
*
|
||||||
|
* @return array
|
||||||
|
*/
|
||||||
|
public function dateRangeHasWeekendProvider(): array
|
||||||
|
{
|
||||||
|
return [
|
||||||
|
'no weekend' => [
|
||||||
|
'2023-07-03',
|
||||||
|
'2023-07-04',
|
||||||
|
false
|
||||||
|
],
|
||||||
|
'start weekend sat' => [
|
||||||
|
'2023-07-01',
|
||||||
|
'2023-07-04',
|
||||||
|
true
|
||||||
|
],
|
||||||
|
'start weekend sun' => [
|
||||||
|
'2023-07-02',
|
||||||
|
'2023-07-04',
|
||||||
|
true
|
||||||
|
],
|
||||||
|
'end weekend sat' => [
|
||||||
|
'2023-07-03',
|
||||||
|
'2023-07-08',
|
||||||
|
true
|
||||||
|
],
|
||||||
|
'end weekend sun' => [
|
||||||
|
'2023-07-03',
|
||||||
|
'2023-07-09',
|
||||||
|
true
|
||||||
|
],
|
||||||
|
'long period > 6 days' => [
|
||||||
|
'2023-07-03',
|
||||||
|
'2023-07-27',
|
||||||
|
true
|
||||||
|
]
|
||||||
|
];
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* date string convert test
|
* date string convert test
|
||||||
*
|
*
|
||||||
@@ -573,10 +676,21 @@ final class CoreLibsCombinedDateTimeTest extends TestCase
|
|||||||
* @param string $input_a
|
* @param string $input_a
|
||||||
* @param string $input_b
|
* @param string $input_b
|
||||||
* @param int|bool $expected
|
* @param int|bool $expected
|
||||||
|
* @param string|null $exception
|
||||||
|
* @param int|null $exception_code
|
||||||
* @return void
|
* @return void
|
||||||
*/
|
*/
|
||||||
public function testCompareDate(string $input_a, string $input_b, $expected): void
|
public function testCompareDate(
|
||||||
{
|
string $input_a,
|
||||||
|
string $input_b,
|
||||||
|
int|bool $expected,
|
||||||
|
?string $exception,
|
||||||
|
?int $exception_code
|
||||||
|
): void {
|
||||||
|
if ($expected === false) {
|
||||||
|
$this->expectException($exception);
|
||||||
|
$this->expectExceptionCode($exception_code);
|
||||||
|
}
|
||||||
$this->assertEquals(
|
$this->assertEquals(
|
||||||
$expected,
|
$expected,
|
||||||
\CoreLibs\Combined\DateTime::compareDate($input_a, $input_b)
|
\CoreLibs\Combined\DateTime::compareDate($input_a, $input_b)
|
||||||
@@ -593,10 +707,21 @@ final class CoreLibsCombinedDateTimeTest extends TestCase
|
|||||||
* @param string $input_a
|
* @param string $input_a
|
||||||
* @param string $input_b
|
* @param string $input_b
|
||||||
* @param int|bool $expected
|
* @param int|bool $expected
|
||||||
|
* @param string|null $exception
|
||||||
|
* @param int|null $exception_code
|
||||||
* @return void
|
* @return void
|
||||||
*/
|
*/
|
||||||
public function testCompareDateTime(string $input_a, string $input_b, $expected): void
|
public function testCompareDateTime(
|
||||||
{
|
string $input_a,
|
||||||
|
string $input_b,
|
||||||
|
int|bool $expected,
|
||||||
|
?string $exception,
|
||||||
|
?int $exception_code
|
||||||
|
): void {
|
||||||
|
if ($expected === false) {
|
||||||
|
$this->expectException($exception);
|
||||||
|
$this->expectExceptionCode($exception_code);
|
||||||
|
}
|
||||||
$this->assertEquals(
|
$this->assertEquals(
|
||||||
$expected,
|
$expected,
|
||||||
\CoreLibs\Combined\DateTime::compareDateTime($input_a, $input_b)
|
\CoreLibs\Combined\DateTime::compareDateTime($input_a, $input_b)
|
||||||
@@ -780,6 +905,29 @@ final class CoreLibsCombinedDateTimeTest extends TestCase
|
|||||||
$output
|
$output
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Undocumented function
|
||||||
|
*
|
||||||
|
* @covers ::dateRangeHasWeekend
|
||||||
|
* @dataProvider dateRangeHasWeekendProvider
|
||||||
|
* @testdox dateRangeHasWeekend $start_date and $end_date are expected weekend $expected [$_dataName]
|
||||||
|
*
|
||||||
|
* @param string $start_date
|
||||||
|
* @param string $end_date
|
||||||
|
* @param bool $expected
|
||||||
|
* @return void
|
||||||
|
*/
|
||||||
|
public function testDateRangeHasWeekend(
|
||||||
|
string $start_date,
|
||||||
|
string $end_date,
|
||||||
|
bool $expected
|
||||||
|
): void {
|
||||||
|
$this->assertEquals(
|
||||||
|
$expected,
|
||||||
|
\CoreLibs\Combined\DateTime::dateRangeHasWeekend($start_date, $end_date)
|
||||||
|
);
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// __END__
|
// __END__
|
||||||
@@ -59,6 +59,27 @@ final class CoreLibsConvertColorsTest extends TestCase
|
|||||||
3 => false,
|
3 => false,
|
||||||
4 => false
|
4 => false
|
||||||
],
|
],
|
||||||
|
'invalid color red ' => [
|
||||||
|
0 => -12,
|
||||||
|
1 => 12,
|
||||||
|
2 => 12,
|
||||||
|
3 => false,
|
||||||
|
4 => false
|
||||||
|
],
|
||||||
|
'invalid color green ' => [
|
||||||
|
0 => 12,
|
||||||
|
1 => -12,
|
||||||
|
2 => 12,
|
||||||
|
3 => false,
|
||||||
|
4 => false
|
||||||
|
],
|
||||||
|
'invalid color blue ' => [
|
||||||
|
0 => 12,
|
||||||
|
1 => 12,
|
||||||
|
2 => -12,
|
||||||
|
3 => false,
|
||||||
|
4 => false
|
||||||
|
],
|
||||||
];
|
];
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -150,10 +171,40 @@ final class CoreLibsConvertColorsTest extends TestCase
|
|||||||
'valid' => true,
|
'valid' => true,
|
||||||
],
|
],
|
||||||
// invalid values
|
// invalid values
|
||||||
'invalid color' => [
|
'invalid color r/h/h low' => [
|
||||||
'rgb' => [-12, 300, 12],
|
'rgb' => [-1, 12, 12],
|
||||||
'hsb' => [-12, 300, 12],
|
'hsb' => [-1, 50, 50],
|
||||||
'hsl' => [-12, 300, 12],
|
'hsl' => [-1, 50, 50],
|
||||||
|
'valid' => false,
|
||||||
|
],
|
||||||
|
'invalid color r/h/h high' => [
|
||||||
|
'rgb' => [256, 12, 12],
|
||||||
|
'hsb' => [361, 50, 50],
|
||||||
|
'hsl' => [361, 50, 50],
|
||||||
|
'valid' => false,
|
||||||
|
],
|
||||||
|
'invalid color g/s/s low' => [
|
||||||
|
'rgb' => [12, -1, 12],
|
||||||
|
'hsb' => [1, -1, 50],
|
||||||
|
'hsl' => [1, -1, 50],
|
||||||
|
'valid' => false,
|
||||||
|
],
|
||||||
|
'invalid color g/s/s high' => [
|
||||||
|
'rgb' => [12, 256, 12],
|
||||||
|
'hsb' => [1, 101, 50],
|
||||||
|
'hsl' => [1, 101, 50],
|
||||||
|
'valid' => false,
|
||||||
|
],
|
||||||
|
'invalid color b/b/l low' => [
|
||||||
|
'rgb' => [12, 12, -1],
|
||||||
|
'hsb' => [1, 50, -1],
|
||||||
|
'hsl' => [1, 50, -1],
|
||||||
|
'valid' => false,
|
||||||
|
],
|
||||||
|
'invalid color b/b/l high' => [
|
||||||
|
'rgb' => [12, 12, 256],
|
||||||
|
'hsb' => [1, 50, 101],
|
||||||
|
'hsl' => [1, 50, 101],
|
||||||
'valid' => false,
|
'valid' => false,
|
||||||
],
|
],
|
||||||
];
|
];
|
||||||
@@ -246,11 +297,22 @@ final class CoreLibsConvertColorsTest extends TestCase
|
|||||||
* @param int $input_r
|
* @param int $input_r
|
||||||
* @param int $input_g
|
* @param int $input_g
|
||||||
* @param int $input_b
|
* @param int $input_b
|
||||||
|
* @param string|bool $expected_hash
|
||||||
* @param string|bool $expected
|
* @param string|bool $expected
|
||||||
* @return void
|
* @return void
|
||||||
*/
|
*/
|
||||||
public function testRgb2hex(int $input_r, int $input_g, int $input_b, $expected_hash, $expected)
|
public function testRgb2hex(
|
||||||
{
|
int $input_r,
|
||||||
|
int $input_g,
|
||||||
|
int $input_b,
|
||||||
|
string|bool $expected_hash,
|
||||||
|
string|bool $expected
|
||||||
|
) {
|
||||||
|
// if expected hash is or expected is false, we need to check for
|
||||||
|
// LengthException
|
||||||
|
if ($expected_hash === false || $expected === false) {
|
||||||
|
$this->expectException(\LengthException::class);
|
||||||
|
}
|
||||||
// with #
|
// with #
|
||||||
$this->assertEquals(
|
$this->assertEquals(
|
||||||
$expected_hash,
|
$expected_hash,
|
||||||
@@ -292,11 +354,19 @@ final class CoreLibsConvertColorsTest extends TestCase
|
|||||||
*/
|
*/
|
||||||
public function testHex2rgb(
|
public function testHex2rgb(
|
||||||
string $input,
|
string $input,
|
||||||
$expected,
|
array|bool $expected,
|
||||||
$expected_str,
|
string|bool $expected_str,
|
||||||
string $separator,
|
string $separator,
|
||||||
$expected_str_sep
|
string|bool $expected_str_sep
|
||||||
): void {
|
): void {
|
||||||
|
if ($expected === false || $expected_str === false || $expected_str_sep === false) {
|
||||||
|
$hex_string = preg_replace("/[^0-9A-Fa-f]/", '', $input);
|
||||||
|
if (!is_string($hex_string)) {
|
||||||
|
$this->expectException(\InvalidArgumentException::class);
|
||||||
|
} else {
|
||||||
|
$this->expectException(\UnexpectedValueException::class);
|
||||||
|
}
|
||||||
|
}
|
||||||
$this->assertEquals(
|
$this->assertEquals(
|
||||||
$expected,
|
$expected,
|
||||||
\CoreLibs\Convert\Colors::hex2rgb($input)
|
\CoreLibs\Convert\Colors::hex2rgb($input)
|
||||||
@@ -324,8 +394,11 @@ final class CoreLibsConvertColorsTest extends TestCase
|
|||||||
* @param array|bool $expected
|
* @param array|bool $expected
|
||||||
* @return void
|
* @return void
|
||||||
*/
|
*/
|
||||||
public function testRgb2hsb(int $input_r, int $input_g, int $input_b, $expected): void
|
public function testRgb2hsb(int $input_r, int $input_g, int $input_b, array|bool $expected): void
|
||||||
{
|
{
|
||||||
|
if ($expected === false) {
|
||||||
|
$this->expectException(\LengthException::class);
|
||||||
|
}
|
||||||
$this->assertEquals(
|
$this->assertEquals(
|
||||||
$expected,
|
$expected,
|
||||||
\CoreLibs\Convert\Colors::rgb2hsb($input_r, $input_g, $input_b)
|
\CoreLibs\Convert\Colors::rgb2hsb($input_r, $input_g, $input_b)
|
||||||
@@ -345,8 +418,12 @@ final class CoreLibsConvertColorsTest extends TestCase
|
|||||||
* @param array|bool $expected
|
* @param array|bool $expected
|
||||||
* @return void
|
* @return void
|
||||||
*/
|
*/
|
||||||
public function testHsb2rgb(float $input_h, float $input_s, float $input_b, $expected): void
|
public function testHsb2rgb(float $input_h, float $input_s, float $input_b, array|bool $expected): void
|
||||||
{
|
{
|
||||||
|
if ($expected === false) {
|
||||||
|
$this->expectException(\LengthException::class);
|
||||||
|
$expected = [];
|
||||||
|
}
|
||||||
$this->assertEquals(
|
$this->assertEquals(
|
||||||
$expected,
|
$expected,
|
||||||
\CoreLibs\Convert\Colors::hsb2rgb($input_h, $input_s, $input_b)
|
\CoreLibs\Convert\Colors::hsb2rgb($input_h, $input_s, $input_b)
|
||||||
@@ -366,8 +443,11 @@ final class CoreLibsConvertColorsTest extends TestCase
|
|||||||
* @param array|bool $expected
|
* @param array|bool $expected
|
||||||
* @return void
|
* @return void
|
||||||
*/
|
*/
|
||||||
public function testRgb2hsl(int $input_r, int $input_g, int $input_b, $expected): void
|
public function testRgb2hsl(int $input_r, int $input_g, int $input_b, array|bool $expected): void
|
||||||
{
|
{
|
||||||
|
if ($expected === false) {
|
||||||
|
$this->expectException(\LengthException::class);
|
||||||
|
}
|
||||||
$this->assertEquals(
|
$this->assertEquals(
|
||||||
$expected,
|
$expected,
|
||||||
\CoreLibs\Convert\Colors::rgb2hsl($input_r, $input_g, $input_b)
|
\CoreLibs\Convert\Colors::rgb2hsl($input_r, $input_g, $input_b)
|
||||||
@@ -387,8 +467,11 @@ final class CoreLibsConvertColorsTest extends TestCase
|
|||||||
* @param array|bool $expected
|
* @param array|bool $expected
|
||||||
* @return void
|
* @return void
|
||||||
*/
|
*/
|
||||||
public function testHsl2rgb($input_h, float $input_s, float $input_l, $expected): void
|
public function testHsl2rgb(int|float $input_h, float $input_s, float $input_l, array|bool $expected): void
|
||||||
{
|
{
|
||||||
|
if ($expected === false) {
|
||||||
|
$this->expectException(\LengthException::class);
|
||||||
|
}
|
||||||
$this->assertEquals(
|
$this->assertEquals(
|
||||||
$expected,
|
$expected,
|
||||||
\CoreLibs\Convert\Colors::hsl2rgb($input_h, $input_s, $input_l)
|
\CoreLibs\Convert\Colors::hsl2rgb($input_h, $input_s, $input_l)
|
||||||
@@ -406,11 +489,11 @@ final class CoreLibsConvertColorsTest extends TestCase
|
|||||||
*/
|
*/
|
||||||
public function testHslHsb360hue(): void
|
public function testHslHsb360hue(): void
|
||||||
{
|
{
|
||||||
$this->assertNotFalse(
|
$this->assertIsArray(
|
||||||
\CoreLibs\Convert\Colors::hsl2rgb(360.0, 90.5, 41.2),
|
\CoreLibs\Convert\Colors::hsl2rgb(360.0, 90.5, 41.2),
|
||||||
'HSL to RGB with 360 hue'
|
'HSL to RGB with 360 hue'
|
||||||
);
|
);
|
||||||
$this->assertNotFalse(
|
$this->assertIsArray(
|
||||||
\CoreLibs\Convert\Colors::hsb2rgb(360, 95, 78.0),
|
\CoreLibs\Convert\Colors::hsb2rgb(360, 95, 78.0),
|
||||||
'HSB to RGB with 360 hue'
|
'HSB to RGB with 360 hue'
|
||||||
);
|
);
|
||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user