我有一个模型,它在SQL中运行一系列条件的查询。因此,该模型需要接受许多参数,即:
this->model_name->method($param1, $param2, ... )
在模型方面,我通常将其设置为
function method($param1 = NULL, $param2 = NULL, ... )
这些参数中的每一个都是可选的,用例会因应用程序而异。所以我的问题是:在什么时候(如果有的话)开始通过数组将这些参数传递给方法是有意义的,la:
$params = [
'param1' => 'whatever',
'param2' => 'whatever',
...
]
this->model_name->method($params)
我认为最终目标是更清晰的代码,而method(null, null, null, null, $param)
的实例更少,除非这是可以做的事情。
答案 0 :(得分:2)
大多数答案一直支持数组方法(一般来说,我也同意),但我会扮演魔鬼的拥护者并列出一些否定词:
文档不太清晰
记录函数/方法的大多数方法都将单独列出该函数的参数。例如,具有基本DocBlock的函数将如下所示:
/**
* A function that accepts an array of params
* @param array $param_array An array of key=>value arguments
*/
function accept_array($param_array = array('key1' => 'first_val', 'key2' => 'second_val')) {
var_dump($param_array);
}
请注意DocBlock不直接支持$param_array
的各个部分,而只是整个数组。相反,单独列出所有参数如下所示:
/**
* A function that 'normal' params
* @param string $key1 First argument
* @param string $key2 Second argument
*/
function accept_normal($key1 = 'first_val', $key2 = 'second_val') {
echo $key1;
echo $key2;
}
如果你希望你的函数是相当自我记录的,这也是一个问题,因为在第一个例子中你不需要在函数本身中实际列出你期望的参数。
默认值可能无法按预期工作
'正如预期'可能是一个加载的短语(这可能是一个更明显的问题),但请采取以下措施:
function accept_array($param_array = array('key1' => 'first_val', 'key2' => 'second_val')) {
var_dump($param_array);
}
accept_array(array('key2' => 'a_different_val'));
有些人可能希望var_dump包含默认值key1
和新值key2
,但整个数组会被替换,这意味着你需要记住在每个函数中手动设置每个键的默认值,如下所示:
function accept_array($param_array = array()) {
if (!isset($param_array['key1'])) { $param_array['key1'] = 'first_val'; }
if (!isset($param_array['key2'])) { $param_array['key2'] = 'second_val'; }
var_dump($param_array);
}
accept_array(array('key2' => 'a_different_val'));
无自动过滤
列出参数“正常”方式还为您提供了一组内置过滤器。以此快速而脏的用户搜索为例:
/**
* We want to allow searching for users by user_id or email only!
* @param array $param_array
*/
function find_user($param_array = array('user_id' => 0, 'email' => '')) {
foreach ($param_array as $field => $value) {
$this->db->or_where($field, $value);
}
$this->db->get('users');
}
find_user(array('first_name' => 'Joe', 'last_name' => 'Bloggs'));
如果不在$param_array
上手动添加一些“接受的密钥”类型验证,对find_user()
函数的调用基本上可以使用它喜欢的任何字段。更简单的版本显然看起来像这样:
/**
* We want to allow searching for users by user_id or email only!
* @param int $user_id
* @param string $email
*/
function find_user($user_id = 0, $email = '') {
$this->db->or_where('user_id', $user_id);
$this->db->or_where('email', $email);
$this->db->get('users');
}
// No way for me to submit any other fields, they'll just fail when they get to the query
find_user('Joe', 'Bloggs'));
我接受其中一些是入门级别的,可能还有更多我错过了(随意评论更多,我会将它们复制到信用回复中),但希望有足够的可以让人们在不考虑手动验证和文档等的情况下,自动使用'数组方法'三思而后行。
答案 1 :(得分:1)
传递一组参数为自我记录代码提供了更好的选择。
当我使用许多参数时,我经常会发现自己使用的样式如下:
// do_something_model($enable_option1,$enable_option2,$enable_option3)
do_something_model(FALSE, TRUE, FALSE)
我带有一个带参数名称的注释行,以提醒自己我是怎样的 使用该模型。
在这种情况下,使用具有有意义的键的数组提供了一个有用的助记符。
最近,我还使用了更多的包装函数。例如,我可能有我的 基本模型方法从表中获取我的所有数据,这个方法会有一些 选项。
然后我定义了一个执行特定任务的新方法,然后使用正确的选项调用其中的基本方法。
<强>脚注强>
我发现如果我的方法有“太多选项”,最好重新考虑方法的目的,并将其分解为两个或更多易于使用的专用方法。
答案 2 :(得分:0)
我也会推荐数组版本。 Symfony2也经常使用这种模式,例如在rendring模板中,创建表单类和创建一般的http响应。您只需要确保清楚地记录所有可能的参数。
答案 3 :(得分:0)
你可以去任何一条路线,但一个数组肯定会让你的方法更清洁。将参数作为数组传递是完全合理的。