Change 'ready' to 'init' (#1057) build docs

* Update docs
* Update examples
* Update README.md
* change emittedReady to emittedInit
* proper deprecation of ready
* check if ready listeners still present, if thats the case, send logger info and emit.

README.md

@@ -78,7 +78,7 @@ $discord = new Discord([
 //      | Intents::MESSAGE_CONTENT, // Note: MESSAGE_CONTENT is privileged, see https://dis.gd/mcfaq
 ]);
 
-$discord->on('ready', function (Discord $discord) {
+$discord->on('init', function (Discord $discord) {
     echo "Bot is ready!", PHP_EOL;
 
     // Listen for messages.

docs/src/pages/api/02_basics.md

@@ -112,10 +112,10 @@ The following options should only be used by large bots that require sharding. I
 
 <hr>
 
-Gateway events should be registered inside the `ready` event, which is emitted once when the bot first starts and has connected to the gateway.
+Gateway events should be registered inside the `init` event, which is emitted once when the bot first starts and has connected to the gateway.
 
 ```php
-$discord->on('ready', function (Discord $discord) {
+$discord->on('init', function (Discord $discord) {
 ```
 
 To register an event we use the `$discord->on(...)` function, which registers a handler.

docs/src/pages/api/03_events/00_events.md

@@ -10,7 +10,7 @@ Most events also requires the respective Intents enabled (as well privileged one
 To listen on gateway events, use the event emitter callback and `Event` name constants.
 Some events are internally handled by the library and may not be registered a listener:
 
-- `Event::READY` (not to be confused with `'ready'`)
+- `Event::READY`
 - `Event::RESUMED`
 - `Event::GUILD_MEMBERS_CHUNK`
 

docs/src/pages/api/03_events/04_guilds.md

@@ -8,7 +8,7 @@ Requires the `Intents::GUILDS` intent.
 
 Called with a `Guild` object in one of the following situations:
 
-1. When the Bot is first starting and the guilds are becoming available. (unless the listener is put inside after 'ready' event)
+1. When the Bot is first starting and the guilds are becoming available. (unless the listener is put inside after 'init' event)
 2. When a guild was unavailable and is now available due to an outage.
 3. When the Bot joins a new guild.
 

examples/ping.php

@@ -26,7 +26,7 @@
 ]);
 
 // When the Bot is ready
-$discord->on('ready', function (Discord $discord) {
+$discord->on('init', function (Discord $discord) {
 
     // Listen for messages
     $discord->on('message', function (Message $message, Discord $discord) {

guide/basics.rst

@@ -71,13 +71,13 @@ The following options should only be used by large bots that require sharding. I
 
 ----
 
-Gateway events should be registered inside the ``ready`` event, which is emitted once when the bot first starts and has connected to the gateway.
+Gateway events should be registered inside the ``init`` event, which is emitted once when the bot first starts and has connected to the gateway.
 
 To register an event we use the ``$discord->on(...)`` function, which registers a handler. A list of events is available `here <https://github.com/discord-php/DiscordPHP/blob/master/src/Discord/WebSockets/Event.php#L30-L75>`_. They are described in more detail in further sections of the documentation. All events take a callback which is called when the event is triggered, and the callback is called with an object representing the content of the event and an instance of the ``Discord`` client.
 
 .. code:: php
 
-   $discord->on('ready', function (Discord $discord) {
+   $discord->on('init', function (Discord $discord) {
 
        $discord->on(Event::MESSAGE_CREATE, function (Message $message, Discord $discord) {
            // ... handle message sent

guide/events/guilds.rst

@@ -10,7 +10,7 @@ Guild Create
 
 Called with a ``Guild`` object in one of the following situations:
 
-1. When the Bot is first starting and the guilds are becoming available. (unless the listener is put inside after ‘ready’ event)
+1. When the Bot is first starting and the guilds are becoming available. (unless the listener is put inside after ‘init’ event)
 2. When a guild was unavailable and is now available due to an outage.
 3. When the Bot joins a new guild.
 

guide/events/index.rst

@@ -24,7 +24,7 @@ All gateway events are enabled by default and can be individually disabled using
 
 To listen on gateway events, use the event emitter callback and ``Event`` name constants. Some events are internally handled by the library and may not be registered a listener:
 
--  ``Event::READY`` (not to be confused with ``'ready'``)
+-  ``Event::READY``
 -  ``Event::RESUMED``
 -  ``Event::GUILD_MEMBERS_CHUNK``
 

src/Discord/Discord.php

@@ -251,11 +251,11 @@ class Discord
     protected $heartbeatTime;
 
     /**
-     * Whether `ready` has been emitted.
+     * Whether `init` has been emitted.
      *
      * @var bool Emitted.
      */
-    protected $emittedReady = false;
+    protected $emittedInit = false;
 
     /**
      * The gateway URL that the WebSocket client will connect to.
@@ -379,7 +379,7 @@ public function __construct(array $options = [])
         }
 
         $function = function () use (&$function) {
-            $this->emittedReady = true;
+            $this->emittedInit = true;
             $this->removeListener('ready', $function);
         };
 
@@ -804,7 +804,7 @@ protected function handleDispatch(object $data): void
             Event::GUILD_DELETE,
         ];
 
-        if (! $this->emittedReady && (! in_array($data->t, $parse))) {
+        if (! $this->emittedInit && (! in_array($data->t, $parse))) {
             $this->unparsedPackets[] = function () use (&$handler, &$deferred, &$data) {
                 /** @var ExtendedPromiseInterface */
                 $promise = coroutine([$handler, 'handle'], $data->d);
@@ -1121,17 +1121,23 @@ protected function send(array $data, bool $force = false): void
     }
 
     /**
-     * Emits ready if it has not been emitted already.
+     * Emits init if it has not been emitted already.
      * @return false|void
      */
     protected function ready()
     {
-        if ($this->emittedReady) {
+        if ($this->emittedInit) {
             return false;
         }
 
         $this->logger->info('client is ready');
-        $this->emit('ready', [$this]);
+        $this->emit('init', [$this]);
+
+        /* deprecated */
+        if (isset($this->listeners['ready'])) {
+            $this->logger->info('The \'ready\' event is deprecated and will be removed in a future version of DiscordPHP. Please use \'init\' instead.');
+            $this->emit('ready', [$this]);
+        }
 
         foreach ($this->unparsedPackets as $parser) {
             $parser();

src/Discord/DiscordCommandClient.php

@@ -59,7 +59,7 @@ public function __construct(array $options = [])
 
         parent::__construct($discordOptions);
 
-        $this->on('ready', function () {
+        $this->on('init', function () {
             $this->commandClientOptions['prefix'] = str_replace('@mention', (string) $this->user, $this->commandClientOptions['prefix']);
             $this->commandClientOptions['name'] = str_replace('<UsernamePlaceholder>', $this->username, $this->commandClientOptions['name']);