0 关注者

类 yii\filters\ContentNegotiator

所有类 | 属性 | 方法
继承关系yii\filters\ContentNegotiator » yii\base\ActionFilter » yii\base\Behavior » yii\base\BaseObject
实现yii\base\BootstrapInterface, yii\base\Configurable
可用版本2.0
源代码 https://github.com/yiisoft/yii2/blob/master/framework/filters/ContentNegotiator.php

ContentNegotiator 支持响应格式协商和应用程序语言协商。

当 支持的格式 属性被指定时，ContentNegotiator 将根据 GET 参数 $formatParam 和 Accept HTTP 头的值支持响应格式协商。如果找到匹配项，yii\web\Response::$format 属性将被设置为选定的格式。 yii\web\Response::$acceptMimeType 以及 yii\web\Response::$acceptParams 也将相应更新。

当 支持的语言 被指定时，ContentNegotiator 将根据 GET 参数 $languageParam 和 Accept-Language HTTP 头的值支持应用程序语言协商。如果找到匹配项，yii\base\Application::$language 属性将被设置为选定的语言。

您可以将 ContentNegotiator 用作引导组件以及操作过滤器。

以下代码展示了如何将 ContentNegotiator 用作引导组件。请注意，在这种情况下，内容协商适用于整个应用程序。

// in application configuration
use yii\web\Response;

return [
    'bootstrap' => [
        [
            'class' => 'yii\filters\ContentNegotiator',
            'formats' => [
                'application/json' => Response::FORMAT_JSON,
                'application/xml' => Response::FORMAT_XML,
            ],
            'languages' => [
                'en',
                'de',
            ],
        ],
    ],
];

以下代码展示了如何在控制器或模块中将 ContentNegotiator 用作操作过滤器。在这种情况下，内容协商结果仅适用于相应的控制器或模块，或者如果您配置了过滤器的 only 或 except 属性，则适用于特定操作。

use yii\web\Response;

public function behaviors()
{
    return [
        [
            'class' => 'yii\filters\ContentNegotiator',
            'only' => ['view', 'index'],  // in a controller
            // if in a module, use the following IDs for user actions
            // 'only' => ['user/view', 'user/index']
            'formats' => [
                'application/json' => Response::FORMAT_JSON,
            ],
            'languages' => [
                'en',
                'de',
            ],
        ],
    ];
}

公共属性

隐藏继承属性

属性 类型 描述 定义于
$except array 此过滤器不应应用于的操作 ID 列表。 yii\base\ActionFilter
$formatParam string 指定响应格式的 GET 参数名称。 yii\filters\ContentNegotiator
$formats array|null 支持的响应格式列表。 yii\filters\ContentNegotiator
$languageParam string 指定 应用程序语言 的 GET 参数名称。 yii\filters\ContentNegotiator
$languages array|null 支持的语言列表。 yii\filters\ContentNegotiator
$only array 此过滤器应应用于的操作 ID 列表。 yii\base\ActionFilter
$owner yii\base\Component|null 此行为的所有者 yii\base\Behavior
$request yii\web\Request 当前请求。 yii\filters\ContentNegotiator
$response yii\web\Response|null 要发送的响应。 yii\filters\ContentNegotiator

公共方法

隐藏继承方法

