如何在 Laravel 4 中获取列名？

Posted 2023-02-24

【中文标题】如何在 Laravel 4 中获取列名？

【英文标题】：How do I get column names in Laravel 4?

【发布时间】：2013-11-25 22:28:42

【问题描述】：

如何在 Laravel 4 中使用 Schema、DB 或 Eloquent 获取数组或对象中表的列名？

我好像找不到一个现成的函数，也许你有一些自定义的实现。

【问题讨论】：

你可能需要raw query

请注意，当 Laravel 达到 4.1 时，以下解决方案可能会发生变化，因为它删除了 Doctrine（以及因此 Doctrine 的 Schema 类）作为依赖项

不敢相信 Laravel 还没有提供这个功能，CodeIgniter 有。我可以在 Laravel 的哪里提交此功能的请求？

【参考方案1】：

我认为有几个不同的选项，如果您使用的是 Eloquent 模型，您可以查看 getAccessibleAttributes() 方法，理论上该方法会为您提供模型的所有列，将 Eloquent 视为属性。

例如，您可以为 User Eloquent 模型上的 users 表执行类似的操作。

$user = // Retrieve your User model.
$columns = User->getAccessibleAttributes();

另一个类似的 Eloquent 方法是 attributesToArray() 方法，但没有“可访问性”要求。返回的数组应该将您的列作为键。然后您可以使用 php 函数 array_keys() 构建一个键数组，这将是您的列。

$user = // Retrieve your User model.
$columns = array_keys(User::attributesToArray());

【讨论】：

$columns = array_keys(User::attributesToArray());给出一个异常 非静态方法 Illuminate\Database\Eloquent\Model::attributesToArray() 不应该被静态调用

你应该用你的实际用户对象来做。例如，$admin->attributesToArray()。

@MikeAnthony 是的，它不是静态方法，我没有意识到。我会更新我的答案。

