Add property/param types

iFixit · Aug 20, 2024 · cfaff59 · cfaff59
1 parent 74967c0
commit cfaff59
Show file tree

Hide file tree

Showing 2 changed files with 39 additions and 29 deletions.
diff --git a/QueryGenerator.php b/QueryGenerator.php
@@ -40,7 +40,13 @@ class QueryGenerator {
     * statements. These correspond to methods that can be called on this class.
     * The values are the syntax rules for collapsing the corresponding clauses.
     *
-    * @var array<string, array{clause: string, prefix: string, glue: string|false, suffix: string, requiresArgument?: bool}>
+    * @var non-empty-array<string, array{
+    *    clause: string,
+    *    prefix: string,
+    *    glue: string|false,
+    *    suffix: string,
+    *    requiresArgument?: bool
+    * }>
     */
    private static array $methods = [
       'select' => [
@@ -186,7 +192,7 @@ class QueryGenerator {
     * MySQL query. Each primary clause has a set of valid sub-clauses that can
     * be present in a completed query of that type.
     *
-    * @var array<string, list<string>>
+    * @var non-empty-array<string, list<string>>
     */
    private static array $possibleClauses = [
       'select' => ['from', 'join', 'where', 'group', 'having', 'order', 'limit', 'offset', 'forupdate'],
@@ -250,7 +256,7 @@ public function __construct(
     * Append the given clause components and parameters to their existing
     * counterparts for the specified clause.
     */
-   public function __call($method, $args) {
+   public function __call(string $method, array $args) {
       $method = strtolower($method);
 
       if (!isset(self::$methods[$method])) {
@@ -300,13 +306,15 @@ public function __call($method, $args) {
     * (one of MissingPrimaryClauseException or MissingRequiredClauseException)
     * unless `skipValidation` has been called.
     *
-    * @param $skipClauses : Exclude the 'clause' part (WHERE, SELECT, FROM,
+    * @param bool $skipClauses : Exclude the 'clause' part (WHERE, SELECT, FROM,
     *                       ...) of each sub-expression. See constructClause
     *                       for more info. This is mostly for internal usage.
     *
     * Returns an array containing the query and paramter list, respectively.
+    *
+    * @return array{0: string, 1: array<string, mixed>}
     */
-   public function build($skipClauses = false) {
+   public function build(bool $skipClauses = false): array {
       if ($this->validateQuery) {
          $this->assertCompleteQuery();
       }
@@ -351,8 +359,11 @@ public function useOr(): self {
    /**
     * Assert the completeness of this QueryGenerator instance by verifying
     * that all required clauses have been set.
+    *
+    * @throws MissingPrimaryClauseException
+    * @throws MissingRequiredClauseException
     */
-   private function assertCompleteQuery() {
+   private function assertCompleteQuery(): void {
       $primaryMethod = $this->getPrimaryMethod();
 
       if (!$primaryMethod) {
@@ -382,29 +393,37 @@ private function assertCompleteQuery() {
       }, $minimumClauses);
       $requiredClauseStr = '{' . implode('}, {', $requiredClauseOptions) . '}';
       throw new MissingRequiredClauseException(
-       "Missing required clauses. One of $requiredClauseStr needed.");
+         "Missing required clauses. One of $requiredClauseStr needed."
+      );
    }
 
    /**
     * Return the list of primary query clauses.
+    *
+    * @return non-empty-list<string>
     */
-   private static function getPrimaryClauses() {
+   private static function getPrimaryClauses(): array {
       return array_keys(self::$possibleClauses);
    }
 
    /**
     * Return the primary clause in this QueryGenerator instance.
     * If multiple primary clauses have been set, all but the first set clause
     * will be ignored.
+    *
+    * @return string|false
     */
-   private function getPrimaryMethod() {
+   private function getPrimaryMethod(): string|bool {
       $primaryClauses = self::getPrimaryClauses();
       $setMethods = $this->getSetMethods();
       $setPrimaryClauses = array_intersect($primaryClauses, $setMethods);
       return reset($setPrimaryClauses);
    }
 
-   private function getSetMethods() {
+   /**
+    * @return array<string, string>
+    */
+   private function getSetMethods(): array {
       $methods = array_keys(array_filter($this->clauses));
       return array_combine($methods, $methods);
    }
@@ -418,7 +437,7 @@ private function getSetMethods() {
     *    constructClause('where') => 'WHERE (foo = ?) AND (bar != ?)'
     *    constructClause('where', false) => '(foo = ?) AND (bar != ?)'
     */
-   private function constructClause($method, $skipClause = false) {
+   private function constructClause(string $method, bool $skipClause = false): string {
       $clauseInfo = self::$methods[$method];
       $prefix = $clauseInfo['prefix'];
       $clause = $clauseInfo['clause'];
@@ -443,8 +462,10 @@ private function constructClause($method, $skipClause = false) {
    /**
     * return the appropriate glue string for the given clause, taking into
     * account $this->useOr
+    *
+    * @return string|false
     */
-   private function getGlue($method) {
+   private function getGlue(string $method): string|bool {
       if ($method !== 'where' || !$this->useOr) {
          return self::$methods[$method]['glue'];
       } else {

diff --git a/psalm-baseline.xml b/psalm-baseline.xml
@@ -1,26 +1,15 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <files psalm-version="5.25.0@01a8eb06b9e9cc6cfb6a320bf9fb14331919d505">
   <file src="QueryGenerator.php">
-    <MissingParamType>
-      <code><![CDATA[$args]]></code>
-      <code><![CDATA[$method]]></code>
-      <code><![CDATA[$method]]></code>
-      <code><![CDATA[$method]]></code>
-      <code><![CDATA[$skipClause]]></code>
-      <code><![CDATA[$skipClauses]]></code>
-    </MissingParamType>
-    <MissingReturnType>
-      <code><![CDATA[assertCompleteQuery]]></code>
-      <code><![CDATA[build]]></code>
-      <code><![CDATA[constructClause]]></code>
-      <code><![CDATA[getGlue]]></code>
-      <code><![CDATA[getPrimaryClauses]]></code>
-      <code><![CDATA[getPrimaryMethod]]></code>
-      <code><![CDATA[getSetMethods]]></code>
-    </MissingReturnType>
+    <PossiblyFalseArgument>
+      <code><![CDATA[$glue]]></code>
+    </PossiblyFalseArgument>
     <PossiblyUnusedMethod>
       <code><![CDATA[useOr]]></code>
     </PossiblyUnusedMethod>
+    <RiskyTruthyFalsyComparison>
+      <code><![CDATA[!$primaryMethod]]></code>
+    </RiskyTruthyFalsyComparison>
     <UnusedProperty>
       <code><![CDATA[$queryModifiers]]></code>
     </UnusedProperty>