Return Methods

You can return rows from the database by building queries programatically and format the output using these methods.

• row( int $id | array $conditions )

• list( [string $column] )

• listId( [default $column = 'id' ] )

• groupId( string )

row( int $id | array $conditions )

Return a single row. Optionally include row id similar to the method rowId().

$user = $db->table('users')->row();

JSON

{
  "id": "1",
  "firstName": "Hans",
  "lastName": "Gruber",
  "email": "[e-mail]"
}

rowId( int $id )

Alias of row().

list( [string $column] )

Return multiple rows. Include optional column name as the row index.

$users = $db->table('users')->where(['id : >' => 1])->list();

JSON

[
  {
    "id": "2",
    "firstName": "Lars",
    "lastName": "Ulrich",
    "email": "[e-mail]"
  },
  {
    "id": "3",
    "firstName": "Hans",
    "lastName": "Nickerdorph",
    "email": "[e-mail]"
  }
]

listId( [default $column = 'id' ] )

Alias of list('id'). Default key is id.

Use column name "email" to return multiple rows into array indexed by column value.

$users = $db->table('users')->listId('email');

JSON

{
  "[e-mail]": {
    "id": "2",
    "firstName": "Lars",
    "lastName": "Ulrich",
    "email": "[e-mail]",
    "created": "2020-12-24"
  },
  "[e-mail]": {
    "id": "3",
    "firstName": "Hans",
    "lastName": "Nickerdorph",
    "email": "[e-mail]",
    "created": "2020-12-28"
  }
}

groupId( [$column = 'id'] )

Return multiple rows into array grouped by column values. Default column is id.

$users = $db->table('users')->groupId('category');

JSON

{
  "client": [
    {
      "id": "1",
      "firstName": "Hans",
      "lastName": "Gruber",
      "email": "[e-mail]",
      "category": "client",
      "created": null
    },
    {
      "id": "3",
      "firstName": "Hans",
      "lastName": "Nickerdorph",
      "email": "[e-mail]",
      "category": "client",
      "created": "2020-12-28"
    }
  ],
  "partner": [
    {
      "id": "2",
      "firstName": "Lars",
      "lastName": "Ulrich",
      "email": "[e-mail]",
      "category": "partner",
      "created": "2020-12-24"
    }
  ]
}