方法 描述 定义于
__call() 调用不是类方法的命名方法。 yii\base\BaseObject
__construct() 构造函数。 yii\base\BaseObject
__get() 返回对象属性的值。 yii\base\BaseObject
__isset() 检查属性是否已设置，即已定义且不为空。 yii\base\BaseObject
__set() 设置对象属性的值。 yii\base\BaseObject
__unset() 将对象属性设置为 null。 yii\base\BaseObject
afterAction() 此方法在执行操作后立即调用。 yii\base\ActionFilter
afterFilter() yii\base\ActionFilter
attach() 将行为对象附加到组件。 yii\base\ActionFilter
beforeAction() 此方法在要执行操作之前立即调用（在所有可能的过滤器之后）。您可以覆盖此方法，以便对操作进行最后一分钟的准备。 yii\filters\ContentNegotiator
beforeFilter() yii\base\ActionFilter
bootstrap() 在应用程序引导阶段调用的引导方法。 yii\filters\ContentNegotiator
canGetProperty() 返回一个值，指示是否可以读取属性。 yii\base\BaseObject
canSetProperty() 返回一个值，指示是否可以设置属性。 yii\base\BaseObject
className() 返回此类的完全限定名称。 yii\base\BaseObject
detach() 将行为对象从组件分离。 yii\base\ActionFilter
events() 为 $owner 的事件声明事件处理程序。 yii\base\Behavior
hasMethod() 返回一个值，指示是否定义了方法。 yii\base\BaseObject
hasProperty() 返回一个值，指示是否定义了属性。 yii\base\BaseObject
init() 初始化对象。 yii\base\BaseObject
negotiate() 协商响应格式和应用程序语言。 yii\filters\ContentNegotiator

受保护方法

隐藏继承方法

方法 描述 定义于
getActionId() 通过将 yii\base\Action::$uniqueId 转换为相对于模块的 ID 来返回操作 ID。 yii\base\ActionFilter
isActive() 返回一个值，指示过滤器是否对给定操作处于活动状态。 yii\base\ActionFilter
isLanguageSupported() 返回一个值，指示请求的语言是否与支持的语言匹配。 yii\filters\ContentNegotiator
negotiateContentType() 协商响应格式。 yii\filters\ContentNegotiator
negotiateLanguage() 协商应用程序语言。 yii\filters\ContentNegotiator

属性详情

隐藏继承属性

$formatParam 公共属性

指定响应格式的 GET 参数名称。请注意，如果指定的格式不存在于 $formats 中，则会抛出 yii\web\NotAcceptableHttpException 异常。如果参数值为空或此属性为 null，则将仅根据 Accept HTTP 头的值确定响应格式。

另请参见 $formats。

public string $formatParam = '_format'
$formats 公共属性

支持的响应格式列表。键是 MIME 类型（例如 application/json），而值是相应的格式（例如 html、json），这些格式必须像 yii\web\Response::$formatters 中声明的那样得到支持。

如果此属性为空或未设置，则将跳过响应格式协商。

public array|null $formats = null
$languageParam 公共属性

指定 应用程序语言 的 GET 参数名称。注意，如果指定的语言与 $languages 中的任何语言都不匹配，则将使用 $languages 中的第一个语言。如果参数值为空，或此属性为 null，则应用程序语言将仅根据 Accept-Language HTTP 标头确定。

另请参见 $languages.

public string $languageParam = '_lang'
$languages 公共属性

支持的语言列表。数组键是支持的语言变体（例如 en-GB、en-US），而数组值是应用程序识别的相应语言代码（例如 en、de）。

数组键并非始终必需。当数组值没有键时，将基于语言回退机制匹配请求的语言。例如，值为 en 将匹配 en、en_US、en-US、en-GB 等。

如果此属性为空或未设置，则将跳过语言协商。

public array|null $languages = null
$request 公共属性

当前请求。如果未设置，将使用 request 应用程序组件。

public yii\web\Request $request = null
$response 公共属性

要发送的响应。如果未设置，将使用 response 应用程序组件。

public yii\web\Response|null $response = null

方法详情

隐藏继承方法

__call() 公共方法

定义于： yii\base\BaseObject::__call()

调用不是类方法的命名方法。

不要直接调用此方法，因为它是一个 PHP 魔术方法，当调用未知方法时会隐式调用。

public mixed __call ( $name, $params )
$name string

方法名称
$params array

方法参数
返回值 mixed

方法返回值
抛出异常 yii\base\UnknownMethodException

当调用未知方法时

 

                public function __call($name, $params)
{
    throw new UnknownMethodException('Calling unknown method: ' . get_class($this) . "::$name()");
}
__construct() 公共方法

定义于： yii\base\BaseObject::__construct()

构造函数。

默认实现执行两件事

  • 使用给定的配置 $config 初始化对象。
  • 调用 init().

