From: Roland Häder Date: Thu, 21 Aug 2025 22:05:41 +0000 (+0200) Subject: Continued: X-Git-Url: https://git.mxchange.org/?a=commitdiff_plain;h=13160e1491f904a6c227b3934817a2fc00c038ba;p=core.git Continued: - added even more type-hints --- diff --git a/framework/main/classes/database/backend/class_BaseDatabaseBackend.php b/framework/main/classes/database/backend/class_BaseDatabaseBackend.php index fd1f5424..e17f3b4f 100644 --- a/framework/main/classes/database/backend/class_BaseDatabaseBackend.php +++ b/framework/main/classes/database/backend/class_BaseDatabaseBackend.php @@ -63,7 +63,7 @@ abstract class BaseDatabaseBackend extends BaseFrameworkSystem implements Databa * * @return $lastException Last thrown exception */ - public final function getLastException () { + public final function getLastException (): FrameworkException { return $this->lastException; } @@ -73,7 +73,7 @@ abstract class BaseDatabaseBackend extends BaseFrameworkSystem implements Databa * @param $lastException Last thrown exception * @return void */ - public final function setLastException (FrameworkException $exceptionInstance) { + public final function setLastException (FrameworkException $exceptionInstance): void { $this->lastException = $exceptionInstance; } @@ -83,7 +83,7 @@ abstract class BaseDatabaseBackend extends BaseFrameworkSystem implements Databa * * @return void */ - protected final function resetLastException () { + protected final function resetLastException (): void { $this->lastException = NULL; } @@ -93,6 +93,6 @@ abstract class BaseDatabaseBackend extends BaseFrameworkSystem implements Databa * @param $data An array with possible non-public data that needs to be removed. * @return $data A cleaned up array with only public data. */ - public abstract function removeNonPublicDataFromArray (array $data); + public abstract function removeNonPublicDataFromArray (array $data): array; } diff --git a/framework/main/classes/database/backend/lfdb_legacy/class_CachedLocalFileDatabase.php b/framework/main/classes/database/backend/lfdb_legacy/class_CachedLocalFileDatabase.php index b0043b30..cea1d5e6 100644 --- a/framework/main/classes/database/backend/lfdb_legacy/class_CachedLocalFileDatabase.php +++ b/framework/main/classes/database/backend/lfdb_legacy/class_CachedLocalFileDatabase.php @@ -110,7 +110,7 @@ class CachedLocalFileDatabase extends BaseDatabaseBackend implements DatabaseBac * * @return $databaseInstance An instance of CachedLocalFileDatabase */ - public static final function createCachedLocalFileDatabase () { + public static final function createCachedLocalFileDatabase (): DatabaseBackend { // Get an instance //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage('CACHED-LOCAL-FILE-DATABASE: CALLED!'); $databaseInstance = new CachedLocalFileDatabase(); @@ -135,7 +135,7 @@ class CachedLocalFileDatabase extends BaseDatabaseBackend implements DatabaseBac * @param $infoInstance The FQFN of the last read file * @return void */ - private function setLastFile (SplFileInfo $infoInstance) { + private function setLastFile (SplFileInfo $infoInstance): void { // Cast string and set it $this->lastFile = $infoInstance; } @@ -145,7 +145,7 @@ class CachedLocalFileDatabase extends BaseDatabaseBackend implements DatabaseBac * * @return $lastFile The last read file's name with full path */ - public final function getLastFile () { + public final function getLastFile (): SplFileInfo { return $this->lastFile; } @@ -155,7 +155,7 @@ class CachedLocalFileDatabase extends BaseDatabaseBackend implements DatabaseBac * @param $contents An array with header and data elements * @return void */ - private function setLastFileContents (array $contents) { + private function setLastFileContents (array $contents): void { // Set array $this->lastContents = $contents; } @@ -165,7 +165,7 @@ class CachedLocalFileDatabase extends BaseDatabaseBackend implements DatabaseBac * * @return $lastContent The array with elements 'header' and 'data'. */ - public final function getLastContents () { + public final function getLastContents (): array { return $this->lastContents; } @@ -174,7 +174,7 @@ class CachedLocalFileDatabase extends BaseDatabaseBackend implements DatabaseBac * * @return $fileExtension The array with elements 'header' and 'data'. */ - public final function getFileExtension () { + public final function getFileExtension (): string { return $this->fileExtension; } @@ -183,7 +183,7 @@ class CachedLocalFileDatabase extends BaseDatabaseBackend implements DatabaseBac * * @return $indexKey Index key */ - public final function getIndexKey () { + public final function getIndexKey (): string { return $this->indexKey; } @@ -193,7 +193,7 @@ class CachedLocalFileDatabase extends BaseDatabaseBackend implements DatabaseBac * @param $infoInstance An instance of a SplFileInfo class * @return $dataArray */ - private function getDataArrayFromFile (SplFileInfo $infoInstance) { + private function getDataArrayFromFile (SplFileInfo $infoInstance): array { // Init compressed data //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage(sprintf('CACHED-LOCAL-FILE-DATABASE: infoInstance=%s - CALLED!', $infoInstance->__toString())); $compressedData = $this->getFileIoInstance()->loadFileContents($infoInstance); @@ -224,7 +224,7 @@ class CachedLocalFileDatabase extends BaseDatabaseBackend implements DatabaseBac * @param $dataArray An array with all the data we shall write * @return void */ - private function writeDataArrayToFqfn (SplFileInfo $infoInstance, array $dataArray) { + private function writeDataArrayToFqfn (SplFileInfo $infoInstance, array $dataArray): void { // Serialize and compress it //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage('CACHED-LOCAL-FILE-DATABASE: Flushing ' . count($dataArray) . ' elements to database file ' . $infoInstance . ' ...'); $compressedData = $this->getCompressorChannelInstance()->getCompressor()->compressStream(json_encode($dataArray)); @@ -243,7 +243,7 @@ class CachedLocalFileDatabase extends BaseDatabaseBackend implements DatabaseBac * @param $dataSetInstance An instance of a database set class * @return $infoArray An array with all table informations */ - private function getContentsFromTableInfoFile (StoreableCriteria $dataSetInstance) { + private function getContentsFromTableInfoFile (StoreableCriteria $dataSetInstance): array { // Default content is no data //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage(sprintf('CACHED-LOCAL-FILE-DATABASE: dataSetInstance=%s - CALLED!', $dataSetInstance->__toString())); $infoArray = []; @@ -271,7 +271,7 @@ class CachedLocalFileDatabase extends BaseDatabaseBackend implements DatabaseBac * @param $rowName Name of the row * @return $infoInstance An instance of a SplFileInfo class */ - private function generateFileFromDataSet (Criteria $dataSetInstance, string $rowName) { + private function generateFileFromDataSet (Criteria $dataSetInstance, string $rowName): SplFileInfo { // Instanciate new file object //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage(sprintf('CACHED-LOCAL-FILE-DATABASE: dataSetInstance=%s,rowName=%s - CALLED!', $dataSetInstance->__toString(), $rowName)); $infoInstance = new SplFileInfo(FrameworkBootstrap::getConfigurationInstance()->getConfigEntry('local_database_path') . $dataSetInstance->getTableName() . DIRECTORY_SEPARATOR . $rowName . '.' . $this->getFileExtension()); @@ -287,7 +287,7 @@ class CachedLocalFileDatabase extends BaseDatabaseBackend implements DatabaseBac * @param $dataSetInstance An instance of a database set class * @return void */ - private function createTableInfoFile (StoreableCriteria $dataSetInstance) { + private function createTableInfoFile (StoreableCriteria $dataSetInstance): void { // Get table name //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage(sprintf('CACHED-LOCAL-FILE-DATABASE: dataSetInstance=%s - CALLED!', $dataSetInstance->__toString())); $tableName = $dataSetInstance->getTableName(); @@ -317,7 +317,7 @@ class CachedLocalFileDatabase extends BaseDatabaseBackend implements DatabaseBac * @param $dataSetInstance An instance of a database set class * @return void */ - private function updateTableInfoFile (StoreableCriteria $dataSetInstance) { + private function updateTableInfoFile (StoreableCriteria $dataSetInstance): void { // Get table name from criteria //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage(sprintf('CACHED-LOCAL-FILE-DATABASE: dataSetInstance=%s - CALLED!', $dataSetInstance->__toString())); $tableName = $dataSetInstance->getTableName(); @@ -345,7 +345,7 @@ class CachedLocalFileDatabase extends BaseDatabaseBackend implements DatabaseBac * @param $dataSetInstance An instance of a database set class * @return void */ - private function updatePrimaryKey (StoreableCriteria $dataSetInstance) { + private function updatePrimaryKey (StoreableCriteria $dataSetInstance): void { // Get table name from criteria //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage(sprintf('CACHED-LOCAL-FILE-DATABASE: dataSetInstance=%s - CALLED!', $dataSetInstance->__toString())); $tableName = $dataSetInstance->getTableName(); @@ -380,7 +380,7 @@ class CachedLocalFileDatabase extends BaseDatabaseBackend implements DatabaseBac * @return void * @todo Do some checks on the database directory and files here */ - public function connectToDatabase () { + public function connectToDatabase (): void { //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage('CACHED-LOCAL-FILE-DATABASE: CALLED!'); } @@ -395,7 +395,7 @@ class CachedLocalFileDatabase extends BaseDatabaseBackend implements DatabaseBac * @throws UnsupportedCriteriaException If the criteria is unsupported * @throws SqlException If an 'SQL error' occurs */ - public function querySelect (string $tableName, LocalSearchCriteria $searchInstance) { + public function querySelect (string $tableName, LocalSearchCriteria $searchInstance): array { // Validate parameter //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage(sprintf('CACHED-LOCAL-FILE-DATABASE: tableName=%s,searchInstance=%s - CALLED!', $tableName, $searchInstance->__toString())); if (empty($tableName)) { @@ -521,7 +521,7 @@ class CachedLocalFileDatabase extends BaseDatabaseBackend implements DatabaseBac * @return void * @throws SqlException If an SQL error occurs */ - public function queryInsertDataSet (StoreableCriteria $dataSetInstance) { + public function queryInsertDataSet (StoreableCriteria $dataSetInstance): void { // Try to save the request away //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage(sprintf('CACHED-LOCAL-FILE-DATABASE: dataSetInstance=%s - CALLED!', $dataSetInstance->__toString())); try { @@ -566,7 +566,7 @@ class CachedLocalFileDatabase extends BaseDatabaseBackend implements DatabaseBac * @throws InvalidArgumentException If $tableName is empty * @throws SqlException If an SQL error occurs */ - public function queryUpdateDataSet (StoreableCriteria $dataSetInstance) { + public function queryUpdateDataSet (StoreableCriteria $dataSetInstance): void { // Get table name //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage(sprintf('CACHED-LOCAL-FILE-DATABASE: dataSetInstance=%s - CALLED!', $dataSetInstance->__toString())); $tableName = $dataSetInstance->getTableName(); @@ -696,7 +696,7 @@ class CachedLocalFileDatabase extends BaseDatabaseBackend implements DatabaseBac * @throws InvalidArgumentException If a parameter is not valid * @todo Rename method to getPrimaryKeyFromTableInfo() */ - public function getPrimaryKeyOfTable (string $tableName) { + public function getPrimaryKeyOfTable (string $tableName): ?string { // Validate parameter //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage(sprintf('CACHED-LOCAL-FILE-DATABASE: tableName=%s - CALLED!', $tableName)); if (empty($tableName)) { @@ -726,7 +726,7 @@ class CachedLocalFileDatabase extends BaseDatabaseBackend implements DatabaseBac * @throws BadMethodCallException If some non-public is already not found but method was called * @todo Add more generic non-public data for removal */ - public function removeNonPublicDataFromArray (array $data) { + public function removeNonPublicDataFromArray (array $data): array { // Check parameter //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage(sprintf('CACHED-LOCAL-FILE-DATABASE: data()=%d - CALLED!', count($data))); if (!isset($data[$this->getIndexKey()])) { @@ -749,7 +749,7 @@ class CachedLocalFileDatabase extends BaseDatabaseBackend implements DatabaseBac * @return $count Total rows of given table * @throws InvalidArgumentException If a parameter is not valid */ - public function countTotalRows (string $tableName) { + public function countTotalRows (string $tableName): int { // Validate parameter //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage(sprintf('CACHED-LOCAL-FILE-DATABASE: tableName=%s - CALLED!', $tableName)); if (empty($tableName)) { diff --git a/framework/main/classes/database/frontend/class_BaseDatabaseFrontend.php b/framework/main/classes/database/frontend/class_BaseDatabaseFrontend.php index a77c54bc..39ac1f27 100644 --- a/framework/main/classes/database/frontend/class_BaseDatabaseFrontend.php +++ b/framework/main/classes/database/frontend/class_BaseDatabaseFrontend.php @@ -8,6 +8,7 @@ use Org\Mxchange\CoreFramework\Criteria\Criteria; use Org\Mxchange\CoreFramework\Criteria\Storing\StoreableCriteria; use Org\Mxchange\CoreFramework\Database\Backend\BaseDatabaseBackend; use Org\Mxchange\CoreFramework\Factory\Object\ObjectFactory; +use Org\Mxchange\CoreFramework\Generic\FrameworkException; use Org\Mxchange\CoreFramework\Object\BaseFrameworkSystem; use Org\Mxchange\CoreFramework\Result\Search\SearchableResult; use Org\Mxchange\CoreFramework\Traits\Cache\CacheableTrait; @@ -286,7 +287,7 @@ abstract class BaseDatabaseFrontend extends BaseFrameworkSystem { * @param $onlyKeys Only use these keys for a cache key * @return $numRows Numbers of rows of database entries */ - public function doSelectCountByCriteria (Criteria $criteriaInstance, array $onlyKeys = []) { + public function doSelectCountByCriteria (Criteria $criteriaInstance, array $onlyKeys = []): int { // Total numbers is -1 so we can distinglish between failed and valid queries //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage(sprintf('BASE-DATABASE-FRONTEND: criteriaInstance=%s,onlyKeys()=%d - CALLED!', $criteriaInstance->__toString(), count($onlyKeys))); $numRows = 0; @@ -311,7 +312,7 @@ abstract class BaseDatabaseFrontend extends BaseFrameworkSystem { * * @return $primaryKey Primary key used in wrapped table */ - public final function generatePrimaryKey () { + public final function generatePrimaryKey (): ?string { // Get the table name and a database instance and ask for it //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage('BASE-DATABASE-FRONTEND: CALLED!'); $primaryKey = FrameworkBootstrap::getDatabaseInstance()->getPrimaryKeyOfTable($this->getTableName()); @@ -326,7 +327,7 @@ abstract class BaseDatabaseFrontend extends BaseFrameworkSystem { * * @return $count Count of total rows in this table */ - public final function countTotalRows () { + public final function countTotalRows (): int { // Get the table name and a database instance and ask for it //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage('BASE-DATABASE-FRONTEND: CALLED!'); $count = FrameworkBootstrap::getDatabaseInstance()->countTotalRows($this->getTableName()); @@ -343,7 +344,7 @@ abstract class BaseDatabaseFrontend extends BaseFrameworkSystem { * @return $data A cleaned up array with only public data. * @throws InvalidArgumentException If a parameter has an invalid value */ - public function removeNonPublicDataFromArray (array $data) { + public function removeNonPublicDataFromArray (array $data): array { // Check parameter //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage(sprintf('BASE-DATABASE-FRONTEND: data()=%d - CALLED!', count($data))); if (count($data) == 0) { diff --git a/framework/main/classes/database/frontend/news/class_NewsDatabaseFrontend.php b/framework/main/classes/database/frontend/news/class_NewsDatabaseFrontend.php index d2adc290..0bb7b158 100644 --- a/framework/main/classes/database/frontend/news/class_NewsDatabaseFrontend.php +++ b/framework/main/classes/database/frontend/news/class_NewsDatabaseFrontend.php @@ -4,6 +4,7 @@ namespace Org\Mxchange\CoreFramework\Database\Frontend\News; // Import framework stuff use Org\Mxchange\CoreFramework\Database\Frontend\BaseDatabaseFrontend; +use Org\Mxchange\CoreFramework\Database\Frontend\DatabaseFrontend; use Org\Mxchange\CoreFramework\Registry\Registerable; /** @@ -29,7 +30,7 @@ use Org\Mxchange\CoreFramework\Registry\Registerable; * You should have received a copy of the GNU General Public License * along with this program. If not, see . */ -class NewsDatabaseFrontend extends BaseDatabaseFrontend implements Registerable { +class NewsDatabaseFrontend extends BaseDatabaseFrontend implements DatabaseFrontend, Registerable { // Constants for database table names const DB_TABLE_NEWS = 'news'; diff --git a/framework/main/classes/database/frontend/payments/class_PaymentsDatabaseFrontend.php b/framework/main/classes/database/frontend/payments/class_PaymentsDatabaseFrontend.php index 3b644c16..ec25b121 100644 --- a/framework/main/classes/database/frontend/payments/class_PaymentsDatabaseFrontend.php +++ b/framework/main/classes/database/frontend/payments/class_PaymentsDatabaseFrontend.php @@ -4,6 +4,7 @@ namespace Org\Mxchange\CoreFramework\Database\Frontend; // Import framework stuff use Org\Mxchange\CoreFramework\Database\Frontend\BaseDatabaseFrontend; +use Org\Mxchange\CoreFramework\Database\Frontend\DatabaseFrontend; use Org\Mxchange\CoreFramework\Registry\Registerable; /** @@ -29,7 +30,7 @@ use Org\Mxchange\CoreFramework\Registry\Registerable; * You should have received a copy of the GNU General Public License * along with this program. If not, see . */ -class PaymentsDatabaseFrontend extends BaseDatabaseFrontend implements Registerable { +class PaymentsDatabaseFrontend extends BaseDatabaseFrontend implements DatabaseFrontend, Registerable { // Constants for exceptions const EXCEPTION_CLIENT_USERNAME_NOT_FOUND = 0x180; @@ -51,7 +52,7 @@ class PaymentsDatabaseFrontend extends BaseDatabaseFrontend implements Registera * * @return $frontendInstance An instance of the created frontend class */ - public static final function createPaymentsDatabaseFrontend (): BaseDatabaseFrontend { + public static final function createPaymentsDatabaseFrontend (): DatabaseFrontend { // Get a new instance $frontendInstance = new PaymentsDatabaseFrontend(); diff --git a/framework/main/classes/database/frontend/user/class_UserDatabaseFrontend.php b/framework/main/classes/database/frontend/user/class_UserDatabaseFrontend.php index fc8348ad..7097ff36 100644 --- a/framework/main/classes/database/frontend/user/class_UserDatabaseFrontend.php +++ b/framework/main/classes/database/frontend/user/class_UserDatabaseFrontend.php @@ -63,7 +63,7 @@ class UserDatabaseFrontend extends BaseDatabaseFrontend implements ManageableAcc * * @return $frontendInstance An instance of the created frontend class */ - public static final function createUserDatabaseFrontend () { + public static final function createUserDatabaseFrontend (): ManageableAccountFrontend { // Get a new instance $frontendInstance = new UserDatabaseFrontend(); @@ -80,7 +80,7 @@ class UserDatabaseFrontend extends BaseDatabaseFrontend implements ManageableAcc * @param $registrationInstance An instance of a registration class * @return void */ - public function insertRegistrationObject (UserRegister $registrationInstance) { + public function insertRegistrationObject (UserRegister $registrationInstance): void { // Generate a data set for the request $dataSetInstance = ObjectFactory::createObjectByConfiguredName('dataset_criteria_class', array(self::DB_TABLE_USER)); @@ -101,7 +101,7 @@ class UserDatabaseFrontend extends BaseDatabaseFrontend implements ManageableAcc * @return void * @throws NullPointerException If $updateInstance or $searchInstance is null */ - public function doUpdateByResult (UpdateableResult $resultInstance) { + public function doUpdateByResult (UpdateableResult $resultInstance): void { // Get the search instance from result $searchInstance = $resultInstance->getSearchInstance(); diff --git a/framework/main/classes/database/frontend/user_points/class_UserPointsDatabaseFrontend.php b/framework/main/classes/database/frontend/user_points/class_UserPointsDatabaseFrontend.php index b7d59355..d0465066 100644 --- a/framework/main/classes/database/frontend/user_points/class_UserPointsDatabaseFrontend.php +++ b/framework/main/classes/database/frontend/user_points/class_UserPointsDatabaseFrontend.php @@ -62,7 +62,7 @@ class UserPointsDatabaseFrontend extends BaseDatabaseFrontend implements Bookabl * * @return $frontendInstance An instance of the created frontend class */ - public static final function createUserPointsDatabaseFrontend () { + public static final function createUserPointsDatabaseFrontend (): BookablePointsFrontend { // Get a new instance $frontendInstance = new UserPointsDatabaseFrontend(); @@ -79,7 +79,7 @@ class UserPointsDatabaseFrontend extends BaseDatabaseFrontend implements Bookabl * @param $pointsInstance An instance of a user class * @return void */ - public function insertUserPoints (BookablePoints $pointsInstance) { + public function insertUserPoints (BookablePoints $pointsInstance): void { // Generate a data set for the request $dataSetInstance = ObjectFactory::createObjectByConfiguredName('dataset_criteria_class', array(self::DB_TABLE_USER_POINTS)); @@ -99,7 +99,7 @@ class UserPointsDatabaseFrontend extends BaseDatabaseFrontend implements Bookabl * @param $resultInstance An instance of a UpdateableResult class * @return void */ - public function doUpdateByResult (UpdateableResult $resultInstance) { + public function doUpdateByResult (UpdateableResult $resultInstance): void { // Generate a data set object $dataSetInstance = ObjectFactory::createObjectByConfiguredName('dataset_criteria_class', array(self::DB_TABLE_USER_POINTS)); diff --git a/framework/main/classes/factories/class_BaseFactory.php b/framework/main/classes/factories/class_BaseFactory.php index 280890b5..de444482 100644 --- a/framework/main/classes/factories/class_BaseFactory.php +++ b/framework/main/classes/factories/class_BaseFactory.php @@ -60,7 +60,7 @@ abstract class BaseFactory extends BaseFrameworkSystem { * @return void * @throws InvalidArgumentException If a parameter is not valid */ - protected static final function countObject (string $fullClassName) { + protected static final function countObject (string $fullClassName): void { // Is the parameter valid? if (empty($fullClassName)) { // No empty class name @@ -86,7 +86,7 @@ abstract class BaseFactory extends BaseFrameworkSystem { * * @return $total Total amount of generated objects */ - public static final function getTotal () { + public static final function getTotal (): int { return self::$total; } @@ -95,7 +95,7 @@ abstract class BaseFactory extends BaseFrameworkSystem { * * @return $objectCounters An array with all object counters */ - public static final function getAllCounters () { + public static final function getAllCounters (): array { return self::$objectCounters; } @@ -106,7 +106,7 @@ abstract class BaseFactory extends BaseFrameworkSystem { * @return $isCounted Whether given class name is counted * @throws InvalidArgumentException If a parameter is not valid */ - public static final function isClassCounted (string $fullClassName) { + public static final function isClassCounted (string $fullClassName): bool { // Is the parameter valid? if (empty($fullClassName)) { // No empty class name diff --git a/framework/main/classes/factories/client/class_ClientFactory.php b/framework/main/classes/factories/client/class_ClientFactory.php index 3b0e3fd4..d64ba4cc 100644 --- a/framework/main/classes/factories/client/class_ClientFactory.php +++ b/framework/main/classes/factories/client/class_ClientFactory.php @@ -50,7 +50,7 @@ class ClientFactory extends BaseFactory { * @param $socketResource An instance of a Socket class (optional) * @return $clientInstance An instance of the requested client */ - public static final function createClientByProtocolInstance (HandleableProtocol $protocolInstance, Socket $socketResource = NULL) { + public static final function createClientByProtocolInstance (HandleableProtocol $protocolInstance, Socket $socketResource = NULL): ClientFactory { // Default is NULL (to initialize variable) $clientInstance = NULL; diff --git a/framework/main/classes/factories/database/class_DatabaseFrontendFactory.php b/framework/main/classes/factories/database/class_DatabaseFrontendFactory.php index 986166a8..0ac55672 100644 --- a/framework/main/classes/factories/database/class_DatabaseFrontendFactory.php +++ b/framework/main/classes/factories/database/class_DatabaseFrontendFactory.php @@ -3,6 +3,7 @@ namespace Org\Mxchange\CoreFramework\Factory\Database\Frontend; // Import framework stuff +use Org\Mxchange\CoreFramework\Database\Frontend\DatabaseFrontend; use Org\Mxchange\CoreFramework\Factory\BaseFactory; use Org\Mxchange\CoreFramework\Factory\Object\ObjectFactory; use Org\Mxchange\CoreFramework\Generic\FrameworkInterface; @@ -54,7 +55,7 @@ class DatabaseFrontendFactory extends BaseFactory { * * @return void */ - public final static function staticInitializer () { + public final static function staticInitializer (): void { // Is it initialized? //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage(sprintf('frontend-FACTORY: self::registryInstance[]=%s - CALLED!', gettype(self::$registryInstance))); if (is_null(self::$registryInstance)) { @@ -71,9 +72,9 @@ class DatabaseFrontendFactory extends BaseFactory { * the registry it will be returned, else a new instance is created and * stored in the same registry entry. * - * @return $frontendInstance A database frontend instance + * @return $frontendInstance An instance of a DatabaseFrontend class */ - public static final function createFrontendByConfiguredName (string $frontendName) { + public static final function createFrontendByConfiguredName (string $frontendName): DatabaseFrontend { // Check parameter //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage(sprintf('DATABASE-FRONTEND-FACTORY: frontendName=%s - CALLED!', $frontendName)); if (empty($frontendName)) { diff --git a/framework/main/classes/factories/html/class_HtmlNewsFactory.php b/framework/main/classes/factories/html/class_HtmlNewsFactory.php index bcf3ed97..cc06a147 100644 --- a/framework/main/classes/factories/html/class_HtmlNewsFactory.php +++ b/framework/main/classes/factories/html/class_HtmlNewsFactory.php @@ -6,6 +6,7 @@ namespace Org\Mxchange\CoreFramework\Factory\News; use Org\Mxchange\CoreFramework\Bootstrap\FrameworkBootstrap; use Org\Mxchange\CoreFramework\Factory\BaseFactory; use Org\Mxchange\CoreFramework\Factory\Object\ObjectFactory; +use Org\Mxchange\CoreFramework\Reader\News\ReadableNews; use Org\Mxchange\CoreFramework\Request\Requestable; /** @@ -46,9 +47,9 @@ class HtmlNewsFactory extends BaseFactory { * request * * @param $requestInstance An instance of a Requestable class - * @return $factoryInstance An instance of a HtmlNewsFactory class + * @return $factoryInstance An instance of a ReadableNews class */ - public static final function createFactoryByRequest (Requestable $requestInstance) { + public static final function createFactoryByRequest (Requestable $requestInstance): ReadableNews { // Set default news reader class $configEntry = 'news_reader_class'; @@ -74,7 +75,7 @@ class HtmlNewsFactory extends BaseFactory { $className = FrameworkBootstrap::getConfigurationInstance()->getConfigEntry($configEntry); // Once we have that name, try to load initialize it - $newsInstance = ObjectFactory::createObjectByName($className, array($requestInstance)); + $newsInstance = ObjectFactory::createObjectByName($className, [$requestInstance]); // Initialize the reader $newsInstance->initializeReader(); diff --git a/framework/main/classes/factories/index/class_FileStackIndexFactory.php b/framework/main/classes/factories/index/class_FileStackIndexFactory.php index aa774a1d..43e58005 100644 --- a/framework/main/classes/factories/index/class_FileStackIndexFactory.php +++ b/framework/main/classes/factories/index/class_FileStackIndexFactory.php @@ -52,7 +52,7 @@ class FileStackIndexFactory extends BaseFactory { * @return $indexInstance An instance of a IndexableStack class * @throws InvalidArgumentException If a parameter is invalid */ - public static final function createFileStackIndexInstance (SplFileInfo $fileInfoInstance, string $type) { + public static final function createFileStackIndexInstance (SplFileInfo $fileInfoInstance, string $type): FileStackIndexFactory { // If there is no handler? if (empty($type)) { // Throw IAE diff --git a/framework/main/classes/factories/login/class_LoginFactory.php b/framework/main/classes/factories/login/class_LoginFactory.php index f7a2bd37..100e353c 100644 --- a/framework/main/classes/factories/login/class_LoginFactory.php +++ b/framework/main/classes/factories/login/class_LoginFactory.php @@ -47,7 +47,7 @@ class LoginFactory extends BaseFactory { * @param $requestInstance An instance of a Requestable class * @return $loginInstance An instance of a login helper (@TODO Use actual interface name) */ - public static final function createLoginObjectByRequest (Requestable $requestInstance) { + public static final function createLoginObjectByRequest (Requestable $requestInstance): LoginFactory { // Get registry instance $registryInstance = ObjectRegistry::getRegistry('factory'); diff --git a/framework/main/classes/factories/objects/class_ObjectFactory.php b/framework/main/classes/factories/objects/class_ObjectFactory.php index e100dc69..9e774acd 100644 --- a/framework/main/classes/factories/objects/class_ObjectFactory.php +++ b/framework/main/classes/factories/objects/class_ObjectFactory.php @@ -56,7 +56,7 @@ class ObjectFactory extends BaseFactory { * @throws NoClassException If the requested class was not found * @throws InvalidArgumentException If className is empty or the name not following naming-convention */ - public static final function createObjectByName (string $fullClassName, array $args = []) { + public static final function createObjectByName (string $fullClassName, array $args = []): FrameworkInterface { // Is the class name valid and is the class there? if (empty($fullClassName)) { // Throw an exception here @@ -98,7 +98,7 @@ class ObjectFactory extends BaseFactory { * @param $args Arguments in an indexed array * @return $objectInstance An instance of the requested object */ - public static final function createObjectByConfiguredName (string $configKey, array $args = []) { + public static final function createObjectByConfiguredName (string $configKey, array $args = []): FrameworkInterface { // Read the configuration entry $fullClassName = FrameworkBootstrap::getConfigurationInstance()->getConfigEntry($configKey); @@ -117,7 +117,7 @@ class ObjectFactory extends BaseFactory { * @param $fullClassName Class name with namespace * @return $shortClassName Stripped class name (no namespace) */ - private static function stripNamespaceFromClassName (string $fullClassName) { + private static function stripNamespaceFromClassName (string $fullClassName): string { // The class name should contain at least 2 back-slashes, so split at them $classNameParts = explode("\\", $fullClassName); diff --git a/framework/main/classes/factories/registry/class_SocketRegistryFactory.php b/framework/main/classes/factories/registry/class_SocketRegistryFactory.php index a3b985c4..a5cb4c12 100644 --- a/framework/main/classes/factories/registry/class_SocketRegistryFactory.php +++ b/framework/main/classes/factories/registry/class_SocketRegistryFactory.php @@ -47,7 +47,7 @@ class SocketRegistryFactory extends BaseFactory { * * @return $registryInstance A socket registry instance */ - public static final function createSocketRegistryInstance () { + public static final function createSocketRegistryInstance (): SocketRegistryFactory { // Get registry instance /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage('SOCKET-REGISTRY-FACTORY: CALLED!'); $objectRegistryInstance = ObjectRegistry::getRegistry('factory'); diff --git a/framework/main/classes/factories/stacks/class_FileStackFactory.php b/framework/main/classes/factories/stacks/class_FileStackFactory.php index 81d9f77b..35decca0 100644 --- a/framework/main/classes/factories/stacks/class_FileStackFactory.php +++ b/framework/main/classes/factories/stacks/class_FileStackFactory.php @@ -53,7 +53,7 @@ class FileStackFactory extends BaseFactory { * @param $stackName Name of the stack * @return $stackInstance An instance of a StackableFile class */ - public static final function createFileStackInstance (string $prefix, string $stackName) { + public static final function createFileStackInstance (string $prefix, string $stackName): FileStackFactory { // Validate parameter //* NOISY-DEBUG */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage(sprintf('FILE-STACK-FACTORY: prefix=%s,stackName=%s - CALLED!', $prefix, $stackName)); if (empty($prefix)) { diff --git a/framework/main/classes/factories/user/class_UserFactory.php b/framework/main/classes/factories/user/class_UserFactory.php index 9aeb0588..4006d6f5 100644 --- a/framework/main/classes/factories/user/class_UserFactory.php +++ b/framework/main/classes/factories/user/class_UserFactory.php @@ -47,7 +47,7 @@ class UserFactory extends BaseFactory { * @param $requestInstance An instance of a Requestable class * @return $userInstance An instance of a user class (@TODO use actual interface name) */ - public static final function createUserByRequest (Requestable $requestInstance) { + public static final function createUserByRequest (Requestable $requestInstance): UserFactory { // Get registry instance $registryInstance = ObjectRegistry::getRegistry('factory'); diff --git a/framework/main/classes/factories/xml/class_XmlTemplateEngineFactory.php b/framework/main/classes/factories/xml/class_XmlTemplateEngineFactory.php index 8c954ace..81f4468e 100644 --- a/framework/main/classes/factories/xml/class_XmlTemplateEngineFactory.php +++ b/framework/main/classes/factories/xml/class_XmlTemplateEngineFactory.php @@ -54,7 +54,7 @@ class XmlTemplateEngineFactory extends BaseFactory { * @param $configKey Config entry name for the template engine * @return $templateInstance A template engine instance */ - public static final function createXmlTemplateEngineInstance (string $configKey) { + public static final function createXmlTemplateEngineInstance (string $configKey): XmlTemplateEngineFactory { // Validate parameter //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage(sprintf('XML-TEMPLATE-ENGINE-FACTORY: configKey=%s - CALLED!', $configKey)); if (empty($configKey)) {