Merge pull request #8928 from ddevsr/docs-service

docs: replace `Services` class to `service()`

Author: kenjis

user_guide_src/source/concepts/services.rst

@@ -37,7 +37,7 @@ come in handy.
 Instead of creating the instance ourself, we let a central class create an instance of the
 class for us. This class is kept very simple. It only contains a method for each class that we want
 to use as a service. The method typically returns a **shared instance** of that class, passing any dependencies
-it might have into it. Then, we would replace our timer creation code with code that calls this new class:
+it might have into it. Then, we would replace our timer creation code with code that calls this global function or Services class:
 
 .. literalinclude:: services/002.php
 
@@ -55,7 +55,7 @@ As many CodeIgniter classes are provided as services, you can get them like the
 
 .. literalinclude:: services/013.php
 
-The ``$typography`` is an instance of the Typography class, and if you call ``\Config\Services::typography()`` again, you will get the exactly same instance.
+The ``$timer`` is an instance of the Timer class, and if you call ``service('timer')`` again, you will get the exactly same instance.
 
 The Services typically return a **shared instance** of the class. The following code creates a ``CURLRequest`` instance at the first call. And the second call returns the exactly same instance.
 
@@ -66,7 +66,7 @@ Therefore, the parameter ``$options2`` for the ``$client2`` does not work. It is
 Getting a New Instance
 ======================
 
-If you want to get a new instance of the Typography class, you need to pass ``false`` to the argument ``$getShared``:
+If you want to get a new instance of the Timer class, you need to pass ``false`` to the argument ``$getShared``:
 
 .. literalinclude:: services/014.php
 
@@ -85,6 +85,8 @@ always return the same instance:
 
 .. literalinclude:: services/003.php
 
+.. note:: Since v4.5.0, when you don't pass parameters to the service, the global function ``service()`` is recommended due to performance improvements.
+
 If the creation method requires additional parameters, they can be passed after the service name:
 
 .. literalinclude:: services/004.php

user_guide_src/source/concepts/services/002.php

@@ -1,3 +1,6 @@
 <?php
 
+$timer = service('timer');
+
+// The code above is the same as the code below.
 $timer = \Config\Services::timer();

user_guide_src/source/concepts/services/012.php

@@ -1,3 +1,3 @@
 <?php
 
-$postManager = \Config\Services::postManager();
+$postManager = service('postManager');

user_guide_src/source/concepts/services/013.php

@@ -1,3 +1,3 @@
 <?php
 
-$typography = \Config\Services::typography();
+$timer = service('timer');

user_guide_src/source/concepts/services/014.php

@@ -1,3 +1,3 @@
 <?php
 
-$typography = \Config\Services::typography(false);
+$timer = \Config\Services::timer(false);

user_guide_src/source/concepts/services/015.php

@@ -4,12 +4,12 @@
     'baseURI' => 'http://example.com/api/v1/',
     'timeout' => 3,
 ];
-$client1 = \Config\Services::curlrequest($options1);
+$client1 = service('curlrequest', $options1);
 
 $options2 = [
     'baseURI' => 'http://another.example.com/api/v2/',
     'timeout' => 10,
 ];
-$client2 = \Config\Services::curlrequest($options2);
+$client2 = service('curlrequest', $options2);
 // $options2 does not work.
 // $client2 is the exactly same instance as $client1.

user_guide_src/source/extending/basecontroller/003.php

@@ -18,6 +18,6 @@ public function initController(/* ... */)
         // Do Not Edit This Line
         parent::initController($request, $response, $logger);
 
-        $this->session = \Config\Services::session();
+        $this->session = service('session');
     }
 }

user_guide_src/source/general/common_functions.rst

@@ -372,7 +372,7 @@ Miscellaneous Functions
     :returns:    The shared Request object.
     :rtype:    IncomingRequest|CLIRequest
 
-    This function is a wrapper for ``Services::request()``.
+    This function is a wrapper for ``Services::request()`` and ``service('request')``.
 
 .. php:function:: response()
 
@@ -381,7 +381,7 @@ Miscellaneous Functions
     :returns:    The shared Response object.
     :rtype:    Response
 
-    This function is a wrapper for ``Services::response()``.
+    This function is a wrapper for ``Services::response()`` and ``service('response')``.
 
 .. php:function:: route_to($method[, ...$params])
 

user_guide_src/source/general/errors/018.php

@@ -1,6 +1,6 @@
 <?php
 
-$response = \Config\Services::response()
+$response = service('response')
     ->redirect('https://example.com/path')
     ->setHeader('Some', 'header')
     ->setCookie('and', 'cookie');

user_guide_src/source/incoming/content_negotiation/001.php

@@ -1,3 +1,3 @@
 <?php
 
-$negotiate = \Config\Services::negotiator();
+$negotiate = service('negotiator');