From ad51823ef5f0eca5c202a917ac5a8b4ff8222878 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Thu, 22 Sep 2022 04:57:59 +0000 Subject: [PATCH] Deploy d22ef2aca9d2034e79f3f08499891adec782962d --- .nojekyll | 0 CNAME | 1 + .../com-carlgo11-tempfiles-Encryption.html | 564 +++++ classes/com-carlgo11-tempfiles-File.html | 1876 +++++++++++++++++ classes/com-carlgo11-tempfiles-Misc.html | 435 ++++ classes/com-carlgo11-tempfiles-api-API.html | 350 +++ .../com-carlgo11-tempfiles-api-Cleanup.html | 429 ++++ .../com-carlgo11-tempfiles-api-Delete.html | 409 ++++ .../com-carlgo11-tempfiles-api-Download.html | 411 ++++ .../com-carlgo11-tempfiles-api-Upload.html | 411 ++++ ...1-tempfiles-datastorage-DataInterface.html | 887 ++++++++ ...o11-tempfiles-datastorage-DataStorage.html | 808 +++++++ ...o11-tempfiles-datastorage-FileStorage.html | 1076 ++++++++++ ...11-tempfiles-datastorage-MySQLStorage.html | 1014 +++++++++ ...arlgo11-tempfiles-exception-BadMethod.html | 361 ++++ ...go11-tempfiles-exception-MissingEntry.html | 361 ++++ css/base.css | 1106 ++++++++++ css/normalize.css | 427 ++++ css/template.css | 192 ++ files/src-com-carlgo11-tempfiles-api-api.html | 253 +++ ...rc-com-carlgo11-tempfiles-api-cleanup.html | 253 +++ ...src-com-carlgo11-tempfiles-api-delete.html | 253 +++ ...c-com-carlgo11-tempfiles-api-download.html | 253 +++ ...src-com-carlgo11-tempfiles-api-upload.html | 253 +++ .../src-com-carlgo11-tempfiles-autoload.html | 423 ++++ files/src-com-carlgo11-tempfiles-config.html | 241 +++ ...1-tempfiles-datastorage-datainterface.html | 253 +++ ...o11-tempfiles-datastorage-datastorage.html | 253 +++ ...o11-tempfiles-datastorage-filestorage.html | 253 +++ ...11-tempfiles-datastorage-mysqlstorage.html | 253 +++ ...src-com-carlgo11-tempfiles-encryption.html | 253 +++ ...arlgo11-tempfiles-exception-badmethod.html | 253 +++ ...go11-tempfiles-exception-missingentry.html | 253 +++ files/src-com-carlgo11-tempfiles-file.html | 254 +++ files/src-com-carlgo11-tempfiles-misc.html | 253 +++ graphs/classes.html | 126 ++ index.html | 336 +++ indices/files.html | 168 ++ js/search.js | 173 ++ js/searchIndex.js | 499 +++++ namespaces/com-carlgo11-tempfiles-api.html | 256 +++ .../com-carlgo11-tempfiles-datastorage.html | 254 +++ .../com-carlgo11-tempfiles-exception.html | 250 +++ namespaces/com-carlgo11-tempfiles.html | 262 +++ namespaces/com-carlgo11.html | 242 +++ namespaces/com.html | 241 +++ namespaces/default.html | 423 ++++ packages/Application.html | 445 ++++ .../com-carlgo11-tempfiles-datastorage.html | 250 +++ packages/com-carlgo11-tempfiles.html | 258 +++ packages/com-carlgo11.html | 242 +++ packages/com.html | 241 +++ packages/default.html | 242 +++ reports/deprecated.html | 157 ++ reports/errors.html | 138 ++ reports/markers.html | 191 ++ 56 files changed, 20719 insertions(+) create mode 100644 .nojekyll create mode 100644 CNAME create mode 100644 classes/com-carlgo11-tempfiles-Encryption.html create mode 100644 classes/com-carlgo11-tempfiles-File.html create mode 100644 classes/com-carlgo11-tempfiles-Misc.html create mode 100644 classes/com-carlgo11-tempfiles-api-API.html create mode 100644 classes/com-carlgo11-tempfiles-api-Cleanup.html create mode 100644 classes/com-carlgo11-tempfiles-api-Delete.html create mode 100644 classes/com-carlgo11-tempfiles-api-Download.html create mode 100644 classes/com-carlgo11-tempfiles-api-Upload.html create mode 100644 classes/com-carlgo11-tempfiles-datastorage-DataInterface.html create mode 100644 classes/com-carlgo11-tempfiles-datastorage-DataStorage.html create mode 100644 classes/com-carlgo11-tempfiles-datastorage-FileStorage.html create mode 100644 classes/com-carlgo11-tempfiles-datastorage-MySQLStorage.html create mode 100644 classes/com-carlgo11-tempfiles-exception-BadMethod.html create mode 100644 classes/com-carlgo11-tempfiles-exception-MissingEntry.html create mode 100644 css/base.css create mode 100644 css/normalize.css create mode 100644 css/template.css create mode 100644 files/src-com-carlgo11-tempfiles-api-api.html create mode 100644 files/src-com-carlgo11-tempfiles-api-cleanup.html create mode 100644 files/src-com-carlgo11-tempfiles-api-delete.html create mode 100644 files/src-com-carlgo11-tempfiles-api-download.html create mode 100644 files/src-com-carlgo11-tempfiles-api-upload.html create mode 100644 files/src-com-carlgo11-tempfiles-autoload.html create mode 100644 files/src-com-carlgo11-tempfiles-config.html create mode 100644 files/src-com-carlgo11-tempfiles-datastorage-datainterface.html create mode 100644 files/src-com-carlgo11-tempfiles-datastorage-datastorage.html create mode 100644 files/src-com-carlgo11-tempfiles-datastorage-filestorage.html create mode 100644 files/src-com-carlgo11-tempfiles-datastorage-mysqlstorage.html create mode 100644 files/src-com-carlgo11-tempfiles-encryption.html create mode 100644 files/src-com-carlgo11-tempfiles-exception-badmethod.html create mode 100644 files/src-com-carlgo11-tempfiles-exception-missingentry.html create mode 100644 files/src-com-carlgo11-tempfiles-file.html create mode 100644 files/src-com-carlgo11-tempfiles-misc.html create mode 100644 graphs/classes.html create mode 100644 index.html create mode 100644 indices/files.html create mode 100644 js/search.js create mode 100644 js/searchIndex.js create mode 100644 namespaces/com-carlgo11-tempfiles-api.html create mode 100644 namespaces/com-carlgo11-tempfiles-datastorage.html create mode 100644 namespaces/com-carlgo11-tempfiles-exception.html create mode 100644 namespaces/com-carlgo11-tempfiles.html create mode 100644 namespaces/com-carlgo11.html create mode 100644 namespaces/com.html create mode 100644 namespaces/default.html create mode 100644 packages/Application.html create mode 100644 packages/com-carlgo11-tempfiles-datastorage.html create mode 100644 packages/com-carlgo11-tempfiles.html create mode 100644 packages/com-carlgo11.html create mode 100644 packages/com.html create mode 100644 packages/default.html create mode 100644 reports/deprecated.html create mode 100644 reports/errors.html create mode 100644 reports/markers.html diff --git a/.nojekyll b/.nojekyll new file mode 100644 index 0000000..e69de29 diff --git a/CNAME b/CNAME new file mode 100644 index 0000000..03706e1 --- /dev/null +++ b/CNAME @@ -0,0 +1 @@ +phpdoc.tempfiles.download \ No newline at end of file diff --git a/classes/com-carlgo11-tempfiles-Encryption.html b/classes/com-carlgo11-tempfiles-Encryption.html new file mode 100644 index 0000000..f70d899 --- /dev/null +++ b/classes/com-carlgo11-tempfiles-Encryption.html @@ -0,0 +1,564 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + + + +
+

Documentation

+ + + + + +
+ +
+
+ + + + +
+ + +
+

+ Encryption + + +
+ in package + +
+ + +

+ + + +

Encryption handling.

+ + + +
+ Tags + +
+
+
+ since +
+
+ 2.0 + + +
+
+ + + + + + +

+ Table of Contents + +

+ +
+
+ createIV() + +  : string +
+
Create an IV (Initialization Vector) string.
+ +
+ decrypt() + +  : string +
+
+ +
+ encrypt() + +  : array<string|int, mixed> +
+
Encrypts string with encryption algorithm specified in config
+ +
+ + + + + + + +
+

+ Methods + +

+
+

+ createIV() + +

+ + +

Create an IV (Initialization Vector) string.

+ + + public + static createIV(string $cipher) : string + +

IV contains of random data from a "random" source. In this case the source is OPENSSL.

+
+ +
Parameters
+
+
+ $cipher + : string +
+
+

Encryption method to use.

+
+ +
+
+ + +
+ Tags + +
+
+
+ throws +
+
+ Exception + +

Throws Exception if unable to create IV

+
+ +
+
+ since +
+
+ 2.0 + + +
+
+ since +
+
+ 2.3 + +

Added support for variable IV length.

+
+ +
+
+ since +
+
+ 3.0 + +

Rename getIV with createIV

+
+ +
+
+ +
Return values
+ string + — +

Returns an IV string encoded with base64.

+
+ + +
+
+

+ decrypt() + +

+ + + + + public + static decrypt(array<string|int, mixed> $input, string $password) : string + + +
Parameters
+
+
+ $input + : array<string|int, mixed> +
+
+

Encrypted data to decrypt.

+
+ +
+
+ $password + : string +
+
+

Plain text decryption password.

+
+ +
+
+ + +
+ Tags + +
+
+
+ since +
+
+ 3.0 + + +
+
+ +
Return values
+ string + — +

Returns decrypted data in the form of a clear text string.

+
+ + +
+
+

+ encrypt() + +

+ + +

Encrypts string with encryption algorithm specified in config

+ + + public + static encrypt(string $input, string $password) : array<string|int, mixed> + + +
Parameters
+
+
+ $input + : string +
+
+

Input data to encrypt.

+
+ +
+
+ $password + : string +
+
+

Plain text password.

+
+ +
+
+ + +
+ Tags + +
+
+
+ throws +
+
+ Exception + +

Throws Exception in the event of encryption error.

+
+ +
+
+ since +
+
+ 3.0 + + +
+
+ example +
+
+ +

encrypt("data", "password");

+
+ +
+
+ +
Return values
+ array<string|int, mixed> + — +

Array containing encrypted version of $input.

+
+ + +
+
+ +
+
+
+
+

+        
+ +
+
+ + + +
+
+
+
+

Search results

