DBIx::Custom::Mapper

简介

DBIx::Custom::Mapper模块是DBIx::Custom框架的参数映射器。

my $mapper = $dbi->mapper(param => $param);
my $new_param = $mapper->map(
  title => 'book.title', # Key
  author => sub { '%' . $_[0] . '%'} # Value
  price => ['book.price' => sub { '%' . $_[0] . '%' }], # Key and value
);

属性

param

my $param = $mapper->param;
$mapper = $mapper->param({title => 'Perl', author => 'Ken'});

参数。在执行map方法时，会对这个属性进行映射得到新的new_param并返回。

pass

my $pass = $mapper->pass;
$mapper = $mapper->pass([qw/title author/]);

在执行map方法时，凡是在pass属性中设置的名称，其键与值都会直接复制到结果中，不会做任何改变。

codition

my $condition = $mapper->condition;
$mapper = $mapper->condition('exists');

映射条件，默认为length。

在执行map的过程中，只有满足codition条件的value才会被放入到结果中。

你可以将以下值设置为codition:

exists

condition => 'exists'

如果key存在，则对key和value进行映射。

defined

condition => 'defined';

如果定义了值，则对key和value进行映射。

length

condition => 'length';

如果值被定义并且长度不为0，则对key和value进行映射。

code reference

condition => sub { defined $_[0] }

你可以把condition的值设置为coderef类型的值。当子程序返回true时，对key和value进行映射。

方法

DBIx::Custom::Mapper 模块继承了Object::Simple中的所有方法，并实现了以下方法。

map

my $new_param = $mapper->map(
  price => {key => 'book.price'}
  title => {value => '%<value>%'}
  author => ['book.author' => '%<value>%']
);

my $new_param = $mapper->map(
  price => {key => 'book.price'}
  title => {value => sub { '%' . shift . '%'}}
  author => ['book.author' => sub { '%' . shift . '%'}]
);

对属性param进行映射，得到新的new_param。

例如，如果param设置为

{
  price => 1900,
  title => 'Perl',
  author => 'Ken',
  issue_date => '2010-11-11'
}

下面的哈希引用被返回。

{
  'book.price' => 1900,
  title => '%Perl%',
  'book.author' => '%Ken%',
}

默认情况下，如果值存在且长度不为0，则映射到结果中。

title => 'Perl'  # Mapped
{title => '' }   # Not mapped
{title => undef} # Not mapped
{}               # Not mapped

你可以设置condition属性，来改变映射条件。

 $mapper->condition('defined');

你也可以为每个key单独指定映射条件：

 my $new_param = $mapper->map(
   price => {key => 'book.price', condition => 'defined'}]
   title => {value => sub { '%' . $_[0] . '%'}, condition => 'defined'}
   author => ['book.author', sub { '%' . $_[0] . '%'}, 'exists']
 );

如果在pass属性中设置了一些key，则这些key对应的key和value会被原样复制到结果中。

$mapper->pass([qw/title author/]);
my $new_param = $mapper->map(price => {key => 'book.price'});

如上代码会把下面的param

{title => 'Perl', author => 'Ken', price => 1900}

映射到下面这个结果

{title => 'Perl', author => 'Ken', 'book.price' => 1900}

map方法中参数的语法

map方法接收一个hash作为参数。hash的键名需要与param中的键名对应，而键值的类型为hashref或arrayref，用来指定具体的映射规则。

当键值为hashref时

# String => Hash reference
price => {key => 'book.price'}
title => {value => '%<value>%'}
title => {value => sub { '%' . shift . '%'}}

如果在hashref中使用了key，则只对param中的key做映射。

# Rule
price => {key => 'book.price'}
# Parameter
price => 1900,
# New parameter
'book.price' => 1900,

如果在hashref中使用了value，则只对param中的value做映射。

# Rule
title => {value => '%<value>%'}
title => {value => sub { '%' . shift . '%'}}

# Parameter
title => 'Perl',
# New parameter
title => '%Perl%',

<value>会被替换为param中的键值，您也可以使用代码引用对原始做转换。

当键值为arrayref时

# String => Array reference
author => ['book.author' => '%<value>%']

这种情况下，键名和键值都会被映射，其结果与键值为hashref时的如下使用方式相同。

# Rule
{key => 'book.author', value => '%<value>%'}