event-store-client

(★ 115)

PHP Event Store Client Implementation

File Explorer

Download Latest Version (.zip)

- - ci.yml
- dependabot.yml
- - docker-compose.yml
- - common-variables.env
  - docker-compose.yml
- - docker-compose.yml
  - README.md
- demo-cluster.php
- demo-persistent-subscription.php
- demo-read-with-logger.php
- demo-read.php
- demo-subscribe-to-all-from.php
- demo-subscribe-to-all.php
- demo-subscribe-to-stream-from-with-logger.php
- demo-subscribe-to-stream-from.php
- demo-subscribe-to-stream.php
- ClientMessageDtos.php
- - AbstractOperation.php
  - AbstractSubscriptionOperation.php
  - AppendToStreamOperation.php
  - ClientOperation.php
  - CommitTransactionOperation.php
  - ConditionalAppendToStreamOperation.php
  - ConnectToPersistentSubscriptionOperation.php
  - CreatePersistentSubscriptionOperation.php
  - DeletePersistentSubscriptionOperation.php
  - DeleteStreamOperation.php
  - ReadAllEventsBackwardOperation.php
  - ReadAllEventsForwardOperation.php
  - ReadEventOperation.php
  - ReadStreamEventsBackwardOperation.php
  - ReadStreamEventsForwardOperation.php
  - StartTransactionOperation.php
  - SubscriptionOperation.php
  - TransactionalWriteOperation.php
  - UpdatePersistentSubscriptionOperation.php
  - VolatileSubscriptionOperation.php
- - ClusterException.php
  - PackageFramingException.php
  - PersistentSubscriptionCommandFailed.php
  - ProjectionCommandConflict.php
  - ProjectionCommandFailed.php
  - UserCommandConflict.php
  - UserCommandFailed.php
- - AuthInfo.php
  - ClusterDnsEndPointDiscoverer.php
  - ConnectingPhase.php
  - ConnectionState.php
  - EndPointDiscoverer.php
  - EventMessageConverter.php
  - EventStoreAllCatchUpSubscription.php
  - EventStoreCatchUpSubscription.php
  - EventStoreConnectionLogicHandler.php
  - EventStoreNodeConnection.php
  - EventStorePersistentSubscription.php
  - EventStoreStreamCatchUpSubscription.php
  - HeartbeatInfo.php
  - IdentifyInfo.php
  - MessageHandler.php
  - NewEventConverter.php
  - NodeEndPoints.php
  - OperationItem.php
  - OperationsManager.php
  - ReconnectionInfo.php
  - SingleEndpointDiscoverer.php
  - StaticEndPointDiscoverer.php
  - StopWatch.php
  - SubscriptionItem.php
  - SubscriptionsManager.php
  - VolatileEventStoreSubscription.php
- - PersistentSubscriptionsClient.php
  - PersistentSubscriptionsManager.php
- - ProjectionsClient.php
  - ProjectionsManager.php
  - QueryManager.php
- - InspectionDecision.php
  - InspectionResult.php
  - TcpCommand.php
  - TcpFlags.php
  - TcpPackage.php
- - UsersClient.php
  - UsersManager.php
- ClusterSettings.php
- ClusterSettingsBuilder.php
- ConnectionSettings.php
- ConnectionSettingsBuilder.php
- ConnectionString.php
- DnsClusterSettingsBuilder.php
- EventStoreConnectionFactory.php
- GossipSeed.php
- GossipSeedClusterSettingsBuilder.php
- Uri.php
- - EventDataComparer.php
  - EventsStream.php
  - OngoingTransaction.php
  - ParallelTransactionTask.php
  - StreamWriter.php
  - TailWriter.php
  - TestConnection.php
  - TestEvent.php
  - TransactionalWriter.php
- - persistent_subscription_manager.php
- - all_stream_with_no_acl_security.php
  - AuthenticationTestCase.php
  - authorized_default_credentials_security.php
  - delete_stream_security.php
  - multiple_role_security.php
  - overriden_system_stream_security.php
  - overriden_system_stream_security_for_all.php
  - overriden_user_stream_security.php
  - read_all_security.php
  - read_stream_meta_security.php
  - read_stream_security.php
  - stream_security_inheritance.php
  - subscribe_to_all_security.php
  - subscribe_to_stream_security.php
  - system_stream_security.php
  - write_stream_meta_security.php
  - write_stream_security.php
- - clientapi_tcp_package.php
- - change_password.php
  - creating_a_user.php
  - deleting_a_user.php
  - enable_disable_user.php
  - get_current_user.php
  - list_users.php
  - reset_password.php
  - TestWithNode.php
  - TestWithUser.php
  - updating_a_user.php
