Manual
Manual copied to clipboard
Added (Helper) Classes section
User description
and added (copied) the content from the old manual about JDate. 99% has been taken from the old page (https://docs.joomla.org/How_to_use_JDate).
PR Type
Documentation
Description
-
Added new documentation section for Joomla's Date class
-
Included comprehensive guide on Date class usage and methods
-
Created index page for helper classes documentation
-
Documented date formatting and timezone handling
Diagram Walkthrough
flowchart LR
A["Documentation"] --> B["Date Class Guide"]
A --> C["Classes Index"]
B --> D["Date Creation"]
B --> E["Date Formatting"]
B --> F["Date Operations"]
B --> G["Date Conversions"]
File Walkthrough
| Relevant files | |||||
|---|---|---|---|---|---|
| Documentation |
|
PR Compliance Guide 🔍
Below is a summary of compliance checks for this PR:
| Security Compliance | |
| 🟢 | No security concerns identifiedNo security vulnerabilities detected by AI analysis. Human verification advised for critical code. |
| Ticket Compliance | |
| ⚪ | 🎫 No ticket provided
|
| Codebase Duplication Compliance | |
| ⚪ | Codebase context is not definedFollow the guide to enable codebase context checks. |
| Custom Compliance | |
| 🟢 |
Generic: Comprehensive Audit TrailsObjective: To create a detailed and reliable record of critical system actions for security analysis Status: Passed |
Generic: Meaningful Naming and Self-Documenting CodeObjective: Ensure all identifiers clearly express their purpose and intent, making code Status: Passed | |
Generic: Robust Error Handling and Edge Case ManagementObjective: Ensure comprehensive error handling that provides meaningful context and graceful Status: Passed | |
Generic: Secure Error HandlingObjective: To prevent the leakage of sensitive system information through error messages while Status: Passed | |
Generic: Secure Logging PracticesObjective: To ensure logs are useful for debugging and auditing without exposing sensitive Status: Passed | |
Generic: Security-First Input Validation and Data HandlingObjective: Ensure all data inputs are validated, sanitized, and handled securely to prevent Status: Passed | |
| |
Compliance status legend
🟢 - Fully Compliant🟡 - Partial Compliant
🔴 - Not Compliant
⚪ - Requires Further Human Verification
🏷️ - Compliance label
PR Code Suggestions ✨
Explore these optional code suggestions:
| Category | Suggestion | Impact |
| Possible issue |
✅
| Low |
✅
| Low | |
| ||
Hi @marcorensch
thanks for your pr, I would like the opportunity not just copy the old documentation instead make it more use full.
For example the usage of base Date class is pretty good explained on the php manual it self https://www.php.net/manual/de/class.datetime.php
The getInstance is pretty use less and should be removed since it's no difference to new Date() but it's not touched for b/c reasons, I may would mark it as legacy code.
The examples how to use the class misses the most important features
- DAY_ABBR -
\D - DAY_NAME -
\l - MONTH_ABBR -
\M - MONTH_NAME -
\F
The best way to create the date object is only mentioned but not explained, Factory::getDate();
The available dynamic properties need to be listed and explained (found in __get method).
The HtmlHelper explaination starts with a useless sentence and doesn't explain anything,
I would understand if you can't or would not like to do the changes but it would be really great if you can do it.
Hi @marcorensch
thanks for your pr, I would like the opportunity not just copy the old documentation instead make it more use full.
For example the usage of base
Dateclass is pretty good explained on the php manual it self https://www.php.net/manual/de/class.datetime.phpThe getInstance is pretty use less and should be removed since it's no difference to
new Date()but it's not touched for b/c reasons, I may would mark it as legacy code.The examples how to use the class misses the most important features
* DAY_ABBR - `\D` * DAY_NAME - `\l` * MONTH_ABBR - `\M` * MONTH_NAME - `\F`The best way to create the date object is only mentioned but not explained,
Factory::getDate();The available dynamic properties need to be listed and explained (found in __get method).
The HtmlHelper explaination starts with a useless sentence and doesn't explain anything,
I would understand if you can't or would not like to do the changes but it would be really great if you can do it.
I will have a look into it - no big deal
@HLeithner > I think I need to stop now... but I think its covered yet?