LaravelのEloquentでデータベースの構造を取得したい

Question

LaravelでCSVの出力処理を構築したのですが、ヘッダー行をつけるために、エクスポートするデータベースのカラム構造を取得したいです。
CSVの出力処理は以下です。

    public function export(){ //GETメソッド
      $culumns = [
        'id','name','email','created_at','updated_at','deleted_at'
      ];
      $users = AdminUser::get($culumns);
      $stream = fopen('php://temp','w'); //メモリ上に仮想的にファイルを作成

      // TODO CSVヘッダー行を追加する
      fputcsv($stream, $culumns);
      foreach ($users as $user) { // Modleクラスのコレクション、コレクションクラスは便利
        fputcsv($stream, $user->toArray()); //$userがモデル
      }

      rewind($stream); // ポインタを頭に戻す、書き込み完了時には最後にポインタが最後にいるので

      $csv = stream_get_contents($stream); // 文字列に変換

      $headers = [
        'Content-Type' => 'text/csv', // HTTPのレスポンスのタイプを指定する(MIMEタイプ参照)
        'Content-Disposition' => 'attachment; filename="users.csv"'
      ];
      return response($csv,200,$headers);
    }

ここで、$culumns変数へカラム構造を配列で定義していますが、AdminUserモデルより自動で指定テーブルの構造を取得したいです。
また、可能であれば構造を取得する際、カラムの除外指定もしたいです。
(このカラムは取得しないといった除外設定。)

何か指定方法はありますか？
パッケージなども有りましたら是非紹介欲しいです。

Answer 1

データベースのスキーマ操作はSchemaクラスで行えます。

$columns = Schema::getColumnListing('table_name');

テーブル名を引数にカラムを配列で取得できます。
実際にどのようなクエリを発行しているかはgetColumnListing()メソッドを追っていけばわかるかと思います。

テーブル名はEloquentのモデルインスタンスから

$model->getTable();

で取得できたかと思います。

カラムの指定、除外処理は配列操作になるかと思います。

Comments

[退会済みユーザー]

ありがとうございます！

Answer 2

class AdminCsvController extends Controller
{
    // 出力したくないカラムリスト
    static $except = [
      'users' => [
        'remember_token',
        'token',
        'password'
      ],
      'admin_users' => [
        'remember_token',
        'password'
      ],
    ];

public function export(Request $request){ //GET
      $target = $request->input('target'); //リクエストからKEY名を取得キー名を

      if($target == 'users'){
        $users = User::all();
      } else if($target == 'admin_users'){
        $users = AdminUser::all();
      }

      $culumns = Schema::getColumnListing($target); //リクエストに応じたKEYを取得

      // 除外したいカラムのKEYを取得し除外する
      foreach (static::$except[$target] as $value) {
        $key = array_search($value,$culumns); //valueに応じたKEYの取得
        if($key > 0){
          unset($culumns[$key]);
        }
      }

      $stream = fopen('php://temp','w'); //メモリ上に仮想的にファイルを作成

      // CSVヘッダー行を追加する
      fputcsv($stream, $culumns);
      foreach ($users as $user) { // Modleクラスのコレクション、コレクションクラス
        fputcsv($stream, $user->toArray());
      }

      rewind($stream); // ポインタを頭に戻す、書き込み完了時には最後にポインタが最後にいるので

      $csv = stream_get_contents($stream); // 文字列に変換

      $headers = [
        'Content-Type' => 'text/csv', // HTTPのレスポンスのタイプを指定する・マイムタイプを調べる・拡張子のようなもの
        'Content-Disposition' => 'attachment; filename="users.csv"'
      ];
      return response($csv,200,$headers);
    }
}