如果在子类中覆盖此方法，建议

  • 构造函数的最后一个参数是配置数组，如这里的 $config。
  • 在构造函数末尾调用父实现。
public void __construct ( $config = [] )
$config array

将用于初始化对象属性的名称-值对

 

                public function __construct($config = [])
{
    if (!empty($config)) {
        Yii::configure($this, $config);
    }
    $this->init();
}
__get() 公共方法

定义于： yii\base\BaseObject::__get()

返回对象属性的值。

不要直接调用此方法，因为它是一个 PHP 魔术方法，当执行 $value = $object->property; 时会隐式调用。

另请参见 __set().

public mixed __get ( $name )
$name string

属性名称
返回值 mixed

属性值
抛出异常 yii\base\UnknownPropertyException

如果未定义属性
抛出异常 yii\base\InvalidCallException

如果属性是只写属性

 

                public function __get($name)
{
    $getter = 'get' . $name;
    if (method_exists($this, $getter)) {
        return $this->$getter();
    } elseif (method_exists($this, 'set' . $name)) {
        throw new InvalidCallException('Getting write-only property: ' . get_class($this) . '::' . $name);
    }
    throw new UnknownPropertyException('Getting unknown property: ' . get_class($this) . '::' . $name);
}
__isset() 公共方法

定义于： yii\base\BaseObject::__isset()

检查属性是否已设置，即已定义且不为空。

不要直接调用此方法，因为它是一个 PHP 魔术方法，当执行 isset($object->property) 时会隐式调用。

注意，如果属性未定义，将返回 false。

另请参见 https://php.ac.cn/manual/en/function.isset.php.

public boolean __isset ( $name )
$name string

属性名称或事件名称
返回值 boolean

命名的属性是否已设置（不为空）。

 

                public function __isset($name)
{
    $getter = 'get' . $name;
    if (method_exists($this, $getter)) {
        return $this->$getter() !== null;
    }
    return false;
}
__set() 公共方法

定义于： yii\base\BaseObject::__set()

设置对象属性的值。

不要直接调用此方法，因为它是一个 PHP 魔术方法，当执行 $object->property = $value; 时会隐式调用。

另请参见 __get().

public void __set ( $name, $value )
$name string

属性名称或事件名称
$value mixed

属性值
抛出异常 yii\base\UnknownPropertyException

如果未定义属性
抛出异常 yii\base\InvalidCallException

如果属性是只读属性

 

                public function __set($name, $value)
{
    $setter = 'set' . $name;
    if (method_exists($this, $setter)) {
        $this->$setter($value);
    } elseif (method_exists($this, 'get' . $name)) {
        throw new InvalidCallException('Setting read-only property: ' . get_class($this) . '::' . $name);
    } else {
        throw new UnknownPropertyException('Setting unknown property: ' . get_class($this) . '::' . $name);
    }
}
__unset() 公共方法

定义于： yii\base\BaseObject::__unset()

将对象属性设置为 null。

不要直接调用此方法，因为它是一个 PHP 魔术方法，当执行 unset($object->property) 时会隐式调用。

注意，如果属性未定义，此方法将不执行任何操作。如果属性是只读属性，它将抛出异常。

另请参见 https://php.ac.cn/manual/en/function.unset.php.

public void __unset ( $name )
$name string

属性名称
抛出异常 yii\base\InvalidCallException

如果属性是只读属性。

 

                public function __unset($name)
{
    $setter = 'set' . $name;
    if (method_exists($this, $setter)) {
        $this->$setter(null);
    } elseif (method_exists($this, 'get' . $name)) {
        throw new InvalidCallException('Unsetting read-only property: ' . get_class($this) . '::' . $name);
    }
}
afterAction() 公共方法

定义于： yii\base\ActionFilter::afterAction()

此方法在执行操作后立即调用。

您可以覆盖此方法来对操作进行一些后处理。

public mixed afterAction ( $action, $result )
$action yii\base\Action

刚刚执行的操作。
$result mixed

操作执行结果
返回值 mixed

