Skip to content
Documentación

Manual Técnico appServiserAdmin

Documentación Técnica del Archivo AuthAssignmentController.php en la Carpeta appServiserAdmin/controllers

Español

Definición de la Carpeta

El archivo AuthAssignmentController.php se encuentra en la carpeta de controladores de un proyecto que utiliza el marco de trabajo Yii2. Este archivo es responsable de manejar las acciones relacionadas con el modelo de AuthAssignment, que generalmente se utiliza para gestionar las asignaciones de roles y permisos a los usuarios en la aplicación.

Propósito

El propósito del archivo AuthAssignmentController.php es implementar las acciones CRUD (Crear, Leer, Actualizar, Eliminar) para el modelo de AuthAssignment. Esto permite a los administradores gestionar los roles y permisos asignados a los usuarios a través de la interfaz de usuario.

Funciones

  1. Listar Asignaciones: Proporciona una acción para listar todas las asignaciones de roles y permisos a los usuarios en la aplicación.
  2. Ver Asignación: Permite a los administradores ver los detalles de una asignación específica.
  3. Crear Asignación: Facilita la creación de una nueva asignación de rol o permiso a un usuario.
  4. Actualizar Asignación: Permite la edición de una asignación existente.
  5. Eliminar Asignación: Proporciona la funcionalidad para eliminar una asignación específica.

Estructura Común

El archivo AuthAssignmentController.php suele tener una estructura similar a la siguiente:

<?php


namespace app\controllers;


use Yii;
use app\models\AuthAssignment;
use app\models\AuthAssignmentSearch;
use yii\web\Controller;
use yii\web\NotFoundHttpException;
use yii\filters\VerbFilter;


/**
 * AuthAssignmentController implements the CRUD actions for AuthAssignment model.
 */
class AuthAssignmentController extends Controller
{
    /**
     * @inheritDoc
     */
    public function behaviors()
    {
        return array_merge(
            parent::behaviors(),
            [
                'verbs' => [
                    'class' => VerbFilter::className(),
                    'actions' => [
                        'delete' => ['POST'],
                    ],
                ],
            ]
        );
    }


    /**
     * Lists all AuthAssignment models.
     *
     * @return string
     */
    public function actionIndex()
    {
        $searchModel = new AuthAssignmentSearch();
        $dataProvider = $searchModel->search($this->request->queryParams);


        return $this->render('index', [
            'searchModel' => $searchModel,
            'dataProvider' => $dataProvider,
        ]);
    }


    /**
     * Displays a single AuthAssignment model.
     * @param string $id ID
     * @return string
     * @throws NotFoundHttpException if the model cannot be found
     */
    public function actionView($id)
    {
        return $this->render('view', [
            'model' => $this->findModel($id),
        ]);
    }


    /**
     * Creates a new AuthAssignment model.
     * If creation is successful, the browser will be redirected to the 'view' page.
     * @return string|\yii\web\Response
     */
    public function actionCreate()
    {
        $model = new AuthAssignment();


        if ($this->request->isPost) {
            if ($model->load($this->request->post()) && $model->save()) {
                return $this->redirect(['view', 'id' => $model->id]);
            }
        } else {
            $model->loadDefaultValues();
        }


        return $this->render('create', [
            'model' => $model,
        ]);
    }


    /**
     * Updates an existing AuthAssignment model.
     * If update is successful, the browser will be redirected to the 'view' page.
     * @param string $id ID
     * @return string|\yii\web\Response
     * @throws NotFoundHttpException if the model cannot be found
     */
    public function actionUpdate($id)
    {
        $model = $this->findModel($id);


        if ($this->request->isPost && $model->load($this->request->post()) && $model->save()) {
            return $this->redirect(['view', 'id' => $model->id]);
        }


        return $this->render('update', [
            'model' => $model,
        ]);
    }


    /**
     * Deletes an existing AuthAssignment model.
     * If deletion is successful, the browser will be redirected to the 'index' page.
     * @param string $id ID
     * @return \yii\web\Response
     * @throws NotFoundHttpException if the model cannot be found
     */
    public function actionDelete($id)
    {
        $this->findModel($id)->delete();


        return $this->redirect(['index']);
    }


    /**
     * Finds the AuthAssignment model based on its primary key value.
     * If the model is not found, a 404 HTTP exception will be thrown.
     * @param string $id ID
     * @return AuthAssignment the loaded model
     * @throws NotFoundHttpException if the model cannot be found
     */
    protected function findModel($id)
    {
        if (($model = AuthAssignment::findOne(['id' => $id])) !== null) {
            return $model;
        }


        throw new NotFoundHttpException(Yii::t('app', 'The requested page does not exist.'));
    }
}

