Merge pull request #180 from WebFiori/dev

Fix to Missing Methods + Upgrade CLI + Documentation

Author: usernane

composer.json

@@ -19,12 +19,12 @@
         "ext-fileinfo": "*",
         "ext-openssl": "*",
         "webfiori/err":"v1.0.6",
-        "webfiori/cli":"v1.1.1",
+        "webfiori/cli":"v1.1.3",
         "webfiori/file":"v1.3.2",
         "webfiori/collections":"v1.1.3",
         "webfiori/ui":"v2.5.5",
         "webfiori/jsonx":"v3.2.2",
-        "webfiori/http":"v3.3.2 ",
+        "webfiori/http":"v3.3.3 ",
         "webfiori/database":"v0.7.4",
         "webfiori/mailer":"v1.0.6"
     },

webfiori/framework/ThemeLoader.php

@@ -152,7 +152,7 @@ public static function resetLoaded() {
      * Loads a theme given its name or class name.
      *
      * If the given name is null or empty string, the method will load the default theme as
-     * specified by the method AppConfig::getBaseThemeName().
+     * which is set by application configuration.
      *
      * @param string|null $themeName The name of the theme. This also can be the name of
      * theme class including its namespace (e.g. Theme::class).

webfiori/framework/cli/helpers/CreateFullRESTHelper.php

@@ -192,11 +192,9 @@ private function getUniqueAPIParams() : array {
     }
     private function IncludeAPISetProps(WebServiceWriter $w, $type) {
         $t = $this->getTable();
-        $w->addProcessCode('$entity = new '.$t->getEntityMapper()->getEntityName().'();');
+        $w->addProcessCode('$entity = $this->getObject('.$t->getEntityMapper()->getEntityName().'::class);');
 
-        foreach ($t->getColsKeys() as $paramName) {
-            $w->addProcessCode('$entity->'.EntityMapper::mapToMethodName($paramName, 's').'($this->getParamVal(\''.$paramName.'\'));');
-        }
+        
         $dbClassName = $this->dbObjWriter->getName();
         $entityName = $this->dbObjWriter->getEntityName();
         $w->addProcessCode("");

webfiori/framework/config/ClassDriver.php

@@ -1269,7 +1269,16 @@ public function setTitle(string $title, string $langCode) {
         $this->configVars['site']['titles'][$langCode] = $title;
         $this->writeAppConfig();
     }
-
+    /**
+     * Initialize configuration driver.
+     * 
+     * This method should be used to create application configuration and
+     * pubulate it with default values if needed.
+     * 
+     * @param bool $reCreate If the configuration is exist and this one is set
+     * to true, the method should remove existing configuration and re-create it
+     * using default values.
+     */
     public function initialize(bool $reCreate = false) {
         $cfgNs = self::CONFIG_NS;
         if ($reCreate) {

webfiori/framework/config/JsonDriver.php

@@ -68,6 +68,7 @@ public function __construct() {
             'database-connections' => new Json(),
         ]);
         $this->json->setIsFormatted(true);
+        $this->json->setPropsStyle('none');
     }
     /**
      * Adds application environment variable to the configuration.
@@ -313,7 +314,15 @@ public function setAppVersion(string $vNum, string $vType, string $releaseDate)
     public function setBaseURL(string $url) {
 
     }
-
+    /**
+     * Sets or update default description of the application that will be used
+     * by web pages.
+     * 
+     * @param string $description The default description.
+     * 
+     * @param string $langCode The code of the language at which the description
+     * will be updated for.
+     */
     public function setDescription(string $description, string $langCode) {
         $code = $this->isValidLangCode($langCode);
 
@@ -324,12 +333,27 @@ public function setDescription(string $description, string $langCode) {
         $appNamesJson->add($code, $description);
         $this->writeJson();
     }
-
+    /**
+     * Sets the home page of the application.
+     * 
+     * 
+     * @param string $url The URL of the home page of the website. For example,
+     * This page is served when the user visits the domain without specifying a path.
+     */
     public function setHomePage(string $url) {
         $this->json->add('home-page', $url);
         $this->writeJson();
     }
-
+    /**
+     * Update application version information.
+     *
+     * @param string $vNum Version number such as 1.0.0.
+     *
+     * @param string $vType Version type such as 'Beta', 'Alpha' or 'RC'.
+     *
+     * @param string $releaseDate The date at which the version was released on.
+     *
+     */
     public function setPrimaryLanguage(string $langCode) {
         $code = $this->isValidLangCode($langCode);
 
@@ -339,22 +363,47 @@ public function setPrimaryLanguage(string $langCode) {
         $this->json->add('primary-lang', $code);
         $this->writeJson();
     }
-
+    /**
+     * Updates the password which is used to protect tasks from unauthorized
+     * execution.
+     *
+     * @param string $newPass The new password. Note that provided value
+     * must be hashed using SHA256 algorithm.
+     *
+     */
     public function setSchedulerPassword(string $newPass) {
         $this->json->add('scheduler-password', $newPass);
         $this->writeJson();
     }
-
+    /**
+     * Sets the default theme which will be used to style web pages.
+     * 
+     * @param string $theme The name of the theme that will be used to style
+     * website UI. This can also be class name of the theme.
+     */
     public function setTheme(string $theme) {
         $this->json->add('theme', $theme);
         $this->writeJson();
     }
-
+    /**
+     * Sets the string which is used to separate application name from page name.
+     * 
+     * @param string $separator A character or a string that is used
+     * to separate application name from web page title. Two common
+     * values are '-' and '|'.
+     */
     public function setTitleSeparator(string $separator) {
         $this->json->add('name-separator', $separator);
         $this->writeJson();
     }
-
+    /**
+     * Returns an array that holds different names for the web application 
+     * on different languages.
+     * 
+     * @return array The indices of the array are language codes such as 'AR' and 
+     * the value of the index is the name.
+     * 
+     */
     public function getAppNames(): array {
         $appNamesJson = $this->json->get('app-names');
         $retVal = [];
@@ -363,7 +412,13 @@ public function getAppNames(): array {
         }
         return $retVal;
     }
-
+    /**
+     * Returns an array that holds different descriptions for the web application 
+     * on different languages.
+     * 
+     * @return array The indices of the array are language codes such as 'AR' and 
+     * the value of the index is the description.
+     */
     public function getDescriptions(): array {
         $descriptions = $this->json->get('app-descriptions');
         $retVal = [];
@@ -372,7 +427,14 @@ public function getDescriptions(): array {
         }
         return $retVal;
     }
-
+    /**
+     * Returns an array that holds different page titles for the web application 
+     * on different languages.
+     * 
+     * @return array The indices of the array are language codes such as 'AR' and 
+     * the value of the index is the title.
+     * 
+     */
     public function getTitles(): array {
         $titles = $this->json->get('titles');
         $retVal = [];
@@ -381,7 +443,14 @@ public function getTitles(): array {
         }
         return $retVal;
     }
-
+    /**
+     * Sets or updates default web page title for a specific display language.
+     * 
+     * @param string $title The title that will be set.
+     * 
+     * @param string $langCode The display language at which the title will be
+     * set or updated for.
+     */
     public function setTitle(string $title, string $langCode) {
         $code = $this->isValidLangCode($langCode);
 

webfiori/framework/scheduler/TaskStatusEmail.php

@@ -118,9 +118,9 @@ private function createTaskInfoTable(AbstractTask $task): HTMLNode {
         $taskTable->addChild($this->createTableRow('Framework Release Date:', WF_RELEASE_DATE));
         $taskTable->addChild($this->createTableRow('Root Directory:', ROOT_PATH));
         $taskTable->addChild($this->createTableRow('Application Directory:', ROOT_PATH.DS.APP_DIR));
-        $taskTable->addChild($this->createTableRow('Application Version:', App::getConfig()->getVersion()));
-        $taskTable->addChild($this->createTableRow('Version Type:', App::getConfig()->getVersionType()));
-        $taskTable->addChild($this->createTableRow('Application Release Date:', App::getConfig()->getReleaseDate()));
+        $taskTable->addChild($this->createTableRow('Application Version:', App::getConfig()->getAppVersion()));
+        $taskTable->addChild($this->createTableRow('Version Type:', App::getConfig()->getAppVersionType()));
+        $taskTable->addChild($this->createTableRow('Application Release Date:', App::getConfig()->getAppReleaseDate()));
 
         if ($task->isSuccess()) {
             $taskTable->addChild($this->createTableRow('Exit Status:', '<b style="color:green">Success</b>'));

webfiori/framework/ui/HTTPCodeView.php

@@ -24,7 +24,7 @@ class HTTPCodeView extends WebPage {
      */
     public function __construct($errCode) {
         parent::__construct();
-        $this->setTheme(App::getConfig()->getBaseThemeName());
+        $this->setTheme(App::getConfig()->getTheme());
 
         $this->setTitle($this->get("general/http-codes/$errCode/code").' - '.$this->get("general/http-codes/$errCode/type"));
         http_response_code(intval($this->get("general/http-codes/$errCode/code")));

webfiori/framework/ui/WebPage.php

@@ -988,8 +988,8 @@ public function setLang(string $lang = 'EN') {
      * 
      * @param string $themeNameOrClass The name of the theme as specified by the 
      * variable 'name' in theme definition. If the given name is 'null', the 
-     * method will load the default theme as specified by the method 
-     * 'AppConfig::getBaseThemeName()'. Note that once the theme is updated, 
+     * method will load the default theme as specified by application configuration. 
+     * Note that once the theme is updated, 
      * the document content of the page will reset if it was set before calling this 
      * method. This also can be the value which can be taken from 'ClassName::class'. 
      *