1: 2: 3: 4: 5: 6: 7: 8: 9: 10: 11: 12: 13: 14: 15: 16: 17: 18: 19: 20: 21: 22: 23: 24: 25: 26: 27: 28: 29: 30: 31: 32: 33: 34: 35: 36: 37: 38: 39: 40: 41: 42: 43: 44: 45: 46: 47: 48: 49: 50: 51: 52: 53: 54: 55: 56: 57: 58: 59: 60: 61: 62: 63: 64: 65: 66: 67: 68: 69: 70: 71: 72: 73: 74: 75: 76: 77: 78: 79: 80: 81: 82: 83: 84: 85: 86: 87: 88: 89: 90: 91: 92: 93: 94: 95: 96: 97: 98: 99: 100: 101: 102: 103: 104: 105: 106: 107: 108: 109: 110: 111: 112: 113: 114: 115: 116: 117: 118: 119: 120: 121: 122: 123: 124: 125: 126: 127: 128: 129: 130: 131: 132: 133: 134: 135: 136: 137: 138: 139: 140: 141: 142: 143: 144: 145: 146: 147: 148: 149: 150: 151: 152: 153: 154: 155: 156: 157: 158: 159: 160: 161: 162: 163: 164: 165: 166: 167: 168: 169: 170: 171: 172: 173: 174: 175: 176: 177: 178: 179: 180: 181: 182: 183: 184: 185: 186: 187: 188: 189: 190: 191: 192: 193: 194: 195: 196: 197: 198: 199: 200: 201: 202: 203: 204: 205: 206: 207: 208: 209: 210: 211: 212: 213: 214: 215: 216: 217: 218: 219: 220: 221: 222: 223: 224: 225: 226: 227: 228: 229: 230: 231: 232: 233: 234: 235: 236: 237: 238: 239: 240: 241: 242: 243: 244: 245: 246: 247: 248: 249: 250: 251: 252: 253: 254: 255: 256: 257: 258: 259: 260: 261: 262: 263: 264: 265: 266: 267: 268: 269: 270: 271: 272: 273: 274: 275: 276: 277: 278: 279: 280: 281: 282: 283: 284: 285: 286: 287: 288: 289: 290: 291: 292: 293: 294: 295: 296: 297: 298: 299: 300: 301: 302: 303: 304: 305: 306: 307: 308: 309: 310: 311: 312: 313: 314: 315: 316: 317: 318: 319: 320: 321: 322: 323: 324: 325: 326: 327: 328: 329: 330: 331: 332: 333: 334: 335: 336: <?php
/**
* MvcCore
*
* This source file is subject to the BSD 3 License
* For the full copyright and license information, please view
* the LICENSE.md file that are distributed with this source code.
*
* @copyright Copyright (c) 2016 Tom Flidr (https://github.com/mvccore)
* @license https://mvccore.github.io/docs/mvccore/5.0.0/LICENCE.md
*/
namespace MvcCore;
/**
* Responsibility - static helpers for core classes.
* - Static functions for string case conversions.
* - Static functions to safely encode/decode JSON.
* - Static functions to get client/server IPs.
* - Static functions to get system temp directory.
* - Static functions to safely invoke dangerous calls.
* - Static functions to write into file by one process only.
* - Static functions to check core classes inheritance.
* - Static functions to cache and read attributes (or PhpDocs tags).
*/
interface ITool {
/**
* Convert all strings `"from" => "to"`:
* - `"MyCustomValue" => "my-custom-value"`
* - `"MyWTFValue" => "my-w-t-f-value"`
* - `"MyWtfValue" => "my-wtf-value"`
* - `"MyCustom/Value/InsideFolder" => "my-custom/value/inside-folder"`
* @param string $pascalCase
* @return string
*/
public static function GetDashedFromPascalCase ($pascalCase = '');
/**
* Convert all string `"from" => "to"`:
* - `"my-custom-value" => "MyCustomValue"`
* - `"my-wtf-value" => "MyWtfValue"`
* - `"my-w-t-f-value" => "MyWTFValue"`
* - `"my-custom/value/inside-folder" => "MyCustom/Value/InsideFolder"`
* @param string $dashed
* @return string
*/
public static function GetPascalCaseFromDashed ($dashed = '');
/**
* Convert all string `"from" => "to"`:
* - `"MyCutomValue" => "my_custom_value"`
* - `"MyWTFValue" => "my_w_t_f_value"`
* - `"MyWtfValue" => "my_wtf_value"`
* - `"MyCutom/Value/InsideFolder" => "my_custom/value/inside_folder"`
* @param string $pascalCase
* @return string
*/
public static function GetUnderscoredFromPascalCase ($pascalCase = '');
/**
* Convert all string `"from" => "to"`:
* - `"my_custom_value" => "MyCutomValue"`
* - `"my_wtf_value" => "MyWtfValue"`
* - `"my_w_t_f_value" => "MyWTFValue"`
* - `"my_custom/value/inside_folder" => "MyCutom/Value/InsideFolder"`
* @param string $underscored
* @return string
*/
public static function GetPascalCaseFromUnderscored ($underscored = '');
/**
* Safely encode json string from php value.
* JSON encoding flags used by default:
* - `JSON_HEX_TAG`:
* All < and > are converted to \u003C and \u003E. Available as of PHP 5.3.0.
* - `JSON_HEX_AMP`:
* All & are converted to \u0026. Available as of PHP 5.3.0.
* - `JSON_HEX_APOS`:
* All ' are converted to \u0027. Available as of PHP 5.3.0.
* - `JSON_HEX_QUOT`:
* All " are converted to \u0022. Available as of PHP 5.3.0.
* - `JSON_UNESCAPED_SLASHES`:
* Don't escape /. Available as of PHP 5.4.0.
* - `JSON_PRESERVE_ZERO_FRACTION`:
* Ensures that float values are always encoded as a float value. Available as of PHP 5.6.6.
* Possible JSON encoding flags to add:
* - `JSON_PRETTY_PRINT`:
* Encode JSON into pretty print syntax, Available as of PHP 5.4.0.
* - `JSON_NUMERIC_CHECK`:
* Encodes numeric strings as numbers (be carefull for phone numbers). Available as of PHP 5.3.3.
* - `JSON_UNESCAPED_UNICODE`:
* Encode multibyte Unicode characters literally (default is to escape as \uXXXX). Available as of PHP 5.4.0.
* - `JSON_UNESCAPED_LINE_TERMINATORS`:
* The line terminators are kept unescaped when JSON_UNESCAPED_UNICODE
* is supplied. It uses the same behaviour as it was before PHP 7.1
* without this constant. Available as of PHP 7.1.0. The following
* constants can be combined to form options for json_decode()
* and json_encode().
* - `JSON_INVALID_UTF8_IGNORE`:
* Ignore invalid UTF-8 characters. Available as of PHP 7.2.0.
* - `JSON_INVALID_UTF8_SUBSTITUTE`:
* Convert invalid UTF-8 characters to \0xfffd (Unicode Character
* 'REPLACEMENT CHARACTER') Available as of PHP 7.2.0.
* - `JSON_THROW_ON_ERROR`:
* Throws JsonException if an error occurs instead of setting the global
* error state that is retrieved with json_last_error() and
* json_last_error_msg(). JSON_PARTIAL_OUTPUT_ON_ERROR takes precedence
* over JSON_THROW_ON_ERROR. Available as of PHP 7.3.0.
* @param mixed $data
* @param int $flags
* @param int $depth Set the maximum depth. Must be greater than zero, default: 512.
* @throws \RuntimeException|\JsonException JSON encoding error.
* @return string
*/
public static function EncodeJson ($data, $flags = 0, $depth = 512);
/**
* Safely decode json string into php `stdClass/array`.
* - `JSON_BIGINT_AS_STRING`:
* Decodes large integers as their original string value. Available as of PHP 5.4.0.
* - `JSON_OBJECT_AS_ARRAY`:
* Decodes JSON objects as PHP array. This option can be added automatically by calling json_decode() with
* the second parameter equal to TRUE. Available as of PHP 5.4.0.
* - `JSON_INVALID_UTF8_IGNORE`:
* Ignore invalid UTF-8 characters. Available as of PHP 7.2.0.
* - `JSON_INVALID_UTF8_SUBSTITUTE`:
* Convert invalid UTF-8 characters to \0xfffd (Unicode Character
* 'REPLACEMENT CHARACTER') Available as of PHP 7.2.0.
* - `JSON_THROW_ON_ERROR`:
* Throws JsonException if an error occurs instead of setting the global
* error state that is retrieved with json_last_error() and
* json_last_error_msg(). JSON_PARTIAL_OUTPUT_ON_ERROR takes precedence
* over JSON_THROW_ON_ERROR. Available as of PHP 7.3.0.
* @param string $jsonStr
* @param int $flags
* @param int $depth User specified recursion depth, default: 512.
* @throws \RuntimeException|\JsonException JSON decoding error.
* @return object
*/
public static function DecodeJson ($jsonStr, $flags = 0, $depth = 512);
/**
* Recognize if given string is JSON or not without JSON parsing.
* @see https://www.ietf.org/rfc/rfc4627.txt
* @param string $jsonStr
* @return bool
*/
public static function IsJsonString ($jsonStr);
/**
* Returns the OS-specific directory for temporary files.
* @return string
*/
public static function GetSystemTmpDir ();
/**
* Recognize if given string is query string without parsing.
* It recognizes query strings like:
* - `key1=value1`
* - `key1=value1&`
* - `key1=value1&key2=value2`
* - `key1=value1&key2=value2&`
* - `key1=&key2=value2`
* - `key1=value&key2=`
* - `key1=value&key2=&key3=`
* ...
* @param string $jsonStr
* @return bool
*/
public static function IsQueryString ($queryStr);
/**
* Safely invoke internal PHP function with it's own error handler.
* Error handler accepts arguments:
* - `string $errMessage` - Error message.
* - `int $errLevel` - Level of the error raised.
* - `string $errFile` - Optional, full path to error file name where error was raised.
* - `int $errLine` - Optional, The error file line number.
* - `array $errContext` - Optional, array that points to the active symbol table at the
* point the error occurred. In other words, `$errContext` will contain
* an array of every variable that existed in the scope the error
* was triggered in. User error handler must not modify error context.
* Warning: This parameter has been DEPRECATED as of PHP 7.2.0.
* Relying on it is highly discouraged.
* If the custom error handler returns `FALSE`, normal internal error handler continues.
* This function is very PHP specific. It's proudly used from Nette Framework, optimized for PHP 5.4+ incl.:
* https://github.com/nette/utils/blob/b623b2deec8729c8285d269ad991a97504f76bd4/src/Utils/Callback.php#L63-L84
* @param string|callable $internalFnOrHandler
* @param array $args
* @param callable $onError
* @return mixed
*/
public static function Invoke ($internalFnOrHandler, array $args, callable $onError);
/**
* Write or append file content by only one single PHP process.
* @see http://php.net/manual/en/function.flock.php
* @see http://php.net/manual/en/function.set-error-handler.php
* @see http://php.net/manual/en/function.clearstatcache.php
* @param string $fullPath File full path.
* @param string $content String content to write.
* @param string $writeMode PHP `fopen()` second argument flag, could be `w`, `w+`, `a`, `a+` etc...
* @param int $lockWaitMilliseconds Milliseconds to wait before next lock file existence is checked in `while()` cycle.
* @param int $maxLockWaitMilliseconds Maximum milliseconds time to wait before thrown an exception about not possible write.
* @param int $oldLockMillisecondsTolerance Maximum milliseconds time to consider lock file as operative or as old after some died process.
* @throws \Exception
* @return bool
*/
public static function AtomicWrite (
$fullPath,
$content,
$writeMode = 'w',
$lockWaitMilliseconds = 100,
$maxLockWaitMilliseconds = 5000,
$oldLockMillisecondsTolerance = 30000
);
/**
* PHP `realpath()` function without checking file/directory existence.
* @see https://www.php.net/manual/en/function.realpath.php
* @param string $path
* @return string
*/
public static function RealPathVirtual ($path);
/**
* Set prefered PHP classes and properties anontation preference.
* PHP8+ attributes anotation is default. Set value to `FALSE`
* to prefer PhpDocs tags anotation instead.
* @param bool $attributesAnotation
* @return bool
*/
public static function SetAttributesAnotations ($attributesAnotation = TRUE);
/**
* Get prefered PHP classes and properties anontation preference.
* PHP8+ attributes anotation is default. `FALSE` value means
* to prefer PhpDocs tags anotation instead.
* @return bool
*/
public static function GetAttributesAnotations ();
/**
* Check if given class implements given interface, else throw an exception.
* @param string $testClassName Full test class name.
* @param string $interfaceName Full interface class name.
* @param bool $checkStaticMethods Check implementation of all static methods by interface static methods.
* @param bool $throwException If `TRUE`, throw an exception if something is not implemented or if `FALSE` return `FALSE` only.
* @throws \InvalidArgumentException
* @return boolean
*/
public static function CheckClassInterface ($testClassName, $interfaceName, $checkStaticMethods = FALSE, $throwException = TRUE);
/**
* Check if given class implements given trait, else throw an exception.
* @param string $testClassName Full test class name.
* @param string $traitName Full trait class name.
* @param bool $throwException If `TRUE`, throw an exception if trait is not implemented or if `FALSE` return `FALSE` only.
* @throws \InvalidArgumentException
* @return boolean
*/
public static function CheckClassTrait ($testClassName, $traitName, $throwException = TRUE);
/**
* Get (cached) class attribute(s) constructor arguments or
* get class PhpDocs tags and it's arguments for older PHP versions.
* You can optionally set prefered way to get desired meta data.
* @param string|object $classFullNameOrInstance Class instance or full class name.
* @param \string[] $attrsClassesOrDocsTags Array with attribute(s) full class names
* or array with PhpDocs tag(s) name(s).
* @param bool|NULL $preferAttributes Prefered way to get meta data. `TRUE` means try
* to get PHP8+ attribute(s) only, `FALSE` means
* try to get PhpDocs tag(s) only and `NULL` (default)
* means try to get PHP8+ attribute(s) first and if
* there is nothing, try to get PhpDocs tag(s).
* @return array Keys are attributes full class names (or PhpDocs tags names) and values
* are attributes constructor arguments (or PhpDocs tags arguments).
*/
public static function GetClassAttrsArgs ($classFullNameOrInstance, $attrsClassesOrDocsTags, $preferAttributes = NULL);
/**
* Get (cached) class method attribute(s) constructor arguments or
* get class method PhpDocs tags and it's arguments for older PHP versions.
* You can optionally set prefered way to get desired meta data.
* @param string|object $classFullNameOrInstance Class instance or full class name.
* @param string $methodName Class method name.
* @param \string[] $attrsClassesOrDocsTags Array with attribute(s) full class names
* or array with PhpDocs tag(s) name(s).
* @param bool|NULL $preferAttributes Prefered way to get meta data. `TRUE` means try
* to get PHP8+ attribute(s) only, `FALSE` means
* try to get PhpDocs tag(s) only and `NULL` (default)
* means try to get PHP8+ attribute(s) first and if
* there is nothing, try to get PhpDocs tag(s).
* @return array Keys are attributes full class names (or PhpDocs tags names) and values
* are attributes constructor arguments (or PhpDocs tags arguments).
*/
public static function GetMethodAttrsArgs ($classFullNameOrInstance, $methodName, $attrsClassesOrDocsTags, $preferAttributes = NULL);
/**
* Get (cached) class property attribute(s) constructor arguments or
* get class property PhpDocs tags and it's arguments for older PHP versions.
* You can optionally set prefered way to get desired meta data.
* @param string|object $classFullNameOrInstance Class instance or full class name.
* @param string $propertyName Class property name.
* @param \string[] $attrsClassesOrDocsTags Array with attribute(s) full class names
* or array with PhpDocs tag(s) name(s).
* @param bool|NULL $preferAttributes Prefered way to get meta data. `TRUE` means try
* to get PHP8+ attribute(s) only, `FALSE` means
* try to get PhpDocs tag(s) only and `NULL` (default)
* means try to get PHP8+ attribute(s) first and if
* there is nothing, try to get PhpDocs tag(s).
* @return array Keys are attributes full class names (or PhpDocs tags names) and values
* are attributes constructor arguments (or PhpDocs tags arguments).
*/
public static function GetPropertyAttrsArgs ($classFullNameOrInstance, $propertyName, $attrsClassesOrDocsTags, $preferAttributes = NULL);
/**
* Return reflection object attribute constructor arguments.
* @param \ReflectionClass|\ReflectionMethod|\ReflectionProperty $reflectionObject
* @param string $attributeClassFullName
* @return array|NULL
*/
public static function GetAttrCtorArgs ($reflectionObject, $attributeClassFullName);
/**
* Return PhpDocs tag arguments, arguments has to be defined without space, separated by comma.
* @param \ReflectionClass|\ReflectionMethod|\ReflectionProperty $reflectionObject
* @param string $phpDocsTagName
* @return array|NULL
*/
public static function GetPhpDocsTagArgs ($reflectionObject, $phpDocsTagName);
}