Skip to content

Commit

Permalink
TASK: Declare public api in php classes
Browse files Browse the repository at this point in the history
NONE. Nearly. But what is this? A small village ...
  • Loading branch information
mhsdesign committed Jan 30, 2024
1 parent d36a006 commit 65fbd3b
Show file tree
Hide file tree
Showing 74 changed files with 180 additions and 1 deletion.
1 change: 1 addition & 0 deletions Classes/ContentRepository/Service/WorkspaceService.php
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@
use Neos\Neos\Utility\NodeTypeWithFallbackProvider;

/**
* @internal
* @Flow\Scope("singleton")
*/
class WorkspaceService
Expand Down
3 changes: 3 additions & 0 deletions Classes/Controller/BackendController.php
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,9 @@
use Neos\Neos\Ui\Domain\InitialData\RoutesProviderInterface;
use Neos\Neos\Ui\Presentation\ApplicationView;

/**
* @internal
*/
class BackendController extends ActionController
{
/**
Expand Down
1 change: 1 addition & 0 deletions Classes/Controller/BackendControllerInternals.php
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@

/**
* @deprecated really un-nice :D
* @internal
*/
class BackendControllerInternals implements ContentRepositoryServiceInterface
{
Expand Down
1 change: 1 addition & 0 deletions Classes/Controller/BackendControllerInternalsFactory.php
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@
/**
* @deprecated
* @implements ContentRepositoryServiceFactoryInterface<BackendControllerInternals>
* @internal
*/
class BackendControllerInternalsFactory implements ContentRepositoryServiceFactoryInterface
{
Expand Down
3 changes: 3 additions & 0 deletions Classes/Controller/BackendServiceController.php
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,9 @@
use Neos\Neos\Ui\TypeConverter\ChangeCollectionConverter;
use Neos\Neos\Utility\NodeUriPathSegmentGenerator;

/**
* @internal
*/
class BackendServiceController extends ActionController
{
use TranslationTrait;
Expand Down
1 change: 1 addition & 0 deletions Classes/Controller/TranslationTrait.php
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@

/**
* A trait to do easy backend module translations
* @internal
*/
trait TranslationTrait
{
Expand Down
3 changes: 3 additions & 0 deletions Classes/Domain/Model/AbstractChange.php
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,9 @@
use Neos\Neos\Ui\Domain\Model\Feedback\Operations\UpdateWorkspaceInfo;
use Neos\Neos\Utility\NodeTypeWithFallbackProvider;

/**
* @internal
*/
abstract class AbstractChange implements ChangeInterface
{
use NodeTypeWithFallbackProvider;
Expand Down
3 changes: 3 additions & 0 deletions Classes/Domain/Model/AbstractFeedback.php
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,9 @@

use Neos\Flow\Mvc\Controller\ControllerContext;

/**
* @internal
*/
abstract class AbstractFeedback implements FeedbackInterface
{
/** @return array<string, mixed> */
Expand Down
1 change: 1 addition & 0 deletions Classes/Domain/Model/ChangeCollection.php
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@

/**
* A collection of changes
* @internal
*/
class ChangeCollection
{
Expand Down
1 change: 1 addition & 0 deletions Classes/Domain/Model/ChangeInterface.php
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@

/**
* An interface to describe a change
* @internal
*/
interface ChangeInterface
{
Expand Down
5 changes: 5 additions & 0 deletions Classes/Domain/Model/Changes/AbstractCreate.php
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,11 @@
use Neos\Neos\Ui\NodeCreationHandler\NodeCreationHandlerInterface;
use Neos\Utility\PositionalArraySorter;

/**
* @internal These objects internally reflect possible operations made by the Neos.Ui.
* They are sorely an implementation detail. You should not use them!
* Please look into the php command API of the Neos CR instead.
*/
abstract class AbstractCreate extends AbstractStructuralChange
{
/**
Expand Down
3 changes: 3 additions & 0 deletions Classes/Domain/Model/Changes/AbstractStructuralChange.php
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,9 @@

/**
* A change that performs structural actions like moving or creating nodes
* @internal These objects internally reflect possible operations made by the Neos.Ui.
* They are sorely an implementation detail. You should not use them!
* Please look into the php command API of the Neos CR instead.
*/
abstract class AbstractStructuralChange extends AbstractChange
{
Expand Down
5 changes: 5 additions & 0 deletions Classes/Domain/Model/Changes/CopyAfter.php
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,11 @@
use Neos\ContentRepository\Core\Projection\ContentGraph\VisibilityConstraints;
use Neos\ContentRepository\Core\SharedModel\Node\NodeName;

/**
* @internal These objects internally reflect possible operations made by the Neos.Ui.
* They are sorely an implementation detail. You should not use them!
* Please look into the php command API of the Neos CR instead.
*/
class CopyAfter extends AbstractStructuralChange
{
/**
Expand Down
5 changes: 5 additions & 0 deletions Classes/Domain/Model/Changes/CopyBefore.php
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,11 @@
use Neos\ContentRepository\Core\Feature\NodeDuplication\Command\CopyNodesRecursively;
use Neos\ContentRepository\Core\SharedModel\Node\NodeName;

/**
* @internal These objects internally reflect possible operations made by the Neos.Ui.
* They are sorely an implementation detail. You should not use them!
* Please look into the php command API of the Neos CR instead.
*/
class CopyBefore extends AbstractStructuralChange
{
/**
Expand Down
5 changes: 5 additions & 0 deletions Classes/Domain/Model/Changes/CopyInto.php
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,11 @@
use Neos\ContentRepository\Core\Projection\ContentGraph\Node;
use Neos\ContentRepository\Core\SharedModel\Node\NodeName;

/**
* @internal These objects internally reflect possible operations made by the Neos.Ui.
* They are sorely an implementation detail. You should not use them!
* Please look into the php command API of the Neos CR instead.
*/
class CopyInto extends AbstractStructuralChange
{
protected ?string $parentContextPath;
Expand Down
5 changes: 5 additions & 0 deletions Classes/Domain/Model/Changes/Create.php
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,11 @@
* source code.
*/

/**
* @internal These objects internally reflect possible operations made by the Neos.Ui.
* They are sorely an implementation detail. You should not use them!
* Please look into the php command API of the Neos CR instead.
*/
class Create extends AbstractCreate
{
public function setParentContextPath(string $parentContextPath): void
Expand Down
5 changes: 5 additions & 0 deletions Classes/Domain/Model/Changes/CreateAfter.php
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,11 @@
* source code.
*/

/**
* @internal These objects internally reflect possible operations made by the Neos.Ui.
* They are sorely an implementation detail. You should not use them!
* Please look into the php command API of the Neos CR instead.
*/
class CreateAfter extends AbstractCreate
{
/**
Expand Down
6 changes: 5 additions & 1 deletion Classes/Domain/Model/Changes/CreateBefore.php
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,11 @@
* source code.
*/


/**
* @internal These objects internally reflect possible operations made by the Neos.Ui.
* They are sorely an implementation detail. You should not use them!
* Please look into the php command API of the Neos CR instead.
*/
class CreateBefore extends AbstractCreate
{
/**
Expand Down
5 changes: 5 additions & 0 deletions Classes/Domain/Model/Changes/MoveAfter.php
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,11 @@
use Neos\Neos\Ui\Domain\Model\Feedback\Operations\RemoveNode;
use Neos\Neos\Ui\Domain\Model\Feedback\Operations\UpdateNodeInfo;

/**
* @internal These objects internally reflect possible operations made by the Neos.Ui.
* They are sorely an implementation detail. You should not use them!
* Please look into the php command API of the Neos CR instead.
*/
class MoveAfter extends AbstractStructuralChange
{
/**
Expand Down
5 changes: 5 additions & 0 deletions Classes/Domain/Model/Changes/MoveBefore.php
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,11 @@
use Neos\Neos\Ui\Domain\Model\Feedback\Operations\RemoveNode;
use Neos\Neos\Ui\Domain\Model\Feedback\Operations\UpdateNodeInfo;

/**
* @internal These objects internally reflect possible operations made by the Neos.Ui.
* They are sorely an implementation detail. You should not use them!
* Please look into the php command API of the Neos CR instead.
*/
class MoveBefore extends AbstractStructuralChange
{
/**
Expand Down
5 changes: 5 additions & 0 deletions Classes/Domain/Model/Changes/MoveInto.php
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,11 @@
use Neos\Neos\Ui\Domain\Model\Feedback\Operations\RemoveNode;
use Neos\Neos\Ui\Domain\Model\Feedback\Operations\UpdateNodeInfo;

/**
* @internal These objects internally reflect possible operations made by the Neos.Ui.
* They are sorely an implementation detail. You should not use them!
* Please look into the php command API of the Neos CR instead.
*/
class MoveInto extends AbstractStructuralChange
{
protected ?string $parentContextPath;
Expand Down
3 changes: 3 additions & 0 deletions Classes/Domain/Model/Changes/Property.php
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,9 @@

/**
* Changes a property on a node
* @internal These objects internally reflect possible operations made by the Neos.Ui.
* They are sorely an implementation detail. You should not use them!
* Please look into the php command API of the Neos CR instead.
*/
class Property extends AbstractChange
{
Expand Down
3 changes: 3 additions & 0 deletions Classes/Domain/Model/Changes/Remove.php
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,9 @@

/**
* Removes a node
* @internal These objects internally reflect possible operations made by the Neos.Ui.
* They are sorely an implementation detail. You should not use them!
* Please look into the php command API of the Neos CR instead.
*/
class Remove extends AbstractChange
{
Expand Down
3 changes: 3 additions & 0 deletions Classes/Domain/Model/Feedback/AbstractMessageFeedback.php
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,9 @@
use Neos\Neos\Ui\Domain\Model\AbstractFeedback;
use Neos\Neos\Ui\Domain\Model\FeedbackInterface;

/**
* @internal
*/
abstract class AbstractMessageFeedback extends AbstractFeedback
{
/**
Expand Down
3 changes: 3 additions & 0 deletions Classes/Domain/Model/Feedback/Messages/Error.php
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,9 @@

use Neos\Neos\Ui\Domain\Model\Feedback\AbstractMessageFeedback;

/**
* @internal
*/
class Error extends AbstractMessageFeedback
{
/**
Expand Down
3 changes: 3 additions & 0 deletions Classes/Domain/Model/Feedback/Messages/Info.php
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,9 @@

use Neos\Neos\Ui\Domain\Model\Feedback\AbstractMessageFeedback;

/**
* @internal
*/
class Info extends AbstractMessageFeedback
{
/**
Expand Down
3 changes: 3 additions & 0 deletions Classes/Domain/Model/Feedback/Messages/Success.php
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,9 @@

use Neos\Neos\Ui\Domain\Model\Feedback\AbstractMessageFeedback;

/**
* @internal
*/
class Success extends AbstractMessageFeedback
{
/**
Expand Down
3 changes: 3 additions & 0 deletions Classes/Domain/Model/Feedback/Operations/NodeCreated.php
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,9 @@
use Neos\Neos\Ui\Domain\Model\FeedbackInterface;
use Neos\Neos\Utility\NodeTypeWithFallbackProvider;

/**
* @internal
*/
class NodeCreated extends AbstractFeedback
{
use NodeTypeWithFallbackProvider;
Expand Down
3 changes: 3 additions & 0 deletions Classes/Domain/Model/Feedback/Operations/Redirect.php
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,9 @@
use Neos\Neos\Ui\Domain\Model\AbstractFeedback;
use Neos\Neos\Ui\Domain\Model\FeedbackInterface;

/**
* @internal
*/
class Redirect extends AbstractFeedback
{
/**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,9 @@
use Neos\Neos\Ui\View\OutOfBandRenderingViewFactory;
use Psr\Http\Message\ResponseInterface;

/**
* @internal
*/
class ReloadContentOutOfBand extends AbstractFeedback
{
protected ?Node $node = null;
Expand Down
3 changes: 3 additions & 0 deletions Classes/Domain/Model/Feedback/Operations/ReloadDocument.php
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,9 @@
use Neos\Neos\Ui\Domain\Model\FeedbackInterface;
use Neos\Neos\Ui\Fusion\Helper\NodeInfoHelper;

/**
* @internal
*/
class ReloadDocument extends AbstractFeedback
{
protected ?Node $node = null;
Expand Down
3 changes: 3 additions & 0 deletions Classes/Domain/Model/Feedback/Operations/RemoveNode.php
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,9 @@
use Neos\Neos\Ui\Domain\Model\AbstractFeedback;
use Neos\Neos\Ui\Domain\Model\FeedbackInterface;

/**
* @internal
*/
class RemoveNode extends AbstractFeedback
{
protected Node $node;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,9 @@
use Neos\Neos\Ui\View\OutOfBandRenderingViewFactory;
use Psr\Http\Message\ResponseInterface;

/**
* @internal
*/
class RenderContentOutOfBand extends AbstractFeedback
{
protected ?Node $node = null;
Expand Down
3 changes: 3 additions & 0 deletions Classes/Domain/Model/Feedback/Operations/UpdateNodeInfo.php
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,9 @@
use Neos\Neos\Ui\Domain\Model\FeedbackInterface;
use Neos\Neos\Ui\Fusion\Helper\NodeInfoHelper;

/**
* @internal
*/
class UpdateNodeInfo extends AbstractFeedback
{
protected ?Node $node = null;
Expand Down
3 changes: 3 additions & 0 deletions Classes/Domain/Model/Feedback/Operations/UpdateNodePath.php
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,9 @@
use Neos\Neos\Ui\Domain\Model\AbstractFeedback;
use Neos\Neos\Ui\Domain\Model\FeedbackInterface;

/**
* @internal
*/
class UpdateNodePath extends AbstractFeedback
{
/**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,9 @@
use Neos\Neos\Ui\Domain\Model\FeedbackInterface;
use Neos\Neos\Ui\Fusion\Helper\NodeInfoHelper;

/**
* @internal
*/
class UpdateNodePreviewUrl extends AbstractFeedback
{
/**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,9 @@
use Neos\Neos\Ui\Domain\Model\FeedbackInterface;
use Neos\Flow\Mvc\Controller\ControllerContext;

/**
* @internal
*/
class UpdateWorkspaceInfo extends AbstractFeedback
{
protected ?WorkspaceName $workspaceName = null;
Expand Down
1 change: 1 addition & 0 deletions Classes/Domain/Model/FeedbackCollection.php
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@

/**
* @Flow\Scope("singleton")
* @internal
*/
class FeedbackCollection implements \JsonSerializable
{
Expand Down
3 changes: 3 additions & 0 deletions Classes/Domain/Model/FeedbackInterface.php
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,9 @@

use Neos\Flow\Mvc\Controller\ControllerContext;

/**
* @internal
*/
interface FeedbackInterface
{
/**
Expand Down
Loading

0 comments on commit 65fbd3b

Please sign in to comment.