Better name for "Model::formName()"

[klimov-paul]

Forked from #236

Method name “yii\base\Model::getFormName()” sounds confusing. For me words “form name” associates with “<form name=”form-name”>”.
I suppose this method should be named otherwise, like:

• getInputName()
• getInputGroupName()
• getRequestName()

[nsanden]

Agree and I think I like getInputName() best

[qiangxue]

I think formName is fine. It means this is the name used by the model in a form.

• getInputName(): this gives the impression of the name of a single input field, which is not the case here.
• getInputGroupName(): this introduces a new term "group" which isn't well defined.
• getRequestName(): this is not better than formName. It is actually worse because the term "request" is too generic, while "form" is very specific.

[rawtaz]

If I may chime in, I don't think that a model class (being an entity, normally) should be aware of the surrounding context/environment. It shouldn't know about things like HTML forms, it should be neutral to such things. Having the model class generate a name for the outside context, instead of having some utility/whatever do it, is like doing the reverse of DI, not clean. In Yii 1.1 terms I think the method at hand would belong in CActiveForm. Not sure what that translates to in Yii 2 terms, but preferrably not the model class :)

[rawtaz]

I think I missed the point of the actual discussion. I agree with @klimov-paul that the method should at least be named so that it isn't form specific. A name that indicates it returns some kind of "system" name would be appropriate, like there are in CHtml today.

[klimov-paul]

Possible variations:

• modelName()
• dataName()

[mdomba]

modelId() ?

[klimov-paul]

modelId() ?

Sounds to return value, which is unique for each class instance.

[nsanden]

rawtaz has good point, i like modelName()

[rawtaz]

If this was to be put in another class (equivalent to CActiveForm or whatever), there wouldn't be a problem coming up with a good name. The fact that this is the case now say something :-)

[klimov-paul]

@rawtaz, see #236

[rawtaz]

Yeah. I don't agree with it.

[mdomba]

Sounds to return value, which is unique for each class instance.

you mean each instance of the same class? why would it mean that? it returns a unique ID of a specific class, there are no two different class with same Id (name)... $model->id() or $model->getId(), $model->getModelId() variations are used in Yii frequently

[klimov-paul]

@mdomba, after some thought, I have nothing against "modelId()". It could be used.

[creocoder]

I think formName() is good. Model::formName() associates with model name inside form. All fine here. No need to rename.

[Ragazzo]

i also think formName() is good in this case.

[qiangxue]

Note that "form" doesn't necessarily refer to HTML forms. The term can be used in API as well. It is usually connected with user inputs, regardless of how it is presented.

[klimov-paul]

Resolution: no further actions.