@Sajan Parikh 即使已实例化，仍然无法正常工作，返回一个空数组 (

【参考方案2】：

新答案

当时我给出了这个答案Laravel 没有办法直接做到这一点，但现在你可以：

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

旧答案

使用属性是行不通的，因为如果你这样做了

$model = new ModelName;

您没有为该模型设置任何属性，您将一无所获。

那么仍然没有真正的选择，所以我不得不进入数据库级别，这是我的 BaseModel：

<?php

class BaseModel extends \Eloquent 

    public function getAllColumnsNames()
    
        switch (DB::connection()->getConfig('driver')) 
            case 'pgsql':
                $query = "SELECT column_name FROM information_schema.columns WHERE table_name = '".$this->table."'";
                $column_name = 'column_name';
                $reverse = true;
                break;

            case 'mysql':
                $query = 'SHOW COLUMNS FROM '.$this->table;
                $column_name = 'Field';
                $reverse = false;
                break;

            case 'sqlsrv':
                $parts = explode('.', $this->table);
                $num = (count($parts) - 1);
                $table = $parts[$num];
                $query = "SELECT column_name FROM ".DB::connection()->getConfig('database').".INFORMATION_SCHEMA.COLUMNS WHERE TABLE_NAME = N'".$table."'";
                $column_name = 'column_name';
                $reverse = false;
                break;

            default: 
                $error = 'Database driver not supported: '.DB::connection()->getConfig('driver');
                throw new Exception($error);
                break;
        

        $columns = array();

        foreach(DB::select($query) as $column)
        
            $columns[] = $column->$column_name;
        

        if($reverse)
        
            $columns = array_reverse($columns);
        

        return $columns;
    

用它来做：

$model = User::find(1);

dd( $model->getAllColumnsNames() );

【讨论】：

我这里没有mysql的访问权限，所以我使用sqlfiddle.com/#!2/066acd/2进行了测试。请您在您的 mysql 中手动运行“SHOW COLUMNS FROM ”吗？

刚刚为 MySQL 修复。

现在有效，谢谢，我接受它，因为它是第一个有效的答案，但@ceejayoz 的答案也有效，对枚举类型进行了一些调整，谢谢。

当时我给出了这个答案，Laravel 没有办法直接做到这一点。答案已编辑。

getColumnListing 是一个受保护的函数；你不能按照你建议的方式使用它，你必须把它包装起来。

【参考方案3】：

您可以深入研究 DB 的 Doctrine 实例。

$columns = DB::connection()
  ->getDoctrineSchemaManager()
  ->listTableColumns('table');

foreach($columns as $column) 
  print $column->getName();
  print $column->getType()->getName();
  print $column->getDefault();
  print $column->getLength();

编辑： Doctrine 不再（从 L4.1 开始）默认安装（它是“建议”而不是“必需”包），但可以添加到您的 composer.json 为doctrine/dbal 保留此功能。

【讨论】：

也试过了，但它不适用于 SQL 服务器：找不到 Class 'Doctrine\DBAL\Driver\PDOSqlsrv\Driver'。

@AntonioCarlosRibeiro 我从来没有将 Microsoft SQL Server 与 Doctrine 一起使用，所以你只能靠自己。如果这是您的基础技术，那么原始查询可能是您最好的选择。不过，OP 正在使用 MySQL。

这个解决方案有效，有一件事要提一下，如果表包含 enum type ，它会抛出这个异常。请求未知数据库类型枚举，Doctrine\DBAL\Platforms\MySqlPlatform 可能不支持。

@Centurion Laravel 在技术上根本不支持枚举——你不能通过模式管理器创建一个。

@ceejayoz 基于我创建的文档，laravel.com/docs/schema, $table->enum('choices', array('foo', 'bar')); ENUM相当于表，事实是Doctrine不支持它们。

【参考方案4】：

你也可以试试这个：

abstract class BaseModel extends Eloquent 

public function getColumnsNames()

    $connection = DB::connection();
    $connection->getSchemaBuilder();

    $table   = $connection->getTablePrefix() . $this->table;
    $grammar = $connection->getSchemaGrammar();
    $results = $connection->select($grammar->compileColumnExists(), array($connection->getDatabaseName(), $table));

    return $connection->getPostProcessor()->processColumnListing($results);

【讨论】：

这对我不起作用。调试器说： $grammar->compileColumnExists($table) = "select column_name from information_schema.columns where table_schema = ? and table_name = ?"它不会在编译时替换查询中的值......我错过了什么？

你能举个例子说明你是如何使用它的吗？这里的想法是仅在您的模型类中使用它。他们将设置 table 属性。这在 4.1.* laravel 应用程序中也适用于我，可能必须在更新的版本中进行更改。

我更新了使 BaseModel 抽象化的代码，以强制实现。

【参考方案5】：

你可以试试Schema::getColumnListing('tablename'):

$columns = Schema::getColumnListing('users'); // users table
dd($columns); // dump the result and die

根据您的表，结果可能是这样的：

array (size=12)
  0 => string 'id' (length=2)
  1 => string 'role_id' (length=7)
  2 => string 'first_name' (length=10)
  3 => string 'last_name' (length=9)
  4 => string 'email' (length=5)
  5 => string 'username' (length=8)
  6 => string 'password' (length=8)
  7 => string 'remember_token' (length=14)
  8 => string 'bio' (length=3)
  9 => string 'created_at' (length=10)
  10 => string 'updated_at' (length=10)
  11 => string 'deleted_at' (length=10)

【讨论】：

在命名空间中不要忘记开头的斜线 \Schema::getColumnListing('tablename')

【参考方案6】：

我知道这可能不是每个人的答案，但也许您可以抓取一条记录，并获取数据的所有键。例如。

array_keys(User::first()->toArray());

【讨论】：

如果您的部分视图依赖于许多不同的模型，这将非常有用。

如果您隐藏或屏蔽了某些列，将无法正常工作。

【参考方案7】：

我使用 SQL Server 并且架构方式对我有用：

$columns = array_keys(Schema::getConnection()
->getDoctrineSchemaManager()
->listTableColumns($yourModel->getTable()) );

【讨论】：

不知道为什么这被否决了，我想我应该提到你可能需要 Doctrine。

【参考方案8】：

如果你有一个模型实例，你可以像下面这样检索：

    $table_name = $model->getTable();
    $connection = $model->getConnection();
    $schemaBulder = $connection->getSchemaBuilder();

    $columns_array = $schemaBulder->getColumnListing($table_name);

适用于 Laravel 5