<?php
// Own namespace
-namespace CoreFramework\Object;
+namespace Org\Mxchange\CoreFramework\Object;
// Import framework stuff
-use CoreFramework\Bootstrap\FrameworkBootstrap;
-use CoreFramework\Compressor\Compressor;
-use CoreFramework\Configuration\FrameworkConfiguration;
-use CoreFramework\Connection\Database\DatabaseConnection;
-use CoreFramework\Controller\Controller;
-use CoreFramework\Criteria\Criteria;
-use CoreFramework\Criteria\Local\LocalSearchCriteria;
-use CoreFramework\Criteria\Local\LocalUpdateCriteria;
-use CoreFramework\Crypto\Cryptable;
-use CoreFramework\Crypto\RandomNumber\RandomNumberGenerator;
-use CoreFramework\Database\Frontend\DatabaseWrapper;
-use CoreFramework\EntryPoint\ApplicationEntryPoint;
-use CoreFramework\Factory\Database\Wrapper\DatabaseWrapperFactory;
-use CoreFramework\Factory\ObjectFactory;
-use CoreFramework\Filesystem\Block;
-use CoreFramework\Filesystem\FilePointer;
-use CoreFramework\Filesystem\FrameworkDirectory;
-use CoreFramework\Filesystem\PathWriteProtectedException;
-use CoreFramework\Generic\FrameworkInterface;
-use CoreFramework\Generic\NullPointerException;
-use CoreFramework\Generic\UnsupportedOperationException;
-use CoreFramework\Handler\Handleable;
-use CoreFramework\Handler\Stream\IoHandler;
-use CoreFramework\Helper\Helper;
-use CoreFramework\Index\Indexable;
-use CoreFramework\Lists\Listable;
-use CoreFramework\Loader\ClassLoader;
-use CoreFramework\Manager\ManageableApplication;
-use CoreFramework\Middleware\Compressor\CompressorChannel;
-use CoreFramework\Middleware\Debug\DebugMiddleware;
-use CoreFramework\Parser\Parseable;
-use CoreFramework\Registry\Register;
-use CoreFramework\Registry\Registry;
-use CoreFramework\Resolver\Resolver;
-use CoreFramework\Result\Database\CachedDatabaseResult;
-use CoreFramework\Result\Search\SearchableResult;
-use CoreFramework\Stacker\Stackable;
-use CoreFramework\State\Stateable;
-use CoreFramework\Stream\Input\InputStream;
-use CoreFramework\Stream\Output\OutputStreamer;
-use CoreFramework\Stream\Output\OutputStream;
-use CoreFramework\Template\CompileableTemplate;
-use CoreFramework\User\ManageableAccount;
-use CoreFramework\Visitor\Visitor;
+use Org\Mxchange\CoreFramework\Bootstrap\FrameworkBootstrap;
+use Org\Mxchange\CoreFramework\Compressor\Compressor;
+use Org\Mxchange\CoreFramework\Configuration\FrameworkConfiguration;
+use Org\Mxchange\CoreFramework\Connection\Database\DatabaseConnection;
+use Org\Mxchange\CoreFramework\Controller\Controller;
+use Org\Mxchange\CoreFramework\Criteria\Criteria;
+use Org\Mxchange\CoreFramework\Criteria\Local\LocalSearchCriteria;
+use Org\Mxchange\CoreFramework\Criteria\Local\LocalUpdateCriteria;
+use Org\Mxchange\CoreFramework\Crypto\Cryptable;
+use Org\Mxchange\CoreFramework\Crypto\RandomNumber\RandomNumberGenerator;
+use Org\Mxchange\CoreFramework\Database\Frontend\DatabaseWrapper;
+use Org\Mxchange\CoreFramework\EntryPoint\ApplicationEntryPoint;
+use Org\Mxchange\CoreFramework\Factory\Database\Wrapper\DatabaseWrapperFactory;
+use Org\Mxchange\CoreFramework\Factory\ObjectFactory;
+use Org\Mxchange\CoreFramework\Filesystem\Block;
+use Org\Mxchange\CoreFramework\Filesystem\FilePointer;
+use Org\Mxchange\CoreFramework\Filesystem\FrameworkDirectory;
+use Org\Mxchange\CoreFramework\Filesystem\PathWriteProtectedException;
+use Org\Mxchange\CoreFramework\Generic\FrameworkInterface;
+use Org\Mxchange\CoreFramework\Generic\NullPointerException;
+use Org\Mxchange\CoreFramework\Generic\UnsupportedOperationException;
+use Org\Mxchange\CoreFramework\Handler\Handleable;
+use Org\Mxchange\CoreFramework\Handler\Stream\IoHandler;
+use Org\Mxchange\CoreFramework\Helper\Helper;
+use Org\Mxchange\CoreFramework\Index\Indexable;
+use Org\Mxchange\CoreFramework\Lists\Listable;
+use Org\Mxchange\CoreFramework\Loader\ClassLoader;
+use Org\Mxchange\CoreFramework\Localization\ManageableLanguage;
+use Org\Mxchange\CoreFramework\Manager\ManageableApplication;
+use Org\Mxchange\CoreFramework\Menu\RenderableMenu;
+use Org\Mxchange\CoreFramework\Middleware\Compressor\CompressorChannel;
+use Org\Mxchange\CoreFramework\Middleware\Debug\DebugMiddleware;
+use Org\Mxchange\CoreFramework\Parser\Parseable;
+use Org\Mxchange\CoreFramework\Registry\GenericRegistry;
+use Org\Mxchange\CoreFramework\Registry\Register;
+use Org\Mxchange\CoreFramework\Resolver\Resolver;
+use Org\Mxchange\CoreFramework\Result\Database\CachedDatabaseResult;
+use Org\Mxchange\CoreFramework\Result\Search\SearchableResult;
+use Org\Mxchange\CoreFramework\Stacker\Stackable;
+use Org\Mxchange\CoreFramework\State\Stateable;
+use Org\Mxchange\CoreFramework\Stream\Input\InputStream;
+use Org\Mxchange\CoreFramework\Stream\Output\OutputStreamer;
+use Org\Mxchange\CoreFramework\Stream\Output\OutputStream;
+use Org\Mxchange\CoreFramework\String\Utils\StringUtils;
+use Org\Mxchange\CoreFramework\Template\CompileableTemplate;
+use Org\Mxchange\CoreFramework\User\ManageableAccount;
+use Org\Mxchange\CoreFramework\Visitor\Visitor;
// Import SPL stuff
use \stdClass;
+use \InvalidArgumentException;
use \Iterator;
use \ReflectionClass;
+use \SplFileInfo;
/**
* The simulator system class is the super class of all other classes. This
*
* @author Roland Haeder <webmaster@shipsimu.org>
* @version 0.0.0
- * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
+ * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2019 Core Developer Team
* @license GNU GPL 3.0 or any newer version
* @link http://www.shipsimu.org
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
-class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
+abstract class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
/**
* Length of output from hash()
*/
private static $hashLength = NULL;
+ /**
+ * Self-referencing instance
+ */
+ private static $instance = NULL;
+
/**
* The real class name
*/
*/
private $helperInstance = NULL;
- /**
- * An instance of a Source class
- */
- private $sourceInstance = NULL;
-
- /**
- * An instance of a UrlSource class
- */
- private $urlSourceInstance = NULL;
-
/**
* An instance of a InputStream class
*/
*/
private $directoryInstance = NULL;
- /**
- * An instance of a communicator
- */
- private $communicatorInstance = NULL;
-
/**
* The concrete output instance
*/
*/
private $registryInstance = NULL;
+ /**
+ * Call-back instance
+ */
+ private $callbackInstance = NULL;
+
/**
* Thousands separator
*/
*/
private $socketResource = false;
- /**
- * Regular expression to use for validation
- */
- private $regularExpression = '';
-
- /**
- * Package data
- */
- private $packageData = array();
-
/**
* Generic array
*/
const EXCEPTION_DATABASE_UPDATED_NOT_ALLOWED = 0x03c;
const EXCEPTION_FILTER_CHAIN_INTERCEPTED = 0x03d;
const EXCEPTION_INVALID_SOCKET = 0x03e;
+ const EXCEPTION_SELF_INSTANCE = 0x03f;
/**
* Hexadecimal->Decimal translation array
// Set configuration instance if no registry ...
if (!$this instanceof Register) {
// ... because registries doesn't need to be configured
- $this->setConfigInstance(FrameworkConfiguration::getSelfInstance());
+ $this->setConfigInstance(FrameworkBootstrap::getConfigurationInstance());
} // END - if
// Is the startup time set? (0 cannot be true anymore)
* @return void
*/
public final function __call ($methodName, $args) {
- return self::__callStatic($methodName, $args);
+ // Set self-instance
+ self::$instance = $this;
+
+ // Call static method
+ self::__callStatic($methodName, $args);
+
+ // Clear self-instance
+ self::$instance = NULL;
}
/**
* The __callStatic() method where all non-implemented static methods end up
*
* @param $methodName Name of the missing method
- * @args $args Arguments passed to the method
+ * @param $args Arguments passed to the method
* @return void
+ * @throws InvalidArgumentException If self::$instance is not a framework's own object
*/
public static final function __callStatic ($methodName, $args) {
// Trace message
//* PRINT-DEBUG: */ printf('[%s:%d]: methodName=%s,args[]=%s - CALLED!' . PHP_EOL, __METHOD__, __LINE__, $methodName, gettype($args));
- // Init argument string
+ // Init argument string and class name
$argsString = '';
+ $className = 'unknown';
+
+ // Is self-instance set?
+ if (self::$instance instanceof FrameworkInterface) {
+ // Framework's own instance
+ $className = self::$instance->__toString();
+ } elseif (!is_null(self::$instance)) {
+ // Invalid argument!
+ throw new InvalidArgumentException(sprintf('self::instance[%s] is not expected.', gettype(self::$instance)), self::EXCEPTION_SELF_INSTANCE);
+ }
// Is it NULL, empty or an array?
if (is_null($args)) {
$argsString .= ', ';
} // END - foreach
- // Remove last comma
+ // Last comma found?
if (substr($argsString, -2, 1) == ',') {
+ // Remove last comma
$argsString = substr($argsString, 0, -2);
} // END - if
$argsString .= ')';
} else {
// Invalid arguments!
- $argsString = '!INVALID:' . gettype($args) . '!';
+ $argsString = sprintf('!INVALID:%s!', gettype($args));
}
// Output stub message
// @TODO __CLASS__ does always return BaseFrameworkSystem but not the extending (=child) class
- self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('[unknown::%s]: Stub! Args: %s',
+ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('[%s::%s]: Stub! Args: %s',
+ $className,
$methodName,
$argsString
));
* @return void
*/
public final function setConfigInstance (FrameworkConfiguration $configInstance) {
- Registry::getRegistry()->addInstance('config', $configInstance);
+ GenericRegistry::getRegistry()->addInstance('config', $configInstance);
}
/**
* @return $configInstance Configuration instance
*/
public final function getConfigInstance () {
- $configInstance = Registry::getRegistry()->getInstance('config');
+ $configInstance = GenericRegistry::getRegistry()->getInstance('config');
return $configInstance;
}
* @return void
*/
public final function setDebugInstance (DebugMiddleware $debugInstance) {
- Registry::getRegistry()->addInstance('debug', $debugInstance);
+ GenericRegistry::getRegistry()->addInstance('debug', $debugInstance);
}
/**
*/
public final function getDebugInstance () {
// Get debug instance
- $debugInstance = Registry::getRegistry()->getInstance('debug');
+ $debugInstance = GenericRegistry::getRegistry()->getInstance('debug');
// Return it
return $debugInstance;
* @return void
*/
public final function setWebOutputInstance (OutputStreamer $webInstance) {
- Registry::getRegistry()->addInstance('web_output', $webInstance);
+ GenericRegistry::getRegistry()->addInstance('web_output', $webInstance);
}
/**
* @return $webOutputInstance - Instance to class WebOutput
*/
public final function getWebOutputInstance () {
- $webOutputInstance = Registry::getRegistry()->getInstance('web_output');
+ $webOutputInstance = GenericRegistry::getRegistry()->getInstance('web_output');
return $webOutputInstance;
}
* @return void
*/
public final function setDatabaseInstance (DatabaseConnection $databaseInstance) {
- Registry::getRegistry()->addInstance('db_instance', $databaseInstance);
+ GenericRegistry::getRegistry()->addInstance('db_instance', $databaseInstance);
}
/**
*/
public final function getDatabaseInstance () {
// Get instance
- $databaseInstance = Registry::getRegistry()->getInstance('db_instance');
+ $databaseInstance = GenericRegistry::getRegistry()->getInstance('db_instance');
// Return instance
return $databaseInstance;
* @return void
*/
public final function setCompressorChannel (CompressorChannel $compressorInstance) {
- Registry::getRegistry()->addInstance('compressor', $compressorInstance);
+ GenericRegistry::getRegistry()->addInstance('compressor', $compressorInstance);
}
/**
* @return $compressorInstance The compressor channel
*/
public final function getCompressorChannel () {
- $compressorInstance = Registry::getRegistry()->getInstance('compressor');
+ $compressorInstance = GenericRegistry::getRegistry()->getInstance('compressor');
return $compressorInstance;
}
- /**
- * Protected getter for a manageable application helper class
- *
- * @return $applicationInstance An instance of a manageable application helper class
- */
- protected final function getApplicationInstance () {
- $applicationInstance = Registry::getRegistry()->getInstance('app');
- return $applicationInstance;
- }
-
- /**
- * Setter for a manageable application helper class
- *
- * @param $applicationInstance An instance of a manageable application helper class
- * @return void
- */
- public final function setApplicationInstance (ManageableApplication $applicationInstance) {
- Registry::getRegistry()->addInstance('application', $applicationInstance);
- }
-
/**
* Private getter for language instance
*
* @return $langInstance An instance to the language sub-system
*/
protected final function getLanguageInstance () {
- $langInstance = Registry::getRegistry()->getInstance('language');
+ $langInstance = GenericRegistry::getRegistry()->getInstance('language');
return $langInstance;
}
* @see LanguageSystem
*/
public final function setLanguageInstance (ManageableLanguage $langInstance) {
- Registry::getRegistry()->addInstance('language', $langInstance);
+ GenericRegistry::getRegistry()->addInstance('language', $langInstance);
}
/**
return $this->socketResource;
}
- /**
- * Setter for regular expression
- *
- * @param $regularExpression A valid regular expression
- * @return void
- */
- public final function setRegularExpression ($regularExpression) {
- //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput($this->__toString() . '::' . __FUNCTION__ . ': regularExpression=' . $regularExpression . ',previous[' . gettype($this->regularExpression) . ']=' . $this->regularExpression);
- $this->regularExpression = $regularExpression;
- }
-
- /**
- * Getter for regular expression
- *
- * @return $regularExpression A valid regular expression
- */
- public final function getRegularExpression () {
- //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput($this->__toString() . '::' . __FUNCTION__ . ': regularExpression[' . gettype($this->regularExpression) . ']=' . $this->regularExpression);
- return $this->regularExpression;
- }
-
/**
* Setter for helper instance
*
return $this->helperInstance;
}
- /**
- * Setter for a Source instance
- *
- * @param $sourceInstance An instance of a Source class
- * @return void
- */
- protected final function setSourceInstance (Source $sourceInstance) {
- $this->sourceInstance = $sourceInstance;
- }
-
- /**
- * Getter for a Source instance
- *
- * @return $sourceInstance An instance of a Source class
- */
- protected final function getSourceInstance () {
- return $this->sourceInstance;
- }
-
- /**
- * Setter for a UrlSource instance
- *
- * @param $sourceInstance An instance of a UrlSource class
- * @return void
- */
- protected final function setUrlSourceInstance (UrlSource $urlSourceInstance) {
- $this->urlSourceInstance = $urlSourceInstance;
- }
-
- /**
- * Getter for a UrlSource instance
- *
- * @return $urlSourceInstance An instance of a UrlSource class
- */
- protected final function getUrlSourceInstance () {
- return $this->urlSourceInstance;
- }
-
/**
* Getter for a InputStream instance
*
return $this->visitorInstance;
}
- /**
- * Setter for raw package Data
- *
- * @param $packageData Raw package Data
- * @return void
- */
- public final function setPackageData (array $packageData) {
- $this->packageData = $packageData;
- }
-
- /**
- * Getter for raw package Data
- *
- * @return $packageData Raw package Data
- */
- public function getPackageData () {
- return $this->packageData;
- }
-
-
/**
* Setter for Iterator instance
*
return $this->directoryInstance;
}
- /**
- * Getter for communicator instance
- *
- * @return $communicatorInstance An instance of a Communicator class
- */
- public final function getCommunicatorInstance () {
- return $this->communicatorInstance;
- }
-
- /**
- * Setter for communicator instance
- *
- * @param $communicatorInstance An instance of a Communicator class
- * @return void
- */
- protected final function setCommunicatorInstance (Communicator $communicatorInstance) {
- $this->communicatorInstance = $communicatorInstance;
- }
-
/**
* Setter for state instance
*
return $this->registryInstance;
}
+ /**
+ * Setter for call-back instance
+ *
+ * @param $callbackInstance An instance of a FrameworkInterface class
+ * @return void
+ */
+ public final function setCallbackInstance (FrameworkInterface $callbackInstance) {
+ $this->callbackInstance = $callbackInstance;
+ }
+
+ /**
+ * Getter for call-back instance
+ *
+ * @return $callbackInstance An instance of a FrameworkInterface class
+ */
+ protected final function getCallbackInstance () {
+ return $this->callbackInstance;
+ }
+
/**
* Setter for command name
*
// Is the application instance set?
if (is_null($applicationInstance)) {
// Get the current instance
- $applicationInstance = Registry::getRegistry()->getInstance('app');
+ $applicationInstance = GenericRegistry::getRegistry()->getInstance('application');
// Still null?
if (is_null($applicationInstance)) {
);
// Output it
- ApplicationEntryPoint::
app_exit(sprintf('<div class="debug_header">
+ ApplicationEntryPoint::
exitApplication(sprintf('<div class="debug_header">
%s debug output:
</div>
<div class="debug_content">
*/
protected function partialStub ($message = '') {
// Init variable
- $stubMessage = 'Partial Stub!';
+ $stubMessage = 'Partial stub!';
- // Is the extra message given?
+ // Is an extra message given?
if (!empty($message)) {
// Then add it as well
$stubMessage .= ' Message: ' . $message;
*/
public final static function createDebugInstance ($className, $lineNumber = NULL) {
// Is the instance set?
- if (!Registry::getRegistry()->instanceExists('debug')) {
+ if (!GenericRegistry::getRegistry()->instanceExists('debug')) {
// Init debug instance
$debugInstance = NULL;
// Try it
try {
// Get a debugger instance
- $debugInstance = DebugMiddleware::createDebugMiddleware(FrameworkConfiguration::getSelfInstance()->getConfigEntry('debug_' . FrameworkBootstrap::getRequestTypeFromSystem() . '_class'), $className);
+ $debugInstance = DebugMiddleware::createDebugMiddleware(FrameworkBootstrap::getConfigurationInstance()->getConfigEntry('debug_' . FrameworkBootstrap::getRequestTypeFromSystem() . '_class'), $className);
} catch (NullPointerException $e) {
// Didn't work, no instance there
exit(sprintf('Cannot create debugInstance! Exception=%s,message=%s,className=%s,lineNumber=%d' . PHP_EOL, $e->__toString(), $e->getMessage(), $className, $lineNumber));
DebugMiddleware::getSelfInstance()->output('');
// Set it in registry
- Registry::getRegistry()->addInstance('debug', $debugInstance);
+ GenericRegistry::getRegistry()->addInstance('debug', $debugInstance);
} else {
// Get instance from registry
- $debugInstance = Registry::getRegistry()->getInstance('debug');
+ $debugInstance = GenericRegistry::getRegistry()->getDebugInstance();
}
// Return it
$className = '';
// Convert all dashes in underscores
- $str = self::convertDashesToUnderscores($str);
+ $str = StringUtils::convertDashesToUnderscores($str);
// Now use that underscores to get classname parts for hungarian style
foreach (explode('_', $str) as $strPart) {
return $className;
}
- /**
- * Converts dashes to underscores, e.g. useable for configuration entries
- *
- * @param $str The string with maybe dashes inside
- * @return $str The converted string with no dashed, but underscores
- */
- public static final function convertDashesToUnderscores ($str) {
- // Convert them all
- $str = str_replace('-', '_', $str);
-
- // Return converted string
- return $str;
- }
-
/**
* Marks up the code by adding e.g. line numbers
*
//* DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput($fieldName.':<pre>'.print_r($fieldArray, true).'</pre>');
// Convert dashes to underscore
- $fieldName2 = self::convertDashesToUnderscores($fieldName);
+ $fieldName2 = StringUtils::convertDashesToUnderscores($fieldName);
// Does the field exist?
if ($this->isFieldSet($fieldName)) {
//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('[' . $this->__toString() . ':' . __LINE__ . '] fieldName=' . $fieldName . ',fieldArray=<pre>'.print_r($fieldArray, true).'</pre>');
// Convert dashes to underscore
- $fieldName = self::convertDashesToUnderscores($fieldName);
+ $fieldName = StringUtils::convertDashesToUnderscores($fieldName);
// Determine it
$isSet = isset($fieldArray[$fieldName]);
*/
protected function initWebOutputInstance () {
// Get application instance
- $applicationInstance = Registry::getRegistry()->getInstance('app');
+ $applicationInstance = GenericRegistry::getRegistry()->getInstance('application');
// Init web output instance
$outputInstance = ObjectFactory::createObjectByConfiguredName('output_class', array($applicationInstance));
* Creates a full-qualified file name (FQFN) for given file name by adding
* a configured temporary file path to it.
*
- * @param $fileName Name for temporary file
- * @return $fqfn Full-qualified file name
+ * @param $infoInstance An instance of a SplFileInfo class
+ * @return $tempInstance An instance of a SplFileInfo class (temporary file)
* @throw PathWriteProtectedException If the path in 'temp_file_path' is write-protected
* @throws FileIoException If the file cannot be written
*/
- protected static function createTempPathForFile ($fileName) {
+ protected static function createTempPathForFile (SplFileInfo $infoInstance) {
// Get config entry
- $basePath = FrameworkConfiguration::getSelfInstance()->getConfigEntry('temp_file_path');
+ $basePath = FrameworkBootstrap::getConfigurationInstance()->getConfigEntry('temp_file_path');
// Is the path writeable?
if (!is_writable($basePath)) {
// Path is write-protected
- throw new PathWriteProtectedException($fileName, self::EXCEPTION_PATH_CANNOT_BE_WRITTEN);
+ throw new PathWriteProtectedException($infoInstance, self::EXCEPTION_PATH_CANNOT_BE_WRITTEN);
} // END - if
// Add it
- $fqfn = $basePath . DIRECTORY_SEPARATOR . $fileName;
+ $tempInstance = new SplFileInfo($basePath . DIRECTORY_SEPARATOR . $infoInstance->getBasename());
// Is it reachable?
- if (!FrameworkBootstrap::isReachableFilePath($fqfn)) {
+ if (!FrameworkBootstrap::isReachableFilePath($tempInstance)) {
// Not reachable
- throw new FileIoException($fqfn, self::EXCEPTION_FILE_NOT_REACHABLE);
+ throw new FileIoException($tempInstance, self::EXCEPTION_FILE_NOT_REACHABLE);
} // END - if
// Return it
- return $fqfn;
+ return $tempInstance;
}
/**
projects / core.git / blobdiff