- a_nak_in_subscription_handler_in_autoack_mode_drops_the_subscription.php
- append_to_stream.php
- appending_to_implicitly_created_stream.php
- appending_to_implicitly_created_stream_using_transaction.php
- can_create_duplicate_persistent_subscription_group_name_on_different_streams.php
- catch_up_subscription_handles_errors.php
- catch_up_subscription_handles_small_batch_sizes.php
- connect.php
- connect_to_existing_persistent_subscription_with_max_one_client.php
- connect_to_existing_persistent_subscription_with_permissions.php
- connect_to_existing_persistent_subscription_with_start_from_beginning_and_events_in_it.php
- connect_to_existing_persistent_subscription_with_start_from_beginning_and_no_stream.php
- connect_to_existing_persistent_subscription_with_start_from_beginning_not_set_and_events_in_it.php
- connect_to_existing_persistent_subscription_with_start_from_beginning_not_set_and_events_in_it_then_event_written.php
- connect_to_existing_persistent_subscription_with_start_from_two_and_no_stream.php
- connect_to_existing_persistent_subscription_with_start_from_x_set_and_events_in_it.php
- connect_to_existing_persistent_subscription_with_start_from_x_set_and_events_in_it_then_event_written.php
- connect_to_existing_persistent_subscription_with_start_from_x_set_higher_than_x_and_events_in_it_then_event_written.php
- connect_to_existing_persistent_subscription_without_permissions.php
- connect_to_non_existing_persistent_subscription_with_permissions.php
- connect_to_persistent_subscription_with_retries.php
- connection_factory_can.php
- connection_string.php
- CountdownEvent.php
- create_duplicate_persistent_subscription_group.php
- create_persistent_subscription_after_deleting_the_same.php
- create_persistent_subscription_group_without_permissions.php
- create_persistent_subscription_on_all_stream.php
- create_persistent_subscription_on_existing_stream.php
- create_persistent_subscription_on_non_existing_stream.php
- create_persistent_subscription_with_dont_timeout.php
- create_persistent_subscription_with_too_big_checkpoint_after.php
- create_persistent_subscription_with_too_big_message_timeout.php
- DefaultData.php
- deleting_existing_persistent_subscription_group_with_permissions.php
- deleting_existing_persistent_subscription_with_subscriber.php
- deleting_persistent_subscription_group_that_doesnt_exist.php
- deleting_persistent_subscription_group_without_permissions.php
- deleting_stream.php
- event_store_connection_should.php
- EventNumber.php
- EventStoreConnectionTestCase.php
- FakeEventStoreConnection.php
- happy_case_catching_up_to_link_to_events_auto_ack.php
- happy_case_catching_up_to_link_to_events_manual_ack.php
- happy_case_catching_up_to_normal_events_auto_ack.php
- happy_case_catching_up_to_normal_events_manual_ack.php
- happy_case_writing_and_subscribing_to_normal_events_auto_ack.php
- happy_case_writing_and_subscribing_to_normal_events_manual_ack.php
- ProjectionSpecification.php
- read_all_events_backward_should.php
- read_all_events_backward_with_linkto_deleted_event.php
- read_all_events_forward_should.php
- read_all_events_forward_with_hard_deleted_stream_should.php
- read_all_events_forward_with_linkto_passed_max_count.php
- read_all_events_forward_with_linkto_to_deleted_event.php
- read_all_events_forward_with_soft_deleted_stream_should.php
- read_event_of_linkto_to_deleted_event.php
- read_event_should.php
- read_event_stream_backward_should.php
- read_event_stream_forward_should.php
- read_stream_events_with_unresolved_linkto.php
- soft_delete.php
- SpecificationWithConnection.php
- SpecificationWithLinkToToDeletedEvents.php
- SpecificationWithLinkToToMaxCountDeletedEvents.php
- subscribe_should.php
- subscribe_to_all_catching_up_should.php
- subscribe_to_all_should.php
- subscribe_to_stream_catching_up_should.php
- SystemUsers.php
- transaction.php
- update_existing_persistent_subscription.php
- update_existing_persistent_subscription_with_subscribers.php
- update_existing_persistent_subscription_without_permissions.php
- update_non_existing_persistent_subscription.php
- when_a_partitioned_projection_is_running.php
- when_a_projection_is_running.php
- when_committing_empty_transaction.php
- when_creating_continuous_projection.php
- when_creating_continuous_projection_with_track_emitted_streams.php
- when_creating_one_time_projection.php
- when_creating_transient_projection.php
- when_disabling_projections.php
- when_enabling_projections.php
- when_having_max_count_set_for_stream.php
- when_having_truncate_before_set_for_stream.php
- when_listing_all_projections.php
- when_listing_continuous_projections.php
- when_listing_one_time_projections.php
- when_resetting_projections.php
- when_updating_a_projection_query.php
- when_working_with_metadata.php
- when_working_with_raw_stream_metadata.php
- when_working_with_stream_metadata_as_structured_info.php
- when_writing_and_subscribing_to_normal_events_manual_nack.php
.coveralls.yml
.docheader
.gitattributes
.gitignore
.php-cs-fixer.php
CHANGELOG.md
ClientMessageDtos.proto
composer.json
LICENSE
phpunit.xml.dist
psalm.xml
README.md

# Installation Guide

1. Get the code

git clone https://github.com/prooph/event-store-client

Downloads the entire project code from GitHub to your computer.

cd event-store-client

Moves into the project folder you just downloaded.

2. Docker

Easy Recommended

Prerequisites

Git Needed to download the project code from GitHub.
Docker Desktop Needed to build and run containers. Install it and keep it running in the background.

docker run --name eventstore-node -it -p 2113:2113 -p 1113:1113 eventstore/eventstore

Runs the built image as an actual container.

✅ Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

Pulled directly from this repo's README.

3. PHP (Composer)

Easy

Prerequisites

Git Needed to download the project code from GitHub.
PHP A PHP runtime is required.
Composer The package manager used to install PHP libraries.

composer install

Installs the PHP libraries listed in composer.json.

✅ Run it with a built-in server like php -S localhost:8000, then open http://localhost:8000 in your browser.