+ +
+
+
    +
    +
    +
    +
    +
    + + +
    + + + + + + + + diff --git a/classes/com-carlgo11-tempfiles-File.html b/classes/com-carlgo11-tempfiles-File.html new file mode 100644 index 0000000..41322d3 --- /dev/null +++ b/classes/com-carlgo11-tempfiles-File.html @@ -0,0 +1,1876 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + + + +
    +

    Documentation

    + + + + + +
    + +
    +
    + + + + +
    + + +
    +

    + File + + +
    + in package + +
    + + +

    + + + +

    File class +Stores all file-related data during a file-upload/-download operation.

    + +

    This data is NOT encrypted. See EncryptedFile for the encrypted equivalent.

    +
    + + +
    + Tags + +
    +
    +
    + since +
    +
    + 2.2 + + +
    +
    + + + + + + +

    + Table of Contents + +

    + +
    +
    + $_content + +  : string +
    +
    + +
    + $_currentViews + +  : int +
    +
    + +
    + $_deletionPassword + +  : string +
    +
    + +
    + $_id + +  : string +
    +
    + +
    + $_iv + +  : mixed +
    +
    + +
    + $_maxViews + +  : int +
    +
    + +
    + $_metaData + +  : array<string|int, mixed> +
    +
    + +
    + $_time + +  : mixed +
    +
    + +
    + __construct() + +  : mixed +
    +
    Main function of File class.
    + +
    + __toString() + +  : string +
    +
    Gets ID of the file.
    + +
    + getContent() + +  : string +
    +
    Gets file content.
    + +
    + getCurrentViews() + +  : int +
    +
    Gets the current views of the file if available.
    + +
    + getDateTime() + +  : DateTime|null +
    +
    Get deletion date & time.
    + +
    + getDeletionPassword() + +  : string +
    +
    Gets the deletion password of the file.
    + +
    + getID() + +  : string +
    +
    Gets ID of the file.
    + +
    + getIV() + +  : mixed +
    +
    + +
    + getMaxViews() + +  : int|null +
    +
    Gets the max available views/downloads before the file gets deleted.
    + +
    + getMetaData() + +  : string|array<string|int, mixed> +
    +
    Gets the metadata of the file if supplied.
    + +
    + setContent() + +  : bool +
    +
    Sets the content of the file.
    + +
    + setCurrentViews() + +  : mixed +
    +
    Sets the current views/downloads of the file.
    + +
    + setDateTime() + +  : bool +
    +
    Set deletion date & time.
    + +
    + setDeletionPassword() + +  : bool +
    +
    Sets the deletion password of the file.
    + +
    + setIV() + +  : bool +
    +
    + +
    + setMaxViews() + +  : bool +
    +
    Sets the max views of the file.
    + +
    + setMetaData() + +  : bool +
    +
    Sets the metadata of the file.
    + +
    + generateID() + +  : bool +
    +
    Generates a new ID for the file.
    + +
    + setID() + +  : bool +
    +
    Sets the ID of the file.
    + +
    + + + + + + +
    +

    + Properties + +

    +
    +

    + $_content + + + +

    + + + + + protected + string + $_content + + +
    + +
    + + +
    + Tags + +
    +
    +
    + +
    +
    +

    + $_currentViews + + + +

    + + + + + protected + int + $_currentViews + = 0 + +
    + +
    + + +
    + Tags + +
    +
    +
    + +
    +
    +

    + $_deletionPassword + + + +

    + + + + + protected + string + $_deletionPassword + + +
    + +
    + + +
    + Tags + +
    +
    +
    + +
    +
    +

    + $_id + + + +

    + + + + + protected + string + $_id + + +
    + +
    + + +
    + Tags + +
    +
    +
    + +
    +
    +

    + $_iv + + + +

    + + + + + protected + mixed + $_iv + + +
    + +
    + + +
    + Tags + +
    +
    +
    + +
    +
    +

    + $_maxViews + + + +

    + + + + + protected + int + $_maxViews + = 0 + +
    + +
    + + +
    + Tags + +
    +
    +
    + +
    +
    +

    + $_metaData + + + +

    + + + + + protected + array<string|int, mixed> + $_metaData + + +
    + +
    + + +
    + Tags + +
    +
    +
    + +
    +
    +

    + $_time + + + +

    + + + + + protected + mixed + $_time + + +
    + +
    + + +
    + Tags + +
    +
    +
    + +
    +
    + +
    +

    + Methods + +

    +
    +

    + __construct() + +

    + + +

    Main function of File class.

    + + + public + __construct([null $file = NULL ][, string|null $id = NULL ]) : mixed + + +
    Parameters
    +
    +
    + $file + : null + = NULL
    +
    +

    $_FILES array if available.

    +
    + +
    +
    + $id + : string|null + = NULL
    +
    +

    ID if one is already set.

    +
    + +
    +
    + + +
    + Tags + +
    +
    +
    + since +
    +
    + 2.2 + + +
    +
    + +
    Return values
    + mixed + — + + +
    +
    +

    + __toString() + +

    + + +

    Gets ID of the file.

    + + + public + __toString() : string + + + + +
    + Tags + +
    +
    +
    + since +
    +
    + 2.2 + + +
    +
    + +
    Return values
    + string + — +

    Returns the ID of the file.

    +
    + + +
    +
    +

    + getContent() + +

    + + +

    Gets file content.

    + + + public + getContent() : string + + + + +
    + Tags + +
    +
    +
    + since +
    +
    + 2.2 + + +
    +
    + +
    Return values
    + string + — +

    Returns file content in clear text.

    +
    + + +
    +
    +

    + getCurrentViews() + +

    + + +

    Gets the current views of the file if available.

    + + + public + getCurrentViews() : int + + + + +
    + Tags + +
    +
    +
    + since +
    +
    + 2.2 + + +
    +
    + +
    Return values
    + int + — +

    Returns current views/downloads of the file if supplied, otherwise NULL.

    +
    + + +
    +
    +

    + getDateTime() + +

    + + +

    Get deletion date & time.

    + + + public + getDateTime() : DateTime|null + + + + +
    + Tags + +
    +
    +
    + since +
    +
    + 2.4 + + +
    +
    + +
    Return values
    + DateTime|null + — +

    Returns the time of which the file will be removed if one is set.

    +
    + + +
    +
    +

    + getDeletionPassword() + +

    + + +

    Gets the deletion password of the file.

    + + + public + getDeletionPassword() : string + + + + +
    + Tags + +
    +
    +
    + since +
    +
    + 2.2 + + +
    +
    + +
    Return values
    + string + — +

    Returns deletion password if supplied, otherwise NULL.

    +
    + + +
    +
    +

    + getID() + +

    + + +

    Gets ID of the file.

    + + + public + getID() : string + + + + +
    + Tags + +
    +
    +
    + since +
    +
    + 2.2 + + +
    +
    + +
    Return values
    + string + — +

    Returns the ID of the file.

    +
    + + +
    +
    +

    + getIV() + +

    + + + + + public + getIV() : mixed + +
    + + + +
    + Tags + +
    +
    +
    + +
    Return values
    + mixed + — + + +
    +
    +

    + getMaxViews() + +

    + + +

    Gets the max available views/downloads before the file gets deleted.

    + + + public + getMaxViews() : int|null + + + + +
    + Tags + +
    +
    +
    + since +
    +
    + 2.2 + + +
    +
    + +
    Return values
    + int|null + — +

    Returns max views of the file if supplied, otherwise NULL.

    +
    + + +
    +
    +

    + getMetaData() + +

    + + +

    Gets the metadata of the file if supplied.

    + + + public + getMetaData([string|null $type = NULL ]) : string|array<string|int, mixed> + + +
    Parameters
    +
    +
    + $type + : string|null + = NULL
    +
    +

    Array key of the desired value.

    +
    + +
    +
    + + +
    + Tags + +
    +
    +
    + since +
    +
    + 2.2 + + +
    +
    + +
    Return values
    + string|array<string|int, mixed> + — +

    Returns data of the desired array key if a $type is supplied, otherwise the entire array.

    +
    + + +
    +
    +

    + setContent() + +

    + + +

    Sets the content of the file.

    + + + public + setContent(string $content) : bool + + +
    Parameters
    +
    +
    + $content + : string +
    +
    +

    New content of the file. Should be sent as clear text.

    +
    + +
    +
    + + +
    + Tags + +
    +
    +
    + since +
    +
    + 2.2 + + +
    +
    + +
    Return values
    + bool + — +

    Returns TRUE if the action was successfully executed, otherwise FALSE.

    +
    + + +
    +
    +

    + setCurrentViews() + +

    + + +

    Sets the current views/downloads of the file.

    + + + public + setCurrentViews(int $views) : mixed + + +
    Parameters
    +
    +
    + $views + : int +
    +
    +

    New views/downloads of the file.

    +
    + +
    +
    + + +
    + Tags + +
    +
    +
    + since +
    +
    + 2.2 + + +
    +
    + since +
    +
    + 2.4 + +

    Switched from deleteFile() in DataStorage to FileStorage.

    +
    + +
    +
    + +
    Return values
    + mixed + — + + +
    +
    +

    + setDateTime() + +

    + + +

    Set deletion date & time.

    + + + public + setDateTime(DateTime $time) : bool + + +
    Parameters
    +
    +
    + $time + : DateTime +
    +
    +

    New DateTime.

    +
    + +
    +
    + + +
    + Tags + +
    +
    +
    + since +
    +
    + 2.4 + + +
    +
    + +
    Return values
    + bool + — +

    Returns TRUE if the action was successful, otherwise FALSE.

    +
    + + +
    +
    +

    + setDeletionPassword() + +

    + + +

    Sets the deletion password of the file.

    + + + public + setDeletionPassword(string $deletionPassword) : bool + + +
    Parameters
    +
    +
    + $deletionPassword + : string +
    +
    +

    New deletion password of the file.

    +
    + +
    +
    + + +
    + Tags + +
    +
    +
    + since +
    +
    + 2.2 + + +
    +
    + +
    Return values
    + bool + — +

    Returns TRUE if the action was successfully executed, otherwise FALSE.

    +
    + + +
    +
    +

    + setIV() + +

    + + + + + public + setIV(array<string|int, mixed> $iv) : bool + +
    + +
    Parameters
    +
    +
    + $iv + : array<string|int, mixed> +
    +
    +
    + +
    +
    + + +
    + Tags + +
    +
    +
    + +
    Return values
    + bool + — + + +
    +
    +

    + setMaxViews() + +

    + + +

    Sets the max views of the file.

    + + + public + setMaxViews(int $views) : bool + + +
    Parameters
    +
    +
    + $views + : int +
    +
    +

    New max views of the file.

    +
    + +
    +
    + + +
    + Tags + +
    +
    +
    + since +
    +
    + 2.2 + + +
    +
    + +
    Return values
    + bool + — +

    Returns TRUE if the action was successfully executed, otherwise FALSE.

    +
    + + +
    +
    +

    + setMetaData() + +

    + + +

    Sets the metadata of the file.

    + + + public + setMetaData(array<string|int, mixed> $metaData) : bool + + +
    Parameters
    +
    +
    + $metaData + : array<string|int, mixed> +
    +
    +
    + +
    +
    + + +
    + Tags + +
    +
    +
    + throws +
    +
    + Exception + +

    Throws exception if size isn't a number.

    +
    + +
    +
    + since +
    +
    + 2.2 + + +
    +
    + +
    Return values
    + bool + — +

    Returns TRUE if the action was successfully executed, otherwise FALSE.

    +
    + + +
    +
    +

    + generateID() + +

    + + +

    Generates a new ID for the file.

    + + + private + generateID() : bool + + + + +
    + Tags + +
    +
    +
    + since +
    +
    + 2.2 + + +
    +
    + since +
    +
    + 2.5 + +

    2nd char is now Server Identifier.

    +
    + +
    +
    + +
    Return values
    + bool + — +

    Returns TRUE if the action was successfully executed, otherwise FALSE.

    +
    + + +
    +
    +

    + setID() + +

    + + +

    Sets the ID of the file.

    + + + private + setID(string $id) : bool + + +
    Parameters
    +
    +
    + $id + : string +
    +
    +

    New ID of the file.

    +
    + +
    +
    + + +
    + Tags + +
    +
    +
    + since +
    +
    + 2.2 + + +
    +
    + +
    Return values
    + bool + — +

    Returns TRUE if the action was successfully executed, otherwise FALSE.

    +
    + + +
    +
    + +
    +
    +
    +
    +
    
    +        
    + +
    +
    + + + +
    +
    +
    +
    +

    Search results

    + +
    +
    +
      +
      +
      +
      +
      +
      + + +
      + + + + + + + + diff --git a/classes/com-carlgo11-tempfiles-Misc.html b/classes/com-carlgo11-tempfiles-Misc.html new file mode 100644 index 0000000..dc493a1 --- /dev/null +++ b/classes/com-carlgo11-tempfiles-Misc.html @@ -0,0 +1,435 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + + + +
      +

      Documentation

      + + + + + +
      + +
      +
      + + + + +
      + + +
      +

      + Misc + + +
      + in package + +
      + + +

      + + + +

      Miscellaneous functions

      + + + +
      + Tags + +
      +
      +
      + since +
      +
      + 2.0 + + +
      +
      + + + + + + +

      + Table of Contents + +

      + +
      +
      + generatePassword() + +  : string +
      +
      Generate a password to use for encryption.
      + +
      + getVar() + +  : string +
      +
      Get a parameter from either $_GET or $_POST.
      + +
      + + + + + + + +
      +

      + Methods + +

      +
      +

      + generatePassword() + +

      + + +

      Generate a password to use for encryption.

      + + + public + static generatePassword([int $minlength = 4 ][, int $maxlength = 10 ]) : string + +

      This function should only be used if a password is not supplied as it's less secure than if the user chooses their own password.

      +
      + +
      Parameters
      +
      +
      + $minlength + : int + = 4
      +
      +

      Minimum length of the password.

      +
      + +
      +
      + $maxlength + : int + = 10
      +
      +

      Maximum length of the password.

      +
      + +
      +
      + + +
      + Tags + +
      +
      +
      + +
      Return values
      + string + — +

      Returns a string of random characters to use as a password.

      +
      + + +
      +
      +

      + getVar() + +

      + + +

      Get a parameter from either $_GET or $_POST.

      + + + public + static getVar(string $name) : string + + +
      Parameters
      +
      +
      + $name + : string +
      +
      +

      Name of the parameter.

      +
      + +
      +
      + + +
      + Tags + +
      +
      +
      + since +
      +
      + 2.4 + +

      Added default NULL return.

      +
      + +
      +
      + +
      Return values
      + string + — +

      Returns parameter data if the parameter exists.

      +
      + + +
      +
      + +
      +
      +
      +
      +
      
      +        
      + +
      +
      + + + +
      +
      +
      +
      +

      Search results

      + +
      +
      +
        +
        +
        +
        +
        +
        + + +
        + + + + + + + + diff --git a/classes/com-carlgo11-tempfiles-api-API.html b/classes/com-carlgo11-tempfiles-api-API.html new file mode 100644 index 0000000..f16403d --- /dev/null +++ b/classes/com-carlgo11-tempfiles-api-API.html @@ -0,0 +1,350 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + + + +
        +

        Documentation

        + + + + + +
        + +
        +
        + + + + +
        + + +
        +

        + API + + +
        + in package + +
        + + +

        + + + + +
        + + +
        + Tags + +
        +
        +
        + + + + + + +

        + Table of Contents + +

        + +
        +
        + outputJSON() + +  : int +
        +
        + +
        + + + + + + + +
        +

        + Methods + +

        +
        +

        + outputJSON() + +

        + + + + + public + outputJSON(mixed $data[, int $HTTPCode = 200 ]) : int + +
        + +
        Parameters
        +
        +
        + $data + : mixed +
        +
        +
        + +
        +
        + $HTTPCode + : int + = 200
        +
        +
        + +
        +
        + + +
        + Tags + +
        +
        +
        + +
        Return values
        + int + — + + +
        +
        + +
        +
        +
        +
        +
        
        +        
        + +
        +
        + + + +
        +
        +
        +
        +

        Search results

        + +
        +
        +
          +
          +
          +
          +
          +
          + + +
          + + + + + + + + diff --git a/classes/com-carlgo11-tempfiles-api-Cleanup.html b/classes/com-carlgo11-tempfiles-api-Cleanup.html new file mode 100644 index 0000000..c097a6b --- /dev/null +++ b/classes/com-carlgo11-tempfiles-api-Cleanup.html @@ -0,0 +1,429 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + + + +
          +

          Documentation

          + + + + + +
          + +
          +
          + + + + +
          + + +
          +

          + Cleanup + + + extends API + + +
          + in package + +
          + + +

          + + + + +
          + + +
          + Tags + +
          +
          +
          + + + + + + +

          + Table of Contents + +

          + +
          +
          + __construct() + +  : mixed +
          +
          Cleanup constructor.
          + +
          + outputJSON() + +  : int +
          +
          + +
          + + + + + + + +
          +

          + Methods + +

          +
          +

          + __construct() + +

          + + +

          Cleanup constructor.

          + + + public + __construct(string|false $method) : mixed + + +
          Parameters
          +
          +
          + $method + : string|false +
          +
          +

          Request HTTP method.

          +
          + +
          +
          + + +
          + Tags + +
          +
          +
          + since +
          +
          + 2.4 + +

          Changed internals to work with FileStorage

          +
          + +
          +
          + since +
          +
          + 2.3 + + +
          +
          + +
          Return values
          + mixed + — + + +
          +
          +

          + outputJSON() + +

          + + + + + public + outputJSON(mixed $data[, int $HTTPCode = 200 ]) : int + +
          + +
          Parameters
          +
          +
          + $data + : mixed +
          +
          +
          + +
          +
          + $HTTPCode + : int + = 200
          +
          +
          + +
          +
          + + +
          + Tags + +
          +
          +
          + +
          Return values
          + int + — + + +
          +
          + +
          +
          +
          +
          +
          
          +        
          + +
          +
          + + + +
          +
          +
          +
          +

          Search results

          + +
          +
          +
            +
            +
            +
            +
            +
            + + +
            + + + + + + + + diff --git a/classes/com-carlgo11-tempfiles-api-Delete.html b/classes/com-carlgo11-tempfiles-api-Delete.html new file mode 100644 index 0000000..b3e7783 --- /dev/null +++ b/classes/com-carlgo11-tempfiles-api-Delete.html @@ -0,0 +1,409 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + + + +
            +

            Documentation

            + + + + + +
            + +
            +
            + + + + +
            + + +
            +

            + Delete + + + extends API + + +
            + in package + +
            + + +

            + + + + +
            + + +
            + Tags + +
            +
            +
            + + + + + + +

            + Table of Contents + +

            + +
            +
            + __construct() + +  : mixed +
            +
            Delete constructor.
            + +
            + outputJSON() + +  : int +
            +
            + +
            + + + + + + + +
            +

            + Methods + +

            +
            +

            + __construct() + +

            + + +

            Delete constructor.

            + + + public + __construct(string|false $method) : mixed + + +
            Parameters
            +
            +
            + $method + : string|false +
            +
            + +
            +
            + + +
            + Tags + +
            +
            +
            + +
            Return values
            + mixed + — + + +
            +
            +

            + outputJSON() + +

            + + + + + public + outputJSON(mixed $data[, int $HTTPCode = 200 ]) : int + +
            + +
            Parameters
            +
            +
            + $data + : mixed +
            +
            +
            + +
            +
            + $HTTPCode + : int + = 200
            +
            +
            + +
            +
            + + +
            + Tags + +
            +
            +
            + +
            Return values
            + int + — + + +
            +
            + +
            +
            +
            +
            +
            
            +        
            + +
            +
            + + + +
            +
            +
            +
            +

            Search results

            + +
            +
            +
              +
              +
              +
              +
              +
              + + +
              + + + + + + + + diff --git a/classes/com-carlgo11-tempfiles-api-Download.html b/classes/com-carlgo11-tempfiles-api-Download.html new file mode 100644 index 0000000..001edcd --- /dev/null +++ b/classes/com-carlgo11-tempfiles-api-Download.html @@ -0,0 +1,411 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + + + +
              +

              Documentation

              + + + + + +
              + +
              +
              + + + + +
              + + +
              +

              + Download + + + extends API + + +
              + in package + +
              + + +

              + + + + +
              + + +
              + Tags + +
              +
              +
              + + + + + + +

              + Table of Contents + +

              + +
              +
              + __construct() + +  : mixed +
              +
              Download constructor.
              + +
              + outputJSON() + +  : int +
              +
              + +
              + + + + + + + +
              +

              + Methods + +

              +
              +

              + __construct() + +

              + + +

              Download constructor.

              + + + public + __construct(string|false $method) : mixed + + +
              Parameters
              +
              +
              + $method + : string|false +
              +
              +

              HTTP method.

              +
              + +
              +
              + + +
              + Tags + +
              +
              +
              + +
              Return values
              + mixed + — + + +
              +
              +

              + outputJSON() + +

              + + + + + public + outputJSON(mixed $data[, int $HTTPCode = 200 ]) : int + +
              + +
              Parameters
              +
              +
              + $data + : mixed +
              +
              +
              + +
              +
              + $HTTPCode + : int + = 200
              +
              +
              + +
              +
              + + +
              + Tags + +
              +
              +
              + +
              Return values
              + int + — + + +
              +
              + +
              +
              +
              +
              +
              
              +        
              + +
              +
              + + + +
              +
              +
              +
              +

              Search results

              + +
              +
              +
                +
                +
                +
                +
                +
                + + +
                + + + + + + + + diff --git a/classes/com-carlgo11-tempfiles-api-Upload.html b/classes/com-carlgo11-tempfiles-api-Upload.html new file mode 100644 index 0000000..b873670 --- /dev/null +++ b/classes/com-carlgo11-tempfiles-api-Upload.html @@ -0,0 +1,411 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + + + +
                +

                Documentation

                + + + + + +
                + +
                +
                + + + + +
                + + +
                +

                + Upload + + + extends API + + +
                + in package + +
                + + +

                + + + + +
                + + +
                + Tags + +
                +
                +
                + + + + + + +

                + Table of Contents + +

                + +
                +
                + __construct() + +  : mixed +
                +
                Upload constructor.
                + +
                + outputJSON() + +  : int +
                +
                + +
                + + + + + + + +
                +

                + Methods + +

                +
                +

                + __construct() + +

                + + +

                Upload constructor.

                + + + public + __construct(string|false $method) : mixed + + +
                Parameters
                +
                +
                + $method + : string|false +
                +
                +

                HTTP method.

                +
                + +
                +
                + + +
                + Tags + +
                +
                +
                + +
                Return values
                + mixed + — + + +
                +
                +

                + outputJSON() + +

                + + + + + public + outputJSON(mixed $data[, int $HTTPCode = 200 ]) : int + +
                + +
                Parameters
                +
                +
                + $data + : mixed +
                +
                +
                + +
                +
                + $HTTPCode + : int + = 200
                +
                +
                + +
                +
                + + +
                + Tags + +
                +
                +
                + +
                Return values
                + int + — + + +
                +
                + +
                +
                +
                +
                +
                
                +        
                + +
                +
                + + + +
                +
                +
                +
                +

                Search results

                + +
                +
                +
                  +
                  +
                  +
                  +
                  +
                  + + +
                  + + + + + + + + diff --git a/classes/com-carlgo11-tempfiles-datastorage-DataInterface.html b/classes/com-carlgo11-tempfiles-datastorage-DataInterface.html new file mode 100644 index 0000000..68c77d7 --- /dev/null +++ b/classes/com-carlgo11-tempfiles-datastorage-DataInterface.html @@ -0,0 +1,887 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + + + +
                  +

                  Documentation

                  + + + + + +
                  + +
                  +
                  + + + + +
                  + + +
                  +

                  + DataInterface +
                  + in + +
                  +

                  + + + + +
                  + + +
                  + Tags + +
                  +
                  +
                  + + + + + + +

                  + Table of Contents + +

                  + +
                  +
                  + deleteEntry() + +  : bool +
                  +
                  Delete a stored entry (file)
                  + +
                  + entryExists() + +  : bool +
                  +
                  See if an entry with the provided ID exists.
                  + +
                  + getDelPassword() + +  : mixed +
                  +
                  Get Deletion password hash.
                  + +
                  + getEntryContent() + +  : array<string|int, mixed>|null +
                  +
                  Get encrypted content (file data) from a stored entry.
                  + +
                  + getEntryExpiry() + +  : string +
                  +
                  Get the expiry date of a stored entry.
                  + +
                  + getEntryMetaData() + +  : array<string|int, mixed>|null +
                  +
                  Get encrypted metadata.
                  + +
                  + listEntries() + +  : array<string|int, mixed>|false +
                  +
                  Get all stored entry IDs
                  + +
                  + saveEntry() + +  : bool +
                  +
                  Save an uploaded entry.
                  + +
                  + + + + + +
                  +

                  + Methods + +

                  +
                  +

                  + deleteEntry() + +

                  + + +

                  Delete a stored entry (file)

                  + + + public + deleteEntry(string $id) : bool + + +
                  Parameters
                  +
                  +
                  + $id + : string +
                  +
                  +

                  Unique ID of the entry to delete.

                  +
                  + +
                  +
                  + + +
                  + Tags + +
                  +
                  +
                  + throws +
                  +
                  + MissingEntry + +

                  Throws MissingEntry exception if no entry with the ID exists.

                  +
                  + +
                  +
                  + since +
                  +
                  + 2.5 + + +
                  +
                  + +
                  Return values
                  + bool + — +

                  Returns true if stored entry successfully deleted.

                  +
                  + + +
                  +
                  +

                  + entryExists() + +

                  + + +

                  See if an entry with the provided ID exists.

                  + + + public + entryExists(string $id) : bool + + +
                  Parameters
                  +
                  +
                  + $id + : string +
                  +
                  +

                  Unique ID of the entry.

                  +
                  + +
                  +
                  + + +
                  + Tags + +
                  +
                  +
                  + since +
                  +
                  + 2.5 + + +
                  +
                  + +
                  Return values
                  + bool + — +

                  Returns TRUE if entry exists, otherwise FALSE.

                  +
                  + + +
                  +
                  +

                  + getDelPassword() + +

                  + + +

                  Get Deletion password hash.

                  + + + public + getDelPassword(string $id) : mixed + + +
                  Parameters
                  +
                  +
                  + $id + : string +
                  +
                  +

                  ID of the entry.

                  +
                  + +
                  +
                  + + +
                  + Tags + +
                  +
                  +
                  + throws +
                  +
                  + MissingEntry + +

                  Throws MissingEntry exception if no entry with the ID exists.

                  +
                  + +
                  +
                  + since +
                  +
                  + 3.0 + + +
                  +
                  + +
                  Return values
                  + mixed + — + + +
                  +
                  +

                  + getEntryContent() + +

                  + + +

                  Get encrypted content (file data) from a stored entry.

                  + + + public + getEntryContent(string $id) : array<string|int, mixed>|null + + +
                  Parameters
                  +
                  +
                  + $id + : string +
                  +
                  +

                  Unique ID of the stored entry.

                  +
                  + +
                  +
                  + + +
                  + Tags + +
                  +
                  +
                  + throws +
                  +
                  + MissingEntry + +

                  Throws MissingEntry exception if no entry with the ID exists.

                  +
                  + +
                  +
                  + since +
                  +
                  + 2.5 + + +
                  +
                  + since +
                  +
                  + 3.0 + +

                  Throw MissingEntry exception instead of NULL.

                  +
                  + +
                  +
                  + +
                  Return values
                  + array<string|int, mixed>|null + — +

                  Returns base64 encoded, encrypted binary file data.

                  +
                  + + +
                  +
                  +

                  + getEntryExpiry() + +

                  + + +

                  Get the expiry date of a stored entry.

                  + + + public + getEntryExpiry(string $id) : string + + +
                  Parameters
                  +
                  +
                  + $id + : string +
                  +
                  +

                  Unique ID of the entry.

                  +
                  + +
                  +
                  + + +
                  + Tags + +
                  +
                  +
                  + throws +
                  +
                  + MissingEntry + +

                  Throws MissingEntry exception if no entry with the ID exists.

                  +
                  + +
                  +
                  + since +
                  +
                  + 2.5 + + +
                  +
                  + +
                  Return values
                  + string + — +

                  Returns the timestamp as a string.

                  +
                  + + +
                  +
                  +

                  + getEntryMetaData() + +

                  + + +

                  Get encrypted metadata.

                  + + + public + getEntryMetaData(string $id) : array<string|int, mixed>|null + + +
                  Parameters
                  +
                  +
                  + $id + : string +
                  +
                  +

                  Unique ID of the stored entry.

                  +
                  + +
                  +
                  + + +
                  + Tags + +
                  +
                  +
                  + throws +
                  +
                  + MissingEntry + +

                  Throws MissingEntry exception if no entry with the ID exists.

                  +
                  + +
                  +
                  + since +
                  +
                  + 2.5 + + +
                  +
                  + +
                  Return values
                  + array<string|int, mixed>|null + — +

                  Returns an encrypted array (split ' ') containing: [0 => name, 1=> size, 2=> type, 3=> deletion password hash, 4=> view array]

                  +
                  + + +
                  +
                  +

                  + listEntries() + +

                  + + +

                  Get all stored entry IDs

                  + + + public + listEntries() : array<string|int, mixed>|false + + + + +
                  + Tags + +
                  +
                  +
                  + since +
                  +
                  + 2.5 + + +
                  +
                  + +
                  Return values
                  + array<string|int, mixed>|false + — +

                  Returns an array of all stored entries.

                  +
                  + + +
                  +
                  +

                  + saveEntry() + +

                  + + +

                  Save an uploaded entry.

                  + + + public + saveEntry(array<string|int, mixed> $file, string $deletionPassword[, array<string|int, mixed>|null $views = NULL ]) : bool + + +
                  Parameters
                  +
                  +
                  + $file + : array<string|int, mixed> +
                  +
                  +

                  EncryptedFile object to store

                  +
                  + +
                  +
                  + $deletionPassword + : string +
                  +
                  +

                  Deletion password hash.

                  +
                  + +
                  +
                  + $views + : array<string|int, mixed>|null + = NULL
                  +
                  +

                  Views array containing current views and max views.

                  +
                  + +
                  +
                  + + +
                  + Tags + +
                  +
                  +
                  + since +
                  +
                  + 2.5 + + +
                  +
                  + +
                  Return values
                  + bool + — +

                  Returns true if file was successfully saved.

                  +
                  + + +
                  +
                  + +
                  +
                  +
                  +
                  +
                  
                  +        
                  + +
                  +
                  + + + +
                  +
                  +
                  +
                  +

                  Search results

                  + +
                  +
                  +
                    +
                    +
                    +
                    +
                    +
                    + + +
                    + + + + + + + + diff --git a/classes/com-carlgo11-tempfiles-datastorage-DataStorage.html b/classes/com-carlgo11-tempfiles-datastorage-DataStorage.html new file mode 100644 index 0000000..a61b0a8 --- /dev/null +++ b/classes/com-carlgo11-tempfiles-datastorage-DataStorage.html @@ -0,0 +1,808 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + + + +
                    +

                    Documentation

                    + + + + + +
                    + +
                    +
                    + + + + +
                    + + +
                    +

                    + DataStorage + + +
                    + in package + +
                    + + +

                    + + + +

                    High level data storage handler.

                    + + + +
                    + Tags + +
                    +
                    +
                    + since +
                    +
                    + 2.5 + + +
                    +
                    + + + + + + +

                    + Table of Contents + +

                    + +
                    +
                    + deleteFile() + +  : bool +
                    +
                    Delete a stored entry.
                    + +
                    + deleteOldFiles() + +  : mixed +
                    +
                    Delete all files older than 24 hours.
                    + +
                    + getDeletionPassword() + +  : string +
                    +
                    + +
                    + getFile() + +  : File +
                    +
                    Get a stored entry.
                    + +
                    + getStorage() + +  : FileStorage|MySQLStorage|false +
                    +
                    Get storage method specified in config.
                    + +
                    + saveFile() + +  : bool +
                    +
                    Save an uploaded entry.
                    + +
                    + updateViews() + +  : bool +
                    +
                    Update current views on existing entry.
                    + +
                    + + + + + + + +
                    +

                    + Methods + +

                    +
                    +

                    + deleteFile() + +

                    + + +

                    Delete a stored entry.

                    + + + public + static deleteFile(string $id) : bool + + +
                    Parameters
                    +
                    +
                    + $id + : string +
                    +
                    +

                    Unique ID of the entry to delete.

                    +
                    + +
                    +
                    + + +
                    + Tags + +
                    +
                    +
                    + throws +
                    +
                    + Exception + +

                    Throws any exceptions from the storage classes.

                    +
                    + +
                    +
                    + since +
                    +
                    + 2.5 + + +
                    +
                    + +
                    Return values
                    + bool + — +

                    Returns TRUE on success & FALSE on failure.

                    +
                    + + +
                    +
                    +

                    + deleteOldFiles() + +

                    + + +

                    Delete all files older than 24 hours.

                    + + + public + static deleteOldFiles() : mixed + + + + +
                    + Tags + +
                    +
                    +
                    + throws +
                    +
                    + Exception + +

                    Throws any exceptions from the storage classes.

                    +
                    + +
                    +
                    + since +
                    +
                    + 2.5 + + +
                    +
                    + +
                    Return values
                    + mixed + — + + +
                    +
                    +

                    + getDeletionPassword() + +

                    + + + + + public + static getDeletionPassword(string $id) : string + +
                    + +
                    Parameters
                    +
                    +
                    + $id + : string +
                    +
                    +
                    + +
                    +
                    + + +
                    + Tags + +
                    +
                    +
                    + +
                    Return values
                    + string + — + + +
                    +
                    +

                    + getFile() + +

                    + + +

                    Get a stored entry.

                    + + + public + static getFile(string $id, string $password) : File + + +
                    Parameters
                    +
                    +
                    + $id + : string +
                    +
                    +

                    Unique ID of the stored entry.

                    +
                    + +
                    +
                    + $password + : string +
                    +
                    +

                    Decryption key of the stored file.

                    +
                    + +
                    +
                    + + +
                    + Tags + +
                    +
                    +
                    + throws +
                    +
                    + Exception + +

                    Throws exception upon file-fetching failure.

                    +
                    + +
                    +
                    + since +
                    +
                    + 2.5 + + +
                    +
                    + +
                    Return values
                    + File + — +

                    Decrypted file as a File object.

                    +
                    + + +
                    +
                    +

                    + getStorage() + +

                    + + +

                    Get storage method specified in config.

                    + + + public + static getStorage() : FileStorage|MySQLStorage|false + + + + +
                    + Tags + +
                    +
                    +
                    + since +
                    +
                    + 2.5 + + +
                    +
                    + +
                    Return values
                    + FileStorage|MySQLStorage|false + — +

                    Returns the storage class specified in the config or FALSE if non is set.

                    +
                    + + +
                    +
                    +

                    + saveFile() + +

                    + + +

                    Save an uploaded entry.

                    + + + public + static saveFile(File $file, string $password) : bool + + +
                    Parameters
                    +
                    +
                    + $file + : File +
                    +
                    +

                    File object to store.

                    +
                    + +
                    +
                    + $password + : string +
                    +
                    +

                    Encryption key.

                    +
                    + +
                    +
                    + + +
                    + Tags + +
                    +
                    +
                    + throws +
                    +
                    + Exception + + +
                    +
                    + since +
                    +
                    + 2.5 + + +
                    +
                    + +
                    Return values
                    + bool + — +

                    Returns TRUE if successful, otherwise false.

                    +
                    + + +
                    +
                    +

                    + updateViews() + +

                    + + +

                    Update current views on existing entry.

                    + + + public + static updateViews(string $id, int $currentViews) : bool + + +
                    Parameters
                    +
                    +
                    + $id + : string +
                    +
                    +

                    Unique ID of the stored entry.

                    +
                    + +
                    +
                    + $currentViews + : int +
                    +
                    +

                    New current views.

                    +
                    + +
                    +
                    + + +
                    + Tags + +
                    +
                    +
                    + throws +
                    +
                    + Exception + + +
                    +
                    + since +
                    +
                    + 3.0 + + +
                    +
                    + +
                    Return values
                    + bool + — +

                    Returns TRUE if views were successfully changed.

                    +
                    + + +
                    +
                    + +
                    +
                    +
                    +
                    +
                    
                    +        
                    + +
                    +
                    + + + +
                    +
                    +
                    +
                    +

                    Search results

                    + +
                    +
                    +
                      +
                      +
                      +
                      +
                      +
                      + + +
                      + + + + + + + + diff --git a/classes/com-carlgo11-tempfiles-datastorage-FileStorage.html b/classes/com-carlgo11-tempfiles-datastorage-FileStorage.html new file mode 100644 index 0000000..d02b45b --- /dev/null +++ b/classes/com-carlgo11-tempfiles-datastorage-FileStorage.html @@ -0,0 +1,1076 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + + + +
                      +

                      Documentation

                      + + + + + +
                      + +
                      +
                      + + + + +
                      + + +
                      +

                      + FileStorage + + +
                      + in package + +
                      + + + implements + DataInterface + +

                      + + + +

                      Local file storage class

                      + +

                      Should only be called by DataStorage!

                      +
                      + + +
                      + Tags + +
                      +
                      +
                      + since +
                      +
                      + 2.5 + + +
                      +
                      + + + + +

                      + Interfaces, Classes, Traits and Enums + +

                      + +
                      +
                      DataInterface
                      +
                      + + + +
                      + + +

                      + Table of Contents + +

                      + +
                      +
                      + deleteEntry() + +  : bool +
                      +
                      Delete a stored entry (file)
                      + +
                      + entryExists() + +  : bool +
                      +
                      See if an entry with the provided ID exists.
                      + +
                      + getDelPassword() + +  : mixed +
                      +
                      Get Deletion password hash.
                      + +
                      + getEntryContent() + +  : array<string|int, mixed> +
                      +
                      Get encrypted content (file data) from a stored entry.
                      + +
                      + getEntryExpiry() + +  : string +
                      +
                      Get the expiry date of a stored entry.
                      + +
                      + getEntryMetaData() + +  : array<string|int, mixed>|null +
                      +
                      Get encrypted metadata.
                      + +
                      + getEntryViews() + +  : array<string|int, mixed>|null +
                      +
                      Get views and max views of a stored entry.
                      + +
                      + listEntries() + +  : array<string|int, mixed>|false +
                      +
                      Get all stored entry IDs
                      + +
                      + saveEntry() + +  : bool +
                      +
                      Save an uploaded entry.
                      + +
                      + updateEntryViews() + +  : bool +
                      +
                      Update views array in stored entry file.
                      + +
                      + + + + + + + +
                      +

                      + Methods + +

                      +
                      +

                      + deleteEntry() + +

                      + + +

                      Delete a stored entry (file)

                      + + + public + deleteEntry(string $id) : bool + + +
                      Parameters
                      +
                      +
                      + $id + : string +
                      +
                      +

                      Unique ID of the entry to delete.

                      +
                      + +
                      +
                      + + +
                      + Tags + +
                      +
                      +
                      + throws +
                      +
                      + MissingEntry + +

                      Throws MissingEntry exception if no entry with the ID exists.

                      +
                      + +
                      +
                      + since +
                      +
                      + 2.5 + + +
                      +
                      + +
                      Return values
                      + bool + — +

                      Returns true if stored entry successfully deleted.

                      +
                      + + +
                      +
                      +

                      + entryExists() + +

                      + + +

                      See if an entry with the provided ID exists.

                      + + + public + entryExists(string $id) : bool + + +
                      Parameters
                      +
                      +
                      + $id + : string +
                      +
                      +

                      Unique ID of the entry.

                      +
                      + +
                      +
                      + + +
                      + Tags + +
                      +
                      +
                      + since +
                      +
                      + 2.5 + + +
                      +
                      + +
                      Return values
                      + bool + — +

                      Returns TRUE if entry exists, otherwise FALSE.

                      +
                      + + +
                      +
                      +

                      + getDelPassword() + +

                      + + +

                      Get Deletion password hash.

                      + + + public + getDelPassword(string $id) : mixed + + +
                      Parameters
                      +
                      +
                      + $id + : string +
                      +
                      +

                      ID of the entry.

                      +
                      + +
                      +
                      + + +
                      + Tags + +
                      +
                      +
                      + throws +
                      +
                      + MissingEntry + +

                      Throws MissingEntry exception if no entry with the ID exists.

                      +
                      + +
                      +
                      + since +
                      +
                      + 3.0 + + +
                      +
                      + +
                      Return values
                      + mixed + — + + +
                      +
                      +

                      + getEntryContent() + +

                      + + +

                      Get encrypted content (file data) from a stored entry.

                      + + + public + getEntryContent(string $id) : array<string|int, mixed> + + +
                      Parameters
                      +
                      +
                      + $id + : string +
                      +
                      +

                      Unique ID of the stored entry.

                      +
                      + +
                      +
                      + + +
                      + Tags + +
                      +
                      +
                      + throws +
                      +
                      + MissingEntry + +

                      Throws MissingEntry exception if no entry with the ID exists.

                      +
                      + +
                      +
                      + since +
                      +
                      + 2.5 + + +
                      +
                      + since +
                      +
                      + 3.0 + +

                      Throw MissingEntry exception instead of NULL.

                      +
                      + +
                      +
                      + +
                      Return values
                      + array<string|int, mixed> + — +

                      Returns base64 encoded, encrypted binary file data.

                      +
                      + + +
                      +
                      +

                      + getEntryExpiry() + +

                      + + +

                      Get the expiry date of a stored entry.

                      + + + public + getEntryExpiry(string $id) : string + + +
                      Parameters
                      +
                      +
                      + $id + : string +
                      +
                      +

                      Unique ID of the entry.

                      +
                      + +
                      +
                      + + +
                      + Tags + +
                      +
                      +
                      + throws +
                      +
                      + MissingEntry + +

                      Throws MissingEntry exception if no entry with the ID exists.

                      +
                      + +
                      +
                      + since +
                      +
                      + 2.5 + + +
                      +
                      + +
                      Return values
                      + string + — +

                      Returns the timestamp as a string.

                      +
                      + + +
                      +
                      +

                      + getEntryMetaData() + +

                      + + +

                      Get encrypted metadata.

                      + + + public + getEntryMetaData(string $id) : array<string|int, mixed>|null + + +
                      Parameters
                      +
                      +
                      + $id + : string +
                      +
                      +

                      Unique ID of the stored entry.

                      +
                      + +
                      +
                      + + +
                      + Tags + +
                      +
                      +
                      + throws +
                      +
                      + MissingEntry + +

                      Throws MissingEntry exception if no entry with the ID exists.

                      +
                      + +
                      +
                      + since +
                      +
                      + 2.5 + + +
                      +
                      + +
                      Return values
                      + array<string|int, mixed>|null + — +

                      Returns an encrypted array (split ' ') containing: [0 => name, 1=> size, 2=> type, 3=> deletion password hash, 4=> view array]

                      +
                      + + +
                      +
                      +

                      + getEntryViews() + +

                      + + +

                      Get views and max views of a stored entry.

                      + + + public + getEntryViews(string $id) : array<string|int, mixed>|null + + +
                      Parameters
                      +
                      +
                      + $id + : string +
                      +
                      +

                      Unique ID of the stored entry.

                      +
                      + +
                      +
                      + + +
                      + Tags + +
                      +
                      +
                      + throws +
                      +
                      + MissingEntry + +

                      Throws MissingEntry exception if no entry with the ID exists.

                      +
                      + +
                      +
                      + since +
                      +
                      + 3.0 + + +
                      +
                      + +
                      Return values
                      + array<string|int, mixed>|null + — +

                      Returns an array containing: [0 => current views, 1 => max views].

                      +
                      + + +
                      +
                      +

                      + listEntries() + +

                      + + +

                      Get all stored entry IDs

                      + + + public + listEntries() : array<string|int, mixed>|false + + + + +
                      + Tags + +
                      +
                      +
                      + since +
                      +
                      + 2.5 + + +
                      +
                      + +
                      Return values
                      + array<string|int, mixed>|false + — +

                      Returns an array of all stored entries.

                      +
                      + + +
                      +
                      +

                      + saveEntry() + +

                      + + +

                      Save an uploaded entry.

                      + + + public + saveEntry(array<string|int, mixed> $file, string $deletionPassword[, array<string|int, mixed>|null $views = NULL ]) : bool + + +
                      Parameters
                      +
                      +
                      + $file + : array<string|int, mixed> +
                      +
                      +

                      object to store

                      +
                      + +
                      +
                      + $deletionPassword + : string +
                      +
                      +

                      Deletion password hash.

                      +
                      + +
                      +
                      + $views + : array<string|int, mixed>|null + = NULL
                      +
                      +

                      Views array containing current views and max views.

                      +
                      + +
                      +
                      + + +
                      + Tags + +
                      +
                      +
                      + since +
                      +
                      + 2.5 + + +
                      +
                      + +
                      Return values
                      + bool + — +

                      Returns true if file was successfully saved.

                      +
                      + + +
                      +
                      +

                      + updateEntryViews() + +

                      + + +

                      Update views array in stored entry file.

                      + + + public + updateEntryViews(string $id, int $currentViews) : bool + + +
                      Parameters
                      +
                      +
                      + $id + : string +
                      +
                      +

                      ID of the entry.

                      +
                      + +
                      +
                      + $currentViews + : int +
                      +
                      +

                      New current views.

                      +
                      + +
                      +
                      + + +
                      + Tags + +
                      +
                      +
                      + since +
                      +
                      + 3.0 + + +
                      +
                      + +
                      Return values
                      + bool + — +

                      Returns true if views successfully changed, otherwise false.

                      +
                      + + +
                      +
                      + +
                      +
                      +
                      +
                      +
                      
                      +        
                      + +
                      +
                      + + + +
                      +
                      +
                      +
                      +

                      Search results

                      + +
                      +
                      +
                        +
                        +
                        +
                        +
                        +
                        + + +
                        + + + + + + + + diff --git a/classes/com-carlgo11-tempfiles-datastorage-MySQLStorage.html b/classes/com-carlgo11-tempfiles-datastorage-MySQLStorage.html new file mode 100644 index 0000000..6c5c5b0 --- /dev/null +++ b/classes/com-carlgo11-tempfiles-datastorage-MySQLStorage.html @@ -0,0 +1,1014 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + + + +
                        +

                        Documentation

                        + + + + + +
                        + +
                        +
                        + + + + +
                        + + +
                        +

                        + MySQLStorage + + +
                        + in package + +
                        + + + implements + DataInterface + +

                        + + + + +
                        + + +
                        + Tags + +
                        +
                        +
                        + + + + +

                        + Interfaces, Classes, Traits and Enums + +

                        + +
                        +
                        DataInterface
                        +
                        + + + +
                        + + +

                        + Table of Contents + +

                        + +
                        +
                        + $_mysql + +  : mysqli +
                        +
                        + +
                        + __construct() + +  : mixed +
                        +
                        + +
                        + __destruct() + +  : mixed +
                        +
                        + +
                        + deleteEntry() + +  : bool +
                        +
                        Delete a stored entry (file)
                        + +
                        + entryExists() + +  : bool +
                        +
                        See if an entry with the provided ID exists.
                        + +
                        + getDelPassword() + +  : mixed +
                        +
                        Get Deletion password hash.
                        + +
                        + getEntryContent() + +  : array<string|int, mixed> +
                        +
                        Get encrypted content (file data) from a stored entry.
                        + +
                        + getEntryExpiry() + +  : string +
                        +
                        Get the expiry date of a stored entry.
                        + +
                        + getEntryMetaData() + +  : array<string|int, mixed>|null +
                        +
                        Get encrypted metadata.
                        + +
                        + listEntries() + +  : array<string|int, mixed>|false +
                        +
                        Get all stored entry IDs
                        + +
                        + saveEntry() + +  : bool +
                        +
                        Save an uploaded entry.
                        + +
                        + + + + + + +
                        +

                        + Properties + +

                        +
                        +

                        + $_mysql + + + +

                        + + + + + protected + mysqli + $_mysql + + +
                        + +
                        + + +
                        + Tags + +
                        +
                        +
                        + +
                        +
                        + +
                        +

                        + Methods + +

                        +
                        +

                        + __construct() + +

                        + + + + + public + __construct() : mixed + +
                        + + + +
                        + Tags + +
                        +
                        +
                        + +
                        Return values
                        + mixed + — + + +
                        +
                        +

                        + __destruct() + +

                        + + + + + public + __destruct() : mixed + +
                        + + + +
                        + Tags + +
                        +
                        +
                        + +
                        Return values
                        + mixed + — + + +
                        +
                        +

                        + deleteEntry() + +

                        + + +

                        Delete a stored entry (file)

                        + + + public + deleteEntry(string $id) : bool + + +
                        Parameters
                        +
                        +
                        + $id + : string +
                        +
                        +

                        Unique ID of the entry to delete.

                        +
                        + +
                        +
                        + + +
                        + Tags + +
                        +
                        +
                        + since +
                        +
                        + 2.5 + + +
                        +
                        + +
                        Return values
                        + bool + — +

                        Returns true if stored entry successfully deleted.

                        +
                        + + +
                        +
                        +

                        + entryExists() + +

                        + + +

                        See if an entry with the provided ID exists.

                        + + + public + entryExists(string $id) : bool + + +
                        Parameters
                        +
                        +
                        + $id + : string +
                        +
                        +

                        Unique ID of the entry.

                        +
                        + +
                        +
                        + + +
                        + Tags + +
                        +
                        +
                        + since +
                        +
                        + 2.5 + + +
                        +
                        + +
                        Return values
                        + bool + — +

                        Returns TRUE if entry exists, otherwise FALSE.

                        +
                        + + +
                        +
                        +

                        + getDelPassword() + +

                        + + +

                        Get Deletion password hash.

                        + + + public + getDelPassword(string $id) : mixed + + +
                        Parameters
                        +
                        +
                        + $id + : string +
                        +
                        +

                        ID of the entry.

                        +
                        + +
                        +
                        + + +
                        + Tags + +
                        +
                        +
                        + +
                        Return values
                        + mixed + — + + +
                        +
                        +

                        + getEntryContent() + +

                        + + +

                        Get encrypted content (file data) from a stored entry.

                        + + + public + getEntryContent(string $id) : array<string|int, mixed> + + +
                        Parameters
                        +
                        +
                        + $id + : string +
                        +
                        +

                        Unique ID of the stored entry.

                        +
                        + +
                        +
                        + + +
                        + Tags + +
                        +
                        +
                        + since +
                        +
                        + 2.5 + + +
                        +
                        + since +
                        +
                        + 3.0 + +

                        Throw MissingEntry exception instead of NULL.

                        +
                        + +
                        +
                        + +
                        Return values
                        + array<string|int, mixed> + — +

                        Returns base64 encoded, encrypted binary file data.

                        +
                        + + +
                        +
                        +

                        + getEntryExpiry() + +

                        + + +

                        Get the expiry date of a stored entry.

                        + + + public + getEntryExpiry(string $id) : string + + +
                        Parameters
                        +
                        +
                        + $id + : string +
                        +
                        +

                        Unique ID of the entry.

                        +
                        + +
                        +
                        + + +
                        + Tags + +
                        +
                        +
                        + since +
                        +
                        + 2.5 + + +
                        +
                        + +
                        Return values
                        + string + — +

                        Returns the timestamp as a string.

                        +
                        + + +
                        +
                        +

                        + getEntryMetaData() + +

                        + + +

                        Get encrypted metadata.

                        + + + public + getEntryMetaData(string $id) : array<string|int, mixed>|null + + +
                        Parameters
                        +
                        +
                        + $id + : string +
                        +
                        +

                        Unique ID of the stored entry.

                        +
                        + +
                        +
                        + + +
                        + Tags + +
                        +
                        +
                        + since +
                        +
                        + 2.5 + + +
                        +
                        + +
                        Return values
                        + array<string|int, mixed>|null + — +

                        Returns an encrypted array (split ' ') containing: [0 => name, 1=> size, 2=> type, 3=> deletion password hash, 4=> view array]

                        +
                        + + +
                        +
                        +

                        + listEntries() + +

                        + + +

                        Get all stored entry IDs

                        + + + public + listEntries() : array<string|int, mixed>|false + + + + +
                        + Tags + +
                        +
                        +
                        + since +
                        +
                        + 2.5 + + +
                        +
                        + deprecated +
                        +
                        + +

                        Not used by DataStorage. Will be removed in the future.

                        +
                        + +
                        +
                        + +
                        Return values
                        + array<string|int, mixed>|false + — +

                        Returns an array of all stored entries.

                        +
                        + + +
                        +
                        +

                        + saveEntry() + +

                        + + +

                        Save an uploaded entry.

                        + + + public + saveEntry(array<string|int, mixed> $file, string $deletionPassword[, array<string|int, mixed>|null $views = NULL ]) : bool + + +
                        Parameters
                        +
                        +
                        + $file + : array<string|int, mixed> +
                        +
                        +

                        EncryptedFile object to store.

                        +
                        + +
                        +
                        + $deletionPassword + : string +
                        +
                        +

                        Deletion password hash.

                        +
                        + +
                        +
                        + $views + : array<string|int, mixed>|null + = NULL
                        +
                        +

                        Views array containing current views and max views.

                        +
                        + +
                        +
                        + + +
                        + Tags + +
                        +
                        +
                        + since +
                        +
                        + 2.5 + + +
                        +
                        + since +
                        +
                        + 3.0 + +

                        Split into 3 tables

                        +
                        + +
                        +
                        + +
                        Return values
                        + bool + — +

                        Returns true if file was successfully saved.

                        +
                        + + +
                        +
                        + +
                        +
                        +
                        +
                        +
                        
                        +        
                        + +
                        +
                        + + + +
                        +
                        +
                        +
                        +

                        Search results

                        + +
                        +
                        +
                          +
                          +
                          +
                          +
                          +
                          + + +
                          + + + + + + + + diff --git a/classes/com-carlgo11-tempfiles-exception-BadMethod.html b/classes/com-carlgo11-tempfiles-exception-BadMethod.html new file mode 100644 index 0000000..02910f1 --- /dev/null +++ b/classes/com-carlgo11-tempfiles-exception-BadMethod.html @@ -0,0 +1,361 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + + + +
                          +

                          Documentation

                          + + + + + +
                          + +
                          +
                          + + + + +
                          + + +
                          +

                          + BadMethod + + + extends Exception + + +
                          + in package + +
                          + + +

                          + + + + +
                          + + +
                          + Tags + +
                          +
                          +
                          + + + + + + +

                          + Table of Contents + +

                          + +
                          +
                          + __construct() + +  : mixed +
                          +
                          + +
                          + + + + + + + +
                          +

                          + Methods + +

                          +
                          +

                          + __construct() + +

                          + + + + + public + __construct([mixed $message = "" ][, mixed $code = 400 ][, Throwable $previous = NULL ]) : mixed + +
                          + +
                          Parameters
                          +
                          +
                          + $message + : mixed + = ""
                          +
                          +
                          + +
                          +
                          + $code + : mixed + = 400
                          +
                          +
                          + +
                          +
                          + $previous + : Throwable + = NULL
                          +
                          +
                          + +
                          +
                          + + +
                          + Tags + +
                          +
                          +
                          + +
                          Return values
                          + mixed + — + + +
                          +
                          + +
                          +
                          +
                          +
                          +
                          
                          +        
                          + +
                          +
                          + + + +
                          +
                          +
                          +
                          +

                          Search results

                          + +
                          +
                          +
                            +
                            +
                            +
                            +
                            +
                            + + +
                            + + + + + + + + diff --git a/classes/com-carlgo11-tempfiles-exception-MissingEntry.html b/classes/com-carlgo11-tempfiles-exception-MissingEntry.html new file mode 100644 index 0000000..c6de214 --- /dev/null +++ b/classes/com-carlgo11-tempfiles-exception-MissingEntry.html @@ -0,0 +1,361 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + + + +
                            +

                            Documentation

                            + + + + + +
                            + +
                            +
                            + + + + +
                            + + +
                            +

                            + MissingEntry + + + extends Exception + + +
                            + in package + +
                            + + +

                            + + + + +
                            + + +
                            + Tags + +
                            +
                            +
                            + + + + + + +

                            + Table of Contents + +

                            + +
                            +
                            + __construct() + +  : mixed +
                            +
                            + +
                            + + + + + + + +
                            +

                            + Methods + +

                            +
                            +

                            + __construct() + +

                            + + + + + public + __construct([mixed $message = "No file found with matching ID and Password." ][, mixed $code = 400 ][, Throwable $previous = NULL ]) : mixed + +
                            + +
                            Parameters
                            +
                            +
                            + $message + : mixed + = "No file found with matching ID and Password."
                            +
                            +
                            + +
                            +
                            + $code + : mixed + = 400
                            +
                            +
                            + +
                            +
                            + $previous + : Throwable + = NULL
                            +
                            +
                            + +
                            +
                            + + +
                            + Tags + +
                            +
                            +
                            + +
                            Return values
                            + mixed + — + + +
                            +
                            + +
                            +
                            +
                            +
                            +
                            
                            +        
                            + +
                            +
                            + + + +
                            +
                            +
                            +
                            +

                            Search results

                            + +
                            +
                            +
                              +
                              +
                              +
                              +
                              +
                              + + +
                              + + + + + + + + diff --git a/css/base.css b/css/base.css new file mode 100644 index 0000000..631cde9 --- /dev/null +++ b/css/base.css @@ -0,0 +1,1106 @@ + +:root { + /* Typography */ + --font-primary: 'Source Sans Pro', Helvetica, Arial, sans-serif; + --font-secondary: 'Source Sans Pro', Helvetica, Arial, sans-serif; + --font-monospace: 'Source Code Pro', monospace; + --line-height--primary: 1.6; + --letter-spacing--primary: .05rem; + --text-base-size: 1em; + --text-scale-ratio: 1.2; + + --text-xxs: calc(var(--text-base-size) / var(--text-scale-ratio) / var(--text-scale-ratio) / var(--text-scale-ratio)); + --text-xs: calc(var(--text-base-size) / var(--text-scale-ratio) / var(--text-scale-ratio)); + --text-sm: calc(var(--text-base-size) / var(--text-scale-ratio)); + --text-md: var(--text-base-size); + --text-lg: calc(var(--text-base-size) * var(--text-scale-ratio)); + --text-xl: calc(var(--text-base-size) * var(--text-scale-ratio) * var(--text-scale-ratio)); + --text-xxl: calc(var(--text-base-size) * var(--text-scale-ratio) * var(--text-scale-ratio) * var(--text-scale-ratio)); + --text-xxxl: calc(var(--text-base-size) * var(--text-scale-ratio) * var(--text-scale-ratio) * var(--text-scale-ratio) * var(--text-scale-ratio)); + --text-xxxxl: calc(var(--text-base-size) * var(--text-scale-ratio) * var(--text-scale-ratio) * var(--text-scale-ratio) * var(--text-scale-ratio) * var(--text-scale-ratio)); + --text-xxxxxl: calc(var(--text-base-size) * var(--text-scale-ratio) * var(--text-scale-ratio) * var(--text-scale-ratio) * var(--text-scale-ratio) * var(--text-scale-ratio) * var(--text-scale-ratio)); + + /* Colors */ + --primary-color-hue: 96; + --primary-color-saturation: 57%; + --primary-color: hsl(var(--primary-color-hue), var(--primary-color-saturation), 60%); + --primary-color-darken: hsl(var(--primary-color-hue), var(--primary-color-saturation), 40%); + --primary-color-darker: hsl(var(--primary-color-hue), var(--primary-color-saturation), 20%); + --primary-color-darkest: hsl(var(--primary-color-hue), var(--primary-color-saturation), 10%); + --primary-color-lighten: hsl(var(--primary-color-hue), var(--primary-color-saturation), 80%); + --primary-color-lighter: hsl(var(--primary-color-hue), var(--primary-color-saturation), 99%); + --dark-gray: #d1d1d1; + --light-gray: #f0f0f0; + + --text-color: var(--primary-color-darkest); + + --header-height: var(--spacing-xxxxl); + --header-bg-color: var(--primary-color); + --code-background-color: var(--primary-color-lighter); + --code-border-color: --primary-color-lighten; + --button-border-color: var(--primary-color-darken); + --button-color: transparent; + --button-color-primary: var(--primary-color); + --button-text-color: #555; + --button-text-color-primary: white; + --popover-background-color: rgba(255, 255, 255, 0.75); + --link-color-primary: var(--primary-color-darken); + --link-hover-color-primary: var(--primary-color-darker); + --form-field-border-color: var(--dark-gray); + --form-field-color: #fff; + --admonition-success-color: var(--primary-color); + --admonition-border-color: silver; + --table-separator-color: var(--primary-color-lighten); + --title-text-color: var(--primary-color); + + --sidebar-border-color: var(--primary-color-lighten); + + /* Grid */ + --container-width: 1400px; + + /* Spacing */ + --spacing-base-size: 1rem; + --spacing-scale-ratio: 1.5; + + --spacing-xxxs: calc(var(--spacing-base-size) / var(--spacing-scale-ratio) / var(--spacing-scale-ratio) / var(--spacing-scale-ratio) / var(--spacing-scale-ratio)); + --spacing-xxs: calc(var(--spacing-base-size) / var(--spacing-scale-ratio) / var(--spacing-scale-ratio) / var(--spacing-scale-ratio)); + --spacing-xs: calc(var(--spacing-base-size) / var(--spacing-scale-ratio) / var(--spacing-scale-ratio)); + --spacing-sm: calc(var(--spacing-base-size) / var(--spacing-scale-ratio)); + --spacing-md: var(--spacing-base-size); + --spacing-lg: calc(var(--spacing-base-size) * var(--spacing-scale-ratio)); + --spacing-xl: calc(var(--spacing-base-size) * var(--spacing-scale-ratio) * var(--spacing-scale-ratio)); + --spacing-xxl: calc(var(--spacing-base-size) * var(--spacing-scale-ratio) * var(--spacing-scale-ratio) * var(--spacing-scale-ratio)); + --spacing-xxxl: calc(var(--spacing-base-size) * var(--spacing-scale-ratio) * var(--spacing-scale-ratio) * var(--spacing-scale-ratio) * var(--spacing-scale-ratio)); + --spacing-xxxxl: calc(var(--spacing-base-size) * var(--spacing-scale-ratio) * var(--spacing-scale-ratio) * var(--spacing-scale-ratio) * var(--spacing-scale-ratio) * var(--spacing-scale-ratio)); + + --border-radius-base-size: 3px; +} + +/* Base Styles +-------------------------------------------------- */ +body { + color: var(--text-color); + font-family: var(--font-primary); + font-size: var(--text-md); + letter-spacing: var(--letter-spacing--primary); + line-height: var(--line-height--primary); + width: 100%; +} + +.phpdocumentor h1, +.phpdocumentor h2, +.phpdocumentor h3, +.phpdocumentor h4, +.phpdocumentor h5, +.phpdocumentor h6 { + margin-bottom: var(--spacing-lg); + margin-top: var(--spacing-lg); + font-weight: 600; +} + +.phpdocumentor h1 { + font-size: var(--text-xxxxl); + letter-spacing: var(--letter-spacing--primary); + line-height: 1.2; + margin-top: 0; +} + +.phpdocumentor h2 { + font-size: var(--text-xxxl); + letter-spacing: var(--letter-spacing--primary); + line-height: 1.25; +} + +.phpdocumentor h3 { + font-size: var(--text-xxl); + letter-spacing: var(--letter-spacing--primary); + line-height: 1.3; +} + +.phpdocumentor h4 { + font-size: var(--text-xl); + letter-spacing: calc(var(--letter-spacing--primary) / 2); + line-height: 1.35; + margin-bottom: var(--spacing-md); +} + +.phpdocumentor h5 { + font-size: var(--text-lg); + letter-spacing: calc(var(--letter-spacing--primary) / 4); + line-height: 1.5; + margin-bottom: var(--spacing-md); + margin-top: var(--spacing-md); +} + +.phpdocumentor h6 { + font-size: var(--text-md); + letter-spacing: 0; + line-height: var(--line-height--primary); + margin-bottom: var(--spacing-md); + margin-top: var(--spacing-md); +} + +.phpdocumentor h1 .headerlink, +.phpdocumentor h2 .headerlink, +.phpdocumentor h3 .headerlink, +.phpdocumentor h4 .headerlink, +.phpdocumentor h5 .headerlink, +.phpdocumentor h6 .headerlink +{ + transition: all .3s ease-in-out; + opacity: 0; + text-decoration: none; + color: silver; + font-size: 80%; +} + +.phpdocumentor h1:hover .headerlink, +.phpdocumentor h2:hover .headerlink, +.phpdocumentor h3:hover .headerlink, +.phpdocumentor h4:hover .headerlink, +.phpdocumentor h5:hover .headerlink, +.phpdocumentor h6:hover .headerlink +{ + opacity: 1; +} +.phpdocumentor p { + margin-top: 0; + margin-bottom: var(--spacing-md); +} +.phpdocumentor figure { + margin-bottom: var(--spacing-md); +} + +.phpdocumentor figcaption { + text-align: center; + font-style: italic; + font-size: 80%; +} + +.phpdocumentor-uml-diagram svg { + max-width: 100%; + height: auto !important; +} +.phpdocumentor-line { + border-top: 1px solid #E1E1E1; + border-width: 0; + margin-bottom: var(--spacing-xxl); + margin-top: var(--spacing-xxl); +} +.phpdocumentor-section { + box-sizing: border-box; + margin: 0 auto; + max-width: var(--container-width); + padding: 0 var(--spacing-lg); + position: relative; + width: 100%; +} + +@media (min-width: 1200px) { + .phpdocumentor-section { + padding: 0; + width: 95%; + } +} +.phpdocumentor-column { + box-sizing: border-box; + float: left; + width: 100%; +} + +@media (min-width: 550px) { + .phpdocumentor-column { + margin-left: 4%; + } + + .phpdocumentor-column:first-child { + margin-left: 0; + } + + .-one.phpdocumentor-column { + width: 4.66666666667%; + } + + .-two.phpdocumentor-column { + width: 13.3333333333%; + } + + .-three.phpdocumentor-column { + width: 22%; + } + + .-four.phpdocumentor-column { + width: 30.6666666667%; + } + + .-five.phpdocumentor-column { + width: 39.3333333333%; + } + + .-six.phpdocumentor-column { + width: 48%; + } + + .-seven.phpdocumentor-column { + width: 56.6666666667%; + } + + .-eight.phpdocumentor-column { + width: 65.3333333333%; + } + + .-nine.phpdocumentor-column { + width: 74.0%; + } + + .-ten.phpdocumentor-column { + width: 82.6666666667%; + } + + .-eleven.phpdocumentor-column { + width: 91.3333333333%; + } + + .-twelve.phpdocumentor-column { + margin-left: 0; + width: 100%; + } + + .-one-third.phpdocumentor-column { + width: 30.6666666667%; + } + + .-two-thirds.phpdocumentor-column { + width: 65.3333333333%; + } + + .-one-half.phpdocumentor-column { + width: 48%; + } + + /* Offsets */ + .-offset-by-one.phpdocumentor-column { + margin-left: 8.66666666667%; + } + + .-offset-by-two.phpdocumentor-column { + margin-left: 17.3333333333%; + } + + .-offset-by-three.phpdocumentor-column { + margin-left: 26%; + } + + .-offset-by-four.phpdocumentor-column { + margin-left: 34.6666666667%; + } + + .-offset-by-five.phpdocumentor-column { + margin-left: 43.3333333333%; + } + + .-offset-by-six.phpdocumentor-column { + margin-left: 52%; + } + + .-offset-by-seven.phpdocumentor-column { + margin-left: 60.6666666667%; + } + + .-offset-by-eight.phpdocumentor-column { + margin-left: 69.3333333333%; + } + + .-offset-by-nine.phpdocumentor-column { + margin-left: 78.0%; + } + + .-offset-by-ten.phpdocumentor-column { + margin-left: 86.6666666667%; + } + + .-offset-by-eleven.phpdocumentor-column { + margin-left: 95.3333333333%; + } + + .-offset-by-one-third.phpdocumentor-column { + margin-left: 34.6666666667%; + } + + .-offset-by-two-thirds.phpdocumentor-column { + margin-left: 69.3333333333%; + } + + .-offset-by-one-half.phpdocumentor-column { + margin-left: 52%; + } +} +.phpdocumentor a { + color: var(--link-color-primary); +} + +.phpdocumentor a:hover { + color: var(--link-hover-color-primary); +} +.phpdocumentor-button { + background-color: var(--button-color); + border: 1px solid var(--button-border-color); + border-radius: var(--border-radius-base-size); + box-sizing: border-box; + color: var(--button-text-color); + cursor: pointer; + display: inline-block; + font-size: var(--text-sm); + font-weight: 600; + height: 38px; + letter-spacing: .1rem; + line-height: 38px; + padding: 0 var(--spacing-xxl); + text-align: center; + text-decoration: none; + text-transform: uppercase; + white-space: nowrap; + margin-bottom: var(--spacing-md); +} + +.phpdocumentor-button .-wide { + width: 100%; +} + +.phpdocumentor-button:hover, +.phpdocumentor-button:focus { + border-color: #888; + color: #333; + outline: 0; +} + +.phpdocumentor-button.-primary { + background-color: var(--button-color-primary); + border-color: var(--button-color-primary); + color: var(--button-text-color-primary); +} + +.phpdocumentor-button.-primary:hover, +.phpdocumentor-button.-primary:focus { + background-color: var(--link-color-primary); + border-color: var(--link-color-primary); + color: var(--button-text-color-primary); +} +.phpdocumentor form { + margin-bottom: var(--spacing-md); +} + +.phpdocumentor-field { + background-color: var(--form-field-color); + border: 1px solid var(--form-field-border-color); + border-radius: var(--border-radius-base-size); + box-shadow: none; + box-sizing: border-box; + height: 38px; + padding: var(--spacing-xxxs) var(--spacing-xxs); /* The 6px vertically centers text on FF, ignored by Webkit */ + margin-bottom: var(--spacing-md); +} + +/* Removes awkward default styles on some inputs for iOS */ +input[type="email"], +input[type="number"], +input[type="search"], +input[type="text"], +input[type="tel"], +input[type="url"], +input[type="password"], +textarea { + -moz-appearance: none; + -webkit-appearance: none; + appearance: none; +} + +.phpdocumentor-textarea { + min-height: 65px; + padding-bottom: var(--spacing-xxxs); + padding-top: var(--spacing-xxxs); +} + +.phpdocumentor-field:focus { + border: 1px solid var(--button-color-primary); + outline: 0; +} + +.phpdocumentor-label { + display: block; + margin-bottom: var(--spacing-xs); +} + +.phpdocumentor-fieldset { + border-width: 0; + padding: 0; +} + +input[type="checkbox"].phpdocumentor-field, +input[type="radio"].phpdocumentor-field { + display: inline; +} +.phpdocumentor-column ul, +div.phpdocumentor-list > ul, +ul.phpdocumentor-list { + list-style: circle; +} + +.phpdocumentor-column ol, +div.phpdocumentor-list > ol, +ol.phpdocumentor-list { + list-style: decimal; +} + + +.phpdocumentor-column ul, +div.phpdocumentor-list > ul, +ol.phpdocumentor-list, +ul.phpdocumentor-list { + margin-top: 0; + padding-left: 1rem; + margin-bottom: var(--spacing-md); +} + +dl { + margin-bottom: var(--spacing-md); +} + +.phpdocumentor-column ul ul, +div.phpdocumentor-list > ul ul, +ul.phpdocumentor-list ul.phpdocumentor-list, +ul.phpdocumentor-list ol.phpdocumentor-list, +ol.phpdocumentor-list ol.phpdocumentor-list, +ol.phpdocumentor-list ul.phpdocumentor-list { + font-size: var(--text-sm); + margin: var(--spacing-xs) 0 var(--spacing-xs) calc(var(--spacing-xs) * 2); +} + +.phpdocumentor-column ul li, +.phpdocumentor-list li { + padding-bottom: var(--spacing-xs); +} + +.phpdocumentor dl dt { + margin-bottom: var(--spacing-xs); +} + +.phpdocumentor dl dd { + margin-bottom: var(--spacing-md); +} +.phpdocumentor pre { + margin-bottom: var(--spacing-md); +} + +.phpdocumentor-code { + font-family: var(--font-monospace); + background: var(--code-background-color); + border: 1px solid var(--code-border-color); + border-radius: var(--border-radius-base-size); + font-size: var(--text-sm); + padding: var(--spacing-sm) var(--spacing-md); + width: 100%; + box-sizing: border-box; +} + +.phpdocumentor-code.-dark { + background: var(--primary-color-darkest); + color: var(--light-gray); + box-shadow: 0 2px 3px var(--dark-gray); +} + +pre > .phpdocumentor-code { + display: block; + white-space: pre; +} +.phpdocumentor blockquote { + border-left: 4px solid var(--primary-color-darken); + margin: var(--spacing-md) 0; + padding: var(--spacing-xs) var(--spacing-sm); + color: var(--primary-color-darker); + font-style: italic; +} + +.phpdocumentor blockquote p:last-of-type { + margin-bottom: 0; +} +.phpdocumentor table { + margin-bottom: var(--spacing-md); +} + +th.phpdocumentor-heading, +td.phpdocumentor-cell { + border-bottom: 1px solid var(--table-separator-color); + padding: var(--spacing-sm) var(--spacing-md); + text-align: left; +} + +th.phpdocumentor-heading:first-child, +td.phpdocumentor-cell:first-child { + padding-left: 0; +} + +th.phpdocumentor-heading:last-child, +td.phpdocumentor-cell:last-child { + padding-right: 0; +} + +.phpdocumentor-header { + display: flex; + flex-direction: row; + align-items: stretch; + flex-wrap: wrap; + justify-content: space-between; + height: auto; + padding: var(--spacing-md) var(--spacing-md); +} + +.phpdocumentor-header__menu-button { + position: absolute; + top: -100%; + left: -100%; +} + +.phpdocumentor-header__menu-icon { + font-size: 2rem; + color: var(--primary-color); +} + +.phpdocumentor-header__menu-button:checked ~ .phpdocumentor-topnav { + max-height: 250px; + padding-top: var(--spacing-md); +} + +@media (min-width: 1000px) { + .phpdocumentor-header { + flex-direction: row; + padding: var(--spacing-lg) var(--spacing-lg); + min-height: var(--header-height); + } + + .phpdocumentor-header__menu-icon { + display: none; + } +} + +@media (min-width: 1000px) { + .phpdocumentor-header { + padding-top: 0; + padding-bottom: 0; + } +} +@media (min-width: 1200px) { + .phpdocumentor-header { + padding: 0; + } +} +.phpdocumentor-title { + box-sizing: border-box; + color: var(--title-text-color); + font-size: var(--text-xxl); + letter-spacing: .05rem; + font-weight: normal; + width: auto; + margin: 0; + display: flex; + align-items: center; +} + +.phpdocumentor-title.-without-divider { + border: none; +} + +.phpdocumentor-title__link { + transition: all .3s ease-out; + display: flex; + color: var(--title-text-color); + text-decoration: none; + font-weight: normal; + white-space: nowrap; + transform: scale(.75); + transform-origin: left; +} + +.phpdocumentor-title__link:hover { + transform: perspective(15rem) translateX(.5rem); + font-weight: 600; +} + +@media (min-width: 1000px) { + .phpdocumentor-title { + width: 30.6666666667%; + border-right: var(--sidebar-border-color) solid 1px; + } + + .phpdocumentor-title__link { + transform-origin: left; + } +} + +@media (min-width: 1000px) { + .phpdocumentor-title__link { + transform: scale(.85); + } +} + +@media (min-width: 1200px) { + .phpdocumentor-title__link { + transform: scale(1); + } +} +.phpdocumentor-topnav { + display: flex; + align-items: center; + margin: 0; + max-height: 0; + overflow: hidden; + transition: max-height 0.2s ease-out; + flex-basis: 100%; +} + +.phpdocumentor-topnav__menu { + text-align: right; + list-style: none; + margin: 0; + padding: 0; + flex: 1; + display: flex; + flex-flow: row wrap; + justify-content: center; +} + +.phpdocumentor-topnav__menu-item { + margin: 0; + width: 100%; + display: inline-block; + text-align: center; + padding: var(--spacing-sm) 0 +} + +.phpdocumentor-topnav__menu-item.-social { + width: auto; + padding: var(--spacing-sm) +} + +.phpdocumentor-topnav__menu-item a { + display: inline-block; + color: var(--text-color); + text-decoration: none; + font-size: var(--text-lg); + transition: all .3s ease-out; + border-bottom: 1px dotted transparent; + line-height: 1; +} + +.phpdocumentor-topnav__menu-item a:hover { + transform: perspective(15rem) translateY(.1rem); + border-bottom: 1px dotted var(--text-color); +} + +@media (min-width: 1000px) { + .phpdocumentor-topnav { + max-height: none; + overflow: visible; + flex-basis: auto; + } + + .phpdocumentor-topnav__menu { + display: flex; + flex-flow: row wrap; + justify-content: flex-end; + } + + .phpdocumentor-topnav__menu-item, + .phpdocumentor-topnav__menu-item.-social { + width: auto; + display: inline; + text-align: right; + padding: 0 0 0 var(--spacing-md) + } +} +.phpdocumentor-sidebar { + margin: 0; + overflow: hidden; + max-height: 0; +} + +.phpdocumentor .phpdocumentor-sidebar .phpdocumentor-list { + padding: var(--spacing-xs) var(--spacing-md); + list-style: none; + margin: 0; +} + +.phpdocumentor .phpdocumentor-sidebar li { + white-space: nowrap; + text-overflow: ellipsis; + overflow: hidden; + padding: 0 0 var(--spacing-xxxs) var(--spacing-md); +} + +.phpdocumentor .phpdocumentor-sidebar abbr, +.phpdocumentor .phpdocumentor-sidebar a { + text-decoration: none; + border-bottom: none; + color: var(--text-color); + font-size: var(--text-md); + padding-left: 0; + transition: padding-left .4s ease-out; +} + +.phpdocumentor .phpdocumentor-sidebar a:hover, +.phpdocumentor .phpdocumentor-sidebar a.-active { + padding-left: 5px; + font-weight: 600; +} + +.phpdocumentor .phpdocumentor-sidebar__category > * { + border-left: 1px solid var(--primary-color-lighten); +} + +.phpdocumentor .phpdocumentor-sidebar__category { + margin-bottom: var(--spacing-lg); +} + +.phpdocumentor .phpdocumentor-sidebar__category-header { + font-size: var(--text-md); + margin-bottom: var(--spacing-xs); + color: var(--link-color-primary); + font-weight: 600; + border-left: 0; +} + +.phpdocumentor .phpdocumentor-sidebar__root-package, +.phpdocumentor .phpdocumentor-sidebar__root-namespace { + font-size: var(--text-md); + margin: 0; + padding-top: var(--spacing-xs); + padding-left: var(--spacing-md); + color: var(--text-color); + font-weight: normal; +} + +@media (min-width: 550px) { + .phpdocumentor-sidebar { + border-right: var(--sidebar-border-color) solid 1px; + } +} + +.phpdocumentor-sidebar__menu-button { + position: absolute; + top: -100%; + left: -100%; +} + +.phpdocumentor-sidebar__menu-icon { + font-size: var(--text-md); + font-weight: 600; + background: var(--primary-color); + color: white; + margin: 0 0 var(--spacing-lg); + display: block; + padding: var(--spacing-sm); + text-align: center; + border-radius: 3px; + text-transform: uppercase; + letter-spacing: .15rem; +} + +.phpdocumentor-sidebar__menu-button:checked ~ .phpdocumentor-sidebar { + max-height: 100%; + padding-top: var(--spacing-md); +} + +@media (min-width: 550px) { + .phpdocumentor-sidebar { + overflow: visible; + max-height: 100%; + } + + .phpdocumentor-sidebar__menu-icon { + display: none; + } +} +.phpdocumentor-admonition { + border: 1px solid var(--admonition-border-color); + border-radius: var(--border-radius-base-size); + border-color: var(--primary-color-lighten); + background-color: var(--primary-color-lighter); + padding: var(--spacing-lg); + margin: var(--spacing-lg) 0; + display: flex; + flex-direction: row; + align-items: flex-start; +} + +.phpdocumentor-admonition p:last-of-type { + margin-bottom: 0; +} + +.phpdocumentor-admonition--success, +.phpdocumentor-admonition.-success { + border-color: var(--admonition-success-color); +} + +.phpdocumentor-admonition__icon { + margin-right: var(--spacing-md); + color: var(--primary-color); + max-width: 3rem; +} +.phpdocumentor ul.phpdocumentor-breadcrumbs { + font-size: var(--text-md); + list-style: none; + margin: 0; + padding: 0; +} + +.phpdocumentor ul.phpdocumentor-breadcrumbs a { + color: var(--text-color); + text-decoration: none; +} + +.phpdocumentor ul.phpdocumentor-breadcrumbs > li { + display: inline-block; + margin: 0; +} + +.phpdocumentor ul.phpdocumentor-breadcrumbs > li + li:before { + color: var(--dark-gray); + content: "\\\A0"; + padding: 0; +} +.phpdocumentor .phpdocumentor-back-to-top { + position: fixed; + bottom: 2rem; + font-size: 2.5rem; + opacity: .25; + transition: all .3s ease-in-out; + right: 2rem; +} + +.phpdocumentor .phpdocumentor-back-to-top:hover { + color: var(--link-color-primary); + opacity: 1; +} +.phpdocumentor-search { + position: relative; + display: none; /** disable by default for non-js flow */ + opacity: .3; /** white-out default for loading indication */ + transition: opacity .3s, background .3s; + margin: var(--spacing-sm) 0; + flex: 1; + min-width: 100%; +} + +.phpdocumentor-search label { + display: flex; + align-items: center; + flex: 1; +} + +.phpdocumentor-search__icon { + color: var(--primary-color); + margin-right: var(--spacing-sm); + width: 1rem; + height: 1rem; +} + +.phpdocumentor-search--enabled { + display: flex; +} + +.phpdocumentor-search--active { + opacity: 1; +} + +.phpdocumentor-search input:disabled { + background-color: lightgray; +} + +.phpdocumentor-search__field:focus, +.phpdocumentor-search__field { + margin-bottom: 0; + border: 0; + border-bottom: 2px solid var(--primary-color); + padding: 0; + border-radius: 0; + flex: 1; +} + +@media (min-width: 1000px) { + .phpdocumentor-search { + min-width: auto; + max-width: 20rem; + margin: 0 0 0 auto; + } +} +.phpdocumentor-content { + position: relative; +} + +.phpdocumentor-search-results { + backdrop-filter: blur(5px); + background: var(--popover-background-color); + position: fixed; + top: 0; + left: 0; + right: 0; + bottom: 0; + padding: 0; + opacity: 1; + pointer-events: all; + + transition: opacity .3s, background .3s; +} + +.phpdocumentor-search-results--hidden { + background: transparent; + backdrop-filter: blur(0); + opacity: 0; + pointer-events: none; +} + +.phpdocumentor-search-results__dialog { + width: 100%; + background: white; + max-height: 100%; + display: flex; + flex-direction: column; +} + +.phpdocumentor-search-results__body { + overflow: auto; +} + +.phpdocumentor-search-results__header { + padding: var(--spacing-lg); + display: flex; + justify-content: space-between; + background: var(--primary-color-darken); + color: white; + align-items: center; +} + +.phpdocumentor-search-results__close { + font-size: var(--text-xl); + background: none; + border: none; + padding: 0; + margin: 0; +} + +.phpdocumentor .phpdocumentor-search-results__title { + font-size: var(--text-xl); + margin-bottom: 0; +} + +.phpdocumentor-search-results__entries { + list-style: none; + padding: 0 var(--spacing-lg); + margin: 0; +} + +.phpdocumentor-search-results__entry { + border-bottom: 1px solid var(--table-separator-color); + padding: var(--spacing-sm) 0; + text-align: left; +} + +.phpdocumentor-search-results__entry a { + display: block; +} + +.phpdocumentor-search-results__entry small { + margin-top: var(--spacing-xs); + margin-bottom: var(--spacing-md); + color: var(--primary-color-darker); + display: block; + word-break: break-word; +} + +.phpdocumentor-search-results__entry h3 { + font-size: var(--text-lg); + margin: 0; +} + +@media (min-width: 550px) { + .phpdocumentor-search-results { + padding: 0 var(--spacing-lg); + } + + .phpdocumentor-search-results__entry h3 { + font-size: var(--text-xxl); + } + + .phpdocumentor-search-results__dialog { + margin: var(--spacing-xl) auto; + max-width: 40rem; + background: white; + border: 1px solid silver; + box-shadow: 0 2px 5px silver; + max-height: 40rem; + border-radius: 3px; + } +} +.phpdocumentor-modal { + position: fixed; + width: 100vw; + height: 100vh; + opacity: 0; + visibility: hidden; + transition: all 0.3s ease; + top: 0; + left: 0; + display: flex; + align-items: center; + justify-content: center; + z-index: 1; +} + +.phpdocumentor-modal__open { + visibility: visible; + opacity: 1; + transition-delay: 0s; +} + +.phpdocumentor-modal-bg { + position: absolute; + background: gray; + opacity: 50%; + width: 100%; + height: 100%; +} + +.phpdocumentor-modal-container { + border-radius: 1em; + background: #fff; + position: relative; + padding: 2em; + box-sizing: border-box; + max-width:100vw; +} + +.phpdocumentor-modal__close { + position: absolute; + right: 0.75em; + top: 0.75em; + outline: none; + appearance: none; + color: var(--primary-color); + background: none; + border: 0px; + font-weight: bold; + cursor: pointer; +} + +/* Used for screen readers and such */ +.visually-hidden { + display: none; +} + +.float-right { + float: right; +} + +.float-left { + float: left; +} diff --git a/css/normalize.css b/css/normalize.css new file mode 100644 index 0000000..653dc00 --- /dev/null +++ b/css/normalize.css @@ -0,0 +1,427 @@ +/*! normalize.css v3.0.2 | MIT License | git.io/normalize */ + +/** + * 1. Set default font family to sans-serif. + * 2. Prevent iOS text size adjust after orientation change, without disabling + * user zoom. + */ + +html { + font-family: sans-serif; /* 1 */ + -ms-text-size-adjust: 100%; /* 2 */ + -webkit-text-size-adjust: 100%; /* 2 */ +} + +/** + * Remove default margin. + */ + +body { + margin: 0; +} + +/* HTML5 display definitions + ========================================================================== */ + +/** + * Correct `block` display not defined for any HTML5 element in IE 8/9. + * Correct `block` display not defined for `details` or `summary` in IE 10/11 + * and Firefox. + * Correct `block` display not defined for `main` in IE 11. + */ + +article, +aside, +details, +figcaption, +figure, +footer, +header, +hgroup, +main, +menu, +nav, +section, +summary { + display: block; +} + +/** + * 1. Correct `inline-block` display not defined in IE 8/9. + * 2. Normalize vertical alignment of `progress` in Chrome, Firefox, and Opera. + */ + +audio, +canvas, +progress, +video { + display: inline-block; /* 1 */ + vertical-align: baseline; /* 2 */ +} + +/** + * Prevent modern browsers from displaying `audio` without controls. + * Remove excess height in iOS 5 devices. + */ + +audio:not([controls]) { + display: none; + height: 0; +} + +/** + * Address `[hidden]` styling not present in IE 8/9/10. + * Hide the `template` element in IE 8/9/11, Safari, and Firefox < 22. + */ + +[hidden], +template { + display: none !important; +} + +/* Links + ========================================================================== */ + +/** + * Remove the gray background color from active links in IE 10. + */ + +a { + background-color: transparent; +} + +/** + * Improve readability when focused and also mouse hovered in all browsers. + */ + +a:active, +a:hover { + outline: 0; +} + +/* Text-level semantics + ========================================================================== */ + +/** + * Address styling not present in IE 8/9/10/11, Safari, and Chrome. + */ + +abbr[title] { + border-bottom: 1px dotted; +} + +/** + * Address style set to `bolder` in Firefox 4+, Safari, and Chrome. + */ + +b, +strong { + font-weight: bold; +} + +/** + * Address styling not present in Safari and Chrome. + */ + +dfn { + font-style: italic; +} + +/** + * Address variable `h1` font-size and margin within `section` and `article` + * contexts in Firefox 4+, Safari, and Chrome. + */ + +h1 { + font-size: 2em; + margin: 0.67em 0; +} + +/** + * Address styling not present in IE 8/9. + */ + +mark { + background: #ff0; + color: #000; +} + +/** + * Address inconsistent and variable font size in all browsers. + */ + +small { + font-size: 80%; +} + +/** + * Prevent `sub` and `sup` affecting `line-height` in all browsers. + */ + +sub, +sup { + font-size: 75%; + line-height: 0; + position: relative; + vertical-align: baseline; +} + +sup { + top: -0.5em; +} + +sub { + bottom: -0.25em; +} + +/* Embedded content + ========================================================================== */ + +/** + * Remove border when inside `a` element in IE 8/9/10. + */ + +img { + border: 0; +} + +/** + * Correct overflow not hidden in IE 9/10/11. + */ + +svg:not(:root) { + overflow: hidden; +} + +/* Grouping content + ========================================================================== */ + +/** + * Address margin not present in IE 8/9 and Safari. + */ + +figure { + margin: 1em 40px; +} + +/** + * Address differences between Firefox and other browsers. + */ + +hr { + -moz-box-sizing: content-box; + box-sizing: content-box; + height: 0; +} + +/** + * Contain overflow in all browsers. + */ + +pre { + overflow: auto; +} + +/** + * Address odd `em`-unit font size rendering in all browsers. + */ + +code, +kbd, +pre, +samp { + font-family: var(--font-monospace); + font-size: 1em; +} + +/* Forms + ========================================================================== */ + +/** + * Known limitation: by default, Chrome and Safari on OS X allow very limited + * styling of `select`, unless a `border` property is set. + */ + +/** + * 1. Correct color not being inherited. + * Known issue: affects color of disabled elements. + * 2. Correct font properties not being inherited. + * 3. Address margins set differently in Firefox 4+, Safari, and Chrome. + */ + +button, +input, +optgroup, +select, +textarea { + color: inherit; /* 1 */ + font: inherit; /* 2 */ + margin: 0; /* 3 */ +} + +/** + * Address `overflow` set to `hidden` in IE 8/9/10/11. + */ + +button { + overflow: visible; +} + +/** + * Address inconsistent `text-transform` inheritance for `button` and `select`. + * All other form control elements do not inherit `text-transform` values. + * Correct `button` style inheritance in Firefox, IE 8/9/10/11, and Opera. + * Correct `select` style inheritance in Firefox. + */ + +button, +select { + text-transform: none; +} + +/** + * 1. Avoid the WebKit bug in Android 4.0.* where (2) destroys native `audio` + * and `video` controls. + * 2. Correct inability to style clickable `input` types in iOS. + * 3. Improve usability and consistency of cursor style between image-type + * `input` and others. + */ + +button, +html input[type="button"], /* 1 */ +input[type="reset"], +input[type="submit"] { + -webkit-appearance: button; /* 2 */ + cursor: pointer; /* 3 */ +} + +/** + * Re-set default cursor for disabled elements. + */ + +button[disabled], +html input[disabled] { + cursor: default; +} + +/** + * Remove inner padding and border in Firefox 4+. + */ + +button::-moz-focus-inner, +input::-moz-focus-inner { + border: 0; + padding: 0; +} + +/** + * Address Firefox 4+ setting `line-height` on `input` using `!important` in + * the UA stylesheet. + */ + +input { + line-height: normal; +} + +/** + * It's recommended that you don't attempt to style these elements. + * Firefox's implementation doesn't respect box-sizing, padding, or width. + * + * 1. Address box sizing set to `content-box` in IE 8/9/10. + * 2. Remove excess padding in IE 8/9/10. + */ + +input[type="checkbox"], +input[type="radio"] { + box-sizing: border-box; /* 1 */ + padding: 0; /* 2 */ +} + +/** + * Fix the cursor style for Chrome's increment/decrement buttons. For certain + * `font-size` values of the `input`, it causes the cursor style of the + * decrement button to change from `default` to `text`. + */ + +input[type="number"]::-webkit-inner-spin-button, +input[type="number"]::-webkit-outer-spin-button { + height: auto; +} + +/** + * 1. Address `appearance` set to `searchfield` in Safari and Chrome. + * 2. Address `box-sizing` set to `border-box` in Safari and Chrome + * (include `-moz` to future-proof). + */ + +input[type="search"] { + -webkit-appearance: textfield; /* 1 */ + -moz-box-sizing: content-box; + -webkit-box-sizing: content-box; /* 2 */ + box-sizing: content-box; +} + +/** + * Remove inner padding and search cancel button in Safari and Chrome on OS X. + * Safari (but not Chrome) clips the cancel button when the search input has + * padding (and `textfield` appearance). + */ + +input[type="search"]::-webkit-search-cancel-button, +input[type="search"]::-webkit-search-decoration { + -webkit-appearance: none; +} + +/** + * Define consistent border, margin, and padding. + */ + +fieldset { + border: 1px solid #c0c0c0; + margin: 0 2px; + padding: 0.35em 0.625em 0.75em; +} + +/** + * 1. Correct `color` not being inherited in IE 8/9/10/11. + * 2. Remove padding so people aren't caught out if they zero out fieldsets. + */ + +legend { + border: 0; /* 1 */ + padding: 0; /* 2 */ +} + +/** + * Remove default vertical scrollbar in IE 8/9/10/11. + */ + +textarea { + overflow: auto; +} + +/** + * Don't inherit the `font-weight` (applied by a rule above). + * NOTE: the default cannot safely be changed in Chrome and Safari on OS X. + */ + +optgroup { + font-weight: bold; +} + +/* Tables + ========================================================================== */ + +/** + * Remove most spacing between table cells. + */ + +table { + border-collapse: collapse; + border-spacing: 0; +} + +td, +th { + padding: 0; +} diff --git a/css/template.css b/css/template.css new file mode 100644 index 0000000..f717828 --- /dev/null +++ b/css/template.css @@ -0,0 +1,192 @@ +.phpdocumentor-summary { + font-style: italic; +} +.phpdocumentor-description { + margin-bottom: var(--spacing-md); +} +.phpdocumentor-element { + position: relative; +} + +.phpdocumentor .phpdocumentor-element__name { + line-height: 1; +} + +.phpdocumentor-element__package, +.phpdocumentor-element__extends, +.phpdocumentor-element__implements { + display: block; + font-size: var(--text-xxs); + font-weight: normal; + opacity: .7; +} + +.phpdocumentor-element__package .phpdocumentor-breadcrumbs { + display: inline; +} + +.phpdocumentor-element:not(:last-child) { + border-bottom: 1px solid var(--primary-color-lighten); + padding-bottom: var(--spacing-lg); +} + +.phpdocumentor-element.-deprecated .phpdocumentor-element__name { + text-decoration: line-through; +} + +.phpdocumentor-element__modifier { + font-size: var(--text-xxs); + padding: calc(var(--spacing-base-size) / 4) calc(var(--spacing-base-size) / 2); + color: var(--text-color); + background-color: var(--light-gray); + border-radius: 3px; + text-transform: uppercase; +} +.phpdocumentor-signature { + display: inline-block; + font-size: var(--text-sm); + margin-bottom: var(--spacing-md); +} + +.phpdocumentor-signature.-deprecated .phpdocumentor-signature__name { + text-decoration: line-through; +} +.phpdocumentor-table-of-contents { +} + +.phpdocumentor-table-of-contents .phpdocumentor-table-of-contents__entry { + padding-top: var(--spacing-xs); + margin-left: 2rem; + display: flex; +} + +.phpdocumentor-table-of-contents .phpdocumentor-table-of-contents__entry > a { + flex: 0 1 auto; +} + +.phpdocumentor-table-of-contents .phpdocumentor-table-of-contents__entry > span { + flex: 1; + white-space: nowrap; + text-overflow: ellipsis; + overflow: hidden; +} + +.phpdocumentor-table-of-contents .phpdocumentor-table-of-contents__entry:after { + content: ''; + height: 12px; + width: 12px; + left: 16px; + position: absolute; +} +.phpdocumentor-table-of-contents .phpdocumentor-table-of-contents__entry.-private:after { + background: url('data:image/svg+xml;utf8,') no-repeat; +} +.phpdocumentor-table-of-contents .phpdocumentor-table-of-contents__entry.-protected:after { + left: 13px; + background: url('data:image/svg+xml;utf8,') no-repeat; +} + +.phpdocumentor-table-of-contents .phpdocumentor-table-of-contents__entry:before { + width: 1.25rem; + height: 1.25rem; + line-height: 1.25rem; + background: transparent url('data:image/svg+xml;utf8,') no-repeat center center; + content: ''; + position: absolute; + left: 0; + border-radius: 50%; + font-weight: 600; + color: white; + text-align: center; + font-size: .75rem; + margin-top: .2rem; +} + +.phpdocumentor-table-of-contents .phpdocumentor-table-of-contents__entry.-method:before { + content: 'M'; + background-image: url('data:image/svg+xml;utf8,'); +} + +.phpdocumentor-table-of-contents .phpdocumentor-table-of-contents__entry.-function:before { + content: 'M'; + background-image: url('data:image/svg+xml;utf8,'); +} + +.phpdocumentor-table-of-contents .phpdocumentor-table-of-contents__entry.-property:before { + content: 'P' +} + +.phpdocumentor-table-of-contents .phpdocumentor-table-of-contents__entry.-constant:before { + content: 'C'; + background-color: transparent; + background-image: url('data:image/svg+xml;utf8,'); +} + +.phpdocumentor-table-of-contents .phpdocumentor-table-of-contents__entry.-class:before { + content: 'C' +} + +.phpdocumentor-table-of-contents .phpdocumentor-table-of-contents__entry.-interface:before { + content: 'I' +} + +.phpdocumentor-table-of-contents .phpdocumentor-table-of-contents__entry.-trait:before { + content: 'T' +} + +.phpdocumentor-table-of-contents .phpdocumentor-table-of-contents__entry.-namespace:before { + content: 'N' +} + +.phpdocumentor-table-of-contents .phpdocumentor-table-of-contents__entry.-package:before { + content: 'P' +} + +.phpdocumentor-table-of-contents .phpdocumentor-table-of-contents__entry.-enum:before { + content: 'E' +} + +.phpdocumentor-table-of-contents dd { + font-style: italic; + margin-left: 2rem; +} +.phpdocumentor-element-found-in { + position: absolute; + top: 0; + right: 0; + font-size: var(--text-sm); + color: gray; +} + +.phpdocumentor-element-found-in .phpdocumentor-element-found-in__source { + flex: 0 1 auto; + display: inline-flex; +} + +.phpdocumentor-element-found-in .phpdocumentor-element-found-in__source:after { + width: 1.25rem; + height: 1.25rem; + line-height: 1.25rem; + background: transparent url('data:image/svg+xml;utf8,') no-repeat center center; + content: ''; + left: 0; + border-radius: 50%; + font-weight: 600; + text-align: center; + font-size: .75rem; + margin-top: .2rem; +} +.phpdocumentor-class-graph { + width: 100%; height: 600px; border:1px solid black; overflow: hidden +} + +.phpdocumentor-class-graph__graph { + width: 100%; +} +.phpdocumentor-tag-list__definition { + display: flex; +} + +.phpdocumentor-tag-link { + margin-right: var(--spacing-sm); +} diff --git a/files/src-com-carlgo11-tempfiles-api-api.html b/files/src-com-carlgo11-tempfiles-api-api.html new file mode 100644 index 0000000..00853a6 --- /dev/null +++ b/files/src-com-carlgo11-tempfiles-api-api.html @@ -0,0 +1,253 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + + + +
                              +

                              Documentation

                              + + + + + +
                              + +
                              +
                              + + + + +
                              +
                                +
                              + +
                              +

                              API.php

                              + + +
                              + + + + + + +

                              + Interfaces, Classes, Traits and Enums + +

                              + +
                              + +
                              API
                              +
                              + + +
                              + + + + + + + + +
                              +
                              +
                              +
                              +
                              
                              +        
                              + +
                              +
                              + + + +
                              +
                              +
                              +
                              +

                              Search results

                              + +
                              +
                              +
                                +
                                +
                                +
                                +
                                +
                                + + +
                                + + + + + + + + diff --git a/files/src-com-carlgo11-tempfiles-api-cleanup.html b/files/src-com-carlgo11-tempfiles-api-cleanup.html new file mode 100644 index 0000000..7907527 --- /dev/null +++ b/files/src-com-carlgo11-tempfiles-api-cleanup.html @@ -0,0 +1,253 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + + + +
                                +

                                Documentation

                                + + + + + +
                                + +
                                +
                                + + + + +
                                +
                                  +
                                + +
                                +

                                Cleanup.php

                                + + +
                                + + + + + + +

                                + Interfaces, Classes, Traits and Enums + +

                                + +
                                + +
                                Cleanup
                                +
                                + + +
                                + + + + + + + + +
                                +
                                +
                                +
                                +
                                
                                +        
                                + +
                                +
                                + + + +
                                +
                                +
                                +
                                +

                                Search results

                                + +
                                +
                                +
                                  +
                                  +
                                  +
                                  +
                                  +
                                  + + +
                                  + + + + + + + + diff --git a/files/src-com-carlgo11-tempfiles-api-delete.html b/files/src-com-carlgo11-tempfiles-api-delete.html new file mode 100644 index 0000000..c0a9cce --- /dev/null +++ b/files/src-com-carlgo11-tempfiles-api-delete.html @@ -0,0 +1,253 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + + + +
                                  +

                                  Documentation

                                  + + + + + +
                                  + +
                                  +
                                  + + + + +
                                  +
                                    +
                                  + +
                                  +

                                  Delete.php

                                  + + +
                                  + + + + + + +

                                  + Interfaces, Classes, Traits and Enums + +

                                  + +
                                  + +
                                  Delete
                                  +
                                  + + +
                                  + + + + + + + + +
                                  +
                                  +
                                  +
                                  +
                                  
                                  +        
                                  + +
                                  +
                                  + + + +
                                  +
                                  +
                                  +
                                  +

                                  Search results

                                  + +
                                  +
                                  +
                                    +
                                    +
                                    +
                                    +
                                    +
                                    + + +
                                    + + + + + + + + diff --git a/files/src-com-carlgo11-tempfiles-api-download.html b/files/src-com-carlgo11-tempfiles-api-download.html new file mode 100644 index 0000000..14b825b --- /dev/null +++ b/files/src-com-carlgo11-tempfiles-api-download.html @@ -0,0 +1,253 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + + + +
                                    +

                                    Documentation

                                    + + + + + +
                                    + +
                                    +
                                    + + + + +
                                    +
                                      +
                                    + +
                                    +

                                    Download.php

                                    + + +
                                    + + + + + + +

                                    + Interfaces, Classes, Traits and Enums + +

                                    + +
                                    + +
                                    Download
                                    +
                                    + + +
                                    + + + + + + + + +
                                    +
                                    +
                                    +
                                    +
                                    
                                    +        
                                    + +
                                    +
                                    + + + +
                                    +
                                    +
                                    +
                                    +

                                    Search results

                                    + +
                                    +
                                    +
                                      +
                                      +
                                      +
                                      +
                                      +
                                      + + +
                                      + + + + + + + + diff --git a/files/src-com-carlgo11-tempfiles-api-upload.html b/files/src-com-carlgo11-tempfiles-api-upload.html new file mode 100644 index 0000000..cd06086 --- /dev/null +++ b/files/src-com-carlgo11-tempfiles-api-upload.html @@ -0,0 +1,253 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + + + +
                                      +

                                      Documentation

                                      + + + + + +
                                      + +
                                      +
                                      + + + + +
                                      +
                                        +
                                      + +
                                      +

                                      Upload.php

                                      + + +
                                      + + + + + + +

                                      + Interfaces, Classes, Traits and Enums + +

                                      + +
                                      + +
                                      Upload
                                      +
                                      + + +
                                      + + + + + + + + +
                                      +
                                      +
                                      +
                                      +
                                      
                                      +        
                                      + +
                                      +
                                      + + + +
                                      +
                                      +
                                      +
                                      +

                                      Search results

                                      + +
                                      +
                                      +
                                        +
                                        +
                                        +
                                        +
                                        +
                                        + + +
                                        + + + + + + + + diff --git a/files/src-com-carlgo11-tempfiles-autoload.html b/files/src-com-carlgo11-tempfiles-autoload.html new file mode 100644 index 0000000..55daa5d --- /dev/null +++ b/files/src-com-carlgo11-tempfiles-autoload.html @@ -0,0 +1,423 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + + + +
                                        +

                                        Documentation

                                        + + + + + +
                                        + +
                                        +
                                        + + + + +
                                        +
                                          +
                                        + +
                                        +

                                        autoload.php

                                        + + +
                                        + + + + + + + + +

                                        + Table of Contents + +

                                        + +
                                        +
                                        + checkFile() + +  : object|null +
                                        +
                                        Checks if a file exists.
                                        + +
                                        + createDirectory() + +  : mixed +
                                        +
                                        + +
                                        + checkVars() + +  : mixed +
                                        +
                                        + +
                                        + + + + + +
                                        +

                                        + Functions + +

                                        +
                                        +

                                        + checkFile() + +

                                        + + +

                                        Checks if a file exists.

                                        + + + + checkFile(string $file) : object|null + +

                                        If it doesn't, the connection dies.

                                        +
                                        + +
                                        Parameters
                                        +
                                        +
                                        + $file + : string +
                                        +
                                        +

                                        Full path of the file.

                                        +
                                        + +
                                        +
                                        + + +
                                        + Tags + +
                                        +
                                        +
                                        + since +
                                        +
                                        + 2.2 + + +
                                        +
                                        + +
                                        Return values
                                        + object|null + — +

                                        Returns the file if found.

                                        +
                                        + + +
                                        +
                                        +

                                        + createDirectory() + +

                                        + + + + + + createDirectory(mixed $dir) : mixed + +
                                        + +
                                        Parameters
                                        +
                                        +
                                        + $dir + : mixed +
                                        +
                                        +
                                        + +
                                        +
                                        + + +
                                        + Tags + +
                                        +
                                        +
                                        + +
                                        Return values
                                        + mixed + — + + +
                                        +
                                        +

                                        + checkVars() + +

                                        + + + + + + checkVars(string $name) : mixed + +
                                        + +
                                        Parameters
                                        +
                                        +
                                        + $name + : string +
                                        +
                                        +
                                        + +
                                        +
                                        + + +
                                        + Tags + +
                                        +
                                        +
                                        + +
                                        Return values
                                        + mixed + — + + +
                                        +
                                        + +
                                        +
                                        +
                                        +
                                        +
                                        
                                        +        
                                        + +
                                        +
                                        + + + +
                                        +
                                        +
                                        +
                                        +

                                        Search results

                                        + +
                                        +
                                        +
                                          +
                                          +
                                          +
                                          +
                                          +
                                          + + +
                                          + + + + + + + + diff --git a/files/src-com-carlgo11-tempfiles-config.html b/files/src-com-carlgo11-tempfiles-config.html new file mode 100644 index 0000000..5827fb1 --- /dev/null +++ b/files/src-com-carlgo11-tempfiles-config.html @@ -0,0 +1,241 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + + + +
                                          +

                                          Documentation

                                          + + + + + +
                                          + +
                                          +
                                          + + + + +
                                          +
                                            +
                                          + +
                                          +

                                          config.php

                                          + + +
                                          + + + + + + + + + + + + + + +
                                          +
                                          +
                                          +
                                          +
                                          
                                          +        
                                          + +
                                          +
                                          + + + +
                                          +
                                          +
                                          +
                                          +

                                          Search results

                                          + +
                                          +
                                          +
                                            +
                                            +
                                            +
                                            +
                                            +
                                            + + +
                                            + + + + + + + + diff --git a/files/src-com-carlgo11-tempfiles-datastorage-datainterface.html b/files/src-com-carlgo11-tempfiles-datastorage-datainterface.html new file mode 100644 index 0000000..a2f4aac --- /dev/null +++ b/files/src-com-carlgo11-tempfiles-datastorage-datainterface.html @@ -0,0 +1,253 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + + + +
                                            +

                                            Documentation

                                            + + + + + +
                                            + +
                                            +
                                            + + + + +
                                            +
                                              +
                                            + +
                                            +

                                            DataInterface.php

                                            + + +
                                            + + + + + + +

                                            + Interfaces, Classes, Traits and Enums + +

                                            + +
                                            +
                                            DataInterface
                                            +
                                            + + + +
                                            + + + + + + + + +
                                            +
                                            +
                                            +
                                            +
                                            
                                            +        
                                            + +
                                            +
                                            + + + +
                                            +
                                            +
                                            +
                                            +

                                            Search results

                                            + +
                                            +
                                            +
                                              +
                                              +
                                              +
                                              +
                                              +
                                              + + +
                                              + + + + + + + + diff --git a/files/src-com-carlgo11-tempfiles-datastorage-datastorage.html b/files/src-com-carlgo11-tempfiles-datastorage-datastorage.html new file mode 100644 index 0000000..eebb874 --- /dev/null +++ b/files/src-com-carlgo11-tempfiles-datastorage-datastorage.html @@ -0,0 +1,253 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + + + +
                                              +

                                              Documentation

                                              + + + + + +
                                              + +
                                              +
                                              + + + + +
                                              +
                                                +
                                              + +
                                              +

                                              DataStorage.php

                                              + + +
                                              + + + + + + +

                                              + Interfaces, Classes, Traits and Enums + +

                                              + +
                                              + +
                                              DataStorage
                                              +
                                              High level data storage handler.
                                              + + +
                                              + + + + + + + + +
                                              +
                                              +
                                              +
                                              +
                                              
                                              +        
                                              + +
                                              +
                                              + + + +
                                              +
                                              +
                                              +
                                              +

                                              Search results

                                              + +
                                              +
                                              +
                                                +
                                                +
                                                +
                                                +
                                                +
                                                + + +
                                                + + + + + + + + diff --git a/files/src-com-carlgo11-tempfiles-datastorage-filestorage.html b/files/src-com-carlgo11-tempfiles-datastorage-filestorage.html new file mode 100644 index 0000000..8d9e858 --- /dev/null +++ b/files/src-com-carlgo11-tempfiles-datastorage-filestorage.html @@ -0,0 +1,253 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + + + +
                                                +

                                                Documentation

                                                + + + + + +
                                                + +
                                                +
                                                + + + + +
                                                +
                                                  +
                                                + +
                                                +

                                                FileStorage.php

                                                + + +
                                                + + + + + + +

                                                + Interfaces, Classes, Traits and Enums + +

                                                + +
                                                + +
                                                FileStorage
                                                +
                                                Local file storage class
                                                + + +
                                                + + + + + + + + +
                                                +
                                                +
                                                +
                                                +
                                                
                                                +        
                                                + +
                                                +
                                                + + + +
                                                +
                                                +
                                                +
                                                +

                                                Search results

                                                + +
                                                +
                                                +
                                                  +
                                                  +
                                                  +
                                                  +
                                                  +
                                                  + + +
                                                  + + + + + + + + diff --git a/files/src-com-carlgo11-tempfiles-datastorage-mysqlstorage.html b/files/src-com-carlgo11-tempfiles-datastorage-mysqlstorage.html new file mode 100644 index 0000000..564ac5c --- /dev/null +++ b/files/src-com-carlgo11-tempfiles-datastorage-mysqlstorage.html @@ -0,0 +1,253 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + + + +
                                                  +

                                                  Documentation

                                                  + + + + + +
                                                  + +
                                                  +
                                                  + + + + +
                                                  +
                                                    +
                                                  + +
                                                  +

                                                  MySQLStorage.php

                                                  + + +
                                                  + + + + + + +

                                                  + Interfaces, Classes, Traits and Enums + +

                                                  + +
                                                  + +
                                                  MySQLStorage
                                                  +
                                                  + + +
                                                  + + + + + + + + +
                                                  +
                                                  +
                                                  +
                                                  +
                                                  
                                                  +        
                                                  + +
                                                  +
                                                  + + + +
                                                  +
                                                  +
                                                  +
                                                  +

                                                  Search results

                                                  + +
                                                  +
                                                  +
                                                    +
                                                    +
                                                    +
                                                    +
                                                    +
                                                    + + +
                                                    + + + + + + + + diff --git a/files/src-com-carlgo11-tempfiles-encryption.html b/files/src-com-carlgo11-tempfiles-encryption.html new file mode 100644 index 0000000..9b294f6 --- /dev/null +++ b/files/src-com-carlgo11-tempfiles-encryption.html @@ -0,0 +1,253 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + + + +
                                                    +

                                                    Documentation

                                                    + + + + + +
                                                    + +
                                                    +
                                                    + + + + +
                                                    +
                                                      +
                                                    + +
                                                    +

                                                    Encryption.php

                                                    + + +
                                                    + + + + + + +

                                                    + Interfaces, Classes, Traits and Enums + +

                                                    + +
                                                    + +
                                                    Encryption
                                                    +
                                                    Encryption handling.
                                                    + + +
                                                    + + + + + + + + +
                                                    +
                                                    +
                                                    +
                                                    +
                                                    
                                                    +        
                                                    + +
                                                    +
                                                    + + + +
                                                    +
                                                    +
                                                    +
                                                    +

                                                    Search results

                                                    + +
                                                    +
                                                    +
                                                      +
                                                      +
                                                      +
                                                      +
                                                      +
                                                      + + +
                                                      + + + + + + + + diff --git a/files/src-com-carlgo11-tempfiles-exception-badmethod.html b/files/src-com-carlgo11-tempfiles-exception-badmethod.html new file mode 100644 index 0000000..5b87cf4 --- /dev/null +++ b/files/src-com-carlgo11-tempfiles-exception-badmethod.html @@ -0,0 +1,253 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + + + +
                                                      +

                                                      Documentation

                                                      + + + + + +
                                                      + +
                                                      +
                                                      + + + + +
                                                      +
                                                        +
                                                      + +
                                                      +

                                                      BadMethod.php

                                                      + + +
                                                      + + + + + + +

                                                      + Interfaces, Classes, Traits and Enums + +

                                                      + +
                                                      + +
                                                      BadMethod
                                                      +
                                                      + + +
                                                      + + + + + + + + +
                                                      +
                                                      +
                                                      +
                                                      +
                                                      
                                                      +        
                                                      + +
                                                      +
                                                      + + + +
                                                      +
                                                      +
                                                      +
                                                      +

                                                      Search results

                                                      + +
                                                      +
                                                      +
                                                        +
                                                        +
                                                        +
                                                        +
                                                        +
                                                        + + +
                                                        + + + + + + + + diff --git a/files/src-com-carlgo11-tempfiles-exception-missingentry.html b/files/src-com-carlgo11-tempfiles-exception-missingentry.html new file mode 100644 index 0000000..19e4bf8 --- /dev/null +++ b/files/src-com-carlgo11-tempfiles-exception-missingentry.html @@ -0,0 +1,253 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + + + +
                                                        +

                                                        Documentation

                                                        + + + + + +
                                                        + +
                                                        +
                                                        + + + + +
                                                        +
                                                          +
                                                        + +
                                                        +

                                                        MissingEntry.php

                                                        + + +
                                                        + + + + + + +

                                                        + Interfaces, Classes, Traits and Enums + +

                                                        + +
                                                        + +
                                                        MissingEntry
                                                        +
                                                        + + +
                                                        + + + + + + + + +
                                                        +
                                                        +
                                                        +
                                                        +
                                                        
                                                        +        
                                                        + +
                                                        +
                                                        + + + +
                                                        +
                                                        +
                                                        +
                                                        +

                                                        Search results

                                                        + +
                                                        +
                                                        +
                                                          +
                                                          +
                                                          +
                                                          +
                                                          +
                                                          + + +
                                                          + + + + + + + + diff --git a/files/src-com-carlgo11-tempfiles-file.html b/files/src-com-carlgo11-tempfiles-file.html new file mode 100644 index 0000000..b8e2015 --- /dev/null +++ b/files/src-com-carlgo11-tempfiles-file.html @@ -0,0 +1,254 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + + + +
                                                          +

                                                          Documentation

                                                          + + + + + +
                                                          + +
                                                          +
                                                          + + + + +
                                                          +
                                                            +
                                                          + +
                                                          +

                                                          File.php

                                                          + + +
                                                          + + + + + + +

                                                          + Interfaces, Classes, Traits and Enums + +

                                                          + +
                                                          + +
                                                          File
                                                          +
                                                          File class +Stores all file-related data during a file-upload/-download operation.
                                                          + + +
                                                          + + + + + + + + +
                                                          +
                                                          +
                                                          +
                                                          +
                                                          
                                                          +        
                                                          + +
                                                          +
                                                          + + + +
                                                          +
                                                          +
                                                          +
                                                          +

                                                          Search results

                                                          + +
                                                          +
                                                          +
                                                            +
                                                            +
                                                            +
                                                            +
                                                            +
                                                            + + +
                                                            + + + + + + + + diff --git a/files/src-com-carlgo11-tempfiles-misc.html b/files/src-com-carlgo11-tempfiles-misc.html new file mode 100644 index 0000000..137ffe2 --- /dev/null +++ b/files/src-com-carlgo11-tempfiles-misc.html @@ -0,0 +1,253 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + + + +
                                                            +

                                                            Documentation

                                                            + + + + + +
                                                            + +
                                                            +
                                                            + + + + +
                                                            +
                                                              +
                                                            + +
                                                            +

                                                            Misc.php

                                                            + + +
                                                            + + + + + + +

                                                            + Interfaces, Classes, Traits and Enums + +

                                                            + +
                                                            + +
                                                            Misc
                                                            +
                                                            Miscellaneous functions
                                                            + + +
                                                            + + + + + + + + +
                                                            +
                                                            +
                                                            +
                                                            +
                                                            
                                                            +        
                                                            + +
                                                            +
                                                            + + + +
                                                            +
                                                            +
                                                            +
                                                            +

                                                            Search results

                                                            + +
                                                            +
                                                            +
                                                              +
                                                              +
                                                              +
                                                              +
                                                              +
                                                              + + +
                                                              + + + + + + + + diff --git a/graphs/classes.html b/graphs/classes.html new file mode 100644 index 0000000..43a2995 --- /dev/null +++ b/graphs/classes.html @@ -0,0 +1,126 @@ + + + + + Documentation + + + + + + + + + +
                                                              +

                                                              Documentation

                                                              + + + + + +
                                                              + +
                                                              +
                                                              + + + + +
                                                              +
                                                              + +
                                                              + +
                                                              +
                                                              +
                                                              +

                                                              Search results

                                                              + +
                                                              +
                                                              +
                                                                +
                                                                +
                                                                +
                                                                +
                                                                +
                                                                + + +
                                                                + + + + + + + + diff --git a/index.html b/index.html new file mode 100644 index 0000000..283df6c --- /dev/null +++ b/index.html @@ -0,0 +1,336 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + + + +
                                                                +

                                                                Documentation

                                                                + + + + + +
                                                                + +
                                                                +
                                                                + + + + +
                                                                +

                                                                Documentation

                                                                + + +

                                                                + Packages + +

                                                                + +
                                                                +
                                                                Application
                                                                +
                                                                com
                                                                +
                                                                + +

                                                                + Namespaces + +

                                                                + +
                                                                +
                                                                com
                                                                +
                                                                + + + +

                                                                + Table of Contents + +

                                                                + +
                                                                +
                                                                + checkFile() + +  : object|null +
                                                                +
                                                                Checks if a file exists.
                                                                + +
                                                                + createDirectory() + +  : mixed +
                                                                +
                                                                + +
                                                                + checkVars() + +  : mixed +
                                                                +
                                                                + +
                                                                + + + +
                                                                +

                                                                + Functions + +

                                                                +
                                                                +

                                                                + checkFile() + +

                                                                + + +

                                                                Checks if a file exists.

                                                                + + + + checkFile(string $file) : object|null + +

                                                                If it doesn't, the connection dies.

                                                                +
                                                                + +
                                                                Parameters
                                                                +
                                                                +
                                                                + $file + : string +
                                                                +
                                                                +

                                                                Full path of the file.

                                                                +
                                                                + +
                                                                +
                                                                + + +
                                                                + Tags + +
                                                                +
                                                                +
                                                                + since +
                                                                +
                                                                + 2.2 + + +
                                                                +
                                                                + +
                                                                Return values
                                                                + object|null + — +

                                                                Returns the file if found.

                                                                +
                                                                + + +
                                                                +
                                                                +

                                                                + createDirectory() + +

                                                                + + + + + + createDirectory(mixed $dir) : mixed + +
                                                                + +
                                                                Parameters
                                                                +
                                                                +
                                                                + $dir + : mixed +
                                                                +
                                                                +
                                                                + +
                                                                +
                                                                + + +
                                                                + Tags + +
                                                                +
                                                                +
                                                                + +
                                                                Return values
                                                                + mixed + — + + +
                                                                +
                                                                +

                                                                + checkVars() + +

                                                                + + + + + + checkVars(string $name) : mixed + +
                                                                + +
                                                                Parameters
                                                                +
                                                                +
                                                                + $name + : string +
                                                                +
                                                                +
                                                                + +
                                                                +
                                                                + + +
                                                                + Tags + +
                                                                +
                                                                +
                                                                + +
                                                                Return values
                                                                + mixed + — + + +
                                                                +
                                                                + +
                                                                +
                                                                +
                                                                +

                                                                Search results

                                                                + +
                                                                +
                                                                +
                                                                  +
                                                                  +
                                                                  +
                                                                  +
                                                                  +
                                                                  + + +
                                                                  + + + + + + + + diff --git a/indices/files.html b/indices/files.html new file mode 100644 index 0000000..93be1eb --- /dev/null +++ b/indices/files.html @@ -0,0 +1,168 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + + + +
                                                                  +

                                                                  Documentation

                                                                  + + + + + +
                                                                  + +
                                                                  +
                                                                  + + + + +
                                                                  + +

                                                                  Files

                                                                  +

                                                                  A

                                                                  + +

                                                                  B

                                                                  + +

                                                                  C

                                                                  + +

                                                                  D

                                                                  + +

                                                                  E

                                                                  + +

                                                                  F

                                                                  + +

                                                                  M

                                                                  + +

                                                                  U

                                                                  + +
                                                                  +
                                                                  +
                                                                  +

                                                                  Search results

                                                                  + +
                                                                  +
                                                                  +
                                                                    +
                                                                    +
                                                                    +
                                                                    +
                                                                    +
                                                                    + + +
                                                                    + + + + + + + + diff --git a/js/search.js b/js/search.js new file mode 100644 index 0000000..093d6d0 --- /dev/null +++ b/js/search.js @@ -0,0 +1,173 @@ +// Search module for phpDocumentor +// +// This module is a wrapper around fuse.js that will use a given index and attach itself to a +// search form and to a search results pane identified by the following data attributes: +// +// 1. data-search-form +// 2. data-search-results +// +// The data-search-form is expected to have a single input element of type 'search' that will trigger searching for +// a series of results, were the data-search-results pane is expected to have a direct UL child that will be populated +// with rendered results. +// +// The search has various stages, upon loading this stage the data-search-form receives the CSS class +// 'phpdocumentor-search--enabled'; this indicates that JS is allowed and indices are being loaded. It is recommended +// to hide the form by default and show it when it receives this class to achieve progressive enhancement for this +// feature. +// +// After loading this module, it is expected to load a search index asynchronously, for example: +// +// +// +// In this script the generated index should attach itself to the search module using the `appendIndex` function. By +// doing it like this the page will continue loading, unhindered by the loading of the search. +// +// After the page has fully loaded, and all these deferred indexes loaded, the initialization of the search module will +// be called and the form will receive the class 'phpdocumentor-search--active', indicating search is ready. At this +// point, the input field will also have it's 'disabled' attribute removed. +var Search = (function () { + var fuse; + var index = []; + var options = { + shouldSort: true, + threshold: 0.6, + location: 0, + distance: 100, + maxPatternLength: 32, + minMatchCharLength: 1, + keys: [ + "fqsen", + "name", + "summary", + "url" + ] + }; + + // Credit David Walsh (https://davidwalsh.name/javascript-debounce-function) + // Returns a function, that, as long as it continues to be invoked, will not + // be triggered. The function will be called after it stops being called for + // N milliseconds. If `immediate` is passed, trigger the function on the + // leading edge, instead of the trailing. + function debounce(func, wait, immediate) { + var timeout; + + return function executedFunction() { + var context = this; + var args = arguments; + + var later = function () { + timeout = null; + if (!immediate) func.apply(context, args); + }; + + var callNow = immediate && !timeout; + clearTimeout(timeout); + timeout = setTimeout(later, wait); + if (callNow) func.apply(context, args); + }; + } + + function close() { + // Start scroll prevention: https://css-tricks.com/prevent-page-scrolling-when-a-modal-is-open/ + const scrollY = document.body.style.top; + document.body.style.position = ''; + document.body.style.top = ''; + window.scrollTo(0, parseInt(scrollY || '0') * -1); + // End scroll prevention + + var form = document.querySelector('[data-search-form]'); + var searchResults = document.querySelector('[data-search-results]'); + + form.classList.toggle('phpdocumentor-search--has-results', false); + searchResults.classList.add('phpdocumentor-search-results--hidden'); + var searchField = document.querySelector('[data-search-form] input[type="search"]'); + searchField.blur(); + } + + function search(event) { + // Start scroll prevention: https://css-tricks.com/prevent-page-scrolling-when-a-modal-is-open/ + document.body.style.position = 'fixed'; + document.body.style.top = `-${window.scrollY}px`; + // End scroll prevention + + // prevent enter's from autosubmitting + event.stopPropagation(); + + var form = document.querySelector('[data-search-form]'); + var searchResults = document.querySelector('[data-search-results]'); + var searchResultEntries = document.querySelector('[data-search-results] .phpdocumentor-search-results__entries'); + + searchResultEntries.innerHTML = ''; + + if (!event.target.value) { + close(); + return; + } + + form.classList.toggle('phpdocumentor-search--has-results', true); + searchResults.classList.remove('phpdocumentor-search-results--hidden'); + var results = fuse.search(event.target.value, {limit: 25}); + + results.forEach(function (result) { + var entry = document.createElement("li"); + entry.classList.add("phpdocumentor-search-results__entry"); + entry.innerHTML += '

                                                                    ' + result.name + "

                                                                    \n"; + entry.innerHTML += '' + result.fqsen + "\n"; + entry.innerHTML += '
                                                                    ' + result.summary + '
                                                                    '; + searchResultEntries.appendChild(entry) + }); + } + + function appendIndex(added) { + index = index.concat(added); + + // re-initialize search engine when appending an index after initialisation + if (typeof fuse !== 'undefined') { + fuse = new Fuse(index, options); + } + } + + function init() { + fuse = new Fuse(index, options); + + var form = document.querySelector('[data-search-form]'); + var searchField = document.querySelector('[data-search-form] input[type="search"]'); + + var closeButton = document.querySelector('.phpdocumentor-search-results__close'); + closeButton.addEventListener('click', function() { close() }.bind(this)); + + var searchResults = document.querySelector('[data-search-results]'); + searchResults.addEventListener('click', function() { close() }.bind(this)); + + form.classList.add('phpdocumentor-search--active'); + + searchField.setAttribute('placeholder', 'Search (Press "/" to focus)'); + searchField.removeAttribute('disabled'); + searchField.addEventListener('keyup', debounce(search, 300)); + + window.addEventListener('keyup', function (event) { + if (event.key === '/') { + searchField.focus(); + } + if (event.code === 'Escape') { + close(); + } + }.bind(this)); + } + + return { + appendIndex, + init + } +})(); + +window.addEventListener('DOMContentLoaded', function () { + var form = document.querySelector('[data-search-form]'); + + // When JS is supported; show search box. Must be before including the search for it to take effect immediately + form.classList.add('phpdocumentor-search--enabled'); +}); + +window.addEventListener('load', function () { + Search.init(); +}); diff --git a/js/searchIndex.js b/js/searchIndex.js new file mode 100644 index 0000000..5c0c555 --- /dev/null +++ b/js/searchIndex.js @@ -0,0 +1,499 @@ +Search.appendIndex( + [ + { + "fqsen": "\\com\\carlgo11\\tempfiles\\api\\API", + "name": "API", + "summary": "", + "url": "classes/com-carlgo11-tempfiles-api-API.html" + }, { + "fqsen": "\\com\\carlgo11\\tempfiles\\api\\API\u003A\u003AoutputJSON\u0028\u0029", + "name": "outputJSON", + "summary": "", + "url": "classes/com-carlgo11-tempfiles-api-API.html#method_outputJSON" + }, { + "fqsen": "\\com\\carlgo11\\tempfiles\\api\\Cleanup", + "name": "Cleanup", + "summary": "", + "url": "classes/com-carlgo11-tempfiles-api-Cleanup.html" + }, { + "fqsen": "\\com\\carlgo11\\tempfiles\\api\\Cleanup\u003A\u003A__construct\u0028\u0029", + "name": "__construct", + "summary": "Cleanup\u0020constructor.", + "url": "classes/com-carlgo11-tempfiles-api-Cleanup.html#method___construct" + }, { + "fqsen": "\\com\\carlgo11\\tempfiles\\api\\Delete", + "name": "Delete", + "summary": "", + "url": "classes/com-carlgo11-tempfiles-api-Delete.html" + }, { + "fqsen": "\\com\\carlgo11\\tempfiles\\api\\Delete\u003A\u003A__construct\u0028\u0029", + "name": "__construct", + "summary": "Delete\u0020constructor.", + "url": "classes/com-carlgo11-tempfiles-api-Delete.html#method___construct" + }, { + "fqsen": "\\com\\carlgo11\\tempfiles\\api\\Download", + "name": "Download", + "summary": "", + "url": "classes/com-carlgo11-tempfiles-api-Download.html" + }, { + "fqsen": "\\com\\carlgo11\\tempfiles\\api\\Download\u003A\u003A__construct\u0028\u0029", + "name": "__construct", + "summary": "Download\u0020constructor.", + "url": "classes/com-carlgo11-tempfiles-api-Download.html#method___construct" + }, { + "fqsen": "\\com\\carlgo11\\tempfiles\\api\\Upload", + "name": "Upload", + "summary": "", + "url": "classes/com-carlgo11-tempfiles-api-Upload.html" + }, { + "fqsen": "\\com\\carlgo11\\tempfiles\\api\\Upload\u003A\u003A__construct\u0028\u0029", + "name": "__construct", + "summary": "Upload\u0020constructor.", + "url": "classes/com-carlgo11-tempfiles-api-Upload.html#method___construct" + }, { + "fqsen": "\\checkFile\u0028\u0029", + "name": "checkFile", + "summary": "Checks\u0020if\u0020a\u0020file\u0020exists.", + "url": "namespaces/default.html#function_checkFile" + }, { + "fqsen": "\\createDirectory\u0028\u0029", + "name": "createDirectory", + "summary": "", + "url": "namespaces/default.html#function_createDirectory" + }, { + "fqsen": "\\checkVars\u0028\u0029", + "name": "checkVars", + "summary": "", + "url": "namespaces/default.html#function_checkVars" + }, { + "fqsen": "\\com\\carlgo11\\tempfiles\\datastorage\\DataInterface", + "name": "DataInterface", + "summary": "", + "url": "classes/com-carlgo11-tempfiles-datastorage-DataInterface.html" + }, { + "fqsen": "\\com\\carlgo11\\tempfiles\\datastorage\\DataInterface\u003A\u003AgetEntryContent\u0028\u0029", + "name": "getEntryContent", + "summary": "Get\u0020encrypted\u0020content\u0020\u0028file\u0020data\u0029\u0020from\u0020a\u0020stored\u0020entry.", + "url": "classes/com-carlgo11-tempfiles-datastorage-DataInterface.html#method_getEntryContent" + }, { + "fqsen": "\\com\\carlgo11\\tempfiles\\datastorage\\DataInterface\u003A\u003AgetEntryMetaData\u0028\u0029", + "name": "getEntryMetaData", + "summary": "Get\u0020encrypted\u0020metadata.", + "url": "classes/com-carlgo11-tempfiles-datastorage-DataInterface.html#method_getEntryMetaData" + }, { + "fqsen": "\\com\\carlgo11\\tempfiles\\datastorage\\DataInterface\u003A\u003AsaveEntry\u0028\u0029", + "name": "saveEntry", + "summary": "Save\u0020an\u0020uploaded\u0020entry.", + "url": "classes/com-carlgo11-tempfiles-datastorage-DataInterface.html#method_saveEntry" + }, { + "fqsen": "\\com\\carlgo11\\tempfiles\\datastorage\\DataInterface\u003A\u003AentryExists\u0028\u0029", + "name": "entryExists", + "summary": "See\u0020if\u0020an\u0020entry\u0020with\u0020the\u0020provided\u0020ID\u0020exists.", + "url": "classes/com-carlgo11-tempfiles-datastorage-DataInterface.html#method_entryExists" + }, { + "fqsen": "\\com\\carlgo11\\tempfiles\\datastorage\\DataInterface\u003A\u003AdeleteEntry\u0028\u0029", + "name": "deleteEntry", + "summary": "Delete\u0020a\u0020stored\u0020entry\u0020\u0028file\u0029", + "url": "classes/com-carlgo11-tempfiles-datastorage-DataInterface.html#method_deleteEntry" + }, { + "fqsen": "\\com\\carlgo11\\tempfiles\\datastorage\\DataInterface\u003A\u003AgetEntryExpiry\u0028\u0029", + "name": "getEntryExpiry", + "summary": "Get\u0020the\u0020expiry\u0020date\u0020of\u0020a\u0020stored\u0020entry.", + "url": "classes/com-carlgo11-tempfiles-datastorage-DataInterface.html#method_getEntryExpiry" + }, { + "fqsen": "\\com\\carlgo11\\tempfiles\\datastorage\\DataInterface\u003A\u003AlistEntries\u0028\u0029", + "name": "listEntries", + "summary": "Get\u0020all\u0020stored\u0020entry\u0020IDs", + "url": "classes/com-carlgo11-tempfiles-datastorage-DataInterface.html#method_listEntries" + }, { + "fqsen": "\\com\\carlgo11\\tempfiles\\datastorage\\DataInterface\u003A\u003AgetDelPassword\u0028\u0029", + "name": "getDelPassword", + "summary": "Get\u0020Deletion\u0020password\u0020hash.", + "url": "classes/com-carlgo11-tempfiles-datastorage-DataInterface.html#method_getDelPassword" + }, { + "fqsen": "\\com\\carlgo11\\tempfiles\\datastorage\\DataStorage", + "name": "DataStorage", + "summary": "High\u0020level\u0020data\u0020storage\u0020handler.", + "url": "classes/com-carlgo11-tempfiles-datastorage-DataStorage.html" + }, { + "fqsen": "\\com\\carlgo11\\tempfiles\\datastorage\\DataStorage\u003A\u003AgetFile\u0028\u0029", + "name": "getFile", + "summary": "Get\u0020a\u0020stored\u0020entry.", + "url": "classes/com-carlgo11-tempfiles-datastorage-DataStorage.html#method_getFile" + }, { + "fqsen": "\\com\\carlgo11\\tempfiles\\datastorage\\DataStorage\u003A\u003AgetStorage\u0028\u0029", + "name": "getStorage", + "summary": "Get\u0020storage\u0020method\u0020specified\u0020in\u0020config.", + "url": "classes/com-carlgo11-tempfiles-datastorage-DataStorage.html#method_getStorage" + }, { + "fqsen": "\\com\\carlgo11\\tempfiles\\datastorage\\DataStorage\u003A\u003AsaveFile\u0028\u0029", + "name": "saveFile", + "summary": "Save\u0020an\u0020uploaded\u0020entry.", + "url": "classes/com-carlgo11-tempfiles-datastorage-DataStorage.html#method_saveFile" + }, { + "fqsen": "\\com\\carlgo11\\tempfiles\\datastorage\\DataStorage\u003A\u003AdeleteOldFiles\u0028\u0029", + "name": "deleteOldFiles", + "summary": "Delete\u0020all\u0020files\u0020older\u0020than\u002024\u0020hours.", + "url": "classes/com-carlgo11-tempfiles-datastorage-DataStorage.html#method_deleteOldFiles" + }, { + "fqsen": "\\com\\carlgo11\\tempfiles\\datastorage\\DataStorage\u003A\u003AdeleteFile\u0028\u0029", + "name": "deleteFile", + "summary": "Delete\u0020a\u0020stored\u0020entry.", + "url": "classes/com-carlgo11-tempfiles-datastorage-DataStorage.html#method_deleteFile" + }, { + "fqsen": "\\com\\carlgo11\\tempfiles\\datastorage\\DataStorage\u003A\u003AupdateViews\u0028\u0029", + "name": "updateViews", + "summary": "Update\u0020current\u0020views\u0020on\u0020existing\u0020entry.", + "url": "classes/com-carlgo11-tempfiles-datastorage-DataStorage.html#method_updateViews" + }, { + "fqsen": "\\com\\carlgo11\\tempfiles\\datastorage\\DataStorage\u003A\u003AgetDeletionPassword\u0028\u0029", + "name": "getDeletionPassword", + "summary": "", + "url": "classes/com-carlgo11-tempfiles-datastorage-DataStorage.html#method_getDeletionPassword" + }, { + "fqsen": "\\com\\carlgo11\\tempfiles\\datastorage\\FileStorage", + "name": "FileStorage", + "summary": "Local\u0020file\u0020storage\u0020class", + "url": "classes/com-carlgo11-tempfiles-datastorage-FileStorage.html" + }, { + "fqsen": "\\com\\carlgo11\\tempfiles\\datastorage\\FileStorage\u003A\u003AgetEntryContent\u0028\u0029", + "name": "getEntryContent", + "summary": "Get\u0020encrypted\u0020content\u0020\u0028file\u0020data\u0029\u0020from\u0020a\u0020stored\u0020entry.", + "url": "classes/com-carlgo11-tempfiles-datastorage-FileStorage.html#method_getEntryContent" + }, { + "fqsen": "\\com\\carlgo11\\tempfiles\\datastorage\\FileStorage\u003A\u003AentryExists\u0028\u0029", + "name": "entryExists", + "summary": "See\u0020if\u0020an\u0020entry\u0020with\u0020the\u0020provided\u0020ID\u0020exists.", + "url": "classes/com-carlgo11-tempfiles-datastorage-FileStorage.html#method_entryExists" + }, { + "fqsen": "\\com\\carlgo11\\tempfiles\\datastorage\\FileStorage\u003A\u003AgetEntryMetaData\u0028\u0029", + "name": "getEntryMetaData", + "summary": "Get\u0020encrypted\u0020metadata.", + "url": "classes/com-carlgo11-tempfiles-datastorage-FileStorage.html#method_getEntryMetaData" + }, { + "fqsen": "\\com\\carlgo11\\tempfiles\\datastorage\\FileStorage\u003A\u003AgetEntryViews\u0028\u0029", + "name": "getEntryViews", + "summary": "Get\u0020views\u0020and\u0020max\u0020views\u0020of\u0020a\u0020stored\u0020entry.", + "url": "classes/com-carlgo11-tempfiles-datastorage-FileStorage.html#method_getEntryViews" + }, { + "fqsen": "\\com\\carlgo11\\tempfiles\\datastorage\\FileStorage\u003A\u003AsaveEntry\u0028\u0029", + "name": "saveEntry", + "summary": "Save\u0020an\u0020uploaded\u0020entry.", + "url": "classes/com-carlgo11-tempfiles-datastorage-FileStorage.html#method_saveEntry" + }, { + "fqsen": "\\com\\carlgo11\\tempfiles\\datastorage\\FileStorage\u003A\u003AgetEntryExpiry\u0028\u0029", + "name": "getEntryExpiry", + "summary": "Get\u0020the\u0020expiry\u0020date\u0020of\u0020a\u0020stored\u0020entry.", + "url": "classes/com-carlgo11-tempfiles-datastorage-FileStorage.html#method_getEntryExpiry" + }, { + "fqsen": "\\com\\carlgo11\\tempfiles\\datastorage\\FileStorage\u003A\u003AdeleteEntry\u0028\u0029", + "name": "deleteEntry", + "summary": "Delete\u0020a\u0020stored\u0020entry\u0020\u0028file\u0029", + "url": "classes/com-carlgo11-tempfiles-datastorage-FileStorage.html#method_deleteEntry" + }, { + "fqsen": "\\com\\carlgo11\\tempfiles\\datastorage\\FileStorage\u003A\u003AlistEntries\u0028\u0029", + "name": "listEntries", + "summary": "Get\u0020all\u0020stored\u0020entry\u0020IDs", + "url": "classes/com-carlgo11-tempfiles-datastorage-FileStorage.html#method_listEntries" + }, { + "fqsen": "\\com\\carlgo11\\tempfiles\\datastorage\\FileStorage\u003A\u003AupdateEntryViews\u0028\u0029", + "name": "updateEntryViews", + "summary": "Update\u0020views\u0020array\u0020in\u0020stored\u0020entry\u0020file.", + "url": "classes/com-carlgo11-tempfiles-datastorage-FileStorage.html#method_updateEntryViews" + }, { + "fqsen": "\\com\\carlgo11\\tempfiles\\datastorage\\FileStorage\u003A\u003AgetDelPassword\u0028\u0029", + "name": "getDelPassword", + "summary": "Get\u0020Deletion\u0020password\u0020hash.", + "url": "classes/com-carlgo11-tempfiles-datastorage-FileStorage.html#method_getDelPassword" + }, { + "fqsen": "\\com\\carlgo11\\tempfiles\\datastorage\\MySQLStorage", + "name": "MySQLStorage", + "summary": "", + "url": "classes/com-carlgo11-tempfiles-datastorage-MySQLStorage.html" + }, { + "fqsen": "\\com\\carlgo11\\tempfiles\\datastorage\\MySQLStorage\u003A\u003A__construct\u0028\u0029", + "name": "__construct", + "summary": "", + "url": "classes/com-carlgo11-tempfiles-datastorage-MySQLStorage.html#method___construct" + }, { + "fqsen": "\\com\\carlgo11\\tempfiles\\datastorage\\MySQLStorage\u003A\u003A__destruct\u0028\u0029", + "name": "__destruct", + "summary": "", + "url": "classes/com-carlgo11-tempfiles-datastorage-MySQLStorage.html#method___destruct" + }, { + "fqsen": "\\com\\carlgo11\\tempfiles\\datastorage\\MySQLStorage\u003A\u003AgetEntryContent\u0028\u0029", + "name": "getEntryContent", + "summary": "Get\u0020encrypted\u0020content\u0020\u0028file\u0020data\u0029\u0020from\u0020a\u0020stored\u0020entry.", + "url": "classes/com-carlgo11-tempfiles-datastorage-MySQLStorage.html#method_getEntryContent" + }, { + "fqsen": "\\com\\carlgo11\\tempfiles\\datastorage\\MySQLStorage\u003A\u003AgetEntryMetaData\u0028\u0029", + "name": "getEntryMetaData", + "summary": "Get\u0020encrypted\u0020metadata.", + "url": "classes/com-carlgo11-tempfiles-datastorage-MySQLStorage.html#method_getEntryMetaData" + }, { + "fqsen": "\\com\\carlgo11\\tempfiles\\datastorage\\MySQLStorage\u003A\u003AsaveEntry\u0028\u0029", + "name": "saveEntry", + "summary": "Save\u0020an\u0020uploaded\u0020entry.", + "url": "classes/com-carlgo11-tempfiles-datastorage-MySQLStorage.html#method_saveEntry" + }, { + "fqsen": "\\com\\carlgo11\\tempfiles\\datastorage\\MySQLStorage\u003A\u003AentryExists\u0028\u0029", + "name": "entryExists", + "summary": "See\u0020if\u0020an\u0020entry\u0020with\u0020the\u0020provided\u0020ID\u0020exists.", + "url": "classes/com-carlgo11-tempfiles-datastorage-MySQLStorage.html#method_entryExists" + }, { + "fqsen": "\\com\\carlgo11\\tempfiles\\datastorage\\MySQLStorage\u003A\u003AdeleteEntry\u0028\u0029", + "name": "deleteEntry", + "summary": "Delete\u0020a\u0020stored\u0020entry\u0020\u0028file\u0029", + "url": "classes/com-carlgo11-tempfiles-datastorage-MySQLStorage.html#method_deleteEntry" + }, { + "fqsen": "\\com\\carlgo11\\tempfiles\\datastorage\\MySQLStorage\u003A\u003AgetEntryExpiry\u0028\u0029", + "name": "getEntryExpiry", + "summary": "Get\u0020the\u0020expiry\u0020date\u0020of\u0020a\u0020stored\u0020entry.", + "url": "classes/com-carlgo11-tempfiles-datastorage-MySQLStorage.html#method_getEntryExpiry" + }, { + "fqsen": "\\com\\carlgo11\\tempfiles\\datastorage\\MySQLStorage\u003A\u003AlistEntries\u0028\u0029", + "name": "listEntries", + "summary": "Get\u0020all\u0020stored\u0020entry\u0020IDs", + "url": "classes/com-carlgo11-tempfiles-datastorage-MySQLStorage.html#method_listEntries" + }, { + "fqsen": "\\com\\carlgo11\\tempfiles\\datastorage\\MySQLStorage\u003A\u003AgetDelPassword\u0028\u0029", + "name": "getDelPassword", + "summary": "Get\u0020Deletion\u0020password\u0020hash.", + "url": "classes/com-carlgo11-tempfiles-datastorage-MySQLStorage.html#method_getDelPassword" + }, { + "fqsen": "\\com\\carlgo11\\tempfiles\\datastorage\\MySQLStorage\u003A\u003A\u0024_mysql", + "name": "_mysql", + "summary": "", + "url": "classes/com-carlgo11-tempfiles-datastorage-MySQLStorage.html#property__mysql" + }, { + "fqsen": "\\com\\carlgo11\\tempfiles\\Encryption", + "name": "Encryption", + "summary": "Encryption\u0020handling.", + "url": "classes/com-carlgo11-tempfiles-Encryption.html" + }, { + "fqsen": "\\com\\carlgo11\\tempfiles\\Encryption\u003A\u003Aencrypt\u0028\u0029", + "name": "encrypt", + "summary": "Encrypts\u0020string\u0020with\u0020encryption\u0020algorithm\u0020specified\u0020in\u0020config", + "url": "classes/com-carlgo11-tempfiles-Encryption.html#method_encrypt" + }, { + "fqsen": "\\com\\carlgo11\\tempfiles\\Encryption\u003A\u003AcreateIV\u0028\u0029", + "name": "createIV", + "summary": "Create\u0020an\u0020IV\u0020\u0028Initialization\u0020Vector\u0029\u0020string.", + "url": "classes/com-carlgo11-tempfiles-Encryption.html#method_createIV" + }, { + "fqsen": "\\com\\carlgo11\\tempfiles\\Encryption\u003A\u003Adecrypt\u0028\u0029", + "name": "decrypt", + "summary": "", + "url": "classes/com-carlgo11-tempfiles-Encryption.html#method_decrypt" + }, { + "fqsen": "\\com\\carlgo11\\tempfiles\\exception\\BadMethod", + "name": "BadMethod", + "summary": "", + "url": "classes/com-carlgo11-tempfiles-exception-BadMethod.html" + }, { + "fqsen": "\\com\\carlgo11\\tempfiles\\exception\\BadMethod\u003A\u003A__construct\u0028\u0029", + "name": "__construct", + "summary": "", + "url": "classes/com-carlgo11-tempfiles-exception-BadMethod.html#method___construct" + }, { + "fqsen": "\\com\\carlgo11\\tempfiles\\exception\\MissingEntry", + "name": "MissingEntry", + "summary": "", + "url": "classes/com-carlgo11-tempfiles-exception-MissingEntry.html" + }, { + "fqsen": "\\com\\carlgo11\\tempfiles\\exception\\MissingEntry\u003A\u003A__construct\u0028\u0029", + "name": "__construct", + "summary": "", + "url": "classes/com-carlgo11-tempfiles-exception-MissingEntry.html#method___construct" + }, { + "fqsen": "\\com\\carlgo11\\tempfiles\\File", + "name": "File", + "summary": "File\u0020class\nStores\u0020all\u0020file\u002Drelated\u0020data\u0020during\u0020a\u0020file\u002Dupload\/\u002Ddownload\u0020operation.", + "url": "classes/com-carlgo11-tempfiles-File.html" + }, { + "fqsen": "\\com\\carlgo11\\tempfiles\\File\u003A\u003A__construct\u0028\u0029", + "name": "__construct", + "summary": "Main\u0020function\u0020of\u0020File\u0020class.", + "url": "classes/com-carlgo11-tempfiles-File.html#method___construct" + }, { + "fqsen": "\\com\\carlgo11\\tempfiles\\File\u003A\u003AgenerateID\u0028\u0029", + "name": "generateID", + "summary": "Generates\u0020a\u0020new\u0020ID\u0020for\u0020the\u0020file.", + "url": "classes/com-carlgo11-tempfiles-File.html#method_generateID" + }, { + "fqsen": "\\com\\carlgo11\\tempfiles\\File\u003A\u003AsetID\u0028\u0029", + "name": "setID", + "summary": "Sets\u0020the\u0020ID\u0020of\u0020the\u0020file.", + "url": "classes/com-carlgo11-tempfiles-File.html#method_setID" + }, { + "fqsen": "\\com\\carlgo11\\tempfiles\\File\u003A\u003A__toString\u0028\u0029", + "name": "__toString", + "summary": "Gets\u0020ID\u0020of\u0020the\u0020file.", + "url": "classes/com-carlgo11-tempfiles-File.html#method___toString" + }, { + "fqsen": "\\com\\carlgo11\\tempfiles\\File\u003A\u003AgetID\u0028\u0029", + "name": "getID", + "summary": "Gets\u0020ID\u0020of\u0020the\u0020file.", + "url": "classes/com-carlgo11-tempfiles-File.html#method_getID" + }, { + "fqsen": "\\com\\carlgo11\\tempfiles\\File\u003A\u003AgetContent\u0028\u0029", + "name": "getContent", + "summary": "Gets\u0020file\u0020content.", + "url": "classes/com-carlgo11-tempfiles-File.html#method_getContent" + }, { + "fqsen": "\\com\\carlgo11\\tempfiles\\File\u003A\u003AsetContent\u0028\u0029", + "name": "setContent", + "summary": "Sets\u0020the\u0020content\u0020of\u0020the\u0020file.", + "url": "classes/com-carlgo11-tempfiles-File.html#method_setContent" + }, { + "fqsen": "\\com\\carlgo11\\tempfiles\\File\u003A\u003AgetCurrentViews\u0028\u0029", + "name": "getCurrentViews", + "summary": "Gets\u0020the\u0020current\u0020views\u0020of\u0020the\u0020file\u0020if\u0020available.", + "url": "classes/com-carlgo11-tempfiles-File.html#method_getCurrentViews" + }, { + "fqsen": "\\com\\carlgo11\\tempfiles\\File\u003A\u003AsetCurrentViews\u0028\u0029", + "name": "setCurrentViews", + "summary": "Sets\u0020the\u0020current\u0020views\/downloads\u0020of\u0020the\u0020file.", + "url": "classes/com-carlgo11-tempfiles-File.html#method_setCurrentViews" + }, { + "fqsen": "\\com\\carlgo11\\tempfiles\\File\u003A\u003AgetMaxViews\u0028\u0029", + "name": "getMaxViews", + "summary": "Gets\u0020the\u0020max\u0020available\u0020views\/downloads\u0020before\u0020the\u0020file\u0020gets\u0020deleted.", + "url": "classes/com-carlgo11-tempfiles-File.html#method_getMaxViews" + }, { + "fqsen": "\\com\\carlgo11\\tempfiles\\File\u003A\u003AsetMaxViews\u0028\u0029", + "name": "setMaxViews", + "summary": "Sets\u0020the\u0020max\u0020views\u0020of\u0020the\u0020file.", + "url": "classes/com-carlgo11-tempfiles-File.html#method_setMaxViews" + }, { + "fqsen": "\\com\\carlgo11\\tempfiles\\File\u003A\u003AgetDeletionPassword\u0028\u0029", + "name": "getDeletionPassword", + "summary": "Gets\u0020the\u0020deletion\u0020password\u0020of\u0020the\u0020file.", + "url": "classes/com-carlgo11-tempfiles-File.html#method_getDeletionPassword" + }, { + "fqsen": "\\com\\carlgo11\\tempfiles\\File\u003A\u003AsetDeletionPassword\u0028\u0029", + "name": "setDeletionPassword", + "summary": "Sets\u0020the\u0020deletion\u0020password\u0020of\u0020the\u0020file.", + "url": "classes/com-carlgo11-tempfiles-File.html#method_setDeletionPassword" + }, { + "fqsen": "\\com\\carlgo11\\tempfiles\\File\u003A\u003AgetMetaData\u0028\u0029", + "name": "getMetaData", + "summary": "Gets\u0020the\u0020metadata\u0020of\u0020the\u0020file\u0020if\u0020supplied.", + "url": "classes/com-carlgo11-tempfiles-File.html#method_getMetaData" + }, { + "fqsen": "\\com\\carlgo11\\tempfiles\\File\u003A\u003AsetMetaData\u0028\u0029", + "name": "setMetaData", + "summary": "Sets\u0020the\u0020metadata\u0020of\u0020the\u0020file.", + "url": "classes/com-carlgo11-tempfiles-File.html#method_setMetaData" + }, { + "fqsen": "\\com\\carlgo11\\tempfiles\\File\u003A\u003AgetIV\u0028\u0029", + "name": "getIV", + "summary": "", + "url": "classes/com-carlgo11-tempfiles-File.html#method_getIV" + }, { + "fqsen": "\\com\\carlgo11\\tempfiles\\File\u003A\u003AsetIV\u0028\u0029", + "name": "setIV", + "summary": "", + "url": "classes/com-carlgo11-tempfiles-File.html#method_setIV" + }, { + "fqsen": "\\com\\carlgo11\\tempfiles\\File\u003A\u003AsetDateTime\u0028\u0029", + "name": "setDateTime", + "summary": "Set\u0020deletion\u0020date\u0020\u0026\u0020time.", + "url": "classes/com-carlgo11-tempfiles-File.html#method_setDateTime" + }, { + "fqsen": "\\com\\carlgo11\\tempfiles\\File\u003A\u003AgetDateTime\u0028\u0029", + "name": "getDateTime", + "summary": "Get\u0020deletion\u0020date\u0020\u0026\u0020time.", + "url": "classes/com-carlgo11-tempfiles-File.html#method_getDateTime" + }, { + "fqsen": "\\com\\carlgo11\\tempfiles\\File\u003A\u003A\u0024_id", + "name": "_id", + "summary": "", + "url": "classes/com-carlgo11-tempfiles-File.html#property__id" + }, { + "fqsen": "\\com\\carlgo11\\tempfiles\\File\u003A\u003A\u0024_content", + "name": "_content", + "summary": "", + "url": "classes/com-carlgo11-tempfiles-File.html#property__content" + }, { + "fqsen": "\\com\\carlgo11\\tempfiles\\File\u003A\u003A\u0024_currentViews", + "name": "_currentViews", + "summary": "", + "url": "classes/com-carlgo11-tempfiles-File.html#property__currentViews" + }, { + "fqsen": "\\com\\carlgo11\\tempfiles\\File\u003A\u003A\u0024_maxViews", + "name": "_maxViews", + "summary": "", + "url": "classes/com-carlgo11-tempfiles-File.html#property__maxViews" + }, { + "fqsen": "\\com\\carlgo11\\tempfiles\\File\u003A\u003A\u0024_deletionPassword", + "name": "_deletionPassword", + "summary": "", + "url": "classes/com-carlgo11-tempfiles-File.html#property__deletionPassword" + }, { + "fqsen": "\\com\\carlgo11\\tempfiles\\File\u003A\u003A\u0024_metaData", + "name": "_metaData", + "summary": "", + "url": "classes/com-carlgo11-tempfiles-File.html#property__metaData" + }, { + "fqsen": "\\com\\carlgo11\\tempfiles\\File\u003A\u003A\u0024_iv", + "name": "_iv", + "summary": "", + "url": "classes/com-carlgo11-tempfiles-File.html#property__iv" + }, { + "fqsen": "\\com\\carlgo11\\tempfiles\\File\u003A\u003A\u0024_time", + "name": "_time", + "summary": "", + "url": "classes/com-carlgo11-tempfiles-File.html#property__time" + }, { + "fqsen": "\\com\\carlgo11\\tempfiles\\Misc", + "name": "Misc", + "summary": "Miscellaneous\u0020functions", + "url": "classes/com-carlgo11-tempfiles-Misc.html" + }, { + "fqsen": "\\com\\carlgo11\\tempfiles\\Misc\u003A\u003AgetVar\u0028\u0029", + "name": "getVar", + "summary": "Get\u0020a\u0020parameter\u0020from\u0020either\u0020\u0024_GET\u0020or\u0020\u0024_POST.", + "url": "classes/com-carlgo11-tempfiles-Misc.html#method_getVar" + }, { + "fqsen": "\\com\\carlgo11\\tempfiles\\Misc\u003A\u003AgeneratePassword\u0028\u0029", + "name": "generatePassword", + "summary": "Generate\u0020a\u0020password\u0020to\u0020use\u0020for\u0020encryption.", + "url": "classes/com-carlgo11-tempfiles-Misc.html#method_generatePassword" + }, { + "fqsen": "\\", + "name": "\\", + "summary": "", + "url": "namespaces/default.html" + }, { + "fqsen": "\\com\\carlgo11\\tempfiles\\api", + "name": "api", + "summary": "", + "url": "namespaces/com-carlgo11-tempfiles-api.html" + }, { + "fqsen": "\\com\\carlgo11\\tempfiles\\datastorage", + "name": "datastorage", + "summary": "", + "url": "namespaces/com-carlgo11-tempfiles-datastorage.html" + }, { + "fqsen": "\\com\\carlgo11\\tempfiles", + "name": "tempfiles", + "summary": "", + "url": "namespaces/com-carlgo11-tempfiles.html" + }, { + "fqsen": "\\com\\carlgo11", + "name": "carlgo11", + "summary": "", + "url": "namespaces/com-carlgo11.html" + }, { + "fqsen": "\\com", + "name": "com", + "summary": "", + "url": "namespaces/com.html" + }, { + "fqsen": "\\com\\carlgo11\\tempfiles\\exception", + "name": "exception", + "summary": "", + "url": "namespaces/com-carlgo11-tempfiles-exception.html" + } ] +); diff --git a/namespaces/com-carlgo11-tempfiles-api.html b/namespaces/com-carlgo11-tempfiles-api.html new file mode 100644 index 0000000..b3ee702 --- /dev/null +++ b/namespaces/com-carlgo11-tempfiles-api.html @@ -0,0 +1,256 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + + + +
                                                                    +

                                                                    Documentation

                                                                    + + + + + +
                                                                    + +
                                                                    +
                                                                    + + + + +
                                                                    + + +
                                                                    +

                                                                    api

                                                                    + + + +

                                                                    + Interfaces, Classes, Traits and Enums + +

                                                                    + +
                                                                    + +
                                                                    API
                                                                    +
                                                                    +
                                                                    Cleanup
                                                                    +
                                                                    +
                                                                    Delete
                                                                    +
                                                                    +
                                                                    Download
                                                                    +
                                                                    +
                                                                    Upload
                                                                    +
                                                                    + + +
                                                                    + + + + + + +
                                                                    +
                                                                    +
                                                                    +
                                                                    +
                                                                    
                                                                    +        
                                                                    + +
                                                                    +
                                                                    + + + +
                                                                    +
                                                                    +
                                                                    +
                                                                    +

                                                                    Search results

                                                                    + +
                                                                    +
                                                                    +
                                                                      +
                                                                      +
                                                                      +
                                                                      +
                                                                      +
                                                                      + + +
                                                                      + + + + + + + + diff --git a/namespaces/com-carlgo11-tempfiles-datastorage.html b/namespaces/com-carlgo11-tempfiles-datastorage.html new file mode 100644 index 0000000..1ffd7be --- /dev/null +++ b/namespaces/com-carlgo11-tempfiles-datastorage.html @@ -0,0 +1,254 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + + + +
                                                                      +

                                                                      Documentation

                                                                      + + + + + +
                                                                      + +
                                                                      +
                                                                      + + + + +
                                                                      + + +
                                                                      +

                                                                      datastorage

                                                                      + + + +

                                                                      + Interfaces, Classes, Traits and Enums + +

                                                                      + +
                                                                      +
                                                                      DataInterface
                                                                      +
                                                                      + +
                                                                      DataStorage
                                                                      +
                                                                      High level data storage handler.
                                                                      +
                                                                      FileStorage
                                                                      +
                                                                      Local file storage class
                                                                      +
                                                                      MySQLStorage
                                                                      +
                                                                      + + +
                                                                      + + + + + + +
                                                                      +
                                                                      +
                                                                      +
                                                                      +
                                                                      
                                                                      +        
                                                                      + +
                                                                      +
                                                                      + + + +
                                                                      +
                                                                      +
                                                                      +
                                                                      +

                                                                      Search results

                                                                      + +
                                                                      +
                                                                      +
                                                                        +
                                                                        +
                                                                        +
                                                                        +
                                                                        +
                                                                        + + +
                                                                        + + + + + + + + diff --git a/namespaces/com-carlgo11-tempfiles-exception.html b/namespaces/com-carlgo11-tempfiles-exception.html new file mode 100644 index 0000000..c54dfbc --- /dev/null +++ b/namespaces/com-carlgo11-tempfiles-exception.html @@ -0,0 +1,250 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + + + +
                                                                        +

                                                                        Documentation

                                                                        + + + + + +
                                                                        + +
                                                                        +
                                                                        + + + + +
                                                                        + + +
                                                                        +

                                                                        exception

                                                                        + + + +

                                                                        + Interfaces, Classes, Traits and Enums + +

                                                                        + +
                                                                        + +
                                                                        BadMethod
                                                                        +
                                                                        +
                                                                        MissingEntry
                                                                        +
                                                                        + + +
                                                                        + + + + + + +
                                                                        +
                                                                        +
                                                                        +
                                                                        +
                                                                        
                                                                        +        
                                                                        + +
                                                                        +
                                                                        + + + +
                                                                        +
                                                                        +
                                                                        +
                                                                        +

                                                                        Search results

                                                                        + +
                                                                        +
                                                                        +
                                                                          +
                                                                          +
                                                                          +
                                                                          +
                                                                          +
                                                                          + + +
                                                                          + + + + + + + + diff --git a/namespaces/com-carlgo11-tempfiles.html b/namespaces/com-carlgo11-tempfiles.html new file mode 100644 index 0000000..e91db04 --- /dev/null +++ b/namespaces/com-carlgo11-tempfiles.html @@ -0,0 +1,262 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + + + +
                                                                          +

                                                                          Documentation

                                                                          + + + + + +
                                                                          + +
                                                                          +
                                                                          + + + + +
                                                                          + + +
                                                                          +

                                                                          tempfiles

                                                                          + + +

                                                                          + Namespaces + +

                                                                          + +
                                                                          +
                                                                          api
                                                                          +
                                                                          datastorage
                                                                          +
                                                                          exception
                                                                          +
                                                                          + +

                                                                          + Interfaces, Classes, Traits and Enums + +

                                                                          + +
                                                                          + +
                                                                          Encryption
                                                                          +
                                                                          Encryption handling.
                                                                          +
                                                                          File
                                                                          +
                                                                          File class +Stores all file-related data during a file-upload/-download operation.
                                                                          +
                                                                          Misc
                                                                          +
                                                                          Miscellaneous functions
                                                                          + + +
                                                                          + + + + + + +
                                                                          +
                                                                          +
                                                                          +
                                                                          +
                                                                          
                                                                          +        
                                                                          + +
                                                                          +
                                                                          + + + +
                                                                          +
                                                                          +
                                                                          +
                                                                          +

                                                                          Search results

                                                                          + +
                                                                          +
                                                                          +
                                                                            +
                                                                            +
                                                                            +
                                                                            +
                                                                            +
                                                                            + + +
                                                                            + + + + + + + + diff --git a/namespaces/com-carlgo11.html b/namespaces/com-carlgo11.html new file mode 100644 index 0000000..65d8d26 --- /dev/null +++ b/namespaces/com-carlgo11.html @@ -0,0 +1,242 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + + + +
                                                                            +

                                                                            Documentation

                                                                            + + + + + +
                                                                            + +
                                                                            +
                                                                            + + + + +
                                                                            + + +
                                                                            +

                                                                            carlgo11

                                                                            + + +

                                                                            + Namespaces + +

                                                                            + +
                                                                            +
                                                                            tempfiles
                                                                            +
                                                                            + + + + + + + +
                                                                            +
                                                                            +
                                                                            +
                                                                            +
                                                                            
                                                                            +        
                                                                            + +
                                                                            +
                                                                            + + + +
                                                                            +
                                                                            +
                                                                            +
                                                                            +

                                                                            Search results

                                                                            + +
                                                                            +
                                                                            +
                                                                              +
                                                                              +
                                                                              +
                                                                              +
                                                                              +
                                                                              + + +
                                                                              + + + + + + + + diff --git a/namespaces/com.html b/namespaces/com.html new file mode 100644 index 0000000..dec9cf2 --- /dev/null +++ b/namespaces/com.html @@ -0,0 +1,241 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + + + +
                                                                              +

                                                                              Documentation

                                                                              + + + + + +
                                                                              + +
                                                                              +
                                                                              + + + + +
                                                                              +
                                                                                +
                                                                              + +
                                                                              +

                                                                              com

                                                                              + + +

                                                                              + Namespaces + +

                                                                              + +
                                                                              +
                                                                              carlgo11
                                                                              +
                                                                              + + + + + + + +
                                                                              +
                                                                              +
                                                                              +
                                                                              +
                                                                              
                                                                              +        
                                                                              + +
                                                                              +
                                                                              + + + +
                                                                              +
                                                                              +
                                                                              +
                                                                              +

                                                                              Search results

                                                                              + +
                                                                              +
                                                                              +
                                                                                +
                                                                                +
                                                                                +
                                                                                +
                                                                                +
                                                                                + + +
                                                                                + + + + + + + + diff --git a/namespaces/default.html b/namespaces/default.html new file mode 100644 index 0000000..12e6df1 --- /dev/null +++ b/namespaces/default.html @@ -0,0 +1,423 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + + + +
                                                                                +

                                                                                Documentation

                                                                                + + + + + +
                                                                                + +
                                                                                +
                                                                                + + + + +
                                                                                +
                                                                                  +
                                                                                + +
                                                                                +

                                                                                API Documentation

                                                                                + + +

                                                                                + Namespaces + +

                                                                                + +
                                                                                +
                                                                                com
                                                                                +
                                                                                + + + +

                                                                                + Table of Contents + +

                                                                                + +
                                                                                +
                                                                                + checkFile() + +  : object|null +
                                                                                +
                                                                                Checks if a file exists.
                                                                                + +
                                                                                + createDirectory() + +  : mixed +
                                                                                +
                                                                                + +
                                                                                + checkVars() + +  : mixed +
                                                                                +
                                                                                + +
                                                                                + + + +
                                                                                +

                                                                                + Functions + +

                                                                                +
                                                                                +

                                                                                + checkFile() + +

                                                                                + + +

                                                                                Checks if a file exists.

                                                                                + + + + checkFile(string $file) : object|null + +

                                                                                If it doesn't, the connection dies.

                                                                                +
                                                                                + +
                                                                                Parameters
                                                                                +
                                                                                +
                                                                                + $file + : string +
                                                                                +
                                                                                +

                                                                                Full path of the file.

                                                                                +
                                                                                + +
                                                                                +
                                                                                + + +
                                                                                + Tags + +
                                                                                +
                                                                                +
                                                                                + since +
                                                                                +
                                                                                + 2.2 + + +
                                                                                +
                                                                                + +
                                                                                Return values
                                                                                + object|null + — +

                                                                                Returns the file if found.

                                                                                +
                                                                                + + +
                                                                                +
                                                                                +

                                                                                + createDirectory() + +

                                                                                + + + + + + createDirectory(mixed $dir) : mixed + +
                                                                                + +
                                                                                Parameters
                                                                                +
                                                                                +
                                                                                + $dir + : mixed +
                                                                                +
                                                                                +
                                                                                + +
                                                                                +
                                                                                + + +
                                                                                + Tags + +
                                                                                +
                                                                                +
                                                                                + +
                                                                                Return values
                                                                                + mixed + — + + +
                                                                                +
                                                                                +

                                                                                + checkVars() + +

                                                                                + + + + + + checkVars(string $name) : mixed + +
                                                                                + +
                                                                                Parameters
                                                                                +
                                                                                +
                                                                                + $name + : string +
                                                                                +
                                                                                +
                                                                                + +
                                                                                +
                                                                                + + +
                                                                                + Tags + +
                                                                                +
                                                                                +
                                                                                + +
                                                                                Return values
                                                                                + mixed + — + + +
                                                                                +
                                                                                + +
                                                                                +
                                                                                +
                                                                                +
                                                                                +
                                                                                
                                                                                +        
                                                                                + +
                                                                                +
                                                                                + + + +
                                                                                +
                                                                                +
                                                                                +
                                                                                +

                                                                                Search results

                                                                                + +
                                                                                +
                                                                                +
                                                                                  +
                                                                                  +
                                                                                  +
                                                                                  +
                                                                                  +
                                                                                  + + +
                                                                                  + + + + + + + + diff --git a/packages/Application.html b/packages/Application.html new file mode 100644 index 0000000..a58b19c --- /dev/null +++ b/packages/Application.html @@ -0,0 +1,445 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + + + +
                                                                                  +

                                                                                  Documentation

                                                                                  + + + + + +
                                                                                  + +
                                                                                  +
                                                                                  + + + + +
                                                                                  +
                                                                                    +
                                                                                  + +
                                                                                  +

                                                                                  Application

                                                                                  + + + +

                                                                                  + Interfaces, Classes, Traits and Enums + +

                                                                                  + +
                                                                                  +
                                                                                  DataInterface
                                                                                  +
                                                                                  + +
                                                                                  API
                                                                                  +
                                                                                  +
                                                                                  Cleanup
                                                                                  +
                                                                                  +
                                                                                  Delete
                                                                                  +
                                                                                  +
                                                                                  Download
                                                                                  +
                                                                                  +
                                                                                  Upload
                                                                                  +
                                                                                  +
                                                                                  MySQLStorage
                                                                                  +
                                                                                  +
                                                                                  Encryption
                                                                                  +
                                                                                  Encryption handling.
                                                                                  +
                                                                                  BadMethod
                                                                                  +
                                                                                  +
                                                                                  MissingEntry
                                                                                  +
                                                                                  + + +
                                                                                  + + +

                                                                                  + Table of Contents + +

                                                                                  + +
                                                                                  +
                                                                                  + checkFile() + +  : object|null +
                                                                                  +
                                                                                  Checks if a file exists.
                                                                                  + +
                                                                                  + createDirectory() + +  : mixed +
                                                                                  +
                                                                                  + +
                                                                                  + checkVars() + +  : mixed +
                                                                                  +
                                                                                  + +
                                                                                  + + + +
                                                                                  +

                                                                                  + Functions + +

                                                                                  +
                                                                                  +

                                                                                  + checkFile() + +

                                                                                  + + +

                                                                                  Checks if a file exists.

                                                                                  + + + + checkFile(string $file) : object|null + +

                                                                                  If it doesn't, the connection dies.

                                                                                  +
                                                                                  + +
                                                                                  Parameters
                                                                                  +
                                                                                  +
                                                                                  + $file + : string +
                                                                                  +
                                                                                  +

                                                                                  Full path of the file.

                                                                                  +
                                                                                  + +
                                                                                  +
                                                                                  + + +
                                                                                  + Tags + +
                                                                                  +
                                                                                  +
                                                                                  + since +
                                                                                  +
                                                                                  + 2.2 + + +
                                                                                  +
                                                                                  + +
                                                                                  Return values
                                                                                  + object|null + — +

                                                                                  Returns the file if found.

                                                                                  +
                                                                                  + + +
                                                                                  +
                                                                                  +

                                                                                  + createDirectory() + +

                                                                                  + + + + + + createDirectory(mixed $dir) : mixed + +
                                                                                  + +
                                                                                  Parameters
                                                                                  +
                                                                                  +
                                                                                  + $dir + : mixed +
                                                                                  +
                                                                                  +
                                                                                  + +
                                                                                  +
                                                                                  + + +
                                                                                  + Tags + +
                                                                                  +
                                                                                  +
                                                                                  + +
                                                                                  Return values
                                                                                  + mixed + — + + +
                                                                                  +
                                                                                  +

                                                                                  + checkVars() + +

                                                                                  + + + + + + checkVars(string $name) : mixed + +
                                                                                  + +
                                                                                  Parameters
                                                                                  +
                                                                                  +
                                                                                  + $name + : string +
                                                                                  +
                                                                                  +
                                                                                  + +
                                                                                  +
                                                                                  + + +
                                                                                  + Tags + +
                                                                                  +
                                                                                  +
                                                                                  + +
                                                                                  Return values
                                                                                  + mixed + — + + +
                                                                                  +
                                                                                  + +
                                                                                  +
                                                                                  +
                                                                                  +
                                                                                  +
                                                                                  
                                                                                  +        
                                                                                  + +
                                                                                  +
                                                                                  + + + +
                                                                                  +
                                                                                  +
                                                                                  +
                                                                                  +

                                                                                  Search results

                                                                                  + +
                                                                                  +
                                                                                  +
                                                                                    +
                                                                                    +
                                                                                    +
                                                                                    +
                                                                                    +
                                                                                    + + +
                                                                                    + + + + + + + + diff --git a/packages/com-carlgo11-tempfiles-datastorage.html b/packages/com-carlgo11-tempfiles-datastorage.html new file mode 100644 index 0000000..5e0d7ca --- /dev/null +++ b/packages/com-carlgo11-tempfiles-datastorage.html @@ -0,0 +1,250 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + + + +
                                                                                    +

                                                                                    Documentation

                                                                                    + + + + + +
                                                                                    + +
                                                                                    +
                                                                                    + + + + +
                                                                                    + + +
                                                                                    +

                                                                                    datastorage

                                                                                    + + + +

                                                                                    + Interfaces, Classes, Traits and Enums + +

                                                                                    + +
                                                                                    + +
                                                                                    DataStorage
                                                                                    +
                                                                                    High level data storage handler.
                                                                                    +
                                                                                    FileStorage
                                                                                    +
                                                                                    Local file storage class
                                                                                    + + +
                                                                                    + + + + + + +
                                                                                    +
                                                                                    +
                                                                                    +
                                                                                    +
                                                                                    
                                                                                    +        
                                                                                    + +
                                                                                    +
                                                                                    + + + +
                                                                                    +
                                                                                    +
                                                                                    +
                                                                                    +

                                                                                    Search results

                                                                                    + +
                                                                                    +
                                                                                    +
                                                                                      +
                                                                                      +
                                                                                      +
                                                                                      +
                                                                                      +
                                                                                      + + +
                                                                                      + + + + + + + + diff --git a/packages/com-carlgo11-tempfiles.html b/packages/com-carlgo11-tempfiles.html new file mode 100644 index 0000000..c5192ab --- /dev/null +++ b/packages/com-carlgo11-tempfiles.html @@ -0,0 +1,258 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + + + +
                                                                                      +

                                                                                      Documentation

                                                                                      + + + + + +
                                                                                      + +
                                                                                      +
                                                                                      + + + + +
                                                                                      + + +
                                                                                      +

                                                                                      tempfiles

                                                                                      + +

                                                                                      + Packages + +

                                                                                      + +
                                                                                      +
                                                                                      datastorage
                                                                                      +
                                                                                      + + +

                                                                                      + Interfaces, Classes, Traits and Enums + +

                                                                                      + +
                                                                                      + +
                                                                                      File
                                                                                      +
                                                                                      File class +Stores all file-related data during a file-upload/-download operation.
                                                                                      +
                                                                                      Misc
                                                                                      +
                                                                                      Miscellaneous functions
                                                                                      + + +
                                                                                      + + + + + + +
                                                                                      +
                                                                                      +
                                                                                      +
                                                                                      +
                                                                                      
                                                                                      +        
                                                                                      + +
                                                                                      +
                                                                                      + + + +
                                                                                      +
                                                                                      +
                                                                                      +
                                                                                      +

                                                                                      Search results

                                                                                      + +
                                                                                      +
                                                                                      +
                                                                                        +
                                                                                        +
                                                                                        +
                                                                                        +
                                                                                        +
                                                                                        + + +
                                                                                        + + + + + + + + diff --git a/packages/com-carlgo11.html b/packages/com-carlgo11.html new file mode 100644 index 0000000..b8f1d55 --- /dev/null +++ b/packages/com-carlgo11.html @@ -0,0 +1,242 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + + + +
                                                                                        +

                                                                                        Documentation

                                                                                        + + + + + +
                                                                                        + +
                                                                                        +
                                                                                        + + + + +
                                                                                        + + +
                                                                                        +

                                                                                        carlgo11

                                                                                        + +

                                                                                        + Packages + +

                                                                                        + +
                                                                                        +
                                                                                        tempfiles
                                                                                        +
                                                                                        + + + + + + + + +
                                                                                        +
                                                                                        +
                                                                                        +
                                                                                        +
                                                                                        
                                                                                        +        
                                                                                        + +
                                                                                        +
                                                                                        + + + +
                                                                                        +
                                                                                        +
                                                                                        +
                                                                                        +

                                                                                        Search results

                                                                                        + +
                                                                                        +
                                                                                        +
                                                                                          +
                                                                                          +
                                                                                          +
                                                                                          +
                                                                                          +
                                                                                          + + +
                                                                                          + + + + + + + + diff --git a/packages/com.html b/packages/com.html new file mode 100644 index 0000000..c4f4769 --- /dev/null +++ b/packages/com.html @@ -0,0 +1,241 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + + + +
                                                                                          +

                                                                                          Documentation

                                                                                          + + + + + +
                                                                                          + +
                                                                                          +
                                                                                          + + + + +
                                                                                          +
                                                                                            +
                                                                                          + +
                                                                                          +

                                                                                          com

                                                                                          + +

                                                                                          + Packages + +

                                                                                          + +
                                                                                          +
                                                                                          carlgo11
                                                                                          +
                                                                                          + + + + + + + + +
                                                                                          +
                                                                                          +
                                                                                          +
                                                                                          +
                                                                                          
                                                                                          +        
                                                                                          + +
                                                                                          +
                                                                                          + + + +
                                                                                          +
                                                                                          +
                                                                                          +
                                                                                          +

                                                                                          Search results

                                                                                          + +
                                                                                          +
                                                                                          +
                                                                                            +
                                                                                            +
                                                                                            +
                                                                                            +
                                                                                            +
                                                                                            + + +
                                                                                            + + + + + + + + diff --git a/packages/default.html b/packages/default.html new file mode 100644 index 0000000..ba508b0 --- /dev/null +++ b/packages/default.html @@ -0,0 +1,242 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + + + +
                                                                                            +

                                                                                            Documentation

                                                                                            + + + + + +
                                                                                            + +
                                                                                            +
                                                                                            + + + + +
                                                                                            +
                                                                                              +
                                                                                            + +
                                                                                            +

                                                                                            API Documentation

                                                                                            + +

                                                                                            + Packages + +

                                                                                            + +
                                                                                            +
                                                                                            Application
                                                                                            +
                                                                                            com
                                                                                            +
                                                                                            + + + + + + + + +
                                                                                            +
                                                                                            +
                                                                                            +
                                                                                            +
                                                                                            
                                                                                            +        
                                                                                            + +
                                                                                            +
                                                                                            + + + +
                                                                                            +
                                                                                            +
                                                                                            +
                                                                                            +

                                                                                            Search results

                                                                                            + +
                                                                                            +
                                                                                            +
                                                                                              +
                                                                                              +
                                                                                              +
                                                                                              +
                                                                                              +
                                                                                              + + +
                                                                                              + + + + + + + + diff --git a/reports/deprecated.html b/reports/deprecated.html new file mode 100644 index 0000000..ad7756a --- /dev/null +++ b/reports/deprecated.html @@ -0,0 +1,157 @@ + + + + + Documentation » Deprecated elements + + + + + + + + + + + + + + + + + + + + + +
                                                                                              +

                                                                                              Documentation

                                                                                              + + + + + +
                                                                                              + +
                                                                                              +
                                                                                              + + + + +
                                                                                              + + +
                                                                                              +

                                                                                              Deprecated

                                                                                              + +

                                                                                              Table of Contents

                                                                                              + + + + +
                                                                                              src/com/carlgo11/tempfiles/datastorage/MySQLStorage.php
                                                                                              + + +

                                                                                              MySQLStorage.php

                                                                                              + + + + + + + + + + + +
                                                                                              LineElementReason
                                                                                              127MySQLStorage::listEntries()

                                                                                              Not used by DataStorage. Will be removed in the future.

                                                                                              +
                                                                                              +
                                                                                              +
                                                                                              +
                                                                                              +
                                                                                              +

                                                                                              Search results

                                                                                              + +
                                                                                              +
                                                                                              +
                                                                                                +
                                                                                                +
                                                                                                +
                                                                                                +
                                                                                                +
                                                                                                + + +
                                                                                                + + + + + + + + diff --git a/reports/errors.html b/reports/errors.html new file mode 100644 index 0000000..9e14805 --- /dev/null +++ b/reports/errors.html @@ -0,0 +1,138 @@ + + + + + Documentation » Compilation errors + + + + + + + + + + + + + + + + + + + + + +
                                                                                                +

                                                                                                Documentation

                                                                                                + + + + + +
                                                                                                + +
                                                                                                +
                                                                                                + + + + +
                                                                                                + + +
                                                                                                +

                                                                                                Errors

                                                                                                + + +
                                                                                                No errors have been found in this project.
                                                                                                + +
                                                                                                +
                                                                                                +
                                                                                                +
                                                                                                +

                                                                                                Search results

                                                                                                + +
                                                                                                +
                                                                                                +
                                                                                                  +
                                                                                                  +
                                                                                                  +
                                                                                                  +
                                                                                                  +
                                                                                                  + + +
                                                                                                  + + + + + + + + diff --git a/reports/markers.html b/reports/markers.html new file mode 100644 index 0000000..a92c2a8 --- /dev/null +++ b/reports/markers.html @@ -0,0 +1,191 @@ + + + + + Documentation » Markers + + + + + + + + + + + + + + + + + + + + + +
                                                                                                  +

                                                                                                  Documentation

                                                                                                  + + + + + +
                                                                                                  + +
                                                                                                  +
                                                                                                  + + + + +
                                                                                                  + + +
                                                                                                  +

                                                                                                  Markers

                                                                                                  + +

                                                                                                  Table of Contents

                                                                                                  + + + + + +
                                                                                                  src/com/carlgo11/tempfiles/datastorage/MySQLStorage.php7
                                                                                                  + + +

                                                                                                  MySQLStorage.php

                                                                                                  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                  TypeLineDescription
                                                                                                  TODO31Implement getEntryContent() method.
                                                                                                  TODO41Implement getEntryMetaData() method.
                                                                                                  TODO96Implement entryExists() method.
                                                                                                  TODO107Implement deleteEntry() method.
                                                                                                  TODO118Implement getEntryExpiry() method.
                                                                                                  TODO128Implement listEntries() method.
                                                                                                  TODO132Implement getDelPassword() method.
                                                                                                  +
                                                                                                  +
                                                                                                  +
                                                                                                  +
                                                                                                  +

                                                                                                  Search results

                                                                                                  + +
                                                                                                  +
                                                                                                  +
                                                                                                    +
                                                                                                    +
                                                                                                    +
                                                                                                    +
                                                                                                    +
                                                                                                    + + +
                                                                                                    + + + + + + + +