<?php
// Own namespace
-namespace CoreFramework\Object;
+namespace Org\Mxchange\CoreFramework\Object;
// Import framework stuff
-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\Factory\Database\Wrapper\DatabaseWrapperFactory;
-use CoreFramework\Factory\ObjectFactory;
-use CoreFramework\Filesystem\Block;
-use CoreFramework\Filesystem\FilePointer;
-use CoreFramework\Filesystem\FrameworkDirectory;
-use CoreFramework\Generic\FrameworkInterface;
-use CoreFramework\Generic\NullPointerException;
-use CoreFramework\Handler\Stream\IoHandler;
-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\Request\Requestable;
-use CoreFramework\Resolver\Resolver;
-use CoreFramework\Result\Database\CachedDatabaseResult;
-use CoreFramework\Result\Search\SearchableResult;
-use CoreFramework\Response\Responseable;
-use CoreFramework\Stream\Output\OutputStreamer;
-use CoreFramework\Template\CompileableTemplate;
-use CoreFramework\User\ManageableAccount;
-use CoreFramework\Visitor\Visitor;
-use CoreFramework\Wrapper\Database\DatabaseWrapper;
+use Org\Mxchange\CoreFramework\Bootstrap\FrameworkBootstrap;
+use Org\Mxchange\CoreFramework\Criteria\Criteria;
+use Org\Mxchange\CoreFramework\EntryPoint\ApplicationEntryPoint;
+use Org\Mxchange\CoreFramework\Factory\ObjectFactory;
+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\Loader\ClassLoader;
+use Org\Mxchange\CoreFramework\Manager\ManageableApplication;
+use Org\Mxchange\CoreFramework\Middleware\Debug\DebugMiddleware;
+use Org\Mxchange\CoreFramework\Registry\GenericRegistry;
+use Org\Mxchange\CoreFramework\Result\Database\CachedDatabaseResult;
+use Org\Mxchange\CoreFramework\State\Stateable;
+use Org\Mxchange\CoreFramework\Stream\Output\OutputStreamer;
+use Org\Mxchange\CoreFramework\Utils\String\StringUtils;
// Import SPL stuff
use \stdClass;
+use \InvalidArgumentException;
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 - 2020 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;
/**
- * The real class name
- */
- private $realClass = 'BaseFrameworkSystem';
-
- /**
- * Instance of a Requestable class
- */
- private $requestInstance = NULL;
-
- /**
- * Instance of a Responseable class
- */
- private $responseInstance = NULL;
-
- /**
- * Search criteria instance
- */
- private $searchInstance = NULL;
-
- /**
- * Update criteria instance
- */
- private $updateInstance = NULL;
-
- /**
- * The file I/O instance for the template loader
- */
- private $fileIoInstance = NULL;
-
- /**
- * Resolver instance
- */
- private $resolverInstance = NULL;
-
- /**
- * Template engine instance
- */
- private $templateInstance = NULL;
-
- /**
- * Database result instance
- */
- private $resultInstance = NULL;
-
- /**
- * Instance for user class
- */
- private $userInstance = NULL;
-
- /**
- * A controller instance
- */
- private $controllerInstance = NULL;
-
- /**
- * Instance of a RNG
- */
- private $rngInstance = NULL;
-
- /**
- * Instance of a crypto helper
- */
- private $cryptoInstance = NULL;
-
- /**
- * Instance of an Iterator class
- */
- private $iteratorInstance = NULL;
-
- /**
- * Instance of the list
- */
- private $listInstance = NULL;
-
- /**
- * Instance of a menu
- */
- private $menuInstance = NULL;
-
- /**
- * Instance of the image
- */
- private $imageInstance = NULL;
-
- /**
- * Instance of the stacker
- */
- private $stackInstance = NULL;
-
- /**
- * A Compressor instance
- */
- private $compressorInstance = NULL;
-
- /**
- * A Parseable instance
- */
- private $parserInstance = NULL;
-
- /**
- * A HandleableProtocol instance
- */
- private $protocolInstance = NULL;
-
- /**
- * A database wrapper instance
+ * Self-referencing instance
*/
- private $databaseInstance = NULL;
+ private static $selfInstance = NULL;
/**
- * A helper instance for the form
- */
- 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 $inputStreamInstance = NULL;
-
- /**
- * An instance of a OutputStream class
- */
- private $outputStreamInstance = NULL;
-
- /**
- * Networkable handler instance
- */
- private $handlerInstance = NULL;
-
- /**
- * Visitor handler instance
- */
- private $visitorInstance = NULL;
-
- /**
- * DHT instance
- */
- private $dhtInstance = NULL;
-
- /**
- * An instance of a database wrapper class
- */
- private $wrapperInstance = NULL;
-
- /**
- * An instance of a file I/O pointer class (not handler)
- */
- private $pointerInstance = NULL;
-
- /**
- * An instance of an Indexable class
- */
- private $indexInstance = NULL;
-
- /**
- * An instance of a Block class
- */
- private $blockInstance = NULL;
-
- /**
- * A Minable instance
- */
- private $minableInstance = NULL;
-
- /**
- * A FrameworkDirectory instance
- */
- private $directoryInstance = NULL;
-
- /**
- * Listener instance
- */
- private $listenerInstance = NULL;
-
- /**
- * An instance of a communicator
- */
- private $communicatorInstance = NULL;
-
- /**
- * The concrete output instance
- */
- private $outputInstance = NULL;
-
- /**
- * State instance
- */
- private $stateInstance = NULL;
-
- /**
- * Thousands separator
- */
- private $thousands = '.'; // German
-
- /**
- * Decimal separator
- */
- private $decimals = ','; // German
-
- /**
- * Socket resource
- */
- private $socketResource = FALSE;
-
- /**
- * Regular expression to use for validation
+ * The real class name
*/
- private $regularExpression = '';
+ private $realClass = __CLASS__;
/**
- * Package data
+ * Call-back instance
*/
- private $packageData = array();
+ private $callbackInstance = NULL;
/**
* Generic array
*/
- private $genericArray = array();
-
- /**
- * Command name
- */
- private $commandName = '';
-
- /**
- * Controller name
- */
- private $controllerName = '';
-
- /**
- * Name of used protocol
- */
- private $protocolName = 'invalid';
-
- /**
- * Array with bitmasks and such for pack/unpack methods to support both
- * 32-bit and 64-bit systems
- */
- private $packingData = array(
- 32 => array(
- 'step' => 3,
- 'left' => 0xffff0000,
- 'right' => 0x0000ffff,
- 'factor' => 16,
- 'format' => 'II',
- ),
- 64 => array(
- 'step' => 7,
- 'left' => 0xffffffff00000000,
- 'right' => 0x00000000ffffffff,
- 'factor' => 32,
- 'format' => 'NN'
- )
- );
-
- /**
- * Simple 64-bit check, thanks to "Salman A" from stackoverflow.com:
- *
- * The integer size is 4 bytes on 32-bit and 8 bytes on a 64-bit system.
- */
- private $archArrayElement = FALSE;
+ private $genericArray = [];
/***********************
* Exception codes.... *
const EXCEPTION_PATH_CANNOT_BE_WRITTEN = 0x03b;
const EXCEPTION_DATABASE_UPDATED_NOT_ALLOWED = 0x03c;
const EXCEPTION_FILTER_CHAIN_INTERCEPTED = 0x03d;
-
- /**
- * Hexadecimal->Decimal translation array
- */
- private static $hexdec = array(
- '0' => 0,
- '1' => 1,
- '2' => 2,
- '3' => 3,
- '4' => 4,
- '5' => 5,
- '6' => 6,
- '7' => 7,
- '8' => 8,
- '9' => 9,
- 'a' => 10,
- 'b' => 11,
- 'c' => 12,
- 'd' => 13,
- 'e' => 14,
- 'f' => 15
- );
-
- /**
- * Decimal->hexadecimal translation array
- */
- private static $dechex = array(
- 0 => '0',
- 1 => '1',
- 2 => '2',
- 3 => '3',
- 4 => '4',
- 5 => '5',
- 6 => '6',
- 7 => '7',
- 8 => '8',
- 9 => '9',
- 10 => 'a',
- 11 => 'b',
- 12 => 'c',
- 13 => 'd',
- 14 => 'e',
- 15 => 'f'
- );
+ const EXCEPTION_INVALID_SOCKET = 0x03e;
+ const EXCEPTION_SELF_INSTANCE = 0x03f;
/**
* Startup time in miliseconds
* @param $className Name of the class
* @return void
*/
- protected function __construct ($className) {
+ protected function __construct (string $className) {
// Set real class
$this->setRealClass($className);
- // Set configuration instance if no registry ...
- if (!$this instanceof Register) {
- // ... because registries doesn't need to be configured
- $this->setConfigInstance(FrameworkConfiguration::getSelfInstance());
- } // END - if
-
- // Is the startup time set? (0 cannot be TRUE anymore)
+ // Is the startup time set? (0 cannot be true anymore)
if (self::$startupTime == 0) {
// Then set it
- self::$startupTime = microtime(TRUE);
- } // END - if
-
- // Set array element
- $this->archArrayElement = (PHP_INT_SIZE === 8 ? 64 : 32);
+ self::$startupTime = microtime(true);
+ }
}
/**
* @return void
*/
public function __destruct () {
- // Flush any updated entries to the database
- $this->flushPendingUpdates();
-
// Is this object already destroyed?
if ($this->__toString() != 'DestructedObject') {
// Destroy all informations about this class but keep some text about it alive
$this->setRealClass('DestructedObject');
} elseif ((defined('DEBUG_DESTRUCTOR')) && (is_object($this->getDebugInstance()))) {
// Already destructed object
- self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('[%s:] The object <span class="object_name">%s</span> is already destroyed.',
- __CLASS__,
+ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('The object <span class="object_name">%s</span> is already destroyed.',
$this->__toString()
));
} else {
* @args $args Arguments passed to the method
* @return void
*/
- public final function __call ($methodName, $args) {
- return self::__callStatic($methodName, $args);
+ public final function __call (string $methodName, array $args = NULL) {
+ // Set self-instance
+ self::$selfInstance = $this;
+
+ // Call static method
+ self::__callStatic($methodName, $args);
+
+ // Clear self-instance
+ self::$selfInstance = 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::$selfInstance is not a framework's own object
*/
- public static final function __callStatic ($methodName, $args) {
- // Trace message
+ public static final function __callStatic (string $methodName, array $args = NULL) {
+ // Init argument string and class name
//* PRINT-DEBUG: */ printf('[%s:%d]: methodName=%s,args[]=%s - CALLED!' . PHP_EOL, __METHOD__, __LINE__, $methodName, gettype($args));
-
- // Init argument string
$argsString = '';
+ $className = 'unknown';
+
+ // Is self-instance set?
+ if (self::$selfInstance instanceof FrameworkInterface) {
+ // Framework's own instance
+ $className = self::$selfInstance->__toString();
+ } elseif (!is_null(self::$selfInstance)) {
+ // Invalid argument!
+ throw new InvalidArgumentException(sprintf('self::instance[%s] is not expected.', gettype(self::$selfInstance)), self::EXCEPTION_SELF_INSTANCE);
+ }
// Is it NULL, empty or an array?
if (is_null($args)) {
// Is an other object, maybe no __toString() available
$argsString .= $reflection->getName();
- } elseif ($arg === TRUE) {
- // ... is boolean 'TRUE'
- $argsString .= 'TRUE';
- } elseif ($arg === FALSE) {
- // ... is boolean 'FALSE'
- $argsString .= 'FALSE';
+ } elseif ($arg === true) {
+ // ... is boolean 'true'
+ $argsString .= 'true';
+ } elseif ($arg === false) {
+ // ... is boolean 'false'
+ $argsString .= 'false';
}
// Comma for next one
$argsString .= ', ';
- } // END - foreach
+ }
- // Remove last comma
+ // Last comma found?
if (substr($argsString, -2, 1) == ',') {
+ // Remove last comma
$argsString = substr($argsString, 0, -2);
- } // END - if
+ }
// Close braces
$argsString .= ')';
- } else {
- // Invalid arguments!
- $argsString = '!INVALID:' . 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 $realClass The name of the real class (not BaseFrameworkSystem)
*/
public function __toString () {
- return $this->realClass;
- }
-
- /**
- * Magic method to catch setting of missing but set class fields/attributes
- *
- * @param $name Name of the field/attribute
- * @param $value Value to store
- * @return void
- */
- public final function __set ($name, $value) {
- $this->debugBackTrace(sprintf('Tried to set a missing field. name=%s, value[%s]=%s',
- $name,
- gettype($value),
- print_r($value, TRUE)
- ));
- }
-
- /**
- * Magic method to catch getting of missing fields/attributes
- *
- * @param $name Name of the field/attribute
- * @return void
- */
- public final function __get ($name) {
- $this->debugBackTrace(sprintf('Tried to get a missing field. name=%s',
- $name
- ));
- }
-
- /**
- * Magic method to catch unsetting of missing fields/attributes
- *
- * @param $name Name of the field/attribute
- * @return void
- */
- public final function __unset ($name) {
- $this->debugBackTrace(sprintf('Tried to unset a missing field. name=%s',
- $name
- ));
- }
-
- /**
- * Magic method to catch object serialization
- *
- * @return $unsupported Unsupported method
- * @throws UnsupportedOperationException Objects of this framework cannot be serialized
- */
- public final function __sleep () {
- throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
- }
-
- /**
- * Magic method to catch object deserialization
- *
- * @return $unsupported Unsupported method
- * @throws UnsupportedOperationException Objects of this framework cannot be serialized
- */
- public final function __wakeup () {
- throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
- }
-
- /**
- * Magic method to catch calls when an object instance is called
- *
- * @return $unsupported Unsupported method
- * @throws UnsupportedOperationException Objects of this framework cannot be serialized
- */
- public final function __invoke () {
- throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
- }
-
- /**
- * Setter for the real class name
- *
- * @param $realClass Class name (string)
- * @return void
- */
- public final function setRealClass ($realClass) {
- // Set real class
- $this->realClass = (string) $realClass;
- }
-
- /**
- * Setter for database result instance
- *
- * @param $resultInstance An instance of a database result class
- * @return void
- * @todo SearchableResult and UpdateableResult shall have a super interface to use here
- */
- protected final function setResultInstance (SearchableResult $resultInstance) {
- $this->resultInstance = $resultInstance;
- }
-
- /**
- * Getter for database result instance
- *
- * @return $resultInstance An instance of a database result class
- */
- public final function getResultInstance () {
- return $this->resultInstance;
- }
-
- /**
- * Setter for template engine instances
- *
- * @param $templateInstance An instance of a template engine class
- * @return void
- */
- protected final function setTemplateInstance (CompileableTemplate $templateInstance) {
- $this->templateInstance = $templateInstance;
- }
-
- /**
- * Getter for template engine instances
- *
- * @return $templateInstance An instance of a template engine class
- */
- protected final function getTemplateInstance () {
- return $this->templateInstance;
- }
-
- /**
- * Setter for search instance
- *
- * @param $searchInstance Searchable criteria instance
- * @return void
- */
- public final function setSearchInstance (LocalSearchCriteria $searchInstance) {
- $this->searchInstance = $searchInstance;
- }
-
- /**
- * Getter for search instance
- *
- * @return $searchInstance Searchable criteria instance
- */
- public final function getSearchInstance () {
- return $this->searchInstance;
- }
-
- /**
- * Setter for update instance
- *
- * @param $updateInstance An instance of a LocalUpdateCriteria clase
- * @return void
- */
- public final function setUpdateInstance (LocalUpdateCriteria $updateInstance) {
- $this->updateInstance = $updateInstance;
- }
-
- /**
- * Getter for update instance
- *
- * @return $updateInstance Updateable criteria instance
- */
- public final function getUpdateInstance () {
- return $this->updateInstance;
- }
-
- /**
- * Setter for resolver instance
- *
- * @param $resolverInstance Instance of a command resolver class
- * @return void
- */
- public final function setResolverInstance (Resolver $resolverInstance) {
- $this->resolverInstance = $resolverInstance;
- }
-
- /**
- * Getter for resolver instance
- *
- * @return $resolverInstance Instance of a command resolver class
- */
- public final function getResolverInstance () {
- return $this->resolverInstance;
- }
-
- /**
- * Setter for language instance
- *
- * @param $configInstance The configuration instance which shall
- * be FrameworkConfiguration
- * @return void
- */
- public final function setConfigInstance (FrameworkConfiguration $configInstance) {
- Registry::getRegistry()->addInstance('config', $configInstance);
- }
-
- /**
- * Getter for configuration instance
- *
- * @return $configInstance Configuration instance
- */
- public final function getConfigInstance () {
- $configInstance = Registry::getRegistry()->getInstance('config');
- return $configInstance;
- }
-
- /**
- * Setter for debug instance
- *
- * @param $debugInstance The instance for debug output class
- * @return void
- */
- public final function setDebugInstance (DebugMiddleware $debugInstance) {
- Registry::getRegistry()->addInstance('debug', $debugInstance);
- }
-
- /**
- * Getter for debug instance
- *
- * @return $debugInstance Instance to class DebugConsoleOutput or DebugWebOutput
- */
- public final function getDebugInstance () {
- // Get debug instance
- $debugInstance = Registry::getRegistry()->getInstance('debug');
-
- // Return it
- return $debugInstance;
- }
-
- /**
- * Setter for web output instance
- *
- * @param $webInstance The instance for web output class
- * @return void
- */
- public final function setWebOutputInstance (OutputStreamer $webInstance) {
- Registry::getRegistry()->addInstance('web_output', $webInstance);
- }
-
- /**
- * Getter for web output instance
- *
- * @return $webOutputInstance - Instance to class WebOutput
- */
- public final function getWebOutputInstance () {
- $webOutputInstance = Registry::getRegistry()->getInstance('web_output');
- return $webOutputInstance;
- }
-
- /**
- * Setter for database instance
- *
- * @param $databaseInstance The instance for the database connection (forced DatabaseConnection)
- * @return void
- */
- public final function setDatabaseInstance (DatabaseConnection $databaseInstance) {
- Registry::getRegistry()->addInstance('db_instance', $databaseInstance);
- }
-
- /**
- * Getter for database layer
- *
- * @return $databaseInstance The database layer instance
- */
- public final function getDatabaseInstance () {
- // Get instance
- $databaseInstance = Registry::getRegistry()->getInstance('db_instance');
-
- // Return instance
- return $databaseInstance;
- }
-
- /**
- * Setter for compressor channel
- *
- * @param $compressorInstance An instance of CompressorChannel
- * @return void
- */
- public final function setCompressorChannel (CompressorChannel $compressorInstance) {
- Registry::getRegistry()->addInstance('compressor', $compressorInstance);
- }
-
- /**
- * Getter for compressor channel
- *
- * @return $compressorInstance The compressor channel
- */
- public final function getCompressorChannel () {
- $compressorInstance = Registry::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('application');
- 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);
- }
-
- /**
- * Setter for request instance
- *
- * @param $requestInstance An instance of a Requestable class
- * @return void
- */
- public final function setRequestInstance (Requestable $requestInstance) {
- $this->requestInstance = $requestInstance;
- }
-
- /**
- * Getter for request instance
- *
- * @return $requestInstance An instance of a Requestable class
- */
- public final function getRequestInstance () {
- return $this->requestInstance;
- }
-
- /**
- * Setter for response instance
- *
- * @param $responseInstance An instance of a Responseable class
- * @return void
- */
- public final function setResponseInstance (Responseable $responseInstance) {
- $this->responseInstance = $responseInstance;
- }
-
- /**
- * Getter for response instance
- *
- * @return $responseInstance An instance of a Responseable class
- */
- public final function getResponseInstance () {
- return $this->responseInstance;
- }
-
- /**
- * Private getter for language instance
- *
- * @return $langInstance An instance to the language sub-system
- */
- protected final function getLanguageInstance () {
- $langInstance = Registry::getRegistry()->getInstance('language');
- return $langInstance;
- }
-
- /**
- * Setter for language instance
- *
- * @param $langInstance An instance to the language sub-system
- * @return void
- * @see LanguageSystem
- */
- public final function setLanguageInstance (ManageableLanguage $langInstance) {
- Registry::getRegistry()->addInstance('language', $langInstance);
- }
-
- /**
- * Private getter for file IO instance
- *
- * @return $fileIoInstance An instance to the file I/O sub-system
- */
- protected final function getFileIoInstance () {
- return $this->fileIoInstance;
- }
-
- /**
- * Setter for file I/O instance
- *
- * @param $fileIoInstance An instance to the file I/O sub-system
- * @return void
- */
- public final function setFileIoInstance (IoHandler $fileIoInstance) {
- $this->fileIoInstance = $fileIoInstance;
- }
-
- /**
- * Protected setter for user instance
- *
- * @param $userInstance An instance of a user class
- * @return void
- */
- protected final function setUserInstance (ManageableAccount $userInstance) {
- $this->userInstance = $userInstance;
- }
-
- /**
- * Getter for user instance
- *
- * @return $userInstance An instance of a user class
- */
- public final function getUserInstance () {
- return $this->userInstance;
- }
-
- /**
- * Setter for controller instance (this surely breaks a bit the MVC patterm)
- *
- * @param $controllerInstance An instance of the controller
- * @return void
- */
- public final function setControllerInstance (Controller $controllerInstance) {
- $this->controllerInstance = $controllerInstance;
- }
-
- /**
- * Getter for controller instance (this surely breaks a bit the MVC patterm)
- *
- * @return $controllerInstance An instance of the controller
- */
- public final function getControllerInstance () {
- return $this->controllerInstance;
- }
-
- /**
- * Setter for RNG instance
- *
- * @param $rngInstance An instance of a random number generator (RNG)
- * @return void
- */
- protected final function setRngInstance (RandomNumberGenerator $rngInstance) {
- $this->rngInstance = $rngInstance;
- }
-
- /**
- * Getter for RNG instance
- *
- * @return $rngInstance An instance of a random number generator (RNG)
- */
- public final function getRngInstance () {
- return $this->rngInstance;
- }
-
- /**
- * Setter for Cryptable instance
- *
- * @param $cryptoInstance An instance of a Cryptable class
- * @return void
- */
- protected final function setCryptoInstance (Cryptable $cryptoInstance) {
- $this->cryptoInstance = $cryptoInstance;
- }
-
- /**
- * Getter for Cryptable instance
- *
- * @return $cryptoInstance An instance of a Cryptable class
- */
- public final function getCryptoInstance () {
- return $this->cryptoInstance;
- }
-
- /**
- * Setter for the list instance
- *
- * @param $listInstance A list of Listable
- * @return void
- */
- protected final function setListInstance (Listable $listInstance) {
- $this->listInstance = $listInstance;
- }
-
- /**
- * Getter for the list instance
- *
- * @return $listInstance A list of Listable
- */
- protected final function getListInstance () {
- return $this->listInstance;
- }
-
- /**
- * Setter for the menu instance
- *
- * @param $menuInstance A RenderableMenu instance
- * @return void
- */
- protected final function setMenuInstance (RenderableMenu $menuInstance) {
- $this->menuInstance = $menuInstance;
- }
-
- /**
- * Getter for the menu instance
- *
- * @return $menuInstance A RenderableMenu instance
- */
- protected final function getMenuInstance () {
- return $this->menuInstance;
- }
-
- /**
- * Setter for image instance
- *
- * @param $imageInstance An instance of an image
- * @return void
- */
- public final function setImageInstance (BaseImage $imageInstance) {
- $this->imageInstance = $imageInstance;
- }
-
- /**
- * Getter for image instance
- *
- * @return $imageInstance An instance of an image
- */
- public final function getImageInstance () {
- return $this->imageInstance;
- }
-
- /**
- * Setter for stacker instance
- *
- * @param $stackInstance An instance of an stacker
- * @return void
- */
- public final function setStackInstance (Stackable $stackInstance) {
- $this->stackInstance = $stackInstance;
- }
-
- /**
- * Getter for stacker instance
- *
- * @return $stackInstance An instance of an stacker
- */
- public final function getStackInstance () {
- return $this->stackInstance;
- }
-
- /**
- * Setter for compressor instance
- *
- * @param $compressorInstance An instance of an compressor
- * @return void
- */
- public final function setCompressorInstance (Compressor $compressorInstance) {
- $this->compressorInstance = $compressorInstance;
- }
-
- /**
- * Getter for compressor instance
- *
- * @return $compressorInstance An instance of an compressor
- */
- public final function getCompressorInstance () {
- return $this->compressorInstance;
- }
-
- /**
- * Setter for Parseable instance
- *
- * @param $parserInstance An instance of an Parseable
- * @return void
- */
- public final function setParserInstance (Parseable $parserInstance) {
- $this->parserInstance = $parserInstance;
- }
-
- /**
- * Getter for Parseable instance
- *
- * @return $parserInstance An instance of an Parseable
- */
- public final function getParserInstance () {
- return $this->parserInstance;
- }
-
- /**
- * Setter for HandleableProtocol instance
- *
- * @param $protocolInstance An instance of an HandleableProtocol
- * @return void
- */
- public final function setProtocolInstance (HandleableProtocol $protocolInstance) {
- $this->protocolInstance = $protocolInstance;
- }
-
- /**
- * Getter for HandleableProtocol instance
- *
- * @return $protocolInstance An instance of an HandleableProtocol
- */
- public final function getProtocolInstance () {
- return $this->protocolInstance;
- }
-
- /**
- * Setter for DatabaseWrapper instance
- *
- * @param $wrapperInstance An instance of an DatabaseWrapper
- * @return void
- */
- public final function setWrapperInstance (DatabaseWrapper $wrapperInstance) {
- $this->wrapperInstance = $wrapperInstance;
- }
-
- /**
- * Getter for DatabaseWrapper instance
- *
- * @return $wrapperInstance An instance of an DatabaseWrapper
- */
- public final function getWrapperInstance () {
- return $this->wrapperInstance;
- }
-
- /**
- * Setter for socket resource
- *
- * @param $socketResource A valid socket resource
- * @return void
- */
- public final function setSocketResource ($socketResource) {
- //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput($this->__toString() . '::' . __FUNCTION__ . ': socketResource=' . $socketResource . ',previous[' . gettype($this->socketResource) . ']=' . $this->socketResource);
- $this->socketResource = $socketResource;
- }
-
- /**
- * Getter for socket resource
- *
- * @return $socketResource A valid socket resource
- */
- public final function getSocketResource () {
- //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput($this->__toString() . '::' . __FUNCTION__ . ': socketResource[' . gettype($this->socketResource) . ']=' . $this->socketResource);
- 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
- *
- * @param $helperInstance An instance of a helper class
- * @return void
- */
- protected final function setHelperInstance (Helper $helperInstance) {
- $this->helperInstance = $helperInstance;
- }
-
- /**
- * Getter for helper instance
- *
- * @return $helperInstance An instance of a helper class
- */
- public final function getHelperInstance () {
- 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
- *
- * @param $inputStreamInstance The InputStream instance
- */
- protected final function getInputStreamInstance () {
- return $this->inputStreamInstance;
- }
-
- /**
- * Setter for a InputStream instance
- *
- * @param $inputStreamInstance The InputStream instance
- * @return void
- */
- protected final function setInputStreamInstance (InputStream $inputStreamInstance) {
- $this->inputStreamInstance = $inputStreamInstance;
- }
-
- /**
- * Getter for a OutputStream instance
- *
- * @param $outputStreamInstance The OutputStream instance
- */
- protected final function getOutputStreamInstance () {
- return $this->outputStreamInstance;
- }
-
- /**
- * Setter for a OutputStream instance
- *
- * @param $outputStreamInstance The OutputStream instance
- * @return void
- */
- protected final function setOutputStreamInstance (OutputStream $outputStreamInstance) {
- $this->outputStreamInstance = $outputStreamInstance;
- }
-
- /**
- * Setter for handler instance
- *
- * @param $handlerInstance An instance of a Handleable class
- * @return void
- */
- protected final function setHandlerInstance (Handleable $handlerInstance) {
- $this->handlerInstance = $handlerInstance;
- }
-
- /**
- * Getter for handler instance
- *
- * @return $handlerInstance A Networkable instance
- */
- protected final function getHandlerInstance () {
- return $this->handlerInstance;
- }
-
- /**
- * Setter for visitor instance
- *
- * @param $visitorInstance A Visitor instance
- * @return void
- */
- protected final function setVisitorInstance (Visitor $visitorInstance) {
- $this->visitorInstance = $visitorInstance;
- }
-
- /**
- * Getter for visitor instance
- *
- * @return $visitorInstance A Visitor instance
- */
- protected final function getVisitorInstance () {
- return $this->visitorInstance;
- }
-
- /**
- * Setter for DHT instance
- *
- * @param $dhtInstance A Distributable instance
- * @return void
- */
- protected final function setDhtInstance (Distributable $dhtInstance) {
- $this->dhtInstance = $dhtInstance;
- }
-
- /**
- * Getter for DHT instance
- *
- * @return $dhtInstance A Distributable instance
- */
- protected final function getDhtInstance () {
- return $this->dhtInstance;
- }
-
- /**
- * 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
- *
- * @param $iteratorInstance An instance of an Iterator
- * @return void
- */
- protected final function setIteratorInstance (Iterator $iteratorInstance) {
- $this->iteratorInstance = $iteratorInstance;
- }
-
- /**
- * Getter for Iterator instance
- *
- * @return $iteratorInstance An instance of an Iterator
- */
- public final function getIteratorInstance () {
- return $this->iteratorInstance;
- }
-
- /**
- * Setter for FilePointer instance
- *
- * @param $pointerInstance An instance of an FilePointer class
- * @return void
- */
- protected final function setPointerInstance (FilePointer $pointerInstance) {
- $this->pointerInstance = $pointerInstance;
- }
-
- /**
- * Getter for FilePointer instance
- *
- * @return $pointerInstance An instance of an FilePointer class
- */
- public final function getPointerInstance () {
- return $this->pointerInstance;
- }
-
- /**
- * Unsets pointer instance which triggers a call of __destruct() if the
- * instance is still there. This is surely not fatal on already "closed"
- * file pointer instances.
- *
- * I don't want to mess around with above setter by giving it a default
- * value NULL as setter should always explicitly only set (existing) object
- * instances and NULL is NULL.
- *
- * @return void
- */
- protected final function unsetPointerInstance () {
- // Simply it to NULL
- $this->pointerInstance = NULL;
- }
-
- /**
- * Setter for Indexable instance
- *
- * @param $indexInstance An instance of an Indexable class
- * @return void
- */
- protected final function setIndexInstance (Indexable $indexInstance) {
- $this->indexInstance = $indexInstance;
- }
-
- /**
- * Getter for Indexable instance
- *
- * @return $indexInstance An instance of an Indexable class
- */
- public final function getIndexInstance () {
- return $this->indexInstance;
- }
-
- /**
- * Setter for Block instance
- *
- * @param $blockInstance An instance of an Block class
- * @return void
- */
- protected final function setBlockInstance (Block $blockInstance) {
- $this->blockInstance = $blockInstance;
- }
-
- /**
- * Getter for Block instance
- *
- * @return $blockInstance An instance of an Block class
- */
- public final function getBlockInstance () {
- return $this->blockInstance;
- }
-
- /**
- * Setter for Minable instance
- *
- * @param $minableInstance A Minable instance
- * @return void
- */
- protected final function setMinableInstance (Minable $minableInstance) {
- $this->minableInstance = $minableInstance;
- }
-
- /**
- * Getter for minable instance
- *
- * @return $minableInstance A Minable instance
- */
- protected final function getMinableInstance () {
- return $this->minableInstance;
- }
-
- /**
- * Setter for FrameworkDirectory instance
- *
- * @param $directoryInstance A FrameworkDirectory instance
- * @return void
- */
- protected final function setDirectoryInstance (FrameworkDirectory $directoryInstance) {
- $this->directoryInstance = $directoryInstance;
- }
-
- /**
- * Getter for FrameworkDirectory instance
- *
- * @return $directoryInstance A FrameworkDirectory instance
- */
- protected final function getDirectoryInstance () {
- return $this->directoryInstance;
- }
-
- /**
- * Setter for listener instance
- *
- * @param $listenerInstance A Listenable instance
- * @return void
- */
- protected final function setListenerInstance (Listenable $listenerInstance) {
- $this->listenerInstance = $listenerInstance;
+ return $this->realClass;
}
/**
- * Getter for listener instance
+ * Magic method to catch setting of missing but set class fields/attributes
*
- * @return $listenerInstance A Listenable instance
+ * @param $name Name of the field/attribute
+ * @param $value Value to store
+ * @return void
*/
- protected final function getListenerInstance () {
- return $this->listenerInstance;
+ public final function __set (string $name, $value) {
+ $this->debugBackTrace(sprintf('Tried to set a missing field. name=%s, value[%s]=%s',
+ $name,
+ gettype($value),
+ print_r($value, true)
+ ));
}
/**
- * Getter for communicator instance
+ * Magic method to catch getting of missing fields/attributes
*
- * @return $communicatorInstance An instance of a Communicator class
+ * @param $name Name of the field/attribute
+ * @return void
*/
- public final function getCommunicatorInstance () {
- return $this->communicatorInstance;
+ public final function __get (string $name) {
+ $this->debugBackTrace(sprintf('Tried to get a missing field. name=%s',
+ $name
+ ));
}
/**
- * Setter for communicator instance
+ * Magic method to catch unsetting of missing fields/attributes
*
- * @param $communicatorInstance An instance of a Communicator class
+ * @param $name Name of the field/attribute
* @return void
*/
- protected final function setCommunicatorInstance (Communicator $communicatorInstance) {
- $this->communicatorInstance = $communicatorInstance;
+ public final function __unset (string $name) {
+ $this->debugBackTrace(sprintf('Tried to unset a missing field. name=%s',
+ $name
+ ));
}
/**
- * Setter for state instance
+ * Magic method to catch object serialization
*
- * @param $stateInstance A Stateable instance
- * @return void
+ * @return $unsupported Unsupported method
+ * @throws UnsupportedOperationException Objects of this framework cannot be serialized
*/
- public final function setStateInstance (Stateable $stateInstance) {
- $this->stateInstance = $stateInstance;
+ public final function __sleep () {
+ throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
}
/**
- * Getter for state instance
+ * Magic method to catch object deserialization
*
- * @return $stateInstance A Stateable instance
+ * @return $unsupported Unsupported method
+ * @throws UnsupportedOperationException Objects of this framework cannot be serialized
*/
- public final function getStateInstance () {
- return $this->stateInstance;
+ public final function __wakeup () {
+ throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
}
/**
- * Setter for output instance
+ * Magic method to catch calls when an object instance is called
*
- * @param $outputInstance The debug output instance
- * @return void
+ * @return $unsupported Unsupported method
+ * @throws UnsupportedOperationException Objects of this framework cannot be serialized
*/
- public final function setOutputInstance (OutputStreamer $outputInstance) {
- $this->outputInstance = $outputInstance;
+ public final function __invoke () {
+ throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
}
/**
- * Getter for output instance
+ * Setter for the real class name
*
- * @return $outputInstance The debug output instance
+ * @param $realClass Class name (string)
+ * @return void
*/
- public final function getOutputInstance () {
- return $this->outputInstance;
+ public final function setRealClass (string $realClass) {
+ // Set real class
+ $this->realClass = $realClass;
}
/**
- * Setter for command name
+ * Setter for debug instance
*
- * @param $commandName Last validated command name
+ * @param $debugInstance The instance for debug output class
* @return void
*/
- protected final function setCommandName ($commandName) {
- $this->commandName = $commandName;
+ public final function setDebugInstance (DebugMiddleware $debugInstance) {
+ GenericRegistry::getRegistry()->addInstance('debug', $debugInstance);
}
/**
- * Getter for command name
+ * Getter for debug instance
*
- * @return $commandName Last validated command name
+ * @return $debugInstance Instance to class DebugConsoleOutput or DebugWebOutput
*/
- protected final function getCommandName () {
- return $this->commandName;
+ public final function getDebugInstance () {
+ // Get debug instance
+ $debugInstance = GenericRegistry::getRegistry()->getInstance('debug');
+
+ // Return it
+ return $debugInstance;
}
/**
- * Setter for controller name
+ * Setter for web output instance
*
- * @param $controllerName Last validated controller name
+ * @param $webInstance The instance for web output class
* @return void
*/
- protected final function setControllerName ($controllerName) {
- $this->controllerName = $controllerName;
+ public final function setWebOutputInstance (OutputStreamer $webInstance) {
+ GenericRegistry::getRegistry()->addInstance('web_output', $webInstance);
}
/**
- * Getter for controller name
+ * Getter for web output instance
*
- * @return $controllerName Last validated controller name
+ * @return $webOutputInstance - Instance to class WebOutput
*/
- protected final function getControllerName () {
- return $this->controllerName;
+ public final function getWebOutputInstance () {
+ $webOutputInstance = GenericRegistry::getRegistry()->getInstance('web_output');
+ return $webOutputInstance;
}
/**
- * Getter for protocol name
+ * Setter for call-back instance
*
- * @return $protocolName Name of used protocol
+ * @param $callbackInstance An instance of a FrameworkInterface class
+ * @return void
*/
- public final function getProtocolName () {
- return $this->protocolName;
+ public final function setCallbackInstance (FrameworkInterface $callbackInstance) {
+ $this->callbackInstance = $callbackInstance;
}
/**
- * Setter for protocol name
+ * Getter for call-back instance
*
- * @param $protocolName Name of used protocol
- * @return void
+ * @return $callbackInstance An instance of a FrameworkInterface class
*/
- protected final function setProtocolName ($protocolName) {
- $this->protocolName = $protocolName;
+ protected final function getCallbackInstance () {
+ return $this->callbackInstance;
}
/**
return crc32($this->__toString());
}
- /**
- * Formats computer generated price values into human-understandable formats
- * with thousand and decimal separators.
- *
- * @param $value The in computer format value for a price
- * @param $currency The currency symbol (use HTML-valid characters!)
- * @param $decNum Number of decimals after commata
- * @return $price The for the current language formated price string
- * @throws MissingDecimalsThousandsSeparatorException If decimals or
- * thousands separator
- * is missing
- */
- public function formatCurrency ($value, $currency = '€', $decNum = 2) {
- // Are all required attriutes set?
- if ((!isset($this->decimals)) || (!isset($this->thousands))) {
- // Throw an exception
- throw new MissingDecimalsThousandsSeparatorException($this, self::EXCEPTION_ATTRIBUTES_ARE_MISSING);
- } // END - if
-
- // Cast the number
- $value = (float) $value;
-
- // Reformat the US number
- $price = number_format($value, $decNum, $this->decimals, $this->thousands) . $currency;
-
- // Return as string...
- return $price;
- }
-
/**
* Appends a trailing slash to a string
*
// Is there a trailing slash?
if (substr($str, -1, 1) != '/') {
$str .= '/';
- } // END - if
+ }
// Return string with trailing slash
return $str;
}
- /**
- * Prepare the template engine (HtmlTemplateEngine by default) for a given
- * application helper instance (ApplicationHelper by default).
- *
- * @param $applicationInstance An application helper instance or
- * null if we shall use the default
- * @return $templateInstance The template engine instance
- * @throws NullPointerException If the discovered application
- * instance is still null
- */
- protected function prepareTemplateInstance (ManageableApplication $applicationInstance = NULL) {
- // Is the application instance set?
- if (is_null($applicationInstance)) {
- // Get the current instance
- $applicationInstance = $this->getApplicationInstance();
-
- // Still null?
- if (is_null($applicationInstance)) {
- // Thrown an exception
- throw new NullPointerException($this, self::EXCEPTION_IS_NULL_POINTER);
- } // END - if
- } // END - if
-
- // Initialize the template engine
- $templateInstance = ObjectFactory::createObjectByConfiguredName('html_template_class');
-
- // Return the prepared instance
- return $templateInstance;
- }
-
/**
* Debugs this instance by putting out it's full content
*
// Is a message set?
if (!empty($message)) {
// Construct message
- $content = sprintf('<div class="debug_message">Message: %s</div>' . PHP_EOL, $message);
- } // END - if
+ $content = sprintf('<div class="debug_message">
+ Message: %s
+</div>' . PHP_EOL, $message);
+ }
// Generate the output
$content .= sprintf('<pre>%s</pre>',
trim(
htmlentities(
- print_r($this, TRUE)
+ print_r($this, true)
)
)
);
// Output it
- ApplicationEntryPoint::app_exit(sprintf('<div class="debug_header">%s debug output:</div><div class="debug_content">%s</div>Loaded includes: <div class="debug_include_list">%s</div>',
+ ApplicationEntryPoint::exitApplication(sprintf('<div class="debug_header">
+ %s debug output:
+</div>
+<div class="debug_content">
+ %s
+</div>
+Loaded includes:
+<div class="debug_include_list">
+ %s
+</div>',
$this->__toString(),
$content,
ClassLoader::getSelfInstance()->getPrintableIncludeList()
* @return void
*/
protected function partialStub ($message = '') {
- // Get the backtrace
- $backtrace = debug_backtrace();
-
- // Generate the class::method string
- $methodName = 'UnknownClass->unknownMethod';
- if ((isset($backtrace[1]['class'])) && (isset($backtrace[1]['function']))) {
- $methodName = $backtrace[1]['class'] . '->' . $backtrace[1]['function'];
- } // END - if
-
- // Construct the full message
- $stubMessage = sprintf('[%s:] Partial stub!',
- $methodName
- );
+ // Init variable
+ $stubMessage = 'Partial stub!';
- // Is the extra message given?
+ // Is an extra message given?
if (!empty($message)) {
// Then add it as well
$stubMessage .= ' Message: ' . $message;
- } // END - if
+ }
// Debug instance is there?
if (!is_null($this->getDebugInstance())) {
* Outputs a debug backtrace and stops further script execution
*
* @param $message An optional message to output
- * @param $doExit Whether exit the program (TRUE is default)
+ * @param $doExit Whether exit the program (true is default)
* @return void
*/
- public function debugBackTrace ($message = '', $doExit = TRUE) {
+ public function debugBackTrace ($message = '', $doExit = true) {
// Sorry, there is no other way getting this nice backtrace
if (!empty($message)) {
// Output message
printf('Message: %s<br />' . PHP_EOL, $message);
- } // END - if
+ }
print('<pre>');
debug_print_backtrace();
print('</pre>');
// Exit program?
- if ($doExit === TRUE) {
+ if ($doExit === true) {
exit();
- } // END - if
+ }
}
/**
*/
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_' . self::getResponseTypeFromSystem() . '_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));
// Empty string should be ignored and used for testing the middleware
DebugMiddleware::getSelfInstance()->output('');
- // Set it in its own class. This will set it in the registry
- $debugInstance->setDebugInstance($debugInstance);
+ // Set it in registry
+ GenericRegistry::getRegistry()->addInstance('debug', $debugInstance);
} else {
// Get instance from registry
- $debugInstance = Registry::getRegistry()->getDebugInstance();
+ $debugInstance = GenericRegistry::getRegistry()->getDebugInstance();
}
// Return it
*
* @param $message Message we shall send out...
* @param $doPrint Whether print or die here (default: print)
- * @paran $stripTags Whether to strip tags (default: FALSE)
+ * @paran $stripTags Whether to strip tags (default: false)
* @return void
*/
- public function debugOutput ($message, $doPrint = TRUE, $stripTags = FALSE) {
+ public function debugOutput ($message, $doPrint = true, $stripTags = false) {
// Set debug instance to NULL
$debugInstance = NULL;
+ // Get backtrace
+ $backtrace = debug_backtrace(!DEBUG_BACKTRACE_PROVIDE_OBJECT);
+
+ // Is function partialStub/__callStatic ?
+ if (in_array($backtrace[1]['function'], array('partialStub', '__call', '__callStatic'))) {
+ // Prepend class::function:line from 3rd element
+ $message = sprintf('[%s::%s:%d]: %s',
+ $backtrace[2]['class'],
+ $backtrace[2]['function'],
+ (isset($backtrace[2]['line']) ? $backtrace[2]['line'] : '0'),
+ $message
+ );
+ } else {
+ // Prepend class::function:line from 2nd element
+ $message = sprintf('[%s::%s:%d]: %s',
+ $backtrace[1]['class'],
+ $backtrace[1]['function'],
+ (isset($backtrace[1]['line']) ? $backtrace[1]['line'] : '0'),
+ $message
+ );
+ }
+
// Try it:
try {
// Get debug instance
// Use debug output handler
$debugInstance->output($message, $stripTags);
- if ($doPrint === FALSE) {
+ if ($doPrint === false) {
// Die here if not printed
exit();
- } // END - if
+ }
} else {
// Are debug times enabled?
- if ($this->getConfigInstance()->getConfigEntry('debug_' . self::getResponseTypeFromSystem() . '_output_timings') == 'Y') {
+ if (FrameworkBootstrap::getConfigurationInstance()->getConfigEntry('debug_' . FrameworkBootstrap::getRequestTypeFromSystem() . '_output_timings') == 'Y') {
// Prepent it
$message = $this->getPrintableExecutionTime() . $message;
- } // END - if
+ }
// Put directly out
- if ($doPrint === TRUE) {
+ if ($doPrint === true) {
// Print message
$this->outputLine($message);
} else {
}
}
- /**
- * Converts e.g. a command from URL to a valid class by keeping out bad characters
- *
- * @param $str The string, what ever it is needs to be converted
- * @return $className Generated class name
- */
- public static final function convertToClassName ($str) {
- // Init class name
- $className = '';
-
- // Convert all dashes in underscores
- $str = self::convertDashesToUnderscores($str);
-
- // Now use that underscores to get classname parts for hungarian style
- foreach (explode('_', $str) as $strPart) {
- // Make the class name part lower case and first upper case
- $className .= ucfirst(strtolower($strPart));
- } // END - foreach
-
- // Return class name
- 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
*
$errorArray['message'],
$errorArray['type']
);
- } // END - if
+ }
// Add line number to the code
foreach (explode(chr(10), $phpCode) as $lineNo => $code) {
($lineNo + 1),
htmlentities($code, ENT_QUOTES)
);
- } // END - foreach
+ }
// Return the code
return $markedCode;
}
- /**
- * Filter a given GMT timestamp (non Uni* stamp!) to make it look more
- * beatiful for web-based front-ends. If null is given a message id
- * null_timestamp will be resolved and returned.
- *
- * @param $timestamp Timestamp to prepare (filter) for display
- * @return $readable A readable timestamp
- */
- public function doFilterFormatTimestamp ($timestamp) {
- // Default value to return
- $readable = '???';
-
- // Is the timestamp null?
- if (is_null($timestamp)) {
- // Get a message string
- $readable = $this->getLanguageInstance()->getMessage('null_timestamp');
- } else {
- switch ($this->getLanguageInstance()->getLanguageCode()) {
- case 'de': // German format is a bit different to default
- // Split the GMT stamp up
- $dateTime = explode(' ', $timestamp );
- $dateArray = explode('-', $dateTime[0]);
- $timeArray = explode(':', $dateTime[1]);
-
- // Construct the timestamp
- $readable = sprintf($this->getConfigInstance()->getConfigEntry('german_date_time'),
- $dateArray[0],
- $dateArray[1],
- $dateArray[2],
- $timeArray[0],
- $timeArray[1],
- $timeArray[2]
- );
- break;
-
- default: // Default is pass-through
- $readable = $timestamp;
- break;
- } // END - switch
- }
-
- // Return the stamp
- return $readable;
- }
-
- /**
- * Filter a given number into a localized number
- *
- * @param $value The raw value from e.g. database
- * @return $localized Localized value
- */
- public function doFilterFormatNumber ($value) {
- // Generate it from config and localize dependencies
- switch ($this->getLanguageInstance()->getLanguageCode()) {
- case 'de': // German format is a bit different to default
- $localized = number_format($value, $this->getConfigInstance()->getConfigEntry('decimals'), ',', '.');
- break;
-
- default: // US, etc.
- $localized = number_format($value, $this->getConfigInstance()->getConfigEntry('decimals'), '.', ',');
- break;
- } // END - switch
-
- // Return it
- return $localized;
- }
-
/**
* "Getter" for databse entry
*
* @return $entry An array with database entries
* @throws NullPointerException If the database result is not found
* @throws InvalidDatabaseResultException If the database result is invalid
+ * @todo Monolithic method, should be moved to proper classes
*/
protected final function getDatabaseEntry () {
// Is there an instance?
if (!$this->getResultInstance() instanceof SearchableResult) {
// Throw an exception here
throw new NullPointerException($this, self::EXCEPTION_IS_NULL_POINTER);
- } // END - if
+ }
// Rewind it
$this->getResultInstance()->rewind();
// Do we have an entry?
- if ($this->getResultInstance()->valid() === FALSE) {
+ if ($this->getResultInstance()->valid() === false) {
// @TODO Move the constant to e.g. BaseDatabaseResult when there is a non-cached database result available
throw new InvalidDatabaseResultException(array($this, $this->getResultInstance()), CachedDatabaseResult::EXCEPTION_INVALID_DATABASE_RESULT);
- } // END - if
+ }
// Get next entry
$this->getResultInstance()->next();
* @return $fieldValue Field value from the user
* @throws NullPointerException If the result instance is null
*/
- public final function getField ($fieldName) {
+ public final function getField (string $fieldName) {
// Default field value
$fieldValue = NULL;
if (is_null($resultInstance)) {
// Then the user instance is no longer valid (expired cookies?)
throw new NullPointerException($this, self::EXCEPTION_IS_NULL_POINTER);
- } // END - if
+ }
// Get current array
$fieldArray = $resultInstance->current();
- //* DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput($fieldName.':<pre>'.print_r($fieldArray, TRUE).'</pre>');
+ //* 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)) {
$fieldValue = $fieldArray[$fieldName2];
} elseif (defined('DEVELOPER')) {
// Missing field entry, may require debugging
- self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('[' . __METHOD__ . ':' . __LINE__ . ']:fieldArray<pre>=' . print_r($fieldArray, TRUE) . '</pre>,fieldName=' . $fieldName . ' not found!');
+ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('[' . __METHOD__ . ':' . __LINE__ . ']:fieldArray<pre>=' . print_r($fieldArray, true) . '</pre>,fieldName=' . $fieldName . ' not found!');
} else {
// Missing field entry, may require debugging
self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('[' . __METHOD__ . ':' . __LINE__ . ']:fieldName=' . $fieldName . ' not found!');
* @return $isSet Whether the given field name is set
* @throws NullPointerException If the result instance is null
*/
- public function isFieldSet ($fieldName) {
+ public function isFieldSet (string $fieldName) {
// Get result instance
$resultInstance = $this->getResultInstance();
if (is_null($resultInstance)) {
// Then the user instance is no longer valid (expired cookies?)
throw new NullPointerException($this, self::EXCEPTION_IS_NULL_POINTER);
- } // END - if
+ }
// Get current array
$fieldArray = $resultInstance->current();
- //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('[' . $this->__toString() . ':' . __LINE__ . '] fieldName=' . $fieldName . ',fieldArray=<pre>'.print_r($fieldArray, TRUE).'</pre>');
+ //* 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]);
return $isSet;
}
- /**
- * Flushs all pending updates to the database layer
- *
- * @return void
- */
- public function flushPendingUpdates () {
- // Get result instance
- $resultInstance = $this->getResultInstance();
-
- // Do we have data to update?
- if ((is_object($resultInstance)) && ($resultInstance->ifDataNeedsFlush())) {
- // Get wrapper class name config entry
- $configEntry = $resultInstance->getUpdateInstance()->getWrapperConfigEntry();
-
- // Create object instance
- $wrapperInstance = DatabaseWrapperFactory::createWrapperByConfiguredName($configEntry);
-
- // Yes, then send the whole result to the database layer
- $wrapperInstance->doUpdateByResult($this->getResultInstance());
- } // END - if
- }
-
/**
* Outputs a deprecation warning to the developer.
*
*/
public function getMilliTime () {
// Get the time of day as float
- $milliTime = gettimeofday(TRUE);
+ $milliTime = gettimeofday(true);
// Return it
return $milliTime;
*/
public function idle ($milliSeconds) {
// Sleep is fine by default
- $hasSlept = TRUE;
+ $hasSlept = true;
// Idle so long with found function
if (function_exists('time_sleep_until')) {
// Return result
return $hasSlept;
}
- /**
- * Converts a hexadecimal string, even with negative sign as first string to
- * a decimal number using BC functions.
- *
- * This work is based on comment #86673 on php.net documentation page at:
- * <http://de.php.net/manual/en/function.dechex.php#86673>
- *
- * @param $hex Hexadecimal string
- * @return $dec Decimal number
- */
- protected function hex2dec ($hex) {
- // Convert to all lower-case
- $hex = strtolower($hex);
-
- // Detect sign (negative/positive numbers)
- $sign = '';
- if (substr($hex, 0, 1) == '-') {
- $sign = '-';
- $hex = substr($hex, 1);
- } // END - if
-
- // Decode the hexadecimal string into a decimal number
- $dec = 0;
- for ($i = strlen($hex) - 1, $e = 1; $i >= 0; $i--, $e = bcmul($e, 16)) {
- $factor = self::$hexdec[substr($hex, $i, 1)];
- $dec = bcadd($dec, bcmul($factor, $e));
- } // END - for
-
- // Return the decimal number
- return $sign . $dec;
- }
-
- /**
- * Converts even very large decimal numbers, also signed, to a hexadecimal
- * string.
- *
- * This work is based on comment #97756 on php.net documentation page at:
- * <http://de.php.net/manual/en/function.hexdec.php#97756>
- *
- * @param $dec Decimal number, even with negative sign
- * @param $maxLength Optional maximum length of the string
- * @return $hex Hexadecimal string
- */
- protected function dec2hex ($dec, $maxLength = 0) {
- // maxLength can be zero or devideable by 2
- assert(($maxLength == 0) || (($maxLength % 2) == 0));
-
- // Detect sign (negative/positive numbers)
- $sign = '';
- if ($dec < 0) {
- $sign = '-';
- $dec = abs($dec);
- } // END - if
-
- // Encode the decimal number into a hexadecimal string
- $hex = '';
- do {
- $hex = self::$dechex[($dec % (2 ^ 4))] . $hex;
- $dec /= (2 ^ 4);
- } while ($dec >= 1);
-
- /*
- * Leading zeros are required for hex-decimal "numbers". In some
- * situations more leading zeros are wanted, so check for both
- * conditions.
- */
- if ($maxLength > 0) {
- // Prepend more zeros
- $hex = str_pad($hex, $maxLength, '0', STR_PAD_LEFT);
- } elseif ((strlen($hex) % 2) != 0) {
- // Only make string's length dividable by 2
- $hex = '0' . $hex;
- }
-
- // Return the hexadecimal string
- return $sign . $hex;
- }
-
- /**
- * Converts a ASCII string (0 to 255) into a decimal number.
- *
- * @param $asc The ASCII string to be converted
- * @return $dec Decimal number
- */
- protected function asc2dec ($asc) {
- // Convert it into a hexadecimal number
- $hex = bin2hex($asc);
-
- // And back into a decimal number
- $dec = $this->hex2dec($hex);
-
- // Return it
- return $dec;
- }
-
- /**
- * Converts a decimal number into an ASCII string.
- *
- * @param $dec Decimal number
- * @return $asc An ASCII string
- */
- protected function dec2asc ($dec) {
- // First convert the number into a hexadecimal string
- $hex = $this->dec2hex($dec);
-
- // Then convert it into the ASCII string
- $asc = $this->hex2asc($hex);
-
- // Return it
- return $asc;
- }
-
- /**
- * Converts a hexadecimal number into an ASCII string. Negative numbers
- * are not allowed.
- *
- * @param $hex Hexadecimal string
- * @return $asc An ASCII string
- */
- protected function hex2asc ($hex) {
- // Check for length, it must be devideable by 2
- //* DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('hex='.$hex);
- assert((strlen($hex) % 2) == 0);
-
- // Walk the string
- $asc = '';
- for ($idx = 0; $idx < strlen($hex); $idx+=2) {
- // Get the decimal number of the chunk
- $part = hexdec(substr($hex, $idx, 2));
-
- // Add it to the final string
- $asc .= chr($part);
- } // END - for
-
- // Return the final string
- return $asc;
- }
/**
* Checks whether the given encoded data was encoded with Base64
*/
protected function isBase64Encoded ($encodedData) {
// Determine it
- $isBase64 = (@base64_decode($encodedData, TRUE) !== FALSE);
+ $isBase64 = (@base64_decode($encodedData, true) !== false);
// Return it
return $isBase64;
}
- /**
- * "Getter" to get response/request type from analysis of the system.
- *
- * @return $responseType Analyzed response type
- */
- protected static function getResponseTypeFromSystem () {
- // Default is console
- $responseType = 'console';
-
- // Is 'HTTP_HOST' set?
- if (isset($_SERVER['HTTP_HOST'])) {
- /*
- * Then it is a HTML response/request as RSS and so on may be
- * transfered over HTTP as well.
- */
- $responseType = 'html';
- } // END - if
-
- // Return it
- return $responseType;
- }
-
/**
* Gets a cache key from Criteria instance
*
* @param $onlyKeys Only use these keys for a cache key
* @return $cacheKey A cache key suitable for lookup/storage purposes
*/
- protected function getCacheKeyByCriteria (Criteria $criteriaInstance, array $onlyKeys = array()) {
+ protected function getCacheKeyByCriteria (Criteria $criteriaInstance, array $onlyKeys = []) {
// Generate it
+ //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('BASE-FRAMEWORK-SYSTEM: criteriaInstance=' . $criteriaInstance->__toString() . ',onlyKeys()=' . count($onlyKeys) . ' - CALLED!');
$cacheKey = sprintf('%s@%s',
$this->__toString(),
$criteriaInstance->getCacheKey($onlyKeys)
);
// And return it
- //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput($this->__toString() . ': cacheKey=' . $cacheKey);
+ //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('BASE-FRAMEWORK-SYSTEM: cacheKey=' . $cacheKey . ' - EXIT!');
return $cacheKey;
}
*/
protected function getPrintableExecutionTime () {
// Caculate the execution time
- $executionTime = microtime(TRUE) - $this->getStartupTime();
+ $executionTime = microtime(true) - $this->getStartupTime();
// Pack it in nice braces
$executionTime = sprintf('[ %01.5f ] ', $executionTime);
if (is_null(self::$hashLength)) {
// No, then hash a string and save its length.
self::$hashLength = strlen(self::hash('abc123'));
- } // END - if
+ }
// Return it
return self::$hashLength;
* @param $assertMismatch Whether to assert mismatches
* @return $ret The (hopefully) secured numbered value
*/
- public function bigintval ($num, $castValue = TRUE, $assertMismatch = FALSE) {
+ public function bigintval ($num, $castValue = true, $assertMismatch = false) {
// Filter all numbers out
$ret = preg_replace('/[^0123456789]/', '', $num);
// Shall we cast?
- if ($castValue === TRUE) {
+ if ($castValue === true) {
// Cast to biggest numeric type
$ret = (double) $ret;
- } // END - if
+ }
// Assert only if requested
- if ($assertMismatch === TRUE) {
+ if ($assertMismatch === true) {
// Has the whole value changed?
assert(('' . $ret . '' != '' . $num . '') && (!is_null($num)));
- } // END - if
+ }
// Return result
return $ret;
* @param $assertMismatch Whether to assert mismatches
* @return $ret The (hopefully) secured hext-numbered value
*/
- public function hexval ($num, $assertMismatch = FALSE) {
+ public function hexval ($num, $assertMismatch = false) {
// Filter all numbers out
$ret = preg_replace('/[^0123456789abcdefABCDEF]/', '', $num);
// Assert only if requested
- if ($assertMismatch === TRUE) {
+ if ($assertMismatch === true) {
// Has the whole value changed?
assert(('' . $ret . '' != '' . $num . '') && (!is_null($num)));
- } // END - if
+ }
// Return result
return $ret;
}
- /**
- * Checks whether start/end marker are set
- *
- * @param $data Data to be checked
- * @return $isset Whether start/end marker are set
- */
- public final function ifStartEndMarkersSet ($data) {
- // Determine it
- $isset = ((substr($data, 0, strlen(BaseRawDataHandler::STREAM_START_MARKER)) == BaseRawDataHandler::STREAM_START_MARKER) && (substr($data, -1 * strlen(BaseRawDataHandler::STREAM_END_MARKER), strlen(BaseRawDataHandler::STREAM_END_MARKER)) == BaseRawDataHandler::STREAM_END_MARKER));
-
- // ... and return it
- return $isset;
- }
-
/**
* Determines if an element is set in the generic array
*
// No, then abort here
trigger_error(__METHOD__ . ': keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ' not found.');
exit;
- } // END - if
+ }
// Debug message
- //* NOISY-DEBUG: */ $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',value=' . print_r($this->genericArray[$keyGroup][$subGroup], TRUE));
+ //* NOISY-DEBUG: */ $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',value=' . print_r($this->genericArray[$keyGroup][$subGroup], true));
// Return it
return $this->genericArray[$keyGroup][$subGroup];
*/
protected final function appendStringToGenericArrayKey ($keyGroup, $subGroup, $key, $value, $appendGlue = '') {
// Debug message
- //* NOISY-DEBUG: */ if (!is_object($value)) $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',key=' . $key . ',value[' . gettype($value) . ']=' . print_r($value, TRUE) . ',appendGlue=' . $appendGlue);
+ //* NOISY-DEBUG: */ if (!is_object($value)) $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',key=' . $key . ',value[' . gettype($value) . ']=' . print_r($value, true) . ',appendGlue=' . $appendGlue);
// Is it already there?
if ($this->isGenericArrayKeySet($keyGroup, $subGroup, $key)) {
*/
protected final function appendStringToGenericArrayElement ($keyGroup, $subGroup, $key, $element, $value, $appendGlue = '') {
// Debug message
- //* NOISY-DEBUG: */ if (!is_object($value)) $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',key=' . $key . ',element=' . $element . ',value[' . gettype($value) . ']=' . print_r($value, TRUE) . ',appendGlue=' . $appendGlue);
+ //* NOISY-DEBUG: */ if (!is_object($value)) $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',key=' . $key . ',element=' . $element . ',value[' . gettype($value) . ']=' . print_r($value, true) . ',appendGlue=' . $appendGlue);
// Is it already there?
if ($this->isGenericArrayElementSet($keyGroup, $subGroup, $key, $element)) {
*/
protected final function setStringGenericArrayElement ($keyGroup, $subGroup, $key, $element, $value, $appendGlue = '') {
// Debug message
- //* NOISY-DEBUG: */ if (!is_object($value)) $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',key=' . $key . ',element=' . $element . ',value[' . gettype($value) . ']=' . print_r($value, TRUE) . ',appendGlue=' . $appendGlue);
+ //* NOISY-DEBUG: */ if (!is_object($value)) $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',key=' . $key . ',element=' . $element . ',value[' . gettype($value) . ']=' . print_r($value, true) . ',appendGlue=' . $appendGlue);
// Set it
$this->genericArray[$keyGroup][$subGroup][$key][$element] = (string) $value;
* @param $forceInit Optionally force initialization
* @return void
*/
- protected final function initGenericArrayGroup ($keyGroup, $subGroup, $forceInit = FALSE) {
+ protected final function initGenericArrayGroup ($keyGroup, $subGroup, $forceInit = false) {
// Debug message
//* NOISY-DEBUG: */ $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',forceInit=' . intval($forceInit));
// Is it already set?
- if (($forceInit === FALSE) && ($this->isGenericArrayGroupSet($keyGroup, $subGroup))) {
+ if (($forceInit === false) && ($this->isGenericArrayGroupSet($keyGroup, $subGroup))) {
// Already initialized
trigger_error(__METHOD__ . ':keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ' already initialized.');
exit;
- } // END - if
+ }
// Initialize it
- $this->genericArray[$keyGroup][$subGroup] = array();
+ $this->genericArray[$keyGroup][$subGroup] = [];
}
/**
* @param $forceInit Optionally force initialization
* @return void
*/
- protected final function initGenericArrayKey ($keyGroup, $subGroup, $key, $forceInit = FALSE) {
+ protected final function initGenericArrayKey ($keyGroup, $subGroup, $key, $forceInit = false) {
// Debug message
//* NOISY-DEBUG: */ $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',key=' . $key . ',forceInit=' . intval($forceInit));
// Is it already set?
- if (($forceInit === FALSE) && ($this->isGenericArrayKeySet($keyGroup, $subGroup, $key))) {
+ if (($forceInit === false) && ($this->isGenericArrayKeySet($keyGroup, $subGroup, $key))) {
// Already initialized
trigger_error(__METHOD__ . ':keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',key=' . $key . ' already initialized.');
exit;
- } // END - if
+ }
// Initialize it
- $this->genericArray[$keyGroup][$subGroup][$key] = array();
+ $this->genericArray[$keyGroup][$subGroup][$key] = [];
}
/**
* @param $forceInit Optionally force initialization
* @return void
*/
- protected final function initGenericArrayElement ($keyGroup, $subGroup, $key, $element, $forceInit = FALSE) {
+ protected final function initGenericArrayElement ($keyGroup, $subGroup, $key, $element, $forceInit = false) {
// Debug message
//* NOISY-DEBUG: */ $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',key=' . $key . ',element=' . $element . ',forceInit=' . intval($forceInit));
// Is it already set?
- if (($forceInit === FALSE) && ($this->isGenericArrayElementSet($keyGroup, $subGroup, $key, $element))) {
+ if (($forceInit === false) && ($this->isGenericArrayElementSet($keyGroup, $subGroup, $key, $element))) {
// Already initialized
trigger_error(__METHOD__ . ':keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',key=' . $key . ',element=' . $element . ' already initialized.');
exit;
- } // END - if
+ }
// Initialize it
- $this->genericArray[$keyGroup][$subGroup][$key][$element] = array();
+ $this->genericArray[$keyGroup][$subGroup][$key][$element] = [];
}
/**
*/
protected final function pushValueToGenericArrayKey ($keyGroup, $subGroup, $key, $value) {
// Debug message
- //* NOISY-DEBUG: */ if (!is_object($value)) $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',key=' . $key . ',value[' . gettype($value) . ']=' . print_r($value, TRUE));
+ //* NOISY-DEBUG: */ if (!is_object($value)) $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',key=' . $key . ',value[' . gettype($value) . ']=' . print_r($value, true));
// Is it set?
if (!$this->isGenericArrayKeySet($keyGroup, $subGroup, $key)) {
// Initialize array
$this->initGenericArrayKey($keyGroup, $subGroup, $key);
- } // END - if
+ }
// Then push it
$count = array_push($this->genericArray[$keyGroup][$subGroup][$key], $value);
// Return count
- //* DEBUG: */ print(__METHOD__ . ': genericArray=' . print_r($this->genericArray[$keyGroup][$subGroup][$key], TRUE));
+ //* DEBUG: */ print(__METHOD__ . ': genericArray=' . print_r($this->genericArray[$keyGroup][$subGroup][$key], true));
//* DEBUG: */ print(__METHOD__ . ': count=' . $count . PHP_EOL);
return $count;
}
*/
protected final function pushValueToGenericArrayElement ($keyGroup, $subGroup, $key, $element, $value) {
// Debug message
- //* NOISY-DEBUG: */ if (!is_object($value)) $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',key=' . $key . ',element=' . $element . ',value[' . gettype($value) . ']=' . print_r($value, TRUE));
+ //* NOISY-DEBUG: */ if (!is_object($value)) $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',key=' . $key . ',element=' . $element . ',value[' . gettype($value) . ']=' . print_r($value, true));
// Is it set?
if (!$this->isGenericArrayElementSet($keyGroup, $subGroup, $key, $element)) {
// Initialize array
$this->initGenericArrayElement($keyGroup, $subGroup, $key, $element);
- } // END - if
+ }
// Then push it
$count = array_push($this->genericArray[$keyGroup][$subGroup][$key][$element], $value);
// Return count
- //* DEBUG: */ print(__METHOD__ . ': genericArray=' . print_r($this->genericArray[$keyGroup][$subGroup][$key], TRUE));
+ //* DEBUG: */ print(__METHOD__ . ': genericArray=' . print_r($this->genericArray[$keyGroup][$subGroup][$key], true));
//* DEBUG: */ print(__METHOD__ . ': count=' . $count . PHP_EOL);
return $count;
}
// Not found
trigger_error(__METHOD__ . ': keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',key=' . $key . ' not found.');
exit;
- } // END - if
+ }
// Then "pop" it
$value = array_pop($this->genericArray[$keyGroup][$subGroup][$key]);
// Return value
- //* DEBUG: */ print(__METHOD__ . ': genericArray=' . print_r($this->genericArray[$keyGroup][$subGroup][$key], TRUE));
- //* DEBUG: */ print(__METHOD__ . ': value[' . gettype($value) . ']=' . print_r($value, TRUE) . PHP_EOL);
+ //* DEBUG: */ print(__METHOD__ . ': genericArray=' . print_r($this->genericArray[$keyGroup][$subGroup][$key], true));
+ //* DEBUG: */ print(__METHOD__ . ': value[' . gettype($value) . ']=' . print_r($value, true) . PHP_EOL);
return $value;
}
// Not found
trigger_error(__METHOD__ . ': keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',key=' . $key . ' not found.');
exit;
- } // END - if
+ }
// Then "shift" it
$value = array_shift($this->genericArray[$keyGroup][$subGroup][$key]);
// Return value
- //* DEBUG: */ print(__METHOD__ . ': genericArray=' . print_r($this->genericArray[$keyGroup][$subGroup][$key], TRUE));
- //* DEBUG: */ print(__METHOD__ . ': value[' . gettype($value) . ']=' . print_r($value, TRUE) . PHP_EOL);
+ //* DEBUG: */ print(__METHOD__ . ': genericArray=' . print_r($this->genericArray[$keyGroup][$subGroup][$key], true));
+ //* DEBUG: */ print(__METHOD__ . ': value[' . gettype($value) . ']=' . print_r($value, true) . PHP_EOL);
return $value;
}
// Abort here
trigger_error(__METHOD__ . ': keyGroup=' . $keyGroup . ' not found.');
exit;
- } // END - if
+ }
// Then count it
$count = count($this->genericArray[$keyGroup]);
// Abort here
trigger_error(__METHOD__ . ': keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ' not found.');
exit;
- } // END - if
+ }
// Then count it
$count = count($this->genericArray[$keyGroup][$subGroup]);
// Then abort here
trigger_error(__METHOD__ . ': keyGroup=' . $keyGroup . ' does not exist.');
exit;
- } // END - if
+ }
// Return it
return $this->genericArray[$keyGroup];
*/
protected final function setGenericArrayKey ($keyGroup, $subGroup, $key, $value) {
// Debug message
- //* NOISY-DEBUG: */ if (!is_object($value)) $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',key=' . $key . ',value[' . gettype($value) . ']=' . print_r($value, TRUE));
+ //* NOISY-DEBUG: */ if (!is_object($value)) $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',key=' . $key . ',value[' . gettype($value) . ']=' . print_r($value, true));
// Set value here
$this->genericArray[$keyGroup][$subGroup][$key] = $value;
// Then abort here
trigger_error(__METHOD__ . ': keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',key=' . $key . ' does not exist.');
exit;
- } // END - if
+ }
// Return it
return $this->genericArray[$keyGroup][$subGroup][$key];
*/
protected final function setGenericArrayElement ($keyGroup, $subGroup, $key, $element, $value) {
// Debug message
- //* NOISY-DEBUG: */ if (!is_object($value)) $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',key=' . $key . ',element=' . $element . ',value[' . gettype($value) . ']=' . print_r($value, TRUE));
+ //* NOISY-DEBUG: */ if (!is_object($value)) $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',key=' . $key . ',element=' . $element . ',value[' . gettype($value) . ']=' . print_r($value, true));
// Then set it
$this->genericArray[$keyGroup][$subGroup][$key][$element] = $value;
// Then abort here
trigger_error(__METHOD__ . ': keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',key=' . $key . ',element=' . $element . ' does not exist.');
exit;
- } // END - if
+ }
// Return it
return $this->genericArray[$keyGroup][$subGroup][$key][$element];
*/
protected function initWebOutputInstance () {
// Get application instance
- $applicationInstance = Registry::getRegistry()->getInstance('app');
-
- // Is this a response instance?
- if ($this instanceof Responseable) {
- // Then set it in application instance
- $applicationInstance->setResponseInstance($this);
- } // END - if
+ $applicationInstance = GenericRegistry::getRegistry()->getInstance('application');
// Init web output instance
$outputInstance = ObjectFactory::createObjectByConfiguredName('output_class', array($applicationInstance));
}
/**
- * Translates boolean TRUE to 'Y' and FALSE to 'N'
+ * Translates boolean true to 'Y' and false to 'N'
*
* @param $boolean Boolean value
* @return $translated Translated boolean value
*/
- public static final function translateBooleanToYesNo ($boolean) {
+ public static final function translateBooleanToYesNo (bool $boolean) {
// Make sure it is really boolean
assert(is_bool($boolean));
// "Translate" it
- $translated = ($boolean === TRUE) ? 'Y' : 'N';
+ $translated = ($boolean === true) ? 'Y' : 'N';
// ... and return it
return $translated;
}
- /**
- * Encodes raw data (almost any type) by "serializing" it and then pack it
- * into a "binary format".
- *
- * @param $rawData Raw data (almost any type)
- * @return $encoded Encoded data
- */
- protected function encodeData ($rawData) {
- // Make sure no objects or resources pass through
- assert(!is_object($rawData));
- assert(!is_resource($rawData));
-
- // First "serialize" it (json_encode() is faster than serialize())
- $encoded = $this->packString(json_encode($rawData));
-
- // And return it
- return $encoded;
- }
-
- /**
- * Pack a string into a "binary format". Please execuse me that this is
- * widely undocumented. :-(
- *
- * @param $str Unpacked string
- * @return $packed Packed string
- * @todo Improve documentation
- */
- protected function packString ($str) {
- // Debug message
- //* NOISY-DEBUG */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('str=' . $str . ' - CALLED!');
-
- // First compress the string (gzcompress is okay)
- $str = gzcompress($str);
-
- // Init variable
- $packed = '';
-
- // And start the "encoding" loop
- for ($idx = 0; $idx < strlen($str); $idx += $this->packingData[$this->archArrayElement]['step']) {
- $big = 0;
- for ($i = 0; $i < $this->packingData[$this->archArrayElement]['step']; $i++) {
- $factor = ($this->packingData[$this->archArrayElement]['step'] - 1 - $i);
-
- if (($idx + $i) <= strlen($str)) {
- $ord = ord(substr($str, ($idx + $i), 1));
-
- $add = $ord * pow(256, $factor);
-
- $big += $add;
-
- //print 'idx=' . $idx . ',i=' . $i . ',ord=' . $ord . ',factor=' . $factor . ',add=' . $add . ',big=' . $big . PHP_EOL;
- } // END - if
- } // END - for
-
- $l = ($big & $this->packingData[$this->archArrayElement]['left']) >>$this->packingData[$this->archArrayElement]['factor'];
- $r = $big & $this->packingData[$this->archArrayElement]['right'];
-
- $chunk = str_pad(pack($this->packingData[$this->archArrayElement]['format'], $l, $r), 8, '0', STR_PAD_LEFT);
- //* NOISY-DEBUG */ print 'big=' . $big . ',chunk('.strlen($chunk) . ')='.md5($chunk).PHP_EOL;
-
- $packed .= $chunk;
- } // END - for
-
- // Return it
- //* NOISY-DEBUG */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('packed=' . $packed . ' - EXIT!');
- return $packed;
- }
-
- /**
- * Checks whether the given file/path is in open_basedir(). This does not
- * gurantee that the file is actually readable and/or writeable. If you need
- * such gurantee then please use isReadableFile() instead.
- *
- * @param $filePathName Name of the file/path to be checked
- * @return $isReachable Whether it is within open_basedir()
- */
- protected static function isReachableFilePath ($filePathName) {
- // Is not reachable by default
- $isReachable = FALSE;
-
- // Get open_basedir parameter
- $openBaseDir = ini_get('open_basedir');
-
- // Is it set?
- if (!empty($openBaseDir)) {
- // Check all entries
- foreach (explode(PATH_SEPARATOR, $openBaseDir) as $dir) {
- // Check on existence
- if (substr($filePathName, 0, strlen($dir)) == $dir) {
- // Is reachable
- $isReachable = TRUE;
- } // END - if
- } // END - foreach
- } else {
- // If open_basedir is not set, all is allowed
- $isReachable = TRUE;
- }
-
- // Return status
- return $isReachable;
- }
-
- /**
- * Checks whether the give file is within open_basedir() (done by
- * isReachableFilePath()), is actually a file and is readable.
- *
- * @param $fileName Name of the file to be checked
- * @return $isReadable Whether the file is readable (and therefor exists)
- */
- public static function isReadableFile ($fileName) {
- // Default is not readable
- $isReadable = FALSE;
-
- // Is within parameters, so check if it is a file and readable
- $isReadable = ((self::isReachableFilePath($fileName)) && (file_exists($fileName)) && (is_file($fileName)) && (is_readable($fileName)));
-
- // Return status
- return $isReadable;
- }
-
/**
* 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);
- } // END - if
+ throw new PathWriteProtectedException($infoInstance, self::EXCEPTION_PATH_CANNOT_BE_WRITTEN);
+ }
// Add it
- $fqfn = $basePath . '/' . $fileName;
+ $tempInstance = new SplFileInfo($basePath . DIRECTORY_SEPARATOR . $infoInstance->getBasename());
// Is it reachable?
- if (!self::isReachableFilePath($fqfn)) {
+ if (!FrameworkBootstrap::isReachableFilePath($tempInstance)) {
// Not reachable
- throw new FileIoException($fqfn, self::EXCEPTION_FILE_NOT_REACHABLE);
- } // END - if
+ throw new FileIoException($tempInstance, self::EXCEPTION_FILE_NOT_REACHABLE);
+ }
// Return it
- return $fqfn;
+ return $tempInstance;
}
/**
* "Getter" for a printable state name
*
* @return $stateName Name of the node's state in a printable format
+ * @todo Move this class away from this monolithic place (not whole class is monolithic)
*/
public final function getPrintableState () {
// Default is 'null'
if ($stateInstance instanceof Stateable) {
// Then use that state name
$stateName = $stateInstance->getStateName();
- } // END - if
+ }
// Return result
return $stateName;
}
- /**
- * Handles socket error for given socket resource and peer data. This method
- * validates $socketResource if it is a valid resource (see is_resource())
- * but assumes valid data in array $recipientData, except that
- * count($recipientData) is always 2.
- *
- * @param $method Value of __METHOD__ from calling method
- * @param $line Value of __LINE__ from calling method
- * @param $socketResource A valid socket resource
- * @param $socketData A valid socket data array (0 = IP/file name, 1 = port)
- * @return void
- * @throws InvalidSocketException If $socketResource is no socket resource
- * @throws NoSocketErrorDetectedException If socket_last_error() gives zero back
- * @todo Move all this socket-related stuff into own class, most of it resides in BaseListener
- */
- protected final function handleSocketError ($method, $line, $socketResource, array $socketData) {
- // This method handles only socket resources
- if (!is_resource($socketResource)) {
- // No resource, abort here
- throw new InvalidSocketException(array($this, $socketResource), BaseListener::EXCEPTION_INVALID_SOCKET);
- } // END - if
-
- // Check socket array, 1st element is mostly IP address (or file name), 2nd is port number
- //* DEBUG-DIE: */ die(__METHOD__ . ':socketData=' . print_r($socketData, TRUE));
- assert(isset($socketData[0]));
- assert(isset($socketData[1]));
-
- // Get error code for first validation (0 is not an error)
- $errorCode = socket_last_error($socketResource);
-
- // If the error code is zero, someone called this method without an error
- if ($errorCode == 0) {
- // No error detected (or previously cleared outside this method)
- throw new NoSocketErrorDetectedException(array($this, $socketResource), BaseListener::EXCEPTION_NO_SOCKET_ERROR);
- } // END - if
-
- // Get handler (method) name
- $handlerName = $this->getSocketErrorHandlerFromCode($errorCode);
-
- // Call-back the error handler method
- call_user_func_array(array($this, $handlerName), array($socketResource, $socketData));
-
- // Finally clear the error because it has been handled
- socket_clear_error($socketResource);
- }
-
}
projects / core.git / blobdiff