Parámetros

  • Namespace: Define el espacio de nombres del controlador, que es app\controllers.
  • Modelos: Utiliza el modelo AuthAssignment para interactuar con la base de datos.
  • Acciones: Implementa acciones para listar, ver, crear, actualizar y eliminar asignaciones de roles y permisos.
  • Comportamientos: Define comportamientos como el manejo de verbos HTTP para las acciones.

English

Technical Documentation for the File AuthAssignmentController.php

Folder Definition

The AuthAssignmentController.php file is located in the controllers folder of a Yii2 project. This file is responsible for handling actions related to the AuthAssignment model, which is typically used to manage role and permission assignments to users in the application.

Purpose

The purpose of the AuthAssignmentController.php file is to implement CRUD (Create, Read, Update, Delete) actions for the AuthAssignment model. This allows administrators to manage the roles and permissions assigned to users through the user interface.

Functions

  1. List Assignments: Provides an action to list all role and permission assignments to users in the application.
  2. View Assignment: Allows administrators to view the details of a specific assignment.
  3. Create Assignment: Facilitates the creation of a new role or permission assignment to a user.
  4. Update Assignment: Allows editing of an existing assignment.
  5. Delete Assignment: Provides functionality to delete a specific assignment.

Common Structure

The AuthAssignmentController.php file typically has a structure similar to the following:

<?php


namespace app\controllers;


use Yii;
use app\models\AuthAssignment;
use app\models\AuthAssignmentSearch;
use yii\web\Controller;
use yii\web\NotFoundHttpException;
use yii\filters\VerbFilter;


/**
 * AuthAssignmentController implements the CRUD actions for AuthAssignment model.
 */
class AuthAssignmentController extends Controller
{
    /**
     * @inheritDoc
     */
    public function behaviors()
    {
        return array_merge(
            parent::behaviors(),
            [
                'verbs' => [
                    'class' => VerbFilter::className(),
                    'actions' => [
                        'delete' => ['POST'],
                    ],
                ],
            ]
        );
    }


    /**
     * Lists all AuthAssignment models.
     *
     * @return string
     */
    public function actionIndex()
    {
        $searchModel = new AuthAssignmentSearch();
        $dataProvider = $searchModel->search($this->request->queryParams);


        return $this->render('index', [
            'searchModel' => $searchModel,
            'dataProvider' => $dataProvider,
        ]);
    }


    /**
     * Displays a single AuthAssignment model.
     * @param string $id ID
     * @return string
     * @throws NotFoundHttpException if the model cannot be found
     */
    public function actionView($id)
    {
        return $this->render('view', [
            'model' => $this->findModel($id),
        ]);
    }


    /**
     * Creates a new AuthAssignment model.
     * If creation is successful, the browser will be redirected to the 'view' page.
     * @return string|\yii\web\Response
     */
    public function actionCreate()
    {
        $model = new AuthAssignment();


        if ($this->request->isPost) {
            if ($model->load($this->request->post()) && $model->save()) {
                return $this->redirect(['view', 'id' => $model->id]);
            }
        } else {
            $model->loadDefaultValues();
        }


        return $this->render('create', [
            'model' => $model,
        ]);
    }


    /**
     * Updates an existing AuthAssignment model.
     * If update is successful, the browser will be redirected to the 'view' page.
     * @param string $id ID
     * @return string|\yii\web\Response
     * @throws NotFoundHttpException if the model cannot be found
     */
    public function actionUpdate($id)
    {
        $model = $this->findModel($id);


        if ($this->request->isPost && $model->load($this->request->post()) && $model->save()) {
            return $this->redirect(['view', 'id' => $model->id]);
        }


        return $this->render('update', [
            'model' => $model,
        ]);
    }


    /**
     * Deletes an existing AuthAssignment model.
     * If deletion is successful, the browser will be redirected to the 'index' page.
     * @param string $id ID
     * @return \yii\web\Response
     * @throws NotFoundHttpException if the model cannot be found
     */
    public function actionDelete($id)
    {
        $this->findModel($id)->delete();


        return $this->redirect(['index']);
    }


    /**
     * Finds the AuthAssignment model based on its primary key value.
     * If the model is not found, a 404 HTTP exception will be thrown.
     * @param string $id ID
     * @return AuthAssignment the loaded model
     * @throws NotFoundHttpException if the model cannot be found
     */
    protected function findModel($id)
    {
        if (($model = AuthAssignment::findOne(['id' => $id])) !== null) {
            return $model;
        }


        throw new NotFoundHttpException(Yii::t('app', 'The requested page does not exist.'));
    }
}

Parameters

  • Namespace: Defines the namespace of the controller, which is app\controllers.
  • Models: Uses the AuthAssignment model to interact with the database.
  • Actions: Implements actions to list, view, create, update, and delete role and permission assignments.
  • Behaviors: Defines behaviors such as handling HTTP verbs for actions.