Yii - Provedores de Dados

O Yii fornece um conjunto de classes de provedor de dados que encapsulam a paginação e classificação. Um provedor de dados implementa yii \ data \ DataProviderInterface. Ele suporta a recuperação de dados classificados e paginados. Os provedores de dados geralmente trabalham com widgets de dados.

Yii inclui -

ActiveDataProvider - Usos yii\db\ActiveQuery ou yii\db\Query para consultar dados de bancos de dados.
SqlDataProvider - Executa SQL e retorna dados como arrays.
ArrayDataProvider - Pega uma grande matriz e retorna uma parte dela.

Você define os comportamentos de classificação e paginação de um provedor de dados configurando seu pagination e sortpropriedades. Widgets de dados, comoyii\grid\GridView, tem uma propriedade chamada dataProvider, que pega uma instância do provedor de dados e exibe os dados na tela.

Preparando o banco de dados

Step 1- Crie um novo banco de dados. O banco de dados pode ser preparado das duas maneiras a seguir.

No terminal, execute mysql -u root –p .
Crie um novo banco de dados via CREATE DATABASE helloworld CHARACTER SET utf8 COLLATE utf8_general_ci;

Step 2 - Configure a conexão do banco de dados no config/db.phpArquivo. A configuração a seguir é para o sistema usado atualmente.

<?php
   return [
      'class' => 'yii\db\Connection',
      'dsn' => 'mysql:host = localhost;dbname = helloworld',
      'username' => 'vladimir',
      'password' => '12345',
      'charset' => 'utf8',
   ];
?>

Step 3 - Dentro da pasta raiz run ./yii migrate/create test_table. Este comando criará uma migração de banco de dados para gerenciar nosso banco de dados. O arquivo de migração deve aparecer nomigrations pasta da raiz do projeto.

Step 4 - Modifique o arquivo de migração (m160106_163154_test_table.php neste caso) desta forma.

<?php
   use yii\db\Schema;
   use yii\db\Migration;
   class m160106_163154_test_table extends Migration {
      public function safeUp() {
         $this->createTable("user", [ "id" => Schema::TYPE_PK, "name" => Schema::TYPE_STRING, "email" => Schema::TYPE_STRING, ]); $this->batchInsert("user", ["name", "email"], [
            ["User1", "[email protected]"],
            ["User2", "[email protected]"],
            ["User3", "[email protected]"],
            ["User4", "[email protected]"],
            ["User5", "[email protected]"],
            ["User6", "[email protected]"],
            ["User7", "[email protected]"],
            ["User8", "[email protected]"],
            ["User9", "[email protected]"],
            ["User10", "[email protected]"],
            ["User11", "[email protected]"],
         ]);
      }
      public function safeDown() {
         $this->dropTable('user');
      }
   }
?>

A migração acima cria um usertabela com estes campos: id, nome e email. Ele também adiciona alguns usuários de demonstração.

Step 5 - Dentro da raiz do projeto run ./yii migrate para aplicar a migração ao banco de dados.

Step 6 - Agora, precisamos criar um modelo para o nosso usermesa. Para simplificar, vamos usar oGiiferramenta de geração de código. Abra issourl: http://localhost:8080/index.php?r=gii. Em seguida, clique no botão “Iniciar” sob o cabeçalho “Gerador de modelo”. Preencha o Nome da Tabela (“usuário”) e a Classe do Modelo (“MeuUsuário”), clique no botão “Visualizar” e por fim, clique no botão “Gerar”.

O modelo MyUser deve aparecer no diretório de modelos.

Provedor de dados ativo

Step 1 - Crie uma função chamada actionDataProvider dentro de SiteController.

public function actionDataProvider(){
   $query = MyUser::find();
   $provider = new ActiveDataProvider([ 'query' => $query,
      'pagination' => [
         'pageSize' => 2,
      ],
   ]);
   // returns an array of users objects
   $users = $provider->getModels();
   var_dump($users);
}

No código acima, definimos uma instância do ActiveDataProviderclasse e exibir usuários da primeira página. oyii\data\ActiveDataProvider classe usa o componente de aplicativo DB como a conexão DB.

Step 2 - Se você inserir o endereço do host local http://localhost:8080/index.php?r=site/dataprovider, você verá a seguinte saída.

Provedor de dados SQL

o yii\data\SqlDataProvider classe trabalha com instruções SQL brutas.

Step 1 - Modifique o actionDataProvider método desta forma.

public function actionDataProvider() {
   $count = Yii::$app->db->createCommand('SELECT COUNT(*) FROM user')->queryScalar(); $provider = new SqlDataProvider([
      'sql' => 'SELECT * FROM user',
      'totalCount' => $count, 'pagination' => [ 'pageSize' => 5, ], 'sort' => [ 'attributes' => [ 'id', 'name', 'email', ], ], ]); // returns an array of data rows $users = $provider->getModels(); var_dump($users);
}

Step 2 - Tipo http://localhost:8080/index.php?r=site/data-provider na barra de endereço do navegador da web, você verá a seguinte saída.

Provedor de dados de matriz

o yii\data\ArrayDataProviderclasse é melhor para trabalhar com grandes arrays. Os elementos nesta matriz podem ser resultados de consultas de instâncias de DAO ou Active Record.

Step 1 - Modifique o actionDataProvider método desta forma.

public function actionDataProvider() {
   $data = MyUser::find()->asArray()->all(); $provider = new ArrayDataProvider([
      'allModels' => $data, 'pagination' => [ 'pageSize' => 3, ], 'sort' => [ 'attributes' => ['id', 'name'], ], ]); // get the rows in the currently requested page $users = $provider->getModels(); var_dump($users);
}

Step 2 - Se você for ao endereço http://localhost:8080/index.php?r=site/data-provider por meio do navegador da web, você verá a seguinte saída.

Observe que, ao contrário do SQL Data Provider e do Active Data Provider, o Array Data Provider carrega todos os dados na memória, por isso é menos eficiente.

↰ Previous page Next page ↱