处理后的操作结果。

 

                public function afterAction($action, $result)
{
    return $result;
}
afterFilter() public method

定义于： yii\base\ActionFilter::afterFilter()

public void afterFilter ( $event )
$event yii\base\ActionEvent 

                public function afterFilter($event)
{
    $event->result = $this->afterAction($event->action, $event->result);
    $this->owner->off(Controller::EVENT_AFTER_ACTION, [$this, 'afterFilter']);
}
attach() public method

定义于： yii\base\ActionFilter::attach()

将行为对象附加到组件。

默认实现将设置 $owner 属性，并按 events() 中声明的方式附加事件处理程序。如果您覆盖此方法，请确保您调用了父级实现。

public void attach ( $owner )
$owner yii\base\Component

要附加此行为的组件。

 

                public function attach($owner)
{
    $this->owner = $owner;
    $owner->on(Controller::EVENT_BEFORE_ACTION, [$this, 'beforeFilter']);
}
beforeAction() public method

此方法在要执行操作之前立即调用（在所有可能的过滤器之后）。您可以覆盖此方法，以便对操作进行最后一分钟的准备。

public boolean beforeAction ( $action )
$action yii\base\Action

要执行的操作。
返回值 boolean

操作是否应该继续执行。

 

                public function beforeAction($action)
{
    $this->negotiate();
    return true;
}
beforeFilter() public method

定义于： yii\base\ActionFilter::beforeFilter()

public void beforeFilter ( $event )
$event yii\base\ActionEvent 

                public function beforeFilter($event)
{
    if (!$this->isActive($event->action)) {
        return;
    }
    $event->isValid = $this->beforeAction($event->action);
    if ($event->isValid) {
        // call afterFilter only if beforeFilter succeeds
        // beforeFilter and afterFilter should be properly nested
        $this->owner->on(Controller::EVENT_AFTER_ACTION, [$this, 'afterFilter'], null, false);
    } else {
        $event->handled = true;
    }
}
bootstrap() public method

在应用程序引导阶段调用的引导方法。

public void bootstrap ( $app )
$app yii\base\Application

当前正在运行的应用程序

 

                public function bootstrap($app)
{
    $this->negotiate();
}
canGetProperty() public method

定义于： yii\base\BaseObject::canGetProperty()

返回一个值，指示是否可以读取属性。

一个属性是可读的，如果

  • 类具有与指定名称关联的 getter 方法（在这种情况下，属性名称不区分大小写）；
  • 类具有与指定名称相同的成员变量（当 $checkVars 为 true 时）；

另见 canSetProperty()。

public boolean canGetProperty ( $name, $checkVars = true )
$name string

属性名称
$checkVars boolean

是否将成员变量视为属性
返回值 boolean

该属性是否可读

 

                public function canGetProperty($name, $checkVars = true)
{
    return method_exists($this, 'get' . $name) || $checkVars && property_exists($this, $name);
}
canSetProperty() public method

定义于： yii\base\BaseObject::canSetProperty()

返回一个值，指示是否可以设置属性。

一个属性是可写的，如果

  • 类具有与指定名称关联的 setter 方法（在这种情况下，属性名称不区分大小写）；
  • 类具有与指定名称相同的成员变量（当 $checkVars 为 true 时）；

另见 canGetProperty()。

public boolean canSetProperty ( $name, $checkVars = true )
$name string

属性名称
$checkVars boolean

是否将成员变量视为属性
返回值 boolean

该属性是否可写

 

                public function canSetProperty($name, $checkVars = true)
{
    return method_exists($this, 'set' . $name) || $checkVars && property_exists($this, $name);
}
className() public static method
自 2.0.14 起已弃用。在 PHP >=5.5 上，请使用 ::class 代替。

定义于： yii\base\BaseObject::className()

返回此类的完全限定名称。

public static string className ( )
返回值 string

此类的完全限定名称。

 

                public static function className()
{
    return get_called_class();
}
detach() public method

定义于： yii\base\ActionFilter::detach()

将行为对象从组件分离。

