Skip to content

Commit

Permalink
TASK: Update references
Browse files Browse the repository at this point in the history
  • Loading branch information
Jenkins committed Aug 10, 2018
1 parent c3ca281 commit a7fa13b
Show file tree
Hide file tree
Showing 16 changed files with 735 additions and 293 deletions.
396 changes: 383 additions & 13 deletions Documentation/References/EelHelpersReference.rst

Large diffs are not rendered by default.

95 changes: 82 additions & 13 deletions Documentation/References/FlowQueryOperationReference.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,17 @@
FlowQuery Operation Reference
=============================

This reference was automatically generated from code on 2017-05-11
This reference was automatically generated from code on 2018-08-10


.. _`FlowQuery Operation Reference: add`:

add
---

Add another $flowQuery object to the current one.
Adds the given items to the current context.
The operation accepts one argument that may be an Array, a FlowQuery
or an Object.

:Implementation: Neos\\Eel\\FlowQuery\\Operations\\AddOperation
:Priority: 1
Expand Down Expand Up @@ -362,6 +364,40 @@ Get the last element inside the context.



.. _`FlowQuery Operation Reference: neosUiDefaultNodes`:

neosUiDefaultNodes
------------------

Fetches all nodes needed for the given state of the UI

:Implementation: Neos\\Neos\\Ui\\FlowQueryOperations\\NeosUiDefaultNodesOperation
:Priority: 100
:Final: No
:Returns: void





.. _`FlowQuery Operation Reference: neosUiFilteredChildren`:

neosUiFilteredChildren
----------------------

"children" operation working on ContentRepository nodes. It iterates over all
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
:Final: No
:Returns: void





.. _`FlowQuery Operation Reference: next`:

next
Expand Down Expand Up @@ -566,6 +602,24 @@ it only returns the nodes matching the given expression.



.. _`FlowQuery Operation Reference: property`:

property
--------

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
:Priority: 100
:Final: Yes
:Returns: mixed





.. _`FlowQuery Operation Reference: property`:

property
Expand All @@ -586,19 +640,35 @@ element is returned.



.. _`FlowQuery Operation Reference: property`:
.. _`FlowQuery Operation Reference: remove`:

property
--------
remove
------

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.
Removes the given items from the current context.
The operation accepts one argument that may be an Array, a FlowQuery
or an Object.

:Implementation: Neos\\ContentRepository\\Eel\\FlowQueryOperations\\PropertyOperation
:Implementation: Neos\\Eel\\FlowQuery\\Operations\\RemoveOperation
:Priority: 1
:Final: No
:Returns: void





.. _`FlowQuery Operation Reference: search`:

search
------



:Implementation: Neos\\Neos\\Ui\\FlowQueryOperations\\SearchOperation
:Priority: 100
:Final: Yes
:Returns: mixed
:Final: No
:Returns: void



Expand Down Expand Up @@ -630,8 +700,7 @@ slice
Slice the current context

If no arguments are given, the full context is returned. Otherwise the
values contained in the context are sliced from begin given as the first
argument to an optional end in the second argument.
value contained in the context are sliced with offset and length.

:Implementation: Neos\\Eel\\FlowQuery\\Operations\\SliceOperation
:Priority: 1
Expand Down
2 changes: 1 addition & 1 deletion Documentation/References/Signals/ContentRepository.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Content Repository Signals Reference
====================================

This reference was automatically generated from code on 2017-03-30
This reference was automatically generated from code on 2018-08-10


.. _`Content Repository Signals Reference: Context (``Neos\ContentRepository\Domain\Service\Context``)`:
Expand Down
4 changes: 2 additions & 2 deletions Documentation/References/Signals/Flow.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Flow Signals Reference
======================

This reference was automatically generated from code on 2017-05-11
This reference was automatically generated from code on 2018-08-10


.. _`Flow Signals Reference: AbstractAdvice (``Neos\Flow\Aop\Advice\AbstractAdvice``)`:
Expand Down Expand Up @@ -330,7 +330,7 @@ This class contains the following signals.
packageStatesUpdated
^^^^^^^^^^^^^^^^^^^^

Emits a signal when package states have been changed (e.g. when a package was created or activated)
Emits a signal when package states have been changed (e.g. when a package was created)

The advice is not proxyable, so the signal is dispatched manually here.

Expand Down
2 changes: 1 addition & 1 deletion Documentation/References/Signals/Media.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Media Signals Reference
=======================

This reference was automatically generated from code on 2017-03-30
This reference was automatically generated from code on 2018-08-10


.. _`Media Signals Reference: Asset (``Neos\Media\Domain\Model\Asset``)`:
Expand Down
87 changes: 86 additions & 1 deletion Documentation/References/Signals/Neos.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,24 @@
Neos Signals Reference
======================

This reference was automatically generated from code on 2017-03-30
This reference was automatically generated from code on 2018-08-10


.. _`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






.. _`Neos Signals Reference: ContentContext (``Neos\Neos\Domain\Service\ContentContext``)`:
Expand All @@ -28,6 +45,74 @@ Autogenerated Proxy Method



.. _`Neos Signals Reference: ContentController (``Neos\Neos\Controller\Backend\ContentController``)`:
ContentController (``Neos\Neos\Controller\Backend\ContentController``)
----------------------------------------------------------------------

This class contains the following signals.

assetUploaded
^^^^^^^^^^^^^

Autogenerated Proxy Method






.. _`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






.. _`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






.. _`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






.. _`Neos Signals Reference: PublishingService (``Neos\Neos\Service\PublishingService``)`:
PublishingService (``Neos\Neos\Service\PublishingService``)
Expand Down
2 changes: 1 addition & 1 deletion Documentation/References/Validators/Flow.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Flow Validator Reference
========================

This reference was automatically generated from code on 2017-03-30
This reference was automatically generated from code on 2018-08-10


.. _`Flow Validator Reference: AggregateBoundaryValidator`:
Expand Down
2 changes: 1 addition & 1 deletion Documentation/References/Validators/Media.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Media Validator Reference
=========================

This reference was automatically generated from code on 2017-03-30
This reference was automatically generated from code on 2018-08-10


.. _`Media Validator Reference: ImageOrientationValidator`:
Expand Down
2 changes: 1 addition & 1 deletion Documentation/References/Validators/Party.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Party Validator Reference
=========================

This reference was automatically generated from code on 2017-03-30
This reference was automatically generated from code on 2018-08-10


.. _`Party Validator Reference: AimAddressValidator`:
Expand Down
2 changes: 1 addition & 1 deletion Documentation/References/ViewHelpers/ContentRepository.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Content Repository ViewHelper Reference
=======================================

This reference was automatically generated from code on 2017-03-30
This reference was automatically generated from code on 2018-08-10


.. _`Content Repository ViewHelper Reference: PaginateViewHelper`:
Expand Down

0 comments on commit a7fa13b

Please sign in to comment.