From 46496556dd9960c1d4961967e829ce190a98c5f9 Mon Sep 17 00:00:00 2001 From: Jenkins Date: Wed, 22 Nov 2023 15:35:03 +0000 Subject: [PATCH] TASK: Update references [skip ci] --- .../References/CommandReference.rst | 1192 +++++++++-------- .../FlowQueryOperationReference.rst | 366 +++-- .../References/Signals/ContentRepository.rst | 241 +--- .../Documentation/References/Signals/Flow.rst | 48 +- .../References/Signals/Media.rst | 34 +- .../Documentation/References/Signals/Neos.rst | 298 +---- .../References/Validators/Flow.rst | 2 +- .../References/Validators/Media.rst | 2 +- .../References/Validators/Party.rst | 2 +- .../ViewHelpers/ContentRepository.rst | 2 +- .../References/ViewHelpers/FluidAdaptor.rst | 6 +- .../References/ViewHelpers/Form.rst | 2 +- .../References/ViewHelpers/Fusion.rst | 2 +- .../References/ViewHelpers/Media.rst | 2 +- .../References/ViewHelpers/Neos.rst | 20 +- .../References/ViewHelpers/TYPO3Fluid.rst | 36 +- 16 files changed, 932 insertions(+), 1323 deletions(-) diff --git a/Neos.Neos/Documentation/References/CommandReference.rst b/Neos.Neos/Documentation/References/CommandReference.rst index fc0cfe20c15..6aa3ad6153d 100644 --- a/Neos.Neos/Documentation/References/CommandReference.rst +++ b/Neos.Neos/Documentation/References/CommandReference.rst @@ -19,291 +19,218 @@ commands that may be available, use:: ./flow help -The following reference was automatically generated from code on 2017-05-11 +The following reference was automatically generated from code on 2023-11-22 -.. _`Neos Command Reference: NEOS.CONTENTREPOSITORY`: - -Package *NEOS.CONTENTREPOSITORY* --------------------------------- +.. _`Neos Command Reference: NEOS.FLOW`: +Package *NEOS.FLOW* +------------------- -.. _`Neos Command Reference: NEOS.CONTENTREPOSITORY neos.contentrepository:nodetypes:show`: -``neos.contentrepository:nodetypes:show`` -************************************** +.. _`Neos Command Reference: NEOS.FLOW neos.flow:cache:collectgarbage`: -**Show NodeType Configuration** +``neos.flow:cache:collectgarbage`` +********************************** -Shows the merged configuration (including supertypes) of a NodeType +**Cache Garbage Collection** -**Examples:** +Runs the Garbage Collection (collectGarbage) method on all registered caches. -``./flow nodeTypes:show Vendor.Site:Content`` +Though the method is defined in the BackendInterface, the implementation +can differ and might not remove any data, depending on possibilities of +the backend. -``./flow nodeTypes:show Vendor.Site:Content --path="properties.bar"`` Options ^^^^^^^ -``--node-type-name`` - The name of the NodeType to show -``--path`` - Optional path of the NodeType-configuration which will be shown +``--cache-identifier`` + If set, this command only applies to the given cache -.. _`Neos Command Reference: NEOS.CONTENTREPOSITORY neos.contentrepository:nodetypes:list`: -``neos.contentrepository:nodetypes:list`` -************************************** -**List NodeTypes** +.. _`Neos Command Reference: NEOS.FLOW neos.flow:cache:flush`: + +``neos.flow:cache:flush`` +************************* -Lists all declared NodeTypes grouped by namespace +**Flush all caches** -**Examples:** +The flush command flushes all caches (including code caches) which have been +registered with Flow's Cache Manager. It will NOT remove any session data, unless +you specifically configure the session caches to not be persistent. -``./flow nodeTypes:list --filter Vendor.Site:`` +If fatal errors caused by a package prevent the compile time bootstrap +from running, the removal of any temporary data can be forced by specifying +the option **--force**. -``./flow nodeTypes:list --filter Vendor.Site:Document --include-abstract`` +This command does not remove the precompiled data provided by frozen +packages unless the **--force** option is used. Options ^^^^^^^ -``--filter`` - Only NodeType-names containing this string will be listed -``--include-abstract`` - List abstract NodeTypes - - -.. _`Neos Command Reference: NEOS.CONTENTREPOSITORY neos.contentrepository:node:repair`: - -``neos.contentrepository:node:repair`` -************************************** - -**Repair inconsistent nodes** - -This command analyzes and repairs the node tree structure and individual nodes -based on the current node type configuration. - -It is possible to execute only one or more specific checks by providing the **--skip** -or **--only** option. See the full description of checks further below for possible check -identifiers. - -The following checks will be performed: - -*Remove abstract and undefined node types* -removeAbstractAndUndefinedNodes - -Will remove all nodes that has an abstract or undefined node type. - -*Remove orphan (parentless) nodes* -removeOrphanNodes - -Will remove all child nodes that do not have a connection to the root node. - -*Remove disallowed child nodes* -removeDisallowedChildNodes - -Will remove all child nodes that are disallowed according to the node type's auto-create -configuration and constraints. +``--force`` + Force flushing of any temporary data -*Remove undefined node properties* -removeUndefinedProperties -Will remove all undefined properties according to the node type configuration. -*Remove broken object references* -removeBrokenEntityReferences +Related commands +^^^^^^^^^^^^^^^^ -Detects and removes references from nodes to entities which don't exist anymore (for -example Image nodes referencing ImageVariant objects which are gone for some reason). +``neos.flow:cache:warmup`` + Warm up caches +``neos.flow:package:freeze`` + Freeze a package +``neos.flow:package:refreeze`` + Refreeze a package -*Remove nodes with invalid dimensions* -removeNodesWithInvalidDimensions -Will check for and optionally remove nodes which have dimension values not matching -the current content dimension configuration. -*Remove nodes with invalid workspace* -removeNodesWithInvalidWorkspace +.. _`Neos Command Reference: NEOS.FLOW neos.flow:cache:flushone`: -Will check for and optionally remove nodes which belong to a workspace which no longer -exists.. +``neos.flow:cache:flushone`` +**************************** -*Repair inconsistent node identifiers* -fixNodesWithInconsistentIdentifier +**Flushes a particular cache by its identifier** -Will check for and optionally repair node identifiers which are out of sync with their -corresponding nodes in a live workspace. +Given a cache identifier, this flushes just that one cache. To find +the cache identifiers, you can use the configuration:show command with +the type set to "Caches". -*Missing child nodes* -createMissingChildNodes +Note that this does not have a force-flush option since it's not +meant to remove temporary code data, resulting into a broken state if +code files lack. -For all nodes (or only those which match the --node-type filter specified with this -command) which currently don't have child nodes as configured by the node type's -configuration new child nodes will be created. +Arguments +^^^^^^^^^ -*Reorder child nodes* -reorderChildNodes +``--identifier`` + Cache identifier to flush cache for -For all nodes (or only those which match the --node-type filter specified with this -command) which have configured child nodes, those child nodes are reordered according to the -position from the parents NodeType configuration. -*Missing default properties* -addMissingDefaultValues -For all nodes (or only those which match the --node-type filter specified with this -command) which currently don\t have a property that have a default value configuration -the default value for that property will be set. -*Repair nodes with missing shadow nodes* -repairShadowNodes -This will reconstruct missing shadow nodes in case something went wrong in creating -or publishing them. This must be used on a workspace other than live. -It searches for nodes which have a corresponding node in one of the base workspaces, -have different node paths, but don't have a corresponding shadow node with a "movedto" -value. +Related commands +^^^^^^^^^^^^^^^^ -*Generate missing URI path segments* -generateUriPathSegments +``neos.flow:cache:flush`` + Flush all caches +``neos.flow:configuration:show`` + Show the active configuration settings -Generates URI path segment properties for all document nodes which don't have a path -segment set yet. -*Remove content dimensions from / and /sites* -removeContentDimensionsFromRootAndSitesNode -Removes content dimensions from the root and sites nodes +.. _`Neos Command Reference: NEOS.FLOW neos.flow:cache:list`: +``neos.flow:cache:list`` +************************ -**Examples:** +**List all configured caches and their status if available** -``./flow node:repair`` +This command will exit with a code 1 if at least one cache status contains errors or warnings +This allows the command to be easily integrated in CI setups (the --quiet flag can be used to reduce verbosity) -``./flow node:repair --node-type Neos.NodeTypes:Page`` -``./flow node:repair --workspace user-robert --only removeOrphanNodes,removeNodesWithInvalidDimensions`` -``./flow node:repair --skip removeUndefinedProperties`` +Options +^^^^^^^ +``--quiet`` + If set, this command only outputs errors & warnings -Options -^^^^^^^ -``--node-type`` - Node type name, if empty update all declared node types -``--workspace`` - Workspace name, default is 'live' -``--dry-run`` - Don't do anything, but report actions -``--cleanup`` - If FALSE, cleanup tasks are skipped -``--skip`` - Skip the given check or checks (comma separated) -``--only`` - Only execute the given check or checks (comma separated) +Related commands +^^^^^^^^^^^^^^^^ +``neos.flow:cache:show`` + Display details of a cache including a detailed status if available -.. _`Neos Command Reference: NEOS.CONTENTREPOSITORY.MIGRATION`: -Package *NEOS.CONTENTREPOSITORY.MIGRATION* -------------------- -.. _`Neos Command Reference: NEOS.CONTENTREPOSITORYREGISTRY neos.contentrepositoryregistry:nodemigration:migrationcreate`: +.. _`Neos Command Reference: NEOS.FLOW neos.flow:cache:setup`: -``neos.contentrepositoryregistry:nodemigration:migrationcreate`` +``neos.flow:cache:setup`` ************************* -**Create a node migration for the given package key** +**Setup the given Cache if possible** -You can specify the ``packageKey`` of your desired package. A node migration will be created in the specified package under ``/Migrations/ContentRepository/``. -The newly created node migration contains a small template to help you to get started, and also a link to the Neos documentation about how node migrations work in Neos. +Invokes the setup() method on the configured CacheBackend (if it implements the WithSetupInterface) +which should setup and validate the backend (i.e. create required database tables, directories, ...) Arguments ^^^^^^^^^ -``--package-key`` - The key for your package (for example ``Neos.Demo``) +``--cache-identifier`` + -Example -^^^^^^^ -.. code-block:: bash - ./flow node:migrationcreate --package-key Neos.Demo -.. _`Neos Command Reference: NEOS.FLOW`: -Package *NEOS.FLOW* -------------------- +Related commands +^^^^^^^^^^^^^^^^ -.. _`Neos Command Reference: NEOS.FLOW neos.flow:cache:flush`: +``neos.flow:cache:list`` + List all configured caches and their status if available +``neos.flow:cache:setupall`` + Setup all Caches -``neos.flow:cache:flush`` -************************* -**Flush all caches** -The flush command flushes all caches (including code caches) which have been -registered with Flow's Cache Manager. It also removes any session data. +.. _`Neos Command Reference: NEOS.FLOW neos.flow:cache:setupall`: -If fatal errors caused by a package prevent the compile time bootstrap -from running, the removal of any temporary data can be forced by specifying -the option **--force**. +``neos.flow:cache:setupall`` +**************************** -This command does not remove the precompiled data provided by frozen -packages unless the **--force** option is used. +**Setup all Caches** + +Invokes the setup() method on all configured CacheBackend that implement the WithSetupInterface interface +which should setup and validate the backend (i.e. create required database tables, directories, ...) + +This command will exit with a code 1 if at least one cache setup failed +This allows the command to be easily integrated in CI setups (the --quiet flag can be used to reduce verbosity) Options ^^^^^^^ -``--force`` - Force flushing of any temporary data +``--quiet`` + If set, this command only outputs errors & warnings Related commands ^^^^^^^^^^^^^^^^ -``neos.flow:cache:warmup`` - Warm up caches -``neos.flow:package:freeze`` - Freeze a package -``neos.flow:package:refreeze`` - Refreeze a package +``neos.flow:cache:setup`` + Setup the given Cache if possible -.. _`Neos Command Reference: NEOS.FLOW neos.flow:cache:flushone`: +.. _`Neos Command Reference: NEOS.FLOW neos.flow:cache:show`: -``neos.flow:cache:flushone`` -**************************** +``neos.flow:cache:show`` +************************ -**Flushes a particular cache by its identifier** +**Display details of a cache including a detailed status if available** -Given a cache identifier, this flushes just that one cache. To find -the cache identifiers, you can use the configuration:show command with -the type set to "Caches". -Note that this does not have a force-flush option since it's not -meant to remove temporary code data, resulting into a broken state if -code files lack. Arguments ^^^^^^^^^ -``--identifier`` - Cache identifier to flush cache for +``--cache-identifier`` + identifier of the cache (for example "Flow_Core") @@ -312,10 +239,8 @@ Arguments Related commands ^^^^^^^^^^^^^^^^ -``neos.flow:cache:flush`` - Flush all caches -``neos.flow:configuration:show`` - Show the active configuration settings +``neos.flow:cache:list`` + List all configured caches and their status if available @@ -396,7 +321,14 @@ Options The command shows the configuration of the current context as it is used by Flow itself. You can specify the configuration type and path if you want to show parts of the configuration. -./flow configuration:show --type Settings --path Neos.Flow.persistence +Display all settings: +./flow configuration:show + +Display Flow persistence settings: +./flow configuration:show --path Neos.Flow.persistence + +Display Flow Object Cache configuration +./flow configuration:show --type Caches --path Flow_Object_Classes @@ -404,7 +336,7 @@ Options ^^^^^^^ ``--type`` - Configuration type to show + Configuration type to show, defaults to Settings ``--path`` path to subconfiguration separated by "." like "Neos.Flow @@ -438,7 +370,7 @@ Options ``--path`` path to the subconfiguration separated by "." like "Neos.Flow ``--verbose`` - if TRUE, output more verbose information on the schema files which were used + if true, output more verbose information on the schema files which were used @@ -520,23 +452,6 @@ Arguments -.. _`Neos Command Reference: NEOS.FLOW neos.flow:core:shell`: - -``neos.flow:core:shell`` -************************ - -**Run the interactive Shell** - -The shell command runs Flow's interactive shell. This shell allows for -entering commands like through the regular command line interface but -additionally supports autocompletion and a user-based command history. - - - - - - - .. _`Neos Command Reference: NEOS.FLOW neos.flow:database:setcharset`: ``neos.flow:database:setcharset`` @@ -556,20 +471,19 @@ For background information on this, see: - http://stackoverflow.com/questions/766809/ - http://dev.mysql.com/doc/refman/5.5/en/alter-table.html +- https://medium.com/@adamhooper/in-mysql-never-use-utf8-use-utf8mb4-11761243e434 +- https://mathiasbynens.be/notes/mysql-utf8mb4 +- https://florian.ec/articles/mysql-doctrine-utf8/ -The main purpose of this is to fix setups that were created with Flow 2.3.x or earlier and whose -database server did not have a default collation of utf8mb4_unicode_ci. In those cases, the tables will -have a collation that does not match the default collation of later Flow versions, potentially leading -to problems when creating foreign key constraints (among others, potentially). +The main purpose of this is to fix setups that were created with Flow before version 5.0. In those cases, +the tables will have a collation that does not match the default collation of later Flow versions, potentially +leading to problems when creating foreign key constraints (among others, potentially). If you have special needs regarding the charset and collation, you *can* override the defaults with -different ones. One thing this might be useful for is when switching to the utf8mb4mb4 character set, see: - -- https://mathiasbynens.be/notes/mysql-utf8mb4 -- https://florian.ec/articles/mysql-doctrine-utf8/ +different ones. Note: This command **is not a general purpose conversion tool**. It will specifically not fix cases -of actual utf8mb4 stored in latin1 columns. For this a conversion to BLOB followed by a conversion to the +of actual utf8 stored in latin1 columns. For this a conversion to BLOB followed by a conversion to the proper type, charset and collation is needed instead. @@ -773,7 +687,7 @@ Related commands **Generate a new migration** -If $diffAgainstCurrent is TRUE (the default), it generates a migration file +If $diffAgainstCurrent is true (the default), it generates a migration file with the diff between current DB structure and the found mapping metadata. Otherwise an empty migration skeleton is generated. @@ -798,6 +712,8 @@ Options Whether to base the migration on the current schema structure ``--filter-expression`` Only include tables/sequences matching the filter expression regexp +``--force`` + Generate migrations even if there are migrations left to execute @@ -832,8 +748,6 @@ Options ``--show-migrations`` Output a list of all migrations and their status -``--show-descriptions`` - Show descriptions for the migrations (enables versions display) @@ -974,30 +888,18 @@ Options -.. _`Neos Command Reference: NEOS.FLOW neos.flow:package:activate`: - -``neos.flow:package:activate`` -****************************** - -**Activate an available package** - -This command activates an existing, but currently inactive package. +.. _`Neos Command Reference: NEOS.FLOW neos.flow:middleware:list`: -Arguments -^^^^^^^^^ +``neos.flow:middleware:list`` +***************************** -``--package-key`` - The package key of the package to create +**Lists all configured middleware components in the order they will be executed** -Related commands -^^^^^^^^^^^^^^^^ -``neos.flow:package:deactivate`` - Deactivate a package @@ -1035,54 +937,6 @@ Related commands -.. _`Neos Command Reference: NEOS.FLOW neos.flow:package:deactivate`: - -``neos.flow:package:deactivate`` -******************************** - -**Deactivate a package** - -This command deactivates a currently active package. - -Arguments -^^^^^^^^^ - -``--package-key`` - The package key of the package to create - - - - - -Related commands -^^^^^^^^^^^^^^^^ - -``neos.flow:package:activate`` - Activate an available package - - - -.. _`Neos Command Reference: NEOS.FLOW neos.flow:package:delete`: - -``neos.flow:package:delete`` -**************************** - -**Delete an existing package** - -This command deletes an existing package identified by the package key. - -Arguments -^^^^^^^^^ - -``--package-key`` - The package key of the package to create - - - - - - - .. _`Neos Command Reference: NEOS.FLOW neos.flow:package:freeze`: ``neos.flow:package:freeze`` @@ -1131,7 +985,7 @@ Related commands **List available packages** Lists all locally available packages. Displays the package key, version and -package title and its state – active or inactive. +package title. @@ -1143,14 +997,6 @@ Options -Related commands -^^^^^^^^^^^^^^^^ - -``neos.flow:package:activate`` - Activate an available package -``neos.flow:package:deactivate`` - Deactivate a package - .. _`Neos Command Reference: NEOS.FLOW neos.flow:package:refreeze`: @@ -1316,78 +1162,92 @@ Options -.. _`Neos Command Reference: NEOS.FLOW neos.flow:routing:getpath`: +.. _`Neos Command Reference: NEOS.FLOW neos.flow:routing:list`: -``neos.flow:routing:getpath`` -***************************** +``neos.flow:routing:list`` +************************** -**Generate a route path** +**List the known routes** -This command takes package, controller and action and displays the -generated route path and the selected route: +This command displays a list of all currently registered routes. -./flow routing:getPath --format json Acme.Demo\\Sub\\Package -Arguments -^^^^^^^^^ -``--package`` - Package key and subpackage, subpackage parts are separated with backslashes -Options -^^^^^^^ -``--controller`` - Controller name, default is 'Standard' -``--action`` - Action name, default is 'index' -``--format`` - Requested Format name default is 'html' +.. _`Neos Command Reference: NEOS.FLOW neos.flow:routing:match`: +``neos.flow:routing:match`` +*************************** +**Match the given URI to a corresponding route** +This command takes an incoming URI and displays the +matched Route and the mapped routing values (if any): +./flow routing:match "/de" --parameters="{\"requestUriHost\": \"localhost\"}" -.. _`Neos Command Reference: NEOS.FLOW neos.flow:routing:list`: +Arguments +^^^^^^^^^ -``neos.flow:routing:list`` -************************** +``--uri`` + The incoming route, absolute or relative -**List the known routes** -This command displays a list of all currently registered routes. +Options +^^^^^^^ + +``--method`` + The HTTP method to simulate (default is 'GET') +``--parameters`` + Route parameters as JSON string. Make sure to specify this option as described in the description in order to prevent parsing issues +.. _`Neos Command Reference: NEOS.FLOW neos.flow:routing:resolve`: -.. _`Neos Command Reference: NEOS.FLOW neos.flow:routing:routepath`: +``neos.flow:routing:resolve`` +***************************** -``neos.flow:routing:routepath`` -******************************* +**Build an URI for the given parameters** -**Route the given route path** +This command takes package, controller and action and displays the +resolved URI and which route matched (if any): -This command takes a given path and displays the detected route and -the selected package, controller and action. +./flow routing:resolve Some.Package --controller SomeController --additional-arguments="{\"some-argument\": \"some-value\"}" Arguments ^^^^^^^^^ -``--path`` - The route path to resolve +``--package`` + Package key (according to "@package" route value) Options ^^^^^^^ -``--method`` - The request method (GET, POST, PUT, DELETE, ...) to simulate +``--controller`` + Controller name (according to "@controller" route value), default is 'Standard' +``--action`` + Action name (according to "@action" route value), default is 'index' +``--format`` + Requested Format name (according to "@format" route value), default is 'html' +``--subpackage`` + SubPackage name (according to "@subpackage" route value) +``--additional-arguments`` + Additional route values as JSON string. Make sure to specify this option as described in the description in order to prevent parsing issues +``--parameters`` + Route parameters as JSON string. Make sure to specify this option as described in the description in order to prevent parsing issues +``--base-uri`` + Base URI of the simulated request, default ist 'http://localhost' +``--force-absolute-uri`` + Whether or not to force the creation of an absolute URI @@ -1414,12 +1274,12 @@ Arguments -.. _`Neos Command Reference: NEOS.FLOW neos.flow:security:generatekeypair`: +.. _`Neos Command Reference: NEOS.FLOW neos.flow:schema:validate`: -``neos.flow:security:generatekeypair`` -************************************** +``neos.flow:schema:validate`` +***************************** -**Generate a public/private key pair and add it to the RSAWalletService** +**Validate the given configurationfile againt a schema file** @@ -1428,34 +1288,80 @@ Arguments Options ^^^^^^^ -``--used-for-passwords`` - If the private key should be used for passwords +``--configuration-file`` + path to the validated configuration file +``--schema-file`` + path to the schema file +``--verbose`` + if true, output more verbose information on the schema files which were used -Related commands -^^^^^^^^^^^^^^^^ -``neos.flow:security:importprivatekey`` - Import a private key +.. _`Neos Command Reference: NEOS.FLOW neos.flow:security:describerole`: +``neos.flow:security:describerole`` +*********************************** -.. _`Neos Command Reference: NEOS.FLOW neos.flow:security:importprivatekey`: +**Show details of a specified role** -``neos.flow:security:importprivatekey`` -*************************************** -**Import a private key** -Read a PEM formatted private key from stdin and import it into the -RSAWalletService. The public key will be automatically extracted and stored -together with the private key as a key pair. +Arguments +^^^^^^^^^ -You can generate the same fingerprint returned from this using these commands: +``--role`` + identifier of the role to describe (for example "Neos.Flow:Everybody") -ssh-keygen -yf my-key.pem > my-key.pub -ssh-keygen -lf my-key.pub + + + + + + +.. _`Neos Command Reference: NEOS.FLOW neos.flow:security:generatekeypair`: + +``neos.flow:security:generatekeypair`` +************************************** + +**Generate a public/private key pair and add it to the RSAWalletService** + + + + + +Options +^^^^^^^ + +``--used-for-passwords`` + If the private key should be used for passwords + + + +Related commands +^^^^^^^^^^^^^^^^ + +``neos.flow:security:importprivatekey`` + Import a private key + + + +.. _`Neos Command Reference: NEOS.FLOW neos.flow:security:importprivatekey`: + +``neos.flow:security:importprivatekey`` +*************************************** + +**Import a private key** + +Read a PEM formatted private key from stdin and import it into the +RSAWalletService. The public key will be automatically extracted and stored +together with the private key as a key pair. + +You can generate the same fingerprint returned from this using these commands: + +ssh-keygen -yf my-key.pem > my-key.pub +ssh-keygen -lf my-key.pub To create a private key to import using this method, you can use: @@ -1508,6 +1414,27 @@ Related commands +.. _`Neos Command Reference: NEOS.FLOW neos.flow:security:listroles`: + +``neos.flow:security:listroles`` +******************************** + +**List all configured roles** + + + + + +Options +^^^^^^^ + +``--include-abstract`` + Set this flag to include abstract roles + + + + + .. _`Neos Command Reference: NEOS.FLOW neos.flow:security:showeffectivepolicy`: ``neos.flow:security:showeffectivepolicy`` @@ -1600,6 +1527,69 @@ Options +.. _`Neos Command Reference: NEOS.FLOW neos.flow:session:collectgarbage`: + +``neos.flow:session:collectgarbage`` +************************************ + +**Run garbage collection for sesions.** + +This command will remove session-data and -metadate of outdated sessions +identified by lastActivityTimestamp being older than inactivityTimeout + +!!! This is usually done automatically after shutdown for the percentage +of requests specified in the setting `Neos.Flow.session.garbageCollection.probability` + +Use this command if you need more direct control over the cleanup intervals. + + + + + + + +.. _`Neos Command Reference: NEOS.FLOW neos.flow:session:destroyall`: + +``neos.flow:session:destroyall`` +******************************** + +**Destroys all sessions.** + +This special command is needed, because sessions are kept in persistent storage and are not flushed +with other caches by default. + +This is functionally equivalent to +`./flow flow:cache:flushOne Flow_Session_Storage && ./flow flow:cache:flushOne Flow_Session_MetaData` + + + + + + + +.. _`Neos Command Reference: NEOS.FLOW neos.flow:signal:listconnected`: + +``neos.flow:signal:listconnected`` +********************************** + +**Lists all connected signals with their slots.** + + + + + +Options +^^^^^^^ + +``--class-name`` + if specified, only signals matching the given fully qualified class name will be shown. Note: escape namespace separators or wrap the value in quotes, e.g. "--class-name Neos\\Flow\\Core\\Bootstrap". +``--method-name`` + if specified, only signals matching the given method name will be shown. This is only useful in conjunction with the "--class-name" option. + + + + + .. _`Neos Command Reference: NEOS.FLOW neos.flow:typeconverter:list`: ``neos.flow:typeconverter:list`` @@ -1641,7 +1631,7 @@ Generates Schema documentation (XSD) for your ViewHelpers, preparing the file to be placed online and used by any XSD-aware editor. After creating the XSD file, reference it in your IDE and import the namespace in your Fluid template by adding the xmlns:* attribute(s): - + Arguments ^^^^^^^^^ @@ -1655,9 +1645,11 @@ Options ^^^^^^^ ``--xsd-namespace`` - Unique target namespace used in the XSD schema (for example "http://yourdomain.org/ns/viewhelpers"). Defaults to "http://typo3.org/ns/". + Unique target namespace used in the XSD schema (for example "http://yourdomain.org/ns/viewhelpers"). Defaults to "https://neos.io/ns/". ``--target-file`` File path and name of the generated XSD schema. If not specified the schema will be output to standard output. +``--xsd-domain`` + Domain used in the XSD schema (for example "http://yourdomain.org"). Defaults to "https://neos.io". @@ -1690,8 +1682,9 @@ exist. By using the --generate-related flag, a missing package, model or repository can be created alongside, avoiding such an error. By specifying the --generate-templates flag, this command will also create -matching Fluid templates for the actions created. This option can only be -used in combination with --generate-actions. +matching Fluid templates for the actions created. +Alternatively, by specifying the --generate-fusion flag, this command will +create matching Fusion files for the actions. The default behavior is to not overwrite any existing code. This can be overridden by specifying the --force flag. @@ -1713,8 +1706,10 @@ Options Also generate index, show, new, create, edit, update and delete actions. ``--generate-templates`` Also generate the templates for each action. +``--generate-fusion`` + If Fusion templates should be generated instead of Fluid. ``--generate-related`` - Also create the mentioned package, related model and repository if neccessary. + Also create the mentioned package, related model and repository if necessary. ``--force`` Overwrite any existing controller or template code. Regardless of this flag, the package, model and repository will never be overwritten. @@ -1842,13 +1837,19 @@ Arguments +Options +^^^^^^^ + +``--package-type`` + Optional package type, e.g. "neos-plugin + Related commands ^^^^^^^^^^^^^^^^ -``typo3.flow:package:create`` - *Command not available* +``neos.flow:package:create`` + Create a new package @@ -1887,6 +1888,35 @@ Related commands +.. _`Neos Command Reference: NEOS.KICKSTARTER neos.kickstarter:kickstart:translation`: + +``neos.kickstarter:kickstart:translation`` +****************************************** + +**Kickstart translation** + +Generates the translation files for the given package. + +Arguments +^^^^^^^^^ + +``--package-key`` + The package key of the package for the translation +``--source-language-key`` + The language key of the default language + + + +Options +^^^^^^^ + +``--target-language-keys`` + Comma separated language keys for the target translations + + + + + .. _`Neos Command Reference: NEOS.MEDIA`: Package *NEOS.MEDIA* @@ -1910,6 +1940,8 @@ Options ``--preset`` Preset name, if provided only thumbnails matching that preset are cleared +``--quiet`` + If set, only errors will be displayed. @@ -1925,7 +1957,7 @@ Options Creates thumbnail images based on the configured thumbnail presets. Optional ``preset`` parameter to only create thumbnails for a specific thumbnail preset configuration. -Additionally accepts a ``async`` parameter determining if the created thumbnails are generated when created. +Additionally, accepts a ``async`` parameter determining if the created thumbnails are generated when created. @@ -1936,6 +1968,8 @@ Options Preset name, if not provided thumbnails are created for all presets ``--async`` Asynchronous generation, if not provided the setting ``Neos.Media.asyncThumbnails`` is used +``--quiet`` + If set, only errors will be displayed. @@ -1959,6 +1993,92 @@ Options ``--simulate`` If set, this command will only tell what it would do instead of doing it right away +``--quiet`` + + + + + + +.. _`Neos Command Reference: NEOS.MEDIA neos.media:media:listvariantpresets`: + +``neos.media:media:listvariantpresets`` +*************************************** + +**List all configurations for your imageVariants.** + +Doesn't matter if configured under 'Neos.Media.variantPresets' or already deleted from this configuration. +This command will find every single one for you. + + + + + + + +.. _`Neos Command Reference: NEOS.MEDIA neos.media:media:removeunused`: + +``neos.media:media:removeunused`` +********************************* + +**Remove unused assets** + +This command iterates over all existing assets, checks their usage count and lists the assets which are not +reported as used by any AssetUsageStrategies. The unused assets can than be removed. + + + +Options +^^^^^^^ + +``--asset-source`` + If specified, only assets of this asset source are considered. For example "neos" or "my-asset-management-system +``--quiet`` + If set, only errors will be displayed. +``--assume-yes`` + If set, "yes" is assumed for the "shall I remove ..." dialogs +``--only-tags`` + Comma-separated list of asset tag labels, that should be taken into account +``--limit`` + Limit the result of unused assets displayed and removed for this run. +``--only-collections`` + Comma-separated list of asset collection titles, that should be taken into account + + + + + +.. _`Neos Command Reference: NEOS.MEDIA neos.media:media:removevariants`: + +``neos.media:media:removevariants`` +*********************************** + +**Cleanup imageVariants with provided identifier and variant name.** + +Image variants that are still configured are removed without usage check and +can be regenerated afterwards with `media:renderVariants`. + +This command will not remove any custom cropped image variants. + +Arguments +^^^^^^^^^ + +``--identifier`` + Identifier of variants to remove. +``--variant-name`` + Variants with this name will be removed (if exist). + + + +Options +^^^^^^^ + +``--quiet`` + If set, only errors and questions will be displayed. +``--assume-yes`` + If set, "yes" is assumed for the "shall I remove ..." dialog. +``--limit`` + Limit the result of unused assets displayed and removed for this run. @@ -1981,6 +2101,36 @@ Options ``--limit`` Limit the amount of thumbnails to be rendered to avoid memory exhaustion +``--quiet`` + If set, only errors will be displayed. + + + + + +.. _`Neos Command Reference: NEOS.MEDIA neos.media:media:rendervariants`: + +``neos.media:media:rendervariants`` +*********************************** + +**Render asset variants** + +Loops over missing configured asset variants and renders them. Optional ``limit`` parameter to +limit the amount of variants to be rendered to avoid memory exhaustion. + +If the re-render parameter is given, any existing variants will be rendered again, too. + + + +Options +^^^^^^^ + +``--limit`` + Limit the amount of variants to be rendered to avoid memory exhaustion +``--quiet`` + If set, only errors will be displayed. +``--recreate`` + If set, existing asset variants will be re-generated and replaced @@ -1992,12 +2142,70 @@ Package *NEOS.NEOS* ------------------- +.. _`Neos Command Reference: NEOS.NEOS neos.neos:cr:export`: + +``neos.neos:cr:export`` +*********************** + +**Export the events from the specified content repository** + + + +Arguments +^^^^^^^^^ + +``--path`` + The path for storing the result + + + +Options +^^^^^^^ + +``--content-repository`` + The content repository identifier +``--verbose`` + If set, all notices will be rendered + + + + + +.. _`Neos Command Reference: NEOS.NEOS neos.neos:cr:import`: + +``neos.neos:cr:import`` +*********************** + +**Import the events from the path into the specified content repository** + + + +Arguments +^^^^^^^^^ + +``--path`` + The path of the stored events like resource://Neos.Demo/Private/Content + + + +Options +^^^^^^^ + +``--content-repository`` + The content repository identifier +``--verbose`` + If set, all notices will be rendered + + + + + .. _`Neos Command Reference: NEOS.NEOS neos.neos:domain:activate`: ``neos.neos:domain:activate`` ***************************** -**Activate a domain record by hostname** +**Activate a domain record by hostname (with globbing)** @@ -2005,7 +2213,7 @@ Arguments ^^^^^^^^^ ``--hostname`` - The hostname to activate + The hostname to activate (globbing is supported) @@ -2026,7 +2234,7 @@ Arguments ^^^^^^^^^ ``--site-node-name`` - The nodeName of the site rootNode, e.g. "neostypo3org + The nodeName of the site rootNode, e.g. "flowneosio ``--hostname`` The hostname to match on, e.g. "flow.neos.io @@ -2049,7 +2257,7 @@ Options ``neos.neos:domain:deactivate`` ******************************* -**Deactivate a domain record by hostname** +**Deactivate a domain record by hostname (with globbing)** @@ -2057,7 +2265,7 @@ Arguments ^^^^^^^^^ ``--hostname`` - The hostname to deactivate + The hostname to deactivate (globbing is supported) @@ -2070,7 +2278,7 @@ Arguments ``neos.neos:domain:delete`` *************************** -**Delete a domain record by hostname** +**Delete a domain record by hostname (with globbing)** @@ -2078,7 +2286,7 @@ Arguments ^^^^^^^^^ ``--hostname`` - The hostname to remove + The hostname to remove (globbing is supported) @@ -2112,7 +2320,7 @@ Options ``neos.neos:site:activate`` *************************** -**Activate a site** +**Activate a site (with globbing)** This command activates the specified site. @@ -2120,7 +2328,7 @@ Arguments ^^^^^^^^^ ``--site-node`` - The node name of the site to activate + The node name of the sites to activate (globbing is supported) @@ -2138,13 +2346,13 @@ Arguments This command allows to create a blank site with just a single empty document in the default dimension. The name of the site, the packageKey must be specified. -If no ``nodeType`` option is specified the command will use `Neos.NodeTypes:Page` as fallback. The node type -must already exists and have the superType ``Neos.Neos:Document``. +The node type given with the ``nodeType`` option must already exists +and have the superType ``Neos.Neos:Document``. -If no ``nodeName` option is specified the command will create a unique node-name from the name of the site. +If no ``nodeName`` option is specified the command will create a unique node-name from the name of the site. If a node name is given it has to be unique for the setup. -If the flag ``activate` is set to false new site will not be activated. +If the flag ``activate`` is set to false new site will not be activated. Arguments ^^^^^^^^^ @@ -2153,18 +2361,18 @@ Arguments The name of the site ``--package-key`` The site package +``--node-type`` + The node type to use for the site node, e.g. Amce.Com:Page Options ^^^^^^^ -``--node-type`` - The node type to use for the site node. (Default = Neos.NodeTypes:Page) ``--node-name`` - The name of the site node. If no nodeName is given it will be determined from the siteName. + The name of the site node. ``--inactive`` - The new site is not activated immediately (default = false). + The new site is not activated immediately (default = false) @@ -2175,7 +2383,7 @@ Options ``neos.neos:site:deactivate`` ***************************** -**Deactivate a site** +**Deactivate a site (with globbing)** This command deactivates the specified site. @@ -2183,77 +2391,9 @@ Arguments ^^^^^^^^^ ``--site-node`` - The node name of the site to deactivate - - - - - - - -.. _`Neos Command Reference: NEOS.NEOS neos.neos:site:export`: - -``neos.neos:site:export`` -************************* - -**Export sites content (e.g. site:export --package-key "Neos.Demo")** - -This command exports all or one specific site with all its content into an XML format. - -If the package key option is given, the site(s) will be exported to the given package in the default -location Resources/Private/Content/Sites.xml. - -If the filename option is given, any resources will be exported to files in a folder named "Resources" -alongside the XML file. - -If neither the filename nor the package key option are given, the XML will be printed to standard output and -assets will be embedded into the XML in base64 encoded form. - - - -Options -^^^^^^^ - -``--site-node`` - the node name of the site to be exported; if none given will export all sites -``--tidy`` - Whether to export formatted XML. This is defaults to true -``--filename`` - relative path and filename to the XML file to create. Any resource will be stored in a sub folder "Resources". -``--package-key`` - Package to store the XML file in. Any resource will be stored in a sub folder "Resources". -``--node-type-filter`` - Filter the node type of the nodes, allows complex expressions (e.g. "Neos.Neos:Page", "!Neos.Neos:Page,Neos.Neos:Text") - - - + The node name of the sites to deactivate (globbing is supported) -.. _`Neos Command Reference: NEOS.NEOS neos.neos:site:import`: - -``neos.neos:site:import`` -************************* - -**Import sites content** - -This command allows for importing one or more sites or partial content from an XML source. The format must -be identical to that produced by the export command. - -If a filename is specified, this command expects the corresponding file to contain the XML structure. The -filename php://stdin can be used to read from standard input. - -If a package key is specified, this command expects a Sites.xml file to be located in the private resources -directory of the given package (Resources/Private/Content/Sites.xml). - - - -Options -^^^^^^^ - -``--package-key`` - Package key specifying the package containing the sites content -``--filename`` - relative path and filename to the XML file containing the sites content @@ -2279,17 +2419,17 @@ Options ``neos.neos:site:prune`` ************************ -**Remove all content and related data - for now. In the future we need some more sophisticated cleanup.** - +**Remove site with content and related data (with globbing)** +In the future we need some more sophisticated cleanup. +Arguments +^^^^^^^^^ +``--site-node`` + Name for site root nodes to clear only content of this sites (globbing is supported) -Options -^^^^^^^ -``--site-node`` - Name of a site root node to clear only content of this site. @@ -2300,7 +2440,7 @@ Options ``neos.neos:user:activate`` *************************** -**Activate a user** +**Activate a user (with globbing)** This command reactivates possibly expired accounts for the given user. @@ -2312,7 +2452,7 @@ Arguments ^^^^^^^^^ ``--username`` - The username of the user to be activated. + The username of the user to be activated (globbing is supported) @@ -2320,7 +2460,7 @@ Options ^^^^^^^ ``--authentication-provider`` - Name of the authentication provider to use for finding the user. Example: "Neos.Neos:Backend + Name of the authentication provider to use for finding the user. @@ -2346,7 +2486,7 @@ Arguments ^^^^^^^^^ ``--username`` - The username of the user + The username of the user (globbing is supported) ``--role`` Role to be added to the user, for example "Neos.Neos:Administrator" or just "Administrator @@ -2384,7 +2524,7 @@ Arguments ^^^^^^^^^ ``--username`` - The username of the user to be created, used as an account identifier for the newly created account + The username of the user to be created, ``--password`` Password of the user to be created ``--first-name`` @@ -2400,7 +2540,7 @@ Options ``--roles`` A comma separated list of roles to assign. Examples: "Editor, Acme.Foo:Reviewer ``--authentication-provider`` - Name of the authentication provider to use for the new account. Example: "Neos.Neos:Backend + Name of the authentication provider to use for the new account. @@ -2411,19 +2551,19 @@ Options ``neos.neos:user:deactivate`` ***************************** -**Deactivate a user** +**Deactivate a user (with globbing)** This command deactivates a user by flagging all of its accounts as expired. -If an authentication provider is specified, this command will look for an account with the given username related -to the given provider. Still, this command will deactivate **all** accounts of a user, once such a user has been -found. +If an authentication provider is specified, this command will look for an account with the given username +related to the given provider. Still, this command will deactivate **all** accounts of a user, +once such a user has been found. Arguments ^^^^^^^^^ ``--username`` - The username of the user to be deactivated. + The username of the user to be deactivated (globbing is supported) @@ -2431,7 +2571,7 @@ Options ^^^^^^^ ``--authentication-provider`` - Name of the authentication provider to use for finding the user. Example: "Neos.Neos:Backend + Name of the authentication provider to use for finding the user. @@ -2442,7 +2582,7 @@ Options ``neos.neos:user:delete`` ************************* -**Delete a user** +**Delete a user (with globbing)** This command deletes an existing Neos user. All content and data directly related to this user, including but not limited to draft workspace contents, will be removed as well. @@ -2458,7 +2598,7 @@ Arguments ^^^^^^^^^ ``--username`` - The username of the user to be removed + The username of the user to be removed (globbing is supported) @@ -2506,9 +2646,9 @@ Arguments ^^^^^^^^^ ``--username`` - The username of the user + The username of the user (globbing is supported) ``--role`` - Role to be removed from the user, for example "Neos.Neos:Administrator" or just "Administrator + Role to be removed from the user, @@ -2549,7 +2689,7 @@ Options ^^^^^^^ ``--authentication-provider`` - Name of the authentication provider to use for finding the user. Example: "Neos.Neos:Backend + Name of the authentication provider to use for finding the user. @@ -2573,7 +2713,7 @@ Arguments ^^^^^^^^^ ``--username`` - The username of the user to show. Usually refers to the account identifier of the user's Neos backend account. + The username of the user to show. @@ -2615,6 +2755,35 @@ Options A description explaining the purpose of the new workspace ``--owner`` The identifier of a User to own the workspace +``--content-repository-identifier`` + + + + + + +.. _`Neos Command Reference: NEOS.NEOS neos.neos:workspace:createroot`: + +``neos.neos:workspace:createroot`` +********************************** + +**Create a new root workspace for a content repository.** + + + +Arguments +^^^^^^^^^ + +``--name`` + + + + +Options +^^^^^^^ + +``--content-repository-identifier`` + @@ -2643,6 +2812,8 @@ Options ``--force`` Delete the workspace and all of its contents +``--content-repository-identifier`` + contentRepositoryIdentifier @@ -2674,45 +2845,10 @@ Arguments Options ^^^^^^^ -``--verbose`` - If enabled, information about individual nodes will be displayed -``--dry-run`` - If set, only displays which nodes would be discarded, no real changes are committed - - - - - -.. _`Neos Command Reference: NEOS.NEOS neos.neos:workspace:discardall`: - -``neos.neos:workspace:discardall`` -********************************** - -**Discard changes in workspace <b>(DEPRECATED)</b>** - -This command discards all modified, created or deleted nodes in the specified workspace. - -Arguments -^^^^^^^^^ - -``--workspace-name`` - Name of the workspace, for example "user-john - - - -Options -^^^^^^^ - -``--verbose`` - If enabled, information about individual nodes will be displayed - - +``--content-repository-identifier`` + -Related commands -^^^^^^^^^^^^^^^^ -``neos.neos:workspace:discard`` - Discard changes in workspace @@ -2727,6 +2863,12 @@ Related commands +Options +^^^^^^^ + +``--content-repository-identifier`` + contentRepositoryIdentifier + @@ -2739,7 +2881,6 @@ Related commands **Publish changes of a workspace** This command publishes all modified, created or deleted nodes in the specified workspace to its base workspace. -If a target workspace is specified, the content is published to that workspace instead. Arguments ^^^^^^^^^ @@ -2752,70 +2893,29 @@ Arguments Options ^^^^^^^ -``--target-workspace`` - If specified, the content will be published to this workspace instead of the base workspace -``--verbose`` - If enabled, some information about individual nodes will be displayed -``--dry-run`` - If set, only displays which nodes would be published, no real changes are committed - +``--content-repository-identifier`` + -.. _`Neos Command Reference: NEOS.NEOS neos.neos:workspace:publishall`: -``neos.neos:workspace:publishall`` -********************************** +.. _`Neos Command Reference: NEOS.NEOS neos.neos:workspace:rebaseoutdated`: -**Publish changes of a workspace <b>(DEPRECATED)</b>** +``neos.neos:workspace:rebaseoutdated`` +************************************** -This command publishes all modified, created or deleted nodes in the specified workspace to the live workspace. +**Rebase all outdated content streams** -Arguments -^^^^^^^^^ -``--workspace-name`` - Name of the workspace, for example "user-john Options ^^^^^^^ -``--verbose`` - If enabled, information about individual nodes will be displayed - - - -Related commands -^^^^^^^^^^^^^^^^ - -``neos.neos:workspace:publish`` - Publish changes of a workspace - - - -.. _`Neos Command Reference: NEOS.NEOS neos.neos:workspace:rebase`: - -``neos.neos:workspace:rebase`` -****************************** - -**Rebase a workspace** - -This command sets a new base workspace for the specified workspace. Note that doing so will put the possible -changes contained in the workspace to be rebased into a different context and thus might lead to unintended -results when being published. - -Arguments -^^^^^^^^^ - -``--workspace`` - Name of the workspace to rebase, for example "user-john -``--base-workspace`` - Name of the new base workspace - - +``--content-repository-identifier`` + contentRepositoryIdentifier diff --git a/Neos.Neos/Documentation/References/FlowQueryOperationReference.rst b/Neos.Neos/Documentation/References/FlowQueryOperationReference.rst index 60cf23d488f..6953f8bf134 100644 --- a/Neos.Neos/Documentation/References/FlowQueryOperationReference.rst +++ b/Neos.Neos/Documentation/References/FlowQueryOperationReference.rst @@ -3,7 +3,7 @@ FlowQuery Operation Reference ============================= -This reference was automatically generated from code on 2023-06-01 +This reference was automatically generated from code on 2023-11-22 .. _`FlowQuery Operation Reference: add`: @@ -24,27 +24,59 @@ or an Object. -.. _`FlowQuery Operation Reference: cacheLifetime`: +.. _`FlowQuery Operation Reference: backReferenceNodes`: -cacheLifetime -------------- +backReferenceNodes +------------------ -"cacheLifetime" operation working on ContentRepository nodes. Will get the minimum of all allowed cache lifetimes for the -nodes in the current FlowQuery context. This means it will evaluate to the nearest future value of the -hiddenBeforeDateTime or hiddenAfterDateTime properties of all nodes in the context. If none are set or all values -are in the past it will evaluate to NULL. +"backReferenceNodes" operation working on Nodes -To include already hidden nodes (with a hiddenBeforeDateTime value in the future) in the result, also invisible nodes -have to be included in the context. This can be achieved using the "context" operation before fetching child nodes. +This operation can be used to find the nodes that are referencing a given node: -Example: + ${q(node).backReferenceNodes().get()} - q(node).context({'invisibleContentShown': true}).children().cacheLifetime() +A referenceName can be specified as argument -:Implementation: Neos\\ContentRepository\\Eel\\FlowQueryOperations\\CacheLifetimeOperation -:Priority: 1 -:Final: Yes -:Returns: integer The cache lifetime in seconds or NULL if either no content collection was given or no child node had a "hiddenBeforeDateTime" or "hiddenAfterDateTime" property set + ${q(node).backReferenceNodes("someReferenceName")} + + + +:Implementation: Neos\\ContentRepository\\NodeAccess\\FlowQueryOperations\\BackReferenceNodesOperation +:Priority: 100 +:Final: No +:Returns: void + + + + + +.. _`FlowQuery Operation Reference: backReferences`: + +backReferences +-------------- + +"backReferences" operation working on Nodes + +This operation can be used to find incoming references of a given node: + + ${q(node).backReferences().get()} + +The result is an array of {@see Reference} instances. + +To render the reference name of the first match: + + $q{node).backReferences().get(0).name.value} + +The {@see ReferencePropertyOperation} can be used to access any property on the reference relation: + + ${q(node).backReferences("someReferenceName").property("somePropertyName")} + + + +:Implementation: Neos\\ContentRepository\\NodeAccess\\FlowQueryOperations\\BackReferencesOperation +:Priority: 100 +:Final: No +:Returns: void @@ -59,7 +91,7 @@ children context elements and returns all child nodes or only those matching the filter expression specified as optional argument. -:Implementation: Neos\\ContentRepository\\Eel\\FlowQueryOperations\\ChildrenOperation +:Implementation: Neos\\ContentRepository\\NodeAccess\\FlowQueryOperations\\ChildrenOperation :Priority: 100 :Final: No :Returns: void @@ -96,7 +128,7 @@ closest get the first node that matches the selector by testing the node itself and traversing up through its ancestors. -:Implementation: Neos\\ContentRepository\\Eel\\FlowQueryOperations\\ClosestOperation +:Implementation: Neos\\ContentRepository\\NodeAccess\\FlowQueryOperations\\ClosestOperation :Priority: 100 :Final: No :Returns: void @@ -105,29 +137,6 @@ traversing up through its ancestors. -.. _`FlowQuery Operation Reference: context`: - -context -------- - -"context" operation working on ContentRepository nodes. Modifies the ContentRepository Context of each -node in the current FlowQuery context by the given properties and returns the same -nodes by identifier if they can be accessed in the new Context (otherwise they -will be skipped). - -Example: - - q(node).context({'invisibleContentShown': true}).children() - -:Implementation: Neos\\ContentRepository\\Eel\\FlowQueryOperations\\ContextOperation -:Priority: 1 -:Final: No -:Returns: void - - - - - .. _`FlowQuery Operation Reference: count`: count @@ -214,18 +223,18 @@ filter This filter implementation contains specific behavior for use on ContentRepository nodes. It will not evaluate any elements that are not instances of the -`NodeInterface`. +`Node`. The implementation changes the behavior of the `instanceof` operator to work on node types instead of PHP object types, so that:: - [instanceof Acme.Com:Page] + [instanceof Neos.NodeTypes:Page] will in fact use `isOfType()` on the `NodeType` of context elements to filter. This filter allow also to filter the current context by a given node. Anything else remains unchanged. -:Implementation: Neos\\ContentRepository\\Eel\\FlowQueryOperations\\FilterOperation +:Implementation: Neos\\ContentRepository\\NodeAccess\\FlowQueryOperations\\FilterOperation :Priority: 100 :Final: No :Returns: void @@ -244,37 +253,37 @@ of nodes specified by a path, identifier or node type (recursive). Example (node name): - q(node).find('main') + q(node).find('main') Example (relative path): - q(node).find('main/text1') + q(node).find('main/text1') Example (absolute path): - q(node).find('/sites/my-site/home') + q(node).find('/sites/my-site/home') Example (identifier): - q(node).find('#30e893c1-caef-0ca5-b53d-e5699bb8e506') + q(node).find('#30e893c1-caef-0ca5-b53d-e5699bb8e506') Example (node type): - q(node).find('[instanceof Acme.Com:Text]') + q(node).find('[instanceof Neos.NodeTypes:Text]') Example (multiple node types): - q(node).find('[instanceof Acme.Com:Text],[instanceof Acme.Com:Image]') + q(node).find('[instanceof Neos.NodeTypes:Text],[instanceof Neos.NodeTypes:Image]') Example (node type with filter): - q(node).find('[instanceof Acme.Com:Text][text*="Neos"]') + q(node).find('[instanceof Neos.NodeTypes:Text][text*="Neos"]') This operation operates rather on the given Context object than on the given node and thus may work with the legacy node interface until subgraphs are available {@inheritdoc} -:Implementation: Neos\\ContentRepository\\Eel\\FlowQueryOperations\\FindOperation +:Implementation: Neos\\ContentRepository\\NodeAccess\\FlowQueryOperations\\FindOperation :Priority: 100 :Final: No :Returns: void @@ -328,13 +337,13 @@ returned. If no such index exists, NULL is returned. has --- -"has" operation working on NodeInterface. Reduce the set of matched elements +"has" operation working on Node. Reduce the set of matched elements to those that have a child node that matches the selector or given subject. Accepts a selector, an array, an object, a traversable object & a FlowQuery object as argument. -:Implementation: Neos\\ContentRepository\\Eel\\FlowQueryOperations\\HasOperation +:Implementation: Neos\\ContentRepository\\NodeAccess\\FlowQueryOperations\\HasOperation :Priority: 100 :Final: No :Returns: void @@ -383,10 +392,10 @@ Get the last element inside the context. neosUiDefaultNodes ------------------ -Fetches all nodes needed for the given state of the UI + :Implementation: Neos\\Neos\\Ui\\FlowQueryOperations\\NeosUiDefaultNodesOperation -:Priority: 100 +:Priority: 110 :Final: No :Returns: void @@ -404,7 +413,7 @@ context elements and returns all child nodes or only those matching the filter expression specified as optional argument. :Implementation: Neos\\Neos\\Ui\\FlowQueryOperations\\NeosUiFilteredChildrenOperation -:Priority: 100 +:Priority: 500 :Final: No :Returns: void @@ -422,7 +431,7 @@ context elements and returns the immediately following sibling. If an optional filter expression is provided, it only returns the node if it matches the given expression. -:Implementation: Neos\\ContentRepository\\Eel\\FlowQueryOperations\\NextOperation +:Implementation: Neos\\ContentRepository\\NodeAccess\\FlowQueryOperations\\NextOperation :Priority: 100 :Final: No :Returns: void @@ -440,8 +449,8 @@ nextAll context elements and returns each following sibling or only those matching the filter expression specified as optional argument. -:Implementation: Neos\\ContentRepository\\Eel\\FlowQueryOperations\\NextAllOperation -:Priority: 0 +:Implementation: Neos\\ContentRepository\\NodeAccess\\FlowQueryOperations\\NextAllOperation +:Priority: 100 :Final: No :Returns: void @@ -459,8 +468,8 @@ and returns each following sibling until the matching sibling is found. If an optional filter expression is provided as a second argument, it only returns the nodes matching the given expression. -:Implementation: Neos\\ContentRepository\\Eel\\FlowQueryOperations\\NextUntilOperation -:Priority: 0 +:Implementation: Neos\\ContentRepository\\NodeAccess\\FlowQueryOperations\\NextUntilOperation +:Priority: 100 :Final: No :Returns: void @@ -468,17 +477,18 @@ it only returns the nodes matching the given expression. -.. _`FlowQuery Operation Reference: parent`: +.. _`FlowQuery Operation Reference: nextUntil`: -parent ------- +nextUntil +--------- -"parent" operation working on ContentRepository nodes. It iterates over all -context elements and returns each direct parent nodes or only those matching -the filter expression specified as optional argument. +"prevUntil" operation working on ContentRepository nodes. It iterates over all context elements +and returns each preceding sibling until the matching sibling is found. +If an optional filter expression is provided as a second argument, +it only returns the nodes matching the given expression. -:Implementation: Neos\\ContentRepository\\Eel\\FlowQueryOperations\\ParentOperation -:Priority: 100 +:Implementation: Neos\\ContentRepository\\NodeAccess\\FlowQueryOperations\\PrevUntilOperation +:Priority: 0 :Final: No :Returns: void @@ -486,17 +496,17 @@ the filter expression specified as optional argument. -.. _`FlowQuery Operation Reference: parents`: +.. _`FlowQuery Operation Reference: parent`: -parents -------- +parent +------ -"parents" operation working on ContentRepository nodes. It iterates over all -context elements and returns the parent nodes or only those matching +"parent" operation working on ContentRepository nodes. It iterates over all +context elements and returns each direct parent nodes or only those matching the filter expression specified as optional argument. -:Implementation: Neos\\ContentRepository\\Eel\\FlowQueryOperations\\ParentsOperation -:Priority: 0 +:Implementation: Neos\\ContentRepository\\NodeAccess\\FlowQueryOperations\\ParentOperation +:Priority: 100 :Final: No :Returns: void @@ -513,7 +523,7 @@ parents context elements and returns the parent nodes or only those matching the filter expression specified as optional argument. -:Implementation: Neos\\Neos\\Eel\\FlowQueryOperations\\ParentsOperation +:Implementation: Neos\\ContentRepository\\NodeAccess\\FlowQueryOperations\\ParentsOperation :Priority: 100 :Final: No :Returns: void @@ -532,26 +542,7 @@ context elements and returns the parent nodes until the matching parent is found If an optional filter expression is provided as a second argument, it only returns the nodes matching the given expression. -:Implementation: Neos\\ContentRepository\\Eel\\FlowQueryOperations\\ParentsUntilOperation -:Priority: 0 -:Final: No -:Returns: void - - - - - -.. _`FlowQuery Operation Reference: parentsUntil`: - -parentsUntil ------------- - -"parentsUntil" operation working on ContentRepository nodes. It iterates over all -context elements and returns the parent nodes until the matching parent is found. -If an optional filter expression is provided as a second argument, -it only returns the nodes matching the given expression. - -:Implementation: Neos\\Neos\\Eel\\FlowQueryOperations\\ParentsUntilOperation +:Implementation: Neos\\ContentRepository\\NodeAccess\\FlowQueryOperations\\ParentsUntilOperation :Priority: 100 :Final: No :Returns: void @@ -570,7 +561,7 @@ context elements and returns the immediately preceding sibling. If an optional filter expression is provided, it only returns the node if it matches the given expression. -:Implementation: Neos\\ContentRepository\\Eel\\FlowQueryOperations\\PrevOperation +:Implementation: Neos\\ContentRepository\\NodeAccess\\FlowQueryOperations\\PrevOperation :Priority: 100 :Final: No :Returns: void @@ -588,26 +579,7 @@ prevAll context elements and returns each preceding sibling or only those matching the filter expression specified as optional argument -:Implementation: Neos\\ContentRepository\\Eel\\FlowQueryOperations\\PrevAllOperation -:Priority: 0 -:Final: No -:Returns: void - - - - - -.. _`FlowQuery Operation Reference: prevUntil`: - -prevUntil ---------- - -"prevUntil" operation working on ContentRepository nodes. It iterates over all context elements -and returns each preceding sibling until the matching sibling is found. -If an optional filter expression is provided as a second argument, -it only returns the nodes matching the given expression. - -:Implementation: Neos\\ContentRepository\\Eel\\FlowQueryOperations\\PrevUntilOperation +:Implementation: Neos\\ContentRepository\\NodeAccess\\FlowQueryOperations\\PrevAllOperation :Priority: 0 :Final: No :Returns: void @@ -625,7 +597,7 @@ Used to access properties of a ContentRepository Node. If the property mame is prefixed with _, internal node properties like start time, end time, hidden are accessed. -:Implementation: Neos\\ContentRepository\\Eel\\FlowQueryOperations\\PropertyOperation +:Implementation: Neos\\ContentRepository\\NodeAccess\\FlowQueryOperations\\PropertyOperation :Priority: 100 :Final: Yes :Returns: mixed @@ -654,6 +626,111 @@ element is returned. +.. _`FlowQuery Operation Reference: referenceNodes`: + +referenceNodes +-------------- + +"referenceNodes" operation working on Nodes + +This operation can be used to find the nodes that are referenced from a given node: + + ${q(node).referenceNodes().get()} + +If a referenceName is given as argument only the references for this name are returned + + ${q(node).referenceNodes("someReferenceName").} + + + +:Implementation: Neos\\ContentRepository\\NodeAccess\\FlowQueryOperations\\ReferenceNodesOperation +:Priority: 100 +:Final: No +:Returns: void + + + + + +.. _`FlowQuery Operation Reference: referenceProperty`: + +referenceProperty +----------------- + +Used to access properties of a ContentRepository Reference + +This operation can be used to return the value of a node reference: + + ${q(node).references("someReferenceName").referenceProperty("somePropertyName")} + + + +:Implementation: Neos\\ContentRepository\\NodeAccess\\FlowQueryOperations\\ReferencePropertyOperation +:Priority: 100 +:Final: Yes +:Returns: mixed + + + + + +.. _`FlowQuery Operation Reference: references`: + +references +---------- + +"references" operation working on Nodes + +This operation can be used to find outgoing references for a given node: + + ${q(node).references().get()} + +The result is an array of {@see Reference} instances. + +To render the reference name of the first match: + + $q{node).references().get(0).name.value} + +The {@see ReferencePropertyOperation} can be used to access any property on the reference relation: + + ${q(node).references("someReferenceName").property("somePropertyName")} + + + +:Implementation: Neos\\ContentRepository\\NodeAccess\\FlowQueryOperations\\ReferencesOperation +:Priority: 100 +:Final: No +:Returns: void + + + + + +.. _`FlowQuery Operation Reference: remove`: + +remove +------ + +Removes the given Node from the current context. + +The operation accepts one argument that may be an Array, a FlowQuery +or an Object. + +!!! This is a Node specific implementation of the generic `remove` operation!!! + +The result is an array of {@see Node} instances. + + + +:Implementation: Neos\\ContentRepository\\NodeAccess\\FlowQueryOperations\\RemoveOperation +:Priority: 100 +:Final: No +:Returns: void + + + + + .. _`FlowQuery Operation Reference: remove`: remove @@ -677,7 +754,9 @@ or an Object. search ------ +Custom search operation using the Content Graph fulltext search +Original implementation: \Neos\Neos\Ui\FlowQueryOperations\SearchOperation :Implementation: Neos\\Neos\\Ui\\FlowQueryOperations\\SearchOperation :Priority: 100 @@ -697,7 +776,7 @@ siblings context elements and returns all sibling nodes or only those matching the filter expression specified as optional argument. -:Implementation: Neos\\ContentRepository\\Eel\\FlowQueryOperations\\SiblingsOperation +:Implementation: Neos\\ContentRepository\\NodeAccess\\FlowQueryOperations\\SiblingsOperation :Priority: 100 :Final: No :Returns: void @@ -745,7 +824,8 @@ Third optional argument are the sort options (see https://www.php.net/manual/en/ - 'SORT_NATURAL' - 'SORT_FLAG_CASE' (use as last option with SORT_STRING, SORT_LOCALE_STRING or SORT_NATURAL) A single sort option can be supplied as string. Multiple sort options are supplied as array. -Other than the above listed sort options throw an error. Omitting the third parameter leaves FlowQuery sort() in SORT_REGULAR sort mode. +Other than the above listed sort options throw an error. +Omitting the third parameter leaves FlowQuery sort() in SORT_REGULAR sort mode. Example usages: sort("title", "ASC", ["SORT_NATURAL", "SORT_FLAG_CASE"]) sort("risk", "DESC", "SORT_NUMERIC") @@ -758,3 +838,45 @@ Example usages: + +.. _`FlowQuery Operation Reference: unique`: + +unique +------ + +"unique" operation working on Nodes + +This operation can be used to ensure that nodes are only once in the flow query context + + ${q(node).backReferences().nodes().unique()get()} + +The result is an array of {@see Node} instances. + +!!! This is a Node specific implementation of the generic `unique` operation!!! + + + +:Implementation: Neos\\ContentRepository\\NodeAccess\\FlowQueryOperations\\UniqueOperation +:Priority: 100 +:Final: No +:Returns: void + + + + + +.. _`FlowQuery Operation Reference: unique`: + +unique +------ + +Removes duplicate items from the current context. + +:Implementation: Neos\\Eel\\FlowQuery\\Operations\\UniqueOperation +:Priority: 1 +:Final: No +:Returns: void + + + + diff --git a/Neos.Neos/Documentation/References/Signals/ContentRepository.rst b/Neos.Neos/Documentation/References/Signals/ContentRepository.rst index e358879b510..184cb2d0a6e 100644 --- a/Neos.Neos/Documentation/References/Signals/ContentRepository.rst +++ b/Neos.Neos/Documentation/References/Signals/ContentRepository.rst @@ -3,244 +3,5 @@ Content Repository Signals Reference ==================================== -This reference was automatically generated from code on 2023-06-01 - - -.. _`Content Repository Signals Reference: Context (``Neos\ContentRepository\Domain\Service\Context``)`: - -Context (``Neos\ContentRepository\Domain\Service\Context``) ------------------------------------------------------------ - -This class contains the following signals. - -beforeAdoptNode -^^^^^^^^^^^^^^^ - - - -afterAdoptNode -^^^^^^^^^^^^^^ - - - - - - - - -.. _`Content Repository Signals Reference: Node (``Neos\ContentRepository\Domain\Model\Node``)`: - -Node (``Neos\ContentRepository\Domain\Model\Node``) ---------------------------------------------------- - -This class contains the following signals. - -beforeNodeMove -^^^^^^^^^^^^^^ - - - -afterNodeMove -^^^^^^^^^^^^^ - - - -beforeNodeCopy -^^^^^^^^^^^^^^ - - - -afterNodeCopy -^^^^^^^^^^^^^ - - - -nodePathChanged -^^^^^^^^^^^^^^^ - -Autogenerated Proxy Method - -Signals that the node path has been changed. - -beforeNodeCreate -^^^^^^^^^^^^^^^^ - -Autogenerated Proxy Method - -Signals that a node will be created. - -afterNodeCreate -^^^^^^^^^^^^^^^ - -Autogenerated Proxy Method - -Signals that a node was created. - -nodeAdded -^^^^^^^^^ - -Autogenerated Proxy Method - -Signals that a node was added. - -nodeUpdated -^^^^^^^^^^^ - -Autogenerated Proxy Method - -Signals that a node was updated. - -nodeRemoved -^^^^^^^^^^^ - -Autogenerated Proxy Method - -Signals that a node was removed. - -beforeNodePropertyChange -^^^^^^^^^^^^^^^^^^^^^^^^ - -Autogenerated Proxy Method - -Signals that the property of a node will be changed. - -nodePropertyChanged -^^^^^^^^^^^^^^^^^^^ - -Autogenerated Proxy Method - -Signals that the property of a node was changed. - - - - - - -.. _`Content Repository Signals Reference: NodeData (``Neos\ContentRepository\Domain\Model\NodeData``)`: - -NodeData (``Neos\ContentRepository\Domain\Model\NodeData``) ------------------------------------------------------------ - -This class contains the following signals. - -nodePathChanged -^^^^^^^^^^^^^^^ - -Autogenerated Proxy Method - -Signals that a node has changed its path. - - - - - - -.. _`Content Repository Signals Reference: NodeDataRepository (``Neos\ContentRepository\Domain\Repository\NodeDataRepository``)`: - -NodeDataRepository (``Neos\ContentRepository\Domain\Repository\NodeDataRepository``) ------------------------------------------------------------------------------------- - -This class contains the following signals. - -repositoryObjectsPersisted -^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Autogenerated Proxy Method - -Signals that persistEntities() in this repository finished correctly. - - - - - - -.. _`Content Repository Signals Reference: PaginateController (``Neos\ContentRepository\ViewHelpers\Widget\Controller\PaginateController``)`: - -PaginateController (``Neos\ContentRepository\ViewHelpers\Widget\Controller\PaginateController``) ------------------------------------------------------------------------------------------------- - -This class contains the following signals. - -viewResolved -^^^^^^^^^^^^ - -Autogenerated Proxy Method - -Emit that the view is resolved. The passed ViewInterface reference, -gives the possibility to add variables to the view, -before passing it on to further rendering - - - - - - -.. _`Content Repository Signals Reference: PublishingService (``Neos\ContentRepository\Domain\Service\PublishingService``)`: - -PublishingService (``Neos\ContentRepository\Domain\Service\PublishingService``) -------------------------------------------------------------------------------- - -This class contains the following signals. - -nodePublished -^^^^^^^^^^^^^ - -Autogenerated Proxy Method - -Signals that a node has been published. - -The signal emits the source node and target workspace, i.e. the node contains its source -workspace. - -nodeDiscarded -^^^^^^^^^^^^^ - -Autogenerated Proxy Method - -Signals that a node has been discarded. - -The signal emits the node that has been discarded. - - - - - - -.. _`Content Repository Signals Reference: Workspace (``Neos\ContentRepository\Domain\Model\Workspace``)`: - -Workspace (``Neos\ContentRepository\Domain\Model\Workspace``) -------------------------------------------------------------- - -This class contains the following signals. - -baseWorkspaceChanged -^^^^^^^^^^^^^^^^^^^^ - -Autogenerated Proxy Method - -Emits a signal after the base workspace has been changed - -beforeNodePublishing -^^^^^^^^^^^^^^^^^^^^ - -Autogenerated Proxy Method - -Emits a signal just before a node is being published - -The signal emits the source node and target workspace, i.e. the node contains its source -workspace. - -afterNodePublishing -^^^^^^^^^^^^^^^^^^^ - -Autogenerated Proxy Method - -Emits a signal when a node has been published. - -The signal emits the source node and target workspace, i.e. the node contains its source -workspace. - - - - +This reference was automatically generated from code on 2023-11-22 diff --git a/Neos.Neos/Documentation/References/Signals/Flow.rst b/Neos.Neos/Documentation/References/Signals/Flow.rst index 43a8131de26..4de4dd1388c 100644 --- a/Neos.Neos/Documentation/References/Signals/Flow.rst +++ b/Neos.Neos/Documentation/References/Signals/Flow.rst @@ -3,7 +3,7 @@ Flow Signals Reference ====================== -This reference was automatically generated from code on 2023-05-01 +This reference was automatically generated from code on 2023-11-22 .. _`Flow Signals Reference: AbstractAdvice (``Neos\Flow\Aop\Advice\AbstractAdvice``)`: @@ -35,17 +35,6 @@ This class contains the following signals. viewResolved ^^^^^^^^^^^^ -Autogenerated Proxy Method - -Emit that the view is resolved. The passed ViewInterface reference, -gives the possibility to add variables to the view, -before passing it on to further rendering - -viewResolved -^^^^^^^^^^^^ - -Autogenerated Proxy Method - Emit that the view is resolved. The passed ViewInterface reference, gives the possibility to add variables to the view, before passing it on to further rendering @@ -65,17 +54,6 @@ This class contains the following signals. viewResolved ^^^^^^^^^^^^ -Autogenerated Proxy Method - -Emit that the view is resolved. The passed ViewInterface reference, -gives the possibility to add variables to the view, -before passing it on to further rendering - -viewResolved -^^^^^^^^^^^^ - -Autogenerated Proxy Method - Emit that the view is resolved. The passed ViewInterface reference, gives the possibility to add variables to the view, before passing it on to further rendering @@ -95,8 +73,6 @@ This class contains the following signals. requestDispatched ^^^^^^^^^^^^^^^^^ -Autogenerated Proxy Method - Emits a signal when a Request has been dispatched The action request is not proxyable, so the signal is dispatched manually here. @@ -193,23 +169,17 @@ This class contains the following signals. authenticatedToken ^^^^^^^^^^^^^^^^^^ -Autogenerated Proxy Method - Signals that the specified token has been successfully authenticated. loggedOut ^^^^^^^^^ -Autogenerated Proxy Method - Signals that all active authentication tokens have been invalidated. Note: the session will be destroyed after this signal has been emitted. successfullyAuthenticated ^^^^^^^^^^^^^^^^^^^^^^^^^ -Autogenerated Proxy Method - Signals that authentication commenced and at least one token was authenticated. @@ -273,8 +243,6 @@ This class contains the following signals. warmupCaches ^^^^^^^^^^^^ -Autogenerated Proxy Method - Signals that caches should be warmed up. Other application parts may subscribe to this signal and execute additional @@ -346,15 +314,11 @@ This class contains the following signals. beforeControllerInvocation ^^^^^^^^^^^^^^^^^^^^^^^^^^ -Autogenerated Proxy Method - This signal is emitted directly before the request is been dispatched to a controller. afterControllerInvocation ^^^^^^^^^^^^^^^^^^^^^^^^^ -Autogenerated Proxy Method - This signal is emitted directly after the request has been dispatched to a controller and the controller returned control back to the dispatcher. @@ -431,8 +395,6 @@ This class contains the following signals. allObjectsPersisted ^^^^^^^^^^^^^^^^^^^ -Autogenerated Proxy Method - Signals that all persistAll() has been executed successfully. @@ -450,8 +412,6 @@ This class contains the following signals. configurationLoaded ^^^^^^^^^^^^^^^^^^^ -Autogenerated Proxy Method - Emits a signal when the policy configuration has been loaded This signal can be used to add roles and/or privilegeTargets during runtime. In the slot make sure to receive the @@ -460,8 +420,6 @@ $policyConfiguration array by reference so you can alter it. rolesInitialized ^^^^^^^^^^^^^^^^ -Autogenerated Proxy Method - Emits a signal when roles have been initialized This signal can be used to register roles during runtime. In the slot make sure to receive the $roles array by @@ -482,8 +440,6 @@ This class contains the following signals. viewResolved ^^^^^^^^^^^^ -Autogenerated Proxy Method - Emit that the view is resolved. The passed ViewInterface reference, gives the possibility to add variables to the view, before passing it on to further rendering @@ -523,8 +479,6 @@ This class contains the following signals. viewResolved ^^^^^^^^^^^^ -Autogenerated Proxy Method - Emit that the view is resolved. The passed ViewInterface reference, gives the possibility to add variables to the view, before passing it on to further rendering diff --git a/Neos.Neos/Documentation/References/Signals/Media.rst b/Neos.Neos/Documentation/References/Signals/Media.rst index 3c6e9069be8..02757797882 100644 --- a/Neos.Neos/Documentation/References/Signals/Media.rst +++ b/Neos.Neos/Documentation/References/Signals/Media.rst @@ -3,7 +3,7 @@ Media Signals Reference ======================= -This reference was automatically generated from code on 2023-06-01 +This reference was automatically generated from code on 2023-11-22 .. _`Media Signals Reference: AssetCollectionController (``Neos\Media\Browser\Controller\AssetCollectionController``)`: @@ -16,8 +16,6 @@ This class contains the following signals. viewResolved ^^^^^^^^^^^^ -Autogenerated Proxy Method - Emit that the view is resolved. The passed ViewInterface reference, gives the possibility to add variables to the view, before passing it on to further rendering @@ -37,8 +35,6 @@ This class contains the following signals. viewResolved ^^^^^^^^^^^^ -Autogenerated Proxy Method - Emit that the view is resolved. The passed ViewInterface reference, gives the possibility to add variables to the view, before passing it on to further rendering @@ -58,8 +54,6 @@ This class contains the following signals. viewResolved ^^^^^^^^^^^^ -Autogenerated Proxy Method - Emit that the view is resolved. The passed ViewInterface reference, gives the possibility to add variables to the view, before passing it on to further rendering @@ -79,29 +73,21 @@ This class contains the following signals. assetCreated ^^^^^^^^^^^^ -Autogenerated Proxy Method - Signals that an asset was added. assetRemoved ^^^^^^^^^^^^ -Autogenerated Proxy Method - Signals that an asset was removed. assetUpdated ^^^^^^^^^^^^ -Autogenerated Proxy Method - Signals that an asset was updated. assetResourceReplaced ^^^^^^^^^^^^^^^^^^^^^ -Autogenerated Proxy Method - Signals that a resource on an asset has been replaced Note: when an asset resource is replaced, the assetUpdated signal is sent anyway @@ -122,8 +108,6 @@ This class contains the following signals. viewResolved ^^^^^^^^^^^^ -Autogenerated Proxy Method - Emit that the view is resolved. The passed ViewInterface reference, gives the possibility to add variables to the view, before passing it on to further rendering @@ -143,8 +127,6 @@ This class contains the following signals. viewResolved ^^^^^^^^^^^^ -Autogenerated Proxy Method - Emit that the view is resolved. The passed ViewInterface reference, gives the possibility to add variables to the view, before passing it on to further rendering @@ -164,8 +146,6 @@ This class contains the following signals. viewResolved ^^^^^^^^^^^^ -Autogenerated Proxy Method - Emit that the view is resolved. The passed ViewInterface reference, gives the possibility to add variables to the view, before passing it on to further rendering @@ -185,8 +165,6 @@ This class contains the following signals. viewResolved ^^^^^^^^^^^^ -Autogenerated Proxy Method - Emit that the view is resolved. The passed ViewInterface reference, gives the possibility to add variables to the view, before passing it on to further rendering @@ -206,8 +184,6 @@ This class contains the following signals. viewResolved ^^^^^^^^^^^^ -Autogenerated Proxy Method - Emit that the view is resolved. The passed ViewInterface reference, gives the possibility to add variables to the view, before passing it on to further rendering @@ -227,22 +203,16 @@ This class contains the following signals. thumbnailRefreshed ^^^^^^^^^^^^^^^^^^ -Autogenerated Proxy Method - Signals that a thumbnail was refreshed. thumbnailPersisted ^^^^^^^^^^^^^^^^^^ -Autogenerated Proxy Method - Signals that a thumbnail was persisted. thumbnailCreated ^^^^^^^^^^^^^^^^ -Autogenerated Proxy Method - Signals that a thumbnail was created. @@ -260,8 +230,6 @@ This class contains the following signals. viewResolved ^^^^^^^^^^^^ -Autogenerated Proxy Method - Emit that the view is resolved. The passed ViewInterface reference, gives the possibility to add variables to the view, before passing it on to further rendering diff --git a/Neos.Neos/Documentation/References/Signals/Neos.rst b/Neos.Neos/Documentation/References/Signals/Neos.rst index 172d5bd3552..801a3a1b272 100644 --- a/Neos.Neos/Documentation/References/Signals/Neos.rst +++ b/Neos.Neos/Documentation/References/Signals/Neos.rst @@ -3,26 +3,7 @@ Neos Signals Reference ====================== -This reference was automatically generated from code on 2023-06-01 - - -.. _`Neos Signals Reference: AbstractCreate (``Neos\Neos\Ui\Domain\Model\Changes\AbstractCreate``)`: - -AbstractCreate (``Neos\Neos\Ui\Domain\Model\Changes\AbstractCreate``) ---------------------------------------------------------------------- - -This class contains the following signals. - -nodeCreationHandlersApplied -^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Autogenerated Proxy Method - -Signals, that all changes by node creation handlers are applied - - - - +This reference was automatically generated from code on 2023-11-22 .. _`Neos Signals Reference: AbstractModuleController (``Neos\Neos\Controller\Module\AbstractModuleController``)`: @@ -35,17 +16,6 @@ This class contains the following signals. viewResolved ^^^^^^^^^^^^ -Autogenerated Proxy Method - -Emit that the view is resolved. The passed ViewInterface reference, -gives the possibility to add variables to the view, -before passing it on to further rendering - -viewResolved -^^^^^^^^^^^^ - -Autogenerated Proxy Method - Emit that the view is resolved. The passed ViewInterface reference, gives the possibility to add variables to the view, before passing it on to further rendering @@ -65,8 +35,6 @@ This class contains the following signals. viewResolved ^^^^^^^^^^^^ -Autogenerated Proxy Method - Emit that the view is resolved. The passed ViewInterface reference, gives the possibility to add variables to the view, before passing it on to further rendering @@ -86,8 +54,6 @@ This class contains the following signals. viewResolved ^^^^^^^^^^^^ -Autogenerated Proxy Method - Emit that the view is resolved. The passed ViewInterface reference, gives the possibility to add variables to the view, before passing it on to further rendering @@ -107,8 +73,6 @@ This class contains the following signals. viewResolved ^^^^^^^^^^^^ -Autogenerated Proxy Method - Emit that the view is resolved. The passed ViewInterface reference, gives the possibility to add variables to the view, before passing it on to further rendering @@ -128,8 +92,6 @@ This class contains the following signals. viewResolved ^^^^^^^^^^^^ -Autogenerated Proxy Method - Emit that the view is resolved. The passed ViewInterface reference, gives the possibility to add variables to the view, before passing it on to further rendering @@ -149,8 +111,6 @@ This class contains the following signals. viewResolved ^^^^^^^^^^^^ -Autogenerated Proxy Method - Emit that the view is resolved. The passed ViewInterface reference, gives the possibility to add variables to the view, before passing it on to further rendering @@ -170,8 +130,6 @@ This class contains the following signals. viewResolved ^^^^^^^^^^^^ -Autogenerated Proxy Method - Emit that the view is resolved. The passed ViewInterface reference, gives the possibility to add variables to the view, before passing it on to further rendering @@ -191,8 +149,6 @@ This class contains the following signals. viewResolved ^^^^^^^^^^^^ -Autogenerated Proxy Method - Emit that the view is resolved. The passed ViewInterface reference, gives the possibility to add variables to the view, before passing it on to further rendering @@ -212,8 +168,6 @@ This class contains the following signals. viewResolved ^^^^^^^^^^^^ -Autogenerated Proxy Method - Emit that the view is resolved. The passed ViewInterface reference, gives the possibility to add variables to the view, before passing it on to further rendering @@ -223,28 +177,6 @@ before passing it on to further rendering -.. _`Neos Signals Reference: ContentContext (``Neos\Neos\Domain\Service\ContentContext``)`: - -ContentContext (``Neos\Neos\Domain\Service\ContentContext``) ------------------------------------------------------------- - -This class contains the following signals. - -beforeAdoptNode -^^^^^^^^^^^^^^^ - - - -afterAdoptNode -^^^^^^^^^^^^^^ - - - - - - - - .. _`Neos Signals Reference: ContentController (``Neos\Neos\Controller\Backend\ContentController``)`: ContentController (``Neos\Neos\Controller\Backend\ContentController``) @@ -255,15 +187,11 @@ This class contains the following signals. assetUploaded ^^^^^^^^^^^^^ -Autogenerated Proxy Method - Signals that a new asset has been uploaded through the Neos Backend viewResolved ^^^^^^^^^^^^ -Autogenerated Proxy Method - Emit that the view is resolved. The passed ViewInterface reference, gives the possibility to add variables to the view, before passing it on to further rendering @@ -283,8 +211,6 @@ This class contains the following signals. viewResolved ^^^^^^^^^^^^ -Autogenerated Proxy Method - Emit that the view is resolved. The passed ViewInterface reference, gives the possibility to add variables to the view, before passing it on to further rendering @@ -294,63 +220,6 @@ before passing it on to further rendering -.. _`Neos Signals Reference: Create (``Neos\Neos\Ui\Domain\Model\Changes\Create``)`: - -Create (``Neos\Neos\Ui\Domain\Model\Changes\Create``) ------------------------------------------------------ - -This class contains the following signals. - -nodeCreationHandlersApplied -^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Autogenerated Proxy Method - -Signals, that all changes by node creation handlers are applied - - - - - - -.. _`Neos Signals Reference: CreateAfter (``Neos\Neos\Ui\Domain\Model\Changes\CreateAfter``)`: - -CreateAfter (``Neos\Neos\Ui\Domain\Model\Changes\CreateAfter``) ---------------------------------------------------------------- - -This class contains the following signals. - -nodeCreationHandlersApplied -^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Autogenerated Proxy Method - -Signals, that all changes by node creation handlers are applied - - - - - - -.. _`Neos Signals Reference: CreateBefore (``Neos\Neos\Ui\Domain\Model\Changes\CreateBefore``)`: - -CreateBefore (``Neos\Neos\Ui\Domain\Model\Changes\CreateBefore``) ------------------------------------------------------------------ - -This class contains the following signals. - -nodeCreationHandlersApplied -^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Autogenerated Proxy Method - -Signals, that all changes by node creation handlers are applied - - - - - - .. _`Neos Signals Reference: DataSourceController (``Neos\Neos\Service\Controller\DataSourceController``)`: DataSourceController (``Neos\Neos\Service\Controller\DataSourceController``) @@ -361,8 +230,6 @@ This class contains the following signals. viewResolved ^^^^^^^^^^^^ -Autogenerated Proxy Method - Emit that the view is resolved. The passed ViewInterface reference, gives the possibility to add variables to the view, before passing it on to further rendering @@ -382,8 +249,6 @@ This class contains the following signals. viewResolved ^^^^^^^^^^^^ -Autogenerated Proxy Method - Emit that the view is resolved. The passed ViewInterface reference, gives the possibility to add variables to the view, before passing it on to further rendering @@ -403,8 +268,6 @@ This class contains the following signals. viewResolved ^^^^^^^^^^^^ -Autogenerated Proxy Method - Emit that the view is resolved. The passed ViewInterface reference, gives the possibility to add variables to the view, before passing it on to further rendering @@ -424,8 +287,6 @@ This class contains the following signals. viewResolved ^^^^^^^^^^^^ -Autogenerated Proxy Method - Emit that the view is resolved. The passed ViewInterface reference, gives the possibility to add variables to the view, before passing it on to further rendering @@ -445,8 +306,6 @@ This class contains the following signals. viewResolved ^^^^^^^^^^^^ -Autogenerated Proxy Method - Emit that the view is resolved. The passed ViewInterface reference, gives the possibility to add variables to the view, before passing it on to further rendering @@ -466,8 +325,6 @@ This class contains the following signals. viewResolved ^^^^^^^^^^^^ -Autogenerated Proxy Method - Emit that the view is resolved. The passed ViewInterface reference, gives the possibility to add variables to the view, before passing it on to further rendering @@ -487,29 +344,6 @@ This class contains the following signals. viewResolved ^^^^^^^^^^^^ -Autogenerated Proxy Method - -Emit that the view is resolved. The passed ViewInterface reference, -gives the possibility to add variables to the view, -before passing it on to further rendering - - - - - - -.. _`Neos Signals Reference: NodeController (``Neos\Neos\Service\Controller\NodeController``)`: - -NodeController (``Neos\Neos\Service\Controller\NodeController``) ----------------------------------------------------------------- - -This class contains the following signals. - -viewResolved -^^^^^^^^^^^^ - -Autogenerated Proxy Method - Emit that the view is resolved. The passed ViewInterface reference, gives the possibility to add variables to the view, before passing it on to further rendering @@ -529,8 +363,6 @@ This class contains the following signals. viewResolved ^^^^^^^^^^^^ -Autogenerated Proxy Method - Emit that the view is resolved. The passed ViewInterface reference, gives the possibility to add variables to the view, before passing it on to further rendering @@ -550,8 +382,6 @@ This class contains the following signals. viewResolved ^^^^^^^^^^^^ -Autogenerated Proxy Method - Emit that the view is resolved. The passed ViewInterface reference, gives the possibility to add variables to the view, before passing it on to further rendering @@ -561,37 +391,6 @@ before passing it on to further rendering -.. _`Neos Signals Reference: PublishingService (``Neos\Neos\Service\PublishingService``)`: - -PublishingService (``Neos\Neos\Service\PublishingService``) ------------------------------------------------------------ - -This class contains the following signals. - -nodePublished -^^^^^^^^^^^^^ - -Autogenerated Proxy Method - -Signals that a node has been published. - -The signal emits the source node and target workspace, i.e. the node contains its source -workspace. - -nodeDiscarded -^^^^^^^^^^^^^ - -Autogenerated Proxy Method - -Signals that a node has been discarded. - -The signal emits the node that has been discarded. - - - - - - .. _`Neos Signals Reference: SchemaController (``Neos\Neos\Controller\Backend\SchemaController``)`: SchemaController (``Neos\Neos\Controller\Backend\SchemaController``) @@ -602,8 +401,6 @@ This class contains the following signals. viewResolved ^^^^^^^^^^^^ -Autogenerated Proxy Method - Emit that the view is resolved. The passed ViewInterface reference, gives the possibility to add variables to the view, before passing it on to further rendering @@ -623,8 +420,6 @@ This class contains the following signals. viewResolved ^^^^^^^^^^^^ -Autogenerated Proxy Method - Emit that the view is resolved. The passed ViewInterface reference, gives the possibility to add variables to the view, before passing it on to further rendering @@ -644,8 +439,6 @@ This class contains the following signals. siteChanged ^^^^^^^^^^^ -Autogenerated Proxy Method - Internal signal @@ -653,25 +446,6 @@ Internal signal -.. _`Neos Signals Reference: SiteImportService (``Neos\Neos\Domain\Service\SiteImportService``)`: - -SiteImportService (``Neos\Neos\Domain\Service\SiteImportService``) ------------------------------------------------------------------- - -This class contains the following signals. - -siteImported -^^^^^^^^^^^^ - -Autogenerated Proxy Method - -Signal that is triggered when a site has been imported successfully - - - - - - .. _`Neos Signals Reference: SiteService (``Neos\Neos\Domain\Service\SiteService``)`: SiteService (``Neos\Neos\Domain\Service\SiteService``) @@ -682,8 +456,6 @@ This class contains the following signals. sitePruned ^^^^^^^^^^ -Autogenerated Proxy Method - Signal that is triggered whenever a site has been pruned @@ -701,8 +473,6 @@ This class contains the following signals. viewResolved ^^^^^^^^^^^^ -Autogenerated Proxy Method - Emit that the view is resolved. The passed ViewInterface reference, gives the possibility to add variables to the view, before passing it on to further rendering @@ -722,8 +492,6 @@ This class contains the following signals. viewResolved ^^^^^^^^^^^^ -Autogenerated Proxy Method - Emit that the view is resolved. The passed ViewInterface reference, gives the possibility to add variables to the view, before passing it on to further rendering @@ -743,8 +511,6 @@ This class contains the following signals. viewResolved ^^^^^^^^^^^^ -Autogenerated Proxy Method - Emit that the view is resolved. The passed ViewInterface reference, gives the possibility to add variables to the view, before passing it on to further rendering @@ -764,50 +530,36 @@ This class contains the following signals. userCreated ^^^^^^^^^^^ -Autogenerated Proxy Method - Signals that a new user, including a new account has been created. userDeleted ^^^^^^^^^^^ -Autogenerated Proxy Method - Signals that the given user has been deleted. userUpdated ^^^^^^^^^^^ -Autogenerated Proxy Method - Signals that the given user data has been updated. rolesAdded ^^^^^^^^^^ -Autogenerated Proxy Method - Signals that new roles have been assigned to the given account rolesRemoved ^^^^^^^^^^^^ -Autogenerated Proxy Method - Signals that roles have been removed to the given account userActivated ^^^^^^^^^^^^^ -Autogenerated Proxy Method - Signals that the given user has been activated userDeactivated ^^^^^^^^^^^^^^^ -Autogenerated Proxy Method - Signals that the given user has been activated @@ -825,8 +577,6 @@ This class contains the following signals. viewResolved ^^^^^^^^^^^^ -Autogenerated Proxy Method - Emit that the view is resolved. The passed ViewInterface reference, gives the possibility to add variables to the view, before passing it on to further rendering @@ -846,29 +596,6 @@ This class contains the following signals. viewResolved ^^^^^^^^^^^^ -Autogenerated Proxy Method - -Emit that the view is resolved. The passed ViewInterface reference, -gives the possibility to add variables to the view, -before passing it on to further rendering - - - - - - -.. _`Neos Signals Reference: WorkspaceController (``Neos\Neos\Service\Controller\WorkspaceController``)`: - -WorkspaceController (``Neos\Neos\Service\Controller\WorkspaceController``) --------------------------------------------------------------------------- - -This class contains the following signals. - -viewResolved -^^^^^^^^^^^^ - -Autogenerated Proxy Method - Emit that the view is resolved. The passed ViewInterface reference, gives the possibility to add variables to the view, before passing it on to further rendering @@ -888,29 +615,6 @@ This class contains the following signals. viewResolved ^^^^^^^^^^^^ -Autogenerated Proxy Method - -Emit that the view is resolved. The passed ViewInterface reference, -gives the possibility to add variables to the view, -before passing it on to further rendering - - - - - - -.. _`Neos Signals Reference: WorkspacesController (``Neos\Neos\Controller\Service\WorkspacesController``)`: - -WorkspacesController (``Neos\Neos\Controller\Service\WorkspacesController``) ----------------------------------------------------------------------------- - -This class contains the following signals. - -viewResolved -^^^^^^^^^^^^ - -Autogenerated Proxy Method - Emit that the view is resolved. The passed ViewInterface reference, gives the possibility to add variables to the view, before passing it on to further rendering diff --git a/Neos.Neos/Documentation/References/Validators/Flow.rst b/Neos.Neos/Documentation/References/Validators/Flow.rst index cd4a15ef7ba..5f767422785 100644 --- a/Neos.Neos/Documentation/References/Validators/Flow.rst +++ b/Neos.Neos/Documentation/References/Validators/Flow.rst @@ -3,7 +3,7 @@ Flow Validator Reference ======================== -This reference was automatically generated from code on 2023-05-01 +This reference was automatically generated from code on 2023-11-22 .. _`Flow Validator Reference: AggregateBoundaryValidator`: diff --git a/Neos.Neos/Documentation/References/Validators/Media.rst b/Neos.Neos/Documentation/References/Validators/Media.rst index e9882ea290b..96e7a7d05b1 100644 --- a/Neos.Neos/Documentation/References/Validators/Media.rst +++ b/Neos.Neos/Documentation/References/Validators/Media.rst @@ -3,7 +3,7 @@ Media Validator Reference ========================= -This reference was automatically generated from code on 2023-05-01 +This reference was automatically generated from code on 2023-11-22 .. _`Media Validator Reference: ImageOrientationValidator`: diff --git a/Neos.Neos/Documentation/References/Validators/Party.rst b/Neos.Neos/Documentation/References/Validators/Party.rst index 209f42baec4..cc0bbb015c9 100644 --- a/Neos.Neos/Documentation/References/Validators/Party.rst +++ b/Neos.Neos/Documentation/References/Validators/Party.rst @@ -3,7 +3,7 @@ Party Validator Reference ========================= -This reference was automatically generated from code on 2023-05-01 +This reference was automatically generated from code on 2023-11-22 .. _`Party Validator Reference: AimAddressValidator`: diff --git a/Neos.Neos/Documentation/References/ViewHelpers/ContentRepository.rst b/Neos.Neos/Documentation/References/ViewHelpers/ContentRepository.rst index 5b95b147e82..271a5eeab15 100644 --- a/Neos.Neos/Documentation/References/ViewHelpers/ContentRepository.rst +++ b/Neos.Neos/Documentation/References/ViewHelpers/ContentRepository.rst @@ -3,6 +3,6 @@ Content Repository ViewHelper Reference ####################################### -This reference was automatically generated from code on 2023-05-01 +This reference was automatically generated from code on 2023-11-22 diff --git a/Neos.Neos/Documentation/References/ViewHelpers/FluidAdaptor.rst b/Neos.Neos/Documentation/References/ViewHelpers/FluidAdaptor.rst index 735234dcc58..9adf63463a5 100644 --- a/Neos.Neos/Documentation/References/ViewHelpers/FluidAdaptor.rst +++ b/Neos.Neos/Documentation/References/ViewHelpers/FluidAdaptor.rst @@ -3,7 +3,7 @@ FluidAdaptor ViewHelper Reference ################################# -This reference was automatically generated from code on 2023-05-01 +This reference was automatically generated from code on 2023-11-22 .. _`FluidAdaptor ViewHelper Reference: f:debug`: @@ -2167,9 +2167,9 @@ Examples Header Footer - + <-- in the outer template, using the widget --> - + Foo: {foo} diff --git a/Neos.Neos/Documentation/References/ViewHelpers/Form.rst b/Neos.Neos/Documentation/References/ViewHelpers/Form.rst index 90ce1be51a9..40d843d305b 100644 --- a/Neos.Neos/Documentation/References/ViewHelpers/Form.rst +++ b/Neos.Neos/Documentation/References/ViewHelpers/Form.rst @@ -3,7 +3,7 @@ Form ViewHelper Reference ######################### -This reference was automatically generated from code on 2023-05-01 +This reference was automatically generated from code on 2023-11-22 .. _`Form ViewHelper Reference: neos.form:form`: diff --git a/Neos.Neos/Documentation/References/ViewHelpers/Fusion.rst b/Neos.Neos/Documentation/References/ViewHelpers/Fusion.rst index f02ed9e8ec5..09d99ff628a 100644 --- a/Neos.Neos/Documentation/References/ViewHelpers/Fusion.rst +++ b/Neos.Neos/Documentation/References/ViewHelpers/Fusion.rst @@ -3,7 +3,7 @@ Fusion ViewHelper Reference ########################### -This reference was automatically generated from code on 2023-05-01 +This reference was automatically generated from code on 2023-11-22 .. _`Fusion ViewHelper Reference: fusion:render`: diff --git a/Neos.Neos/Documentation/References/ViewHelpers/Media.rst b/Neos.Neos/Documentation/References/ViewHelpers/Media.rst index df696b062d6..99060d002d5 100644 --- a/Neos.Neos/Documentation/References/ViewHelpers/Media.rst +++ b/Neos.Neos/Documentation/References/ViewHelpers/Media.rst @@ -3,7 +3,7 @@ Media ViewHelper Reference ########################## -This reference was automatically generated from code on 2023-05-01 +This reference was automatically generated from code on 2023-11-22 .. _`Media ViewHelper Reference: neos.media:fileTypeIcon`: diff --git a/Neos.Neos/Documentation/References/ViewHelpers/Neos.rst b/Neos.Neos/Documentation/References/ViewHelpers/Neos.rst index 1d9bf73d4cb..f00b48665ec 100644 --- a/Neos.Neos/Documentation/References/ViewHelpers/Neos.rst +++ b/Neos.Neos/Documentation/References/ViewHelpers/Neos.rst @@ -3,7 +3,7 @@ Neos ViewHelper Reference ######################### -This reference was automatically generated from code on 2023-05-01 +This reference was automatically generated from code on 2023-11-22 .. _`Neos ViewHelper Reference: neos:backend.authenticationProviderLabel`: @@ -762,13 +762,6 @@ ViewHelper to find out if Neos is rendering the backend. -Arguments -********* - -* ``node`` (Neos\ContentRepository\Core\Projection\ContentGraph\Node, *optional*): Node - - - Examples ******** @@ -807,8 +800,6 @@ ViewHelper to find out if Neos is rendering an edit mode. Arguments ********* -* ``node`` (Neos\ContentRepository\Core\Projection\ContentGraph\Node, *optional*): Optional Node to use context from - * ``mode`` (string, *optional*): Optional rendering mode name to check if this specific mode is active @@ -868,8 +859,6 @@ ViewHelper to find out if Neos is rendering a preview mode. Arguments ********* -* ``node`` (Neos\ContentRepository\Core\Projection\ContentGraph\Node, *optional*): Optional Node to use context from - * ``mode`` (string, *optional*): Optional rendering mode name to check if this specific mode is active @@ -928,13 +917,6 @@ the ViewHelper or have "node" set as template variable at least. -Arguments -********* - -* ``node`` (Neos\ContentRepository\Core\Projection\ContentGraph\Node, *optional*): Node - - - Examples ******** diff --git a/Neos.Neos/Documentation/References/ViewHelpers/TYPO3Fluid.rst b/Neos.Neos/Documentation/References/ViewHelpers/TYPO3Fluid.rst index 71d34adfa32..b91423b23ad 100644 --- a/Neos.Neos/Documentation/References/ViewHelpers/TYPO3Fluid.rst +++ b/Neos.Neos/Documentation/References/ViewHelpers/TYPO3Fluid.rst @@ -3,7 +3,7 @@ TYPO3 Fluid ViewHelper Reference ################################ -This reference was automatically generated from code on 2023-05-01 +This reference was automatically generated from code on 2023-11-22 .. _`TYPO3 Fluid ViewHelper Reference: f:alias`: @@ -109,7 +109,7 @@ Container tag Some output or Fluid code - + Additional output is also not compilable because of the ViewHelper @@ -277,7 +277,7 @@ Exception if it contains syntax errors. You can put child nodes in CDATA tags to avoid this. Using this ViewHelper won't have a notable effect on performance, -especially once the template is parsed. However it can lead to reduced +especially once the template is parsed. However, it can lead to reduced readability. You can use layouts and partials to split a large template into smaller parts. Using self-descriptive names for the partials can make comments redundant. @@ -617,7 +617,7 @@ Arguments * ``reverse`` (boolean, *optional*): If TRUE, iterates in reverse -* ``iteration`` (string, *optional*): The name of the variable to store iteration information (index, cycle, isFirst, isLast, isEven, isOdd) +* ``iteration`` (string, *optional*): The name of the variable to store iteration information (index, cycle, total, isFirst, isLast, isEven, isOdd) @@ -1141,7 +1141,27 @@ Arguments f:or ---- -If content is empty use alternative text +Or ViewHelper + +If content is null use alternative text. + +Usage of f:or +============= + +:: + + {f:variable(name:'fallback',value:'this is not the variable you\'re looking for')} + {undefinedVariable -> f:or(alternative:fallback)} + +Usage of ternary operator +========================= + +In some cases (e.g. when you want to check for empty instead of null) +it might be more handy to use a ternary operator instead of f:or + +:: + + {emptyVariable ?: 'this is an alterative text'} :Implementation: TYPO3Fluid\\Fluid\\ViewHelpers\\OrViewHelper @@ -1151,9 +1171,9 @@ If content is empty use alternative text Arguments ********* -* ``content`` (mixed, *optional*): Content to check if empty +* ``content`` (mixed, *optional*): Content to check if null -* ``alternative`` (mixed, *optional*): Alternative if content is empty +* ``alternative`` (mixed, *optional*): Alternative if content is null * ``arguments`` (array, *optional*): Arguments to be replaced in the resulting string, using sprintf @@ -1268,8 +1288,6 @@ Arguments * ``delegate`` (string, *optional*): Optional PHP class name of a permanent, included-in-app ParsedTemplateInterface implementation to override partial/section -* ``renderable`` (TYPO3Fluid\Fluid\Core\Rendering\RenderableInterface, *optional*): Instance of a RenderableInterface implementation to be rendered - * ``arguments`` (array, *optional*): Array of variables to be transferred. Use {_all} for all variables * ``optional`` (boolean, *optional*): If TRUE, considers the *section* optional. Partial never is.