Bug(バグ) #3510
完了opConfig::get() の $default に null 以外を指定すると sns_config.yml のデフォルト値が使用されない
100%
説明
Overview (現象)¶
sns_config.yml には下記のようにデフォルト値を設定する項目があり、例えば opConfig::get('sns_name')
とした場合に sns_config テーブルに該当する値が存在しない場合は 'MySNS'
が返るようになっている。また、sns_config.yml でデフォルト値が定義されていない項目については opConfig::get() の第二引数 $default の値が返る。
general:
sns_name:
Name: "sns_name"
Caption: "SNS名"
FormType: "input"
ValueType: "text"
Default: "MySNS"
IsRequired: true
しかし opConfig::get() の第二引数 $default に null 以外の値を指定すると、sns_config テーブルに存在しない設定項目について sns_config.yml に記述されている Default の値は無視され $default の値が返ってしまう。
Causes (原因)¶
public static function get($name, $default = null)
{
$setting = self::getConfigurationSetting();
$result = null;
$result = Doctrine::getTable('SnsConfig')->get($name, $default);
if (isset($setting[$name]))
{
if (is_null($result))
{
$result = self::getDefaultValue($name);
}
}
return $result;
}
SnsConfigTable::get() の第二引数に $default を指定しているため、sns_config テーブル内に該当するレコードが存在しない場合に is_null($result)
が false となり、$result が sns_config から取得された値なのか区別ができなくなってしまうことが原因。
Way to fix (修正内容)¶
SnsConfigTable::get() の第二引数には null を指定し、最後の return $result;
の箇所で $default を使用するか否かの判定を行う。
Youichi Kimura さんが約11年前に更新
- ステータス を New(新規) から Accepted(着手) に変更
- 対象バージョン を OpenPNE 3.9.0-old にセット
Youichi Kimura さんが約11年前に更新
- ステータス を Accepted(着手) から Pending Review(レビュー待ち) に変更
- 進捗率 を 0 から 50 に変更
更新履歴 1ee2d377283742abcbdc00ade1243a318031325f で適用されました。
Yuya Watanabe さんが約11年前に更新
- ステータス を Pending Review(レビュー待ち) から Rejected(差し戻し) に変更
Chiharu Nakajima さんがほぼ10年前に更新
このチケットの内容は下記の項目に該当する不具合であるため、一旦優先度を下げます。
・未対応でもユーザーに影響が少ない不具合(回避可能な不具合である等)
isao sano さんがほぼ5年前に更新
- コピー先 Backport(バックポート) #4384: opConfig::get() の $default に null 以外を指定すると sns_config.yml のデフォルト値が使用されない を追加
kaoru n さんが3年以上前に更新
#3510-2 で適用されたコードは、old-master ブランチには含まれているが、
https://github.com/openpne/OpenPNE3/blob/old-master/lib/config/opConfig.class.php#L50-L59
その他のブランチに含まれていない。
https://github.com/openpne/OpenPNE3/blame/master/lib/config/opConfig.class.php#L50-L59
https://github.com/openpne/OpenPNE3/blame/stable-3.10.x/lib/config/opConfig.class.php#L50-L59
https://github.com/openpne/OpenPNE3/blame/stable-3.8.x/lib/config/opConfig.class.php#L50-L59
削除された形跡もないため、おそらく適用されていないままと考えられる。
kaoru n さんが3年以上前に更新
- ステータス を Rejected(差し戻し) から Pending Review(レビュー待ち) に変更
https://github.com/openpne/OpenPNE3/pull/637
にてプルリクエストしました
Rimpei Ogawa さんが3年以上前に更新
- ステータス を Pending Review(レビュー待ち) から Pending Testing(テスト待ち) に変更
- 進捗率 を 50 から 70 に変更