默认实现将取消设置 $owner 属性，并分离 events() 中声明的事件处理程序。如果您覆盖此方法，请确保您调用了父级实现。

public void detach ( )

                public function detach()
{
    if ($this->owner) {
        $this->owner->off(Controller::EVENT_BEFORE_ACTION, [$this, 'beforeFilter']);
        $this->owner->off(Controller::EVENT_AFTER_ACTION, [$this, 'afterFilter']);
        $this->owner = null;
    }
}
events() public method

定义于： yii\base\Behavior::events()

为 $owner 的事件声明事件处理程序。

子类可以覆盖此方法来声明应附加到 $owner 组件事件的 PHP 回调函数。

当行为附加到所有者时，回调函数将附加到 $owner 的事件；当行为从组件分离时，它们将从事件中分离。

回调函数可以是以下任何一种

  • 此行为中的方法：'handleClick'，等效于 [$this, 'handleClick']
  • 对象方法：[$object, 'handleClick']
  • 静态方法：['Page', 'handleClick']
  • 匿名函数：function ($event) { ... }

以下是一个例子

[
    Model::EVENT_BEFORE_VALIDATE => 'myBeforeValidate',
    Model::EVENT_AFTER_VALIDATE => 'myAfterValidate',
]
public array events ( )
返回值 array

事件（数组键）和相应的事件处理程序方法（数组值）。

 

                public function events()
{
    return [];
}
getActionId() protected method (available since version 2.0.7)

定义于： yii\base\ActionFilter::getActionId()

通过将 yii\base\Action::$uniqueId 转换为相对于模块的 ID 来返回操作 ID。

protected string getActionId ( $action )
$action yii\base\Action 

                protected function getActionId($action)
{
    if ($this->owner instanceof Module) {
        $mid = $this->owner->getUniqueId();
        $id = $action->getUniqueId();
        if ($mid !== '' && strpos($id, $mid) === 0) {
            $id = substr($id, strlen($mid) + 1);
        }
    } else {
        $id = $action->id;
    }
    return $id;
}
hasMethod() 公共方法

定义于: yii\base\BaseObject::hasMethod()

返回一个值，指示是否定义了方法。

默认实现调用 PHP 函数 method_exists()。如果实现了 PHP 魔术方法 __call()，则可以重写此方法。

public boolean hasMethod ( $name )
$name string

方法名称
返回值 boolean

方法是否已定义

 

                public function hasMethod($name)
{
    return method_exists($this, $name);
}
hasProperty() 公共方法

定义于: yii\base\BaseObject::hasProperty()

返回一个值，指示是否定义了属性。

属性定义如下：

  • 类具有与指定名称关联的 getter 或 setter 方法（在这种情况下，属性名称不区分大小写）；
  • 类具有与指定名称相同的成员变量（当 $checkVars 为 true 时）；

另请参见

public boolean hasProperty ( $name, $checkVars = true )
$name string

属性名称
$checkVars boolean

是否将成员变量视为属性
返回值 boolean

属性是否已定义

 

                public function hasProperty($name, $checkVars = true)
{
    return $this->canGetProperty($name, $checkVars) || $this->canSetProperty($name, false);
}
init() 公共方法

定义于: yii\base\BaseObject::init()

初始化对象。

此方法在构造函数结束时调用，在对象使用给定配置初始化之后调用。

public void init ( )

                public function init()
{
}
isActive() 受保护的方法

定义于: yii\base\ActionFilter::isActive()

返回一个值，指示过滤器是否对给定操作处于活动状态。

protected boolean isActive ( $action )
$action yii\base\Action

正在过滤的操作
返回值 boolean

过滤器是否对给定操作有效。

 

                protected function isActive($action)
{
    $id = $this->getActionId($action);
    if (empty($this->only)) {
        $onlyMatch = true;
    } else {
        $onlyMatch = false;
        foreach ($this->only as $pattern) {
            if (StringHelper::matchWildcard($pattern, $id)) {
                $onlyMatch = true;
                break;
            }
        }
    }
    $exceptMatch = false;
    foreach ($this->except as $pattern) {
        if (StringHelper::matchWildcard($pattern, $id)) {
            $exceptMatch = true;
            break;
        }
    }
    return !$exceptMatch && $onlyMatch;
}
isLanguageSupported() 受保护的方法

