PhpPlaisio / kernel

src/Nub.php

Indentation +349 added lines, -349 removed lines

@@ -36,383 +36,383 @@
  */
 abstract class Nub
 {
-  //--------------------------------------------------------------------------------------------------------------------
-  /**
-   * The data layer generated by PhpStratum.
-   *
-   * @var Object
-   */
-  public static $dl;
-
-  /**
-   * A reference to the singleton instance of this class.
-   *
-   * @var Nub
-   */
-  public static $nub;
-
-  /**
-   * The helper object for web assets.
-   *
-   * @var WebAssets
-   */
-  public static $assets;
-
-  /**
-   * The helper object for authorization.
-   *
-   * @var Authority
-   */
-  public static $authority;
-
-  /**
-   * The Babel object for retrieving linguistic entities.
-   *
-   * @var Babel
-   */
-  public static $babel;
-
-  /**
-   * The helper object for deriving the canonical hostname.
-   *
-   * @var CanonicalHostnameResolver
-   */
-  public static $canonicalHostnameResolver;
-
-  /**
-   * The helper object for get Cgi variables.
-   *
-   * @var Cgi
-   */
-  public static $cgi;
-
-  /**
-   * The helper object for deriving the company.
-   *
-   * @var CompanyResolver
-   */
-  public static $companyResolver;
-
-  /**
-   * Helper object for getting directory names.
-   *
-   * @var Dirs
-   */
-  public static $dirs;
-
-  /**
-   * The helper object for resolving the code of the language in which the response must be drafted.
-   *
-   * @var LanguageResolver
-   */
-  public static $languageResolver;
-
-  /**
-   * The helper object for providing information about the HTTP request.
-   *
-   * @var Request
-   */
-  public static $request;
-
-  /**
-   * The helper object for handling the HTTP page request.
-   *
-   * @var RequestHandler
-   */
-  public static $requestHandler;
-
-  /**
-   * The helper object for logging HTTP page requests.
-   *
-   * @var RequestLogger
-   */
-  public static $requestLogger;
-
-  /**
-   * The helper object for resolving the CGI parameters from a clean URL.
-   *
-   * @var RequestParameterResolver
-   */
-  public static $requestParameterResolver;
-
-  /**
-   * The helper object for session management.
-   *
-   * @var Session
-   */
-  public static $session;
-
-  /**
-   * The start time of serving the page request.
-   *
-   * @var float
-   */
-  public static $time0;
-
-  /**
-   * The factory for creating Obfuscators.
-   *
-   * @var ObfuscatorFactory
-   */
-  protected static $obfuscatorFactory;
-
-  /**
-   * Information about the requested page.
-   *
-   * {@deprecated}
-   *
-   * @var array
-   */
-  public $pageInfo;
-
-  //--------------------------------------------------------------------------------------------------------------------
-  /**
-   * Object constructor.
-   */
-  protected function __construct()
-  {
+    //--------------------------------------------------------------------------------------------------------------------
+    /**
+     * The data layer generated by PhpStratum.
+     *
+     * @var Object
+     */
+    public static $dl;
+
+    /**
+     * A reference to the singleton instance of this class.
+     *
+     * @var Nub
+     */
+    public static $nub;
+
+    /**
+     * The helper object for web assets.
+     *
+     * @var WebAssets
+     */
+    public static $assets;
+
+    /**
+     * The helper object for authorization.
+     *
+     * @var Authority
+     */
+    public static $authority;
+
+    /**
+     * The Babel object for retrieving linguistic entities.
+     *
+     * @var Babel
+     */
+    public static $babel;
+
+    /**
+     * The helper object for deriving the canonical hostname.
+     *
+     * @var CanonicalHostnameResolver
+     */
+    public static $canonicalHostnameResolver;
+
+    /**
+     * The helper object for get Cgi variables.
+     *
+     * @var Cgi
+     */
+    public static $cgi;
+
+    /**
+     * The helper object for deriving the company.
+     *
+     * @var CompanyResolver
+     */
+    public static $companyResolver;
+
+    /**
+     * Helper object for getting directory names.
+     *
+     * @var Dirs
+     */
+    public static $dirs;
+
+    /**
+     * The helper object for resolving the code of the language in which the response must be drafted.
+     *
+     * @var LanguageResolver
+     */
+    public static $languageResolver;
+
+    /**
+     * The helper object for providing information about the HTTP request.
+     *
+     * @var Request
+     */
+    public static $request;
+
+    /**
+     * The helper object for handling the HTTP page request.
+     *
+     * @var RequestHandler
+     */
+    public static $requestHandler;
+
+    /**
+     * The helper object for logging HTTP page requests.
+     *
+     * @var RequestLogger
+     */
+    public static $requestLogger;
+
+    /**
+     * The helper object for resolving the CGI parameters from a clean URL.
+     *
+     * @var RequestParameterResolver
+     */
+    public static $requestParameterResolver;
+
+    /**
+     * The helper object for session management.
+     *
+     * @var Session
+     */
+    public static $session;
+
+    /**
+     * The start time of serving the page request.
+     *
+     * @var float
+     */
+    public static $time0;
+
+    /**
+     * The factory for creating Obfuscators.
+     *
+     * @var ObfuscatorFactory
+     */
+    protected static $obfuscatorFactory;
+
+    /**
+     * Information about the requested page.
+     *
+     * {@deprecated}
+     *
+     * @var array
+     */
+    public $pageInfo;
+
+    //--------------------------------------------------------------------------------------------------------------------
+    /**
+     * Object constructor.
+     */
+    protected function __construct()
+    {
     self::$nub = $this;
-  }
-
-  //--------------------------------------------------------------------------------------------------------------------
-  /**
-   * De-obfuscates an obfuscated database ID.
-   *
-   * @param string|null $code  The obfuscated database ID.
-   * @param string      $alias An alias for the column holding the IDs.
-   *
-   * @return int|null
-   */
-  public static function deObfuscate(?string $code, string $alias): ?int
-  {
+    }
+
+    //--------------------------------------------------------------------------------------------------------------------
+    /**
+     * De-obfuscates an obfuscated database ID.
+     *
+     * @param string|null $code  The obfuscated database ID.
+     * @param string      $alias An alias for the column holding the IDs.
+     *
+     * @return int|null
+     */
+    public static function deObfuscate(?string $code, string $alias): ?int
+    {
     return self::$obfuscatorFactory->decode($code, $alias);
-  }
-
-  //--------------------------------------------------------------------------------------------------------------------
-  /**
-   * Returns an Obfuscator for obfuscating and de-obfuscating database IDs.
-   *
-   * @param string $alias An alias for the column holding the IDs.
-   *
-   * @return Obfuscator
-   */
-  public static function getObfuscator(string $alias): Obfuscator
-  {
+    }
+
+    //--------------------------------------------------------------------------------------------------------------------
+    /**
+     * Returns an Obfuscator for obfuscating and de-obfuscating database IDs.
+     *
+     * @param string $alias An alias for the column holding the IDs.
+     *
+     * @return Obfuscator
+     */
+    public static function getObfuscator(string $alias): Obfuscator
+    {
     return self::$obfuscatorFactory->getObfuscator($alias);
-  }
-
-  //--------------------------------------------------------------------------------------------------------------------
-  /**
-   * Obfuscates a database ID.
-   *
-   * @param int|null $id    The database ID.
-   * @param string   $alias An alias for the column holding the IDs.
-   *
-   * @return string
-   */
-  public static function obfuscate(?int $id, string $alias): ?string
-  {
+    }
+
+    //--------------------------------------------------------------------------------------------------------------------
+    /**
+     * Obfuscates a database ID.
+     *
+     * @param int|null $id    The database ID.
+     * @param string   $alias An alias for the column holding the IDs.
+     *
+     * @return string
+     */
+    public static function obfuscate(?int $id, string $alias): ?string
+    {
     return self::$obfuscatorFactory->encode($id, $alias);
-  }
-
-  //--------------------------------------------------------------------------------------------------------------------
-  /**
-   * Acquires a lock on a database entity and returns the object holding the lock.
-   *
-   * @param int $nameId   The ID of the name of the entity lock.
-   * @param int $entityId The ID of the entity.
-   *
-   * @return EntityLock
-   */
-  public function createEntityLock(int $nameId, int $entityId): EntityLock
-  {
+    }
+
+    //--------------------------------------------------------------------------------------------------------------------
+    /**
+     * Acquires a lock on a database entity and returns the object holding the lock.
+     *
+     * @param int $nameId   The ID of the name of the entity lock.
+     * @param int $entityId The ID of the entity.
+     *
+     * @return EntityLock
+     */
+    public function createEntityLock(int $nameId, int $entityId): EntityLock
+    {
     unset($nameId);
     unset($entityId);
 
     throw new \LogicException('Not implemented');
-  }
-
-  //--------------------------------------------------------------------------------------------------------------------
-  /**
-   * Returns a login handler for logging in a user agent.
-   *
-   * @return LoginHandler
-   */
-  public function createLoginHandler(): LoginHandler
-  {
+    }
+
+    //--------------------------------------------------------------------------------------------------------------------
+    /**
+     * Returns a login handler for logging in a user agent.
+     *
+     * @return LoginHandler
+     */
+    public function createLoginHandler(): LoginHandler
+    {
     throw new \LogicException('Not implemented');
-  }
-
-  //--------------------------------------------------------------------------------------------------------------------
-  /**
-   * Creates an empty mail message.
-   *
-   * @return MailMessage
-   */
-  public function createMailMessage(): MailMessage
-  {
+    }
+
+    //--------------------------------------------------------------------------------------------------------------------
+    /**
+     * Creates an empty mail message.
+     *
+     * @return MailMessage
+     */
+    public function createMailMessage(): MailMessage
+    {
     throw new \LogicException('Not implemented');
-  }
-
-  //--------------------------------------------------------------------------------------------------------------------
-  /**
-   * Acquires a named lock and returns the object holding the lock.
-   *
-   * @param int $id The ID of the named lock.
-   *
-   * @return NamedLock
-   */
-  public function createNamedLock(int $id): NamedLock
-  {
+    }
+
+    //--------------------------------------------------------------------------------------------------------------------
+    /**
+     * Acquires a named lock and returns the object holding the lock.
+     *
+     * @param int $id The ID of the named lock.
+     *
+     * @return NamedLock
+     */
+    public function createNamedLock(int $id): NamedLock
+    {
     unset($id);
 
     throw new \LogicException('Not implemented');
-  }
-
-  //--------------------------------------------------------------------------------------------------------------------
-  /**
-   * Returns the BLOB Store object.
-   *
-   * @return BlobStore
-   */
-  public function getBlobStore(): BlobStore
-  {
+    }
+
+    //--------------------------------------------------------------------------------------------------------------------
+    /**
+     * Returns the BLOB Store object.
+     *
+     * @return BlobStore
+     */
+    public function getBlobStore(): BlobStore
+    {
     throw new \LogicException('Not implemented');
-  }
-
-  //--------------------------------------------------------------------------------------------------------------------
-  /**
-   * Returns the configuration vault for storing and retrieving sensitive configuration data safely.
-   *
-   * @return ConfigVault
-   */
-  public function getConfigVault(): ConfigVault
-  {
+    }
+
+    //--------------------------------------------------------------------------------------------------------------------
+    /**
+     * Returns the configuration vault for storing and retrieving sensitive configuration data safely.
+     *
+     * @return ConfigVault
+     */
+    public function getConfigVault(): ConfigVault
+    {
     throw new \LogicException('Not implemented');
-  }
-
-  //--------------------------------------------------------------------------------------------------------------------
-  /**
-   * Returns the error logger.
-   *
-   * @return ErrorLogger
-   */
-  public function getErrorLogger(): ErrorLogger
-  {
+    }
+
+    //--------------------------------------------------------------------------------------------------------------------
+    /**
+     * Returns the error logger.
+     *
+     * @return ErrorLogger
+     */
+    public function getErrorLogger(): ErrorLogger
+    {
     throw new \LogicException('Not implemented');
-  }
-
-  //--------------------------------------------------------------------------------------------------------------------
-  /**
-   * Returns the event dispatcher.
-   *
-   * @return EventDispatcher
-   */
-  public function getEventDispatcher(): EventDispatcher
-  {
+    }
+
+    //--------------------------------------------------------------------------------------------------------------------
+    /**
+     * Returns the event dispatcher.
+     *
+     * @return EventDispatcher
+     */
+    public function getEventDispatcher(): EventDispatcher
+    {
     throw new \LogicException('Not implemented');
-  }
-
-  //--------------------------------------------------------------------------------------------------------------------
-  /**
-   * Returns the exception handler.
-   *
-   * @return ExceptionHandler
-   */
-  public function getExceptionHandler(): ExceptionHandler
-  {
+    }
+
+    //--------------------------------------------------------------------------------------------------------------------
+    /**
+     * Returns the exception handler.
+     *
+     * @return ExceptionHandler
+     */
+    public function getExceptionHandler(): ExceptionHandler
+    {
     throw new \LogicException('Not implemented');
-  }
-
-  //--------------------------------------------------------------------------------------------------------------------
-  /**
-   * Returns the ID of the index page.
-   *
-   * @return int
-   */
-  public function getIndexPagId(): int
-  {
+    }
+
+    //--------------------------------------------------------------------------------------------------------------------
+    /**
+     * Returns the ID of the index page.
+     *
+     * @return int
+     */
+    public function getIndexPagId(): int
+    {
     throw new \LogicException('Not implemented');
-  }
-
-  //--------------------------------------------------------------------------------------------------------------------
-  /**
-   * Returns the URL of the login page.
-   *
-   * @param string|null $redirect After a successful login the user agent must be redirected to this URL.
-   *
-   * @return string
-   */
-  public function getLoginUrl(?string $redirect = null): string
-  {
+    }
+
+    //--------------------------------------------------------------------------------------------------------------------
+    /**
+     * Returns the URL of the login page.
+     *
+     * @param string|null $redirect After a successful login the user agent must be redirected to this URL.
+     *
+     * @return string
+     */
+    public function getLoginUrl(?string $redirect = null): string
+    {
     unset($redirect);
 
     throw new \LogicException('Not implemented');
-  }
-
-  //--------------------------------------------------------------------------------------------------------------------
-  /**
-   * Returns ID of the menu item associated with the requested page.
-   *
-   * {@deprecated}
-   *
-   * @return int|null
-   */
-  public function getMnuId(): ?int
-  {
+    }
+
+    //--------------------------------------------------------------------------------------------------------------------
+    /**
+     * Returns ID of the menu item associated with the requested page.
+     *
+     * {@deprecated}
+     *
+     * @return int|null
+     */
+    public function getMnuId(): ?int
+    {
     return $this->pageInfo['mnu_id'];
-  }
-
-  //--------------------------------------------------------------------------------------------------------------------
-  /**
-   * Returns the ID of the "original" page.
-   *
-   * {@deprecated}
-   *
-   * @return int|null
-   */
-  public function getPagIdOrg(): ?int
-  {
+    }
+
+    //--------------------------------------------------------------------------------------------------------------------
+    /**
+     * Returns the ID of the "original" page.
+     *
+     * {@deprecated}
+     *
+     * @return int|null
+     */
+    public function getPagIdOrg(): ?int
+    {
     return $this->pageInfo['pag_id_org'];
-  }
-
-  //--------------------------------------------------------------------------------------------------------------------
-  /**
-   * Returns page group title.
-   *
-   * {@deprecated}
-   *
-   * @return string|null
-   */
-  public function getPageGroupTitle(): ?string
-  {
+    }
+
+    //--------------------------------------------------------------------------------------------------------------------
+    /**
+     * Returns page group title.
+     *
+     * {@deprecated}
+     *
+     * @return string|null
+     */
+    public function getPageGroupTitle(): ?string
+    {
     return $this->pageInfo['ptb_title'];
-  }
-
-  //--------------------------------------------------------------------------------------------------------------------
-  /**
-   * Returns page group title.
-   *
-   * {@deprecated}
-   *
-   * @return int|null
-   */
-  public function getPtbId(): ?int
-  {
+    }
+
+    //--------------------------------------------------------------------------------------------------------------------
+    /**
+     * Returns page group title.
+     *
+     * {@deprecated}
+     *
+     * @return int|null
+     */
+    public function getPtbId(): ?int
+    {
     return $this->pageInfo['ptb_id'];
-  }
-
-  //--------------------------------------------------------------------------------------------------------------------
-  /**
-   * Handles the actual page request including authorization and security checking, transaction handling,
-   * request logging, and exception handling.
-   */
-  public function handlePageRequest(): void
-  {
+    }
+
+    //--------------------------------------------------------------------------------------------------------------------
+    /**
+     * Handles the actual page request including authorization and security checking, transaction handling,
+     * request logging, and exception handling.
+     */
+    public function handlePageRequest(): void
+    {
     self::$requestHandler->handleRequest();
-  }
+    }
 
-  //--------------------------------------------------------------------------------------------------------------------
+    //--------------------------------------------------------------------------------------------------------------------
 }
 
 //----------------------------------------------------------------------------------------------------------------------