Merge pull request #9113 from kenjis/docs-CSRF-filter

docs: update comments for CSRF

Author: kenjis

system/Filters/CSRF.php

@@ -18,6 +18,7 @@
 use CodeIgniter\HTTP\RequestInterface;
 use CodeIgniter\HTTP\ResponseInterface;
 use CodeIgniter\Security\Exceptions\SecurityException;
+use CodeIgniter\Security\Security;
 
 /**
  * CSRF filter.
@@ -30,14 +31,7 @@
 class CSRF implements FilterInterface
 {
     /**
-     * Do whatever processing this filter needs to do.
-     * By default it should not return anything during
-     * normal execution. However, when an abnormal state
-     * is found, it should return an instance of
-     * CodeIgniter\HTTP\Response. If it does, script
-     * execution will end and that Response will be
-     * sent back to the client, allowing for error pages,
-     * redirects, etc.
+     * CSRF verification.
      *
      * @param list<string>|null $arguments
      *
@@ -51,6 +45,7 @@ public function before(RequestInterface $request, $arguments = null)
             return;
         }
 
+        /** @var Security $security */
         $security = service('security');
 
         try {

system/Security/Security.php

@@ -233,7 +233,7 @@ private function configureCookie(CookieConfig $cookie): void
     }
 
     /**
-     * CSRF Verify
+     * CSRF verification.
      *
      * @return $this
      *