Project

General

Profile

Bug(バグ) #3510

opConfig::get() の $default に null 以外を指定すると sns_config.yml のデフォルト値が使用されない

Added by Youichi Kimura almost 6 years ago. Updated over 2 years ago.

Status:
Rejected(差し戻し)
Priority:
Low(低め)
Target version:
Start date:
2013-12-04
Due date:
% Done:

50%

3.6 で発生するか:
Unknown (未調査)
3.8 で発生するか:
Unknown (未調査)

Description

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 を使用するか否かの判定を行う。

Associated revisions

Revision 1ee2d377 (diff)
Added by Youichi Kimura almost 6 years ago

fix opConfig::get() doesn't use `Default' value in sns_config.yml when $default argument is set (fixes #3510)

History

#1 Updated by Youichi Kimura almost 6 years ago

  • Status changed from New(新規) to Accepted(着手)
  • Target version set to OpenPNE 3.9.0-old

#2 Updated by Youichi Kimura almost 6 years ago

  • Status changed from Accepted(着手) to Pending Review(レビュー待ち)
  • % Done changed from 0 to 50

更新履歴 1ee2d377283742abcbdc00ade1243a318031325f で適用されました。

#3 Updated by Youichi Kimura almost 6 years ago

  • Description updated (diff)
  • Assignee set to Youichi Kimura

#4 Updated by Yuya Watanabe almost 6 years ago

  • Status changed from Pending Review(レビュー待ち) to Rejected(差し戻し)

フィードバック

修正内容もテスト実行も問題無いですが,現状だとデフォルト値の優先順位が不明瞭なためコメントか何かにその辺りを記述しておいてもらえると嬉しいです.

テスト実行

$ php test/unit/config/opConfigTest.php 
1..6
# opConfig::get()
ok 1
ok 2
ok 3
ok 4
ok 5
ok 6
# Looks like everything went fine.

#5 Updated by Chiharu Nakajima almost 5 years ago

  • Priority changed from Normal(通常) to Low(低め)

#6 Updated by Chiharu Nakajima almost 5 years ago

このチケットの内容は下記の項目に該当する不具合であるため、一旦優先度を下げます。
・未対応でもユーザーに影響が少ない不具合(回避可能な不具合である等)

#7 Updated by kaoru n over 2 years ago

  • Target version changed from OpenPNE 3.9.0-old to OpenPNE 3.9.0

対象バージョン変更のため、修正内容の確認を行います。

Also available in: Atom PDF