返回一个值，指示请求的语言是否与支持的语言匹配。

protected boolean isLanguageSupported ( $requested, $supported )
$requested string

请求的语言代码
$supported string

支持的语言代码
返回值 boolean

请求的语言是否受支持

 

                protected function isLanguageSupported($requested, $supported)
{
    $supported = str_replace('_', '-', strtolower($supported));
    $requested = str_replace('_', '-', strtolower($requested));
    return strpos($requested . '-', $supported . '-') === 0;
}
negotiate() 公共方法

协商响应格式和应用程序语言。

public void negotiate ( )

                public function negotiate()
{
    $request = $this->request ?: Yii::$app->getRequest();
    $response = $this->response ?: Yii::$app->getResponse();
    if (!empty($this->formats)) {
        if (\count($this->formats) > 1) {
            $response->getHeaders()->add('Vary', 'Accept');
        }
        $this->negotiateContentType($request, $response);
    }
    if (!empty($this->languages)) {
        if (\count($this->languages) > 1) {
            $response->getHeaders()->add('Vary', 'Accept-Language');
        }
        Yii::$app->language = $this->negotiateLanguage($request);
    }
}
negotiateContentType() 受保护的方法

协商响应格式。

protected void negotiateContentType ( $request, $response )
$request yii\web\Request
$response yii\web\Response
抛出异常 yii\web\BadRequestHttpException

如果为 GET 参数 $formatParam 收到一个数组。
抛出异常 yii\web\NotAcceptableHttpException

如果未接受任何请求的内容类型。

 

                protected function negotiateContentType($request, $response)
{
    if (!empty($this->formatParam) && ($format = $request->get($this->formatParam)) !== null) {
        if (is_array($format)) {
            throw new BadRequestHttpException("Invalid data received for GET parameter '{$this->formatParam}'.");
        }
        if (in_array($format, $this->formats)) {
            $response->format = $format;
            $response->acceptMimeType = null;
            $response->acceptParams = [];
            return;
        }
        throw new NotAcceptableHttpException('The requested response format is not supported: ' . $format);
    }
    $types = $request->getAcceptableContentTypes();
    if (empty($types)) {
        $types['*/*'] = [];
    }
    foreach ($types as $type => $params) {
        if (isset($this->formats[$type])) {
            $response->format = $this->formats[$type];
            $response->acceptMimeType = $type;
            $response->acceptParams = $params;
            return;
        }
    }
    foreach ($this->formats as $type => $format) {
        $response->format = $format;
        $response->acceptMimeType = $type;
        $response->acceptParams = [];
        break;
    }
    if (isset($types['*/*'])) {
        return;
    }
    throw new NotAcceptableHttpException('None of your requested content types is supported.');
}
negotiateLanguage() 受保护的方法

协商应用程序语言。

protected string negotiateLanguage ( $request )
$request yii\web\Request
返回值 string

选择的语言

 

                protected function negotiateLanguage($request)
{
    if (!empty($this->languageParam) && ($language = $request->get($this->languageParam)) !== null) {
        if (is_array($language)) {
            // If an array received, then skip it and use the first of supported languages
            return reset($this->languages);
        }
        if (isset($this->languages[$language])) {
            return $this->languages[$language];
        }
        foreach ($this->languages as $key => $supported) {
            if (is_int($key) && $this->isLanguageSupported($language, $supported)) {
                return $supported;
            }
        }
        return reset($this->languages);
    }
    foreach ($request->getAcceptableLanguages() as $language) {
        if (isset($this->languages[$language])) {
            return $this->languages[$language];
        }
        foreach ($this->languages as $key => $supported) {
            if (is_int($key) && $this->isLanguageSupported($language, $supported)) {
                return $supported;
            }
        }
    }
    return reset($this->languages);
}