sitegeist / fusionlinkprototypes
Missing Prototypes for easier linking to actions and modules
Installs: 14 152
Dependents: 3
Suggesters: 0
Security: 0
Stars: 2
Watchers: 3
Forks: 0
Open Issues: 0
Type:neos-package
Requires
- neos/fusion: ~7.0||~8.0||dev-master
Requires (Dev)
- phpstan/phpstan: ^0.12.78
This package is auto-updated.
Last update: 2024-10-24 18:07:51 UTC
README
Missing Prototypes for easier linking to actions and modules.
By default the linking between backend modules or from backend modules has been cumbersome. Since modules use a subrequest the Neos UriBuilder created all links inside the module.
This package adds the prototypes Sitegeist.FusionLinkPrototypes:ActionUri
, Sitegeist.FusionLinkPrototypes:ActionLink
and Sitegeist.FusionLinkPrototypes:ModuleUri
, Sitegeist.FusionLinkPrototypes:ModuleLink
that always use the current
main request to avoid this confusion.
!!! Those prototypes likely will end up in Neos eventually. The package here provides a replacement for older versions of Neos plus allows to play with the api and behavior before creating a core-pr !!!
Authors & Sponsors
- Martin Ficzel - ficzel@sitegeist.de
The development and the public-releases of this package is generously sponsored by our employer http://www.sitegeist.de.
Installation
Sitegeist.FusionLinkPrototypes is available via packagist run composer require sitegeist/fusionlinkprototypes
.
We use semantic versioning so every breaking change will increase the major-version number.
Usage
Sitegeist.FusionLinkPrototypes:ActionUri
Built a URI to a controller action
package
(string) The package key (e.g.My.Package
)subpackage
(string) The subpackage, empty by defaultcontroller
(string) The controller name (e.g.Registration
)action
(string) The action name (e.g.new
)arguments
(array) Arguments to the action by named keyformat
(string) An optional request format (e.g.html
)section
(string) An optional fragment (hash) for the URIadditionalParams
(array) Additional URI query parameters by named keyaddQueryString
(boolean) Whether to keep the query parameters of the current URIargumentsToBeExcludedFromQueryString
(array) Query parameters to exclude foraddQueryString
absolute
(boolean) Whether to create an absolute URI
Example::
uri = Sitegeist.FusionLinkPrototypes:ActionUri {
package = 'My.Package'
controller = 'Registration'
action = 'new'
}
Sitegeist.FusionLinkPrototypes:ActionLink
Extends Neos.Fusion:Tag
and adds an attributes.href
defined as Sitegeist.FusionLinkPrototypes:ActionUri
Tag properties:
tagName
(string) Tag name of the HTML element, defaults toa
content
(string) The inner content of the element, will only be rendered if the tag is not self-closing and the closing tag is not omittedattributes
(iterable) Tag attributes as key-value pairs. Default isNeos.Fusion:DataStructure
. If a non iterable is returned the value is casted to string.attributes.href
defined asSitegeist.FusionLinkPrototypes:ActionLink
- ... for more see the documentation of
Neos.Fusion:Tag
ActionUri properties:
package
(string) The package key (e.g.My.Package
)subpackage
(string) The subpackage, empty by defaultcontroller
(string) The controller name (e.g.Registration
)action
(string) The action name (e.g.new
)arguments
(array) Arguments to the action by named keyformat
(string) An optional request format (e.g.html
)section
(string) An optional fragment (hash) for the URIadditionalParams
(array) Additional URI query parameters by named keyaddQueryString
(boolean) Whether to keep the query parameters of the current URIargumentsToBeExcludedFromQueryString
(array) Query parameters to exclude foraddQueryString
absolute
(boolean) Whether to create an absolute URI
Example::
link = Sitegeist.FusionLinkPrototypes:ActionLink {
content = "Register new user"
package = 'My.Package'
controller = 'Registration'
action = 'new'
}
Sitegeist.FusionLinkPrototypes:ModuleUri
Built a URI to a backend module. This allows to link between backend modules !!! For links to the Neos content module read the dedicated section !!!
module
(string) The module path (e.g.content
ormanagement/sites
)controller
(string) The controller name (e.g.Registration
)action
(string) The action name (e.g.new
)arguments
(array) Arguments to the action by named keyformat
(string) An optional request format (e.g.html
)section
(string) An optional fragment (hash) for the URIadditionalParams
(array) Additional URI query parameters by named keyaddQueryString
(boolean) Whether to keep the query parameters of the current URIargumentsToBeExcludedFromQueryString
(array) Query parameters to exclude foraddQueryString
absolute
(boolean) Whether to create an absolute URI
Example::
uri = Sitegeist.FusionLinkPrototypes:ModuleUri {
module="administration/sites"
action="edit"
arguments.site = ${site}
}
Sitegeist.FusionLinkPrototypes:ModuleLink
Extends Neos.Fusion:Tag
and adds an attributes.href
defined as Sitegeist.FusionLinkPrototypes:ModuleUri
!!! For links to the Neos content module read the dedicated section !!!
Tag properties:
tagName
(string) Tag name of the HTML element, defaults toa
content
(string) The inner content of the element, will only be rendered if the tag is not self-closing and the closing tag is not omittedattributes
(iterable) Tag attributes as key-value pairs. Default isNeos.Fusion:DataStructure
. If a non iterable is returned the value is casted to string.attributes.href
defined asSitegeist.FusionLinkPrototypes:ActionLink
- ... for more see the documentation of
Neos.Fusion:Tag
ModuleUri properties:
module
(string) The module path (e.g.content
ormanagement/sites
)controller
(string) The controller name (e.g.Registration
)action
(string) The action name (e.g.new
)arguments
(array) Arguments to the action by named keyformat
(string) An optional request format (e.g.html
)section
(string) An optional fragment (hash) for the URIadditionalParams
(array) Additional URI query parameters by named keyaddQueryString
(boolean) Whether to keep the query parameters of the current URIargumentsToBeExcludedFromQueryString
(array) Query parameters to exclude foraddQueryString
absolute
(boolean) Whether to create an absolute URI
Example::
link = Sitegeist.FusionLinkPrototypes:ModuleLink {
content = "To the site module"
module="administration/sites"
action="edit"
arguments.site = ${site}
}
Linking to the Neos content-module
As the Neos content-module is not based on other backend modules it is linked via Sitegeist.FusionLinkPrototypes:ActionLink
.
Example::
contentModuleLink = Sitegeist.FusionLinkPrototypes:ActionLink {
content = "To the content module"
package="Neos.Neos.Ui"
controller="Backend"
action="index"
arguments.node = ${node}
}
contentModuleUri = Sitegeist.FusionLinkPrototypes:ActionUri {
module="administration/sites"
action="edit"
arguments.node = ${node}
}
Contribution
We will gladly accept contributions. Please send us pull requests.