Blame view

vendor/yiisoft/yii2/base/Action.php 3.6 KB
abf1649b   andryeyev   Чистая установка ...
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
  <?php
  /**
   * @link http://www.yiiframework.com/
   * @copyright Copyright (c) 2008 Yii Software LLC
   * @license http://www.yiiframework.com/license/
   */
  
  namespace yii\base;
  
  use Yii;
  
  /**
   * Action is the base class for all controller action classes.
   *
   * Action provides a way to reuse action method code. An action method in an Action
   * class can be used in multiple controllers or in different projects.
   *
   * Derived classes must implement a method named `run()`. This method
   * will be invoked by the controller when the action is requested.
   * The `run()` method can have parameters which will be filled up
   * with user input values automatically according to their names.
   * For example, if the `run()` method is declared as follows:
   *
   * ~~~
   * public function run($id, $type = 'book') { ... }
   * ~~~
   *
   * And the parameters provided for the action are: `['id' => 1]`.
   * Then the `run()` method will be invoked as `run(1)` automatically.
   *
   * @property string $uniqueId The unique ID of this action among the whole application. This property is
   * read-only.
   *
   * @author Qiang Xue <qiang.xue@gmail.com>
   * @since 2.0
   */
  class Action extends Component
  {
      /**
       * @var string ID of the action
       */
      public $id;
      /**
       * @var Controller|\yii\web\Controller the controller that owns this action
       */
      public $controller;
  
  
      /**
       * Constructor.
       *
       * @param string $id the ID of this action
       * @param Controller $controller the controller that owns this action
       * @param array $config name-value pairs that will be used to initialize the object properties
       */
      public function __construct($id, $controller, $config = [])
      {
          $this->id = $id;
          $this->controller = $controller;
          parent::__construct($config);
      }
  
      /**
       * Returns the unique ID of this action among the whole application.
       *
       * @return string the unique ID of this action among the whole application.
       */
      public function getUniqueId()
      {
          return $this->controller->getUniqueId() . '/' . $this->id;
      }
  
      /**
       * Runs this action with the specified parameters.
       * This method is mainly invoked by the controller.
       *
       * @param array $params the parameters to be bound to the action's run() method.
       * @return mixed the result of the action
       * @throws InvalidConfigException if the action class does not have a run() method
       */
      public function runWithParams($params)
      {
          if (!method_exists($this, 'run')) {
              throw new InvalidConfigException(get_class($this) . ' must define a "run()" method.');
          }
          $args = $this->controller->bindActionParams($this, $params);
          Yii::trace('Running action: ' . get_class($this) . '::run()', __METHOD__);
          if (Yii::$app->requestedParams === null) {
              Yii::$app->requestedParams = $args;
          }
          if ($this->beforeRun()) {
              $result = call_user_func_array([$this, 'run'], $args);
              $this->afterRun();
  
              return $result;
          } else {
              return null;
          }
      }
  
      /**
       * This method is called right before `run()` is executed.
       * You may override this method to do preparation work for the action run.
       * If the method returns false, it will cancel the action.
       *
       * @return boolean whether to run the action.
       */
      protected function beforeRun()
      {
          return true;
      }
  
      /**
       * This method is called right after `run()` is executed.
       * You may override this method to do post-processing work for the action run.
       */
      protected function afterRun()
      {
      }
  }