folded-php / view Goto Github PK

Description

The package folded/exception as released version 0.3.

Expected behavior

This package uses folded/exception 0.3.

Actual behavior

This package uses folded/exception 0.1.

Alternatives solutions

None.

Notes

Description

To send emails, I would like to use Blade. Currently, displayView will not return the HTML content.

Proposal

A new function to get the rendered, HTML content from a given view.

use function Folded\getRenderedView;

$html = getRenderedView("emails.account-created");

Worarkound solutions

None.

Notes

None.

Description

I am always passing the company name in each of the views that extends a base layout that displays this company name in the header.

I would prefer describing that this layout always need this company name, in order to free my other views from constantly adding this value.

Expected results

To be able to pass data to a certain layout or view.

use function Folded\addDataToView;
use function Folded\getConfig; // composer require folded/config

addDataToView("layouts.base", [
  "companyName" => getConfig("company.name"),
]);

Current behavior

I have to pass the company name in all of the views that extends my base layout.

Current alternatives

Passing data in all of the views that extends my base layout.

Notes

The solution seen in Laracasts forum using classic Laravel View facade.

Description

This package use an old version of folded/exception.

Proposal

Upgrade to folded/exception:0.4.*

Worarkound solutions

Notes

Description

When the code loads functions, it should detect the existance of the function under the namespace instead of just the name of the function

Expected behavior

The call of function_exists() use the full qualified namespace.

namespace Folded;

if (!function_exists("Folded\theFunction")) {
  // load the function now
}

Actual behavior

Functions declared twice enters in collision.

Alternatives solutions

None.

Description

There is no templates for bugs and enhancements, which can reduce the chances someone will want to describe his issue or can make difficult to format and clarify an issue without proper templates.

Expected behavior

Enhancements issue template

For an enhancements, the following sections (using level 2 title, ##) should be shown:

• Description
• Proposal
• Workaround solutions
• Notes

The text hints, using italic, should be shown below each of these titles (without the double quotes):

• Description: "Give some context and motivation for the proposed solution."
• Proposal: "The detail proposition. Can include code."
• Worarkound solutions: "Mention every existing workaround you know that will solve the issue apart from the proposed solution."
• Notes: "Add everything that relates the proposal, like future induced issues, related issues, ..."

Bug issue template

For a bug, the following sections (using level 2 title, ##) should be shown:

• Description
• Steps to reproduce the issue
• Expected behavior
• Workaround solutions
• Notes

The text hints, using italic, should be show below each of these titles (without the double quotes):

• Description: "Any information that can give more understanding about how you came to this issue."
• Steps to reproduce the issue: "Detail precisely how we can reproduce the issue from a blank new project (if possible)."
• Expected behavior: "Describe what the output or the behavior should be instead of the issue you have."
• Workaround solutions: "Mention every existing workaround you know that will solve the issue."
• Notes: "Add everything that relates the proposal, like related issues, ..."

Alternatives solutions

To write by hand the issue layout.

Description

Currently we duplicate the route URL both in the addGetRoute() method and in the view. A system associating a route with its name to be able to get the URL by the route name instead.

Expected behavior

To be able to register an optional name for the route:

use function Folded\addGetRoute;

addGetRoute("/", function() {}, "home.index");

To be able to get an URL by the route name:

use function getRouteUrl;
echo getRouteUrl("home.index"); // string (1) "/"

Actual behavior

No method to get an URL from the route name.

Alternatives solutions

Duplicating the URLs in the routes registration file and the view.

Notes

Description

Static analysis helps catching bugs earlier.

Proposal

• Using phpstan/phpstan and run the command after the test command: pest --coverage && phpstan analyse src
• Use the level 8 for a maximum of consistency
• Use a phpstan.neon configuration file

Worarkound solutions

None.

Notes

None.

Description

The view class is not meant to be extended. Mark it as final.

Proposal

The View class is marked as final.

Worarkound solutions

None.

Notes

None.