Class: PluginSonotsOption

Example)

1.   Assume min = 1, max = 10
2.   array(0, 5) to array(1, 5)
3.   array(1, null) to array(2, 10)
4.   array(3, 1) to array(4, 4)
5.   array(-5, null) to array(6, 10)
6.   array(0, -4) to array(1, 6)

An Example:

1.   $conf_options = array(
2.          // option  => array(Type, Default, Conf)
3.         'hierarchy' => array('bool', true),
4.         'num'       => array('interval', null),
5.         'filter'    => array('string', null),
6.         'sort'      => array('enum', 'name', array('name', 'reading', 'date')),
7.   );
8.   $options = array('filter'=>'AAA');
9.   list($options, $unknowns) = PluginSonotsOption::evaluate_options($options, $conf_options);
10.   var_export($options); // array('hierarchy'=>true,'num'=>null,'filter'=>'AAA','sort'=>'name')

Another Example with parse_option_line:

1.   $conf_options = array(
2.          // option  => array(Type, Default, Conf)
3.         'hierarchy' => array('bool', true),
4.         'num'       => array('interval', null),
5.         'filter'    => array('string', null, 'default'),
6.         'sort'      => array('enum', 'name', array('name', 'reading', 'date')),
7.   );
8.   $optline = 'Hoge/,filter,sort=reading';
9.   $options = PluginSonotsOption::parse_option_line($optline);
10.   var_export($options); // array('Hoge/'=>true,'filter'=>true,'sort'=>'reading')
11.   list($options, $unknowns) = PluginSonotsOption::evaluate_options($options, $conf_options);
12.   var_export($options); // array('hierarchy'=>true,'num'=>null,'filter'=>'default','sort'=>'reading')
13.   var_export($unknowns); // array('Hoge/'=>true)

How to Write $conf_options:

   $conf_options is an array of array(Type, Default, Conf)

   Role of Type)
     Specify one of the following types as a string:
     - bool      : boolean true or false
     - string    : string
     - array     : array
     - enum      : take only one element of possible values
     - enumarray : take only elements in possible values
     - number    : number
     - interval  : interval string. @see parse_interval for details
     - options   : options (will be recursively evaluated inside)

   Role of Default)
     It is the default value when the option was not specified by users.

   Role of Conf)
     Basically, the conf also means a default value, but it is for
     when the option was given but the option argument was not given, i.e.,
     the case no "=value" in the option line. Let me call it as default2.
     Concurrently, the conf has a different meaning for following types
     and this was the original main role of conf.
     - enum      : list possible values as an array. As default2,
                   the first element of array is used.
     - enumarray : list possible values as an array. As default2,
                   the entire array is used.
     - options   : $conf_options recursively. As default2, 'options'
                   are recursively configured by $conf_options for this
                   options, thus, defaults in $conf_options are used.

opt1=val1&opt2=val2&opt3=(a&b) Note that this is not inverse of parse_uri_option_line exactly because parse_uri_option_line assumes input variables are already rawurldecoded, but this performs rawurlencode.

Example)

1.  1:5   means 1st to 5th returns array(0, 5)
2.  2:3   means 2nd to 3rd returns array(1, 2)
3.  2:    means 2nd to end returns array(1, null)
4.  :3    means 1st to 2rd returns array(0, 3)
5.  4     means 4th returns array(3, 1)
6.  -5:   means last 5th to end returns array(-5, null)
7.  :-5   means 1st to last 5th returns array(0, -4)
8.  1+2   means 1st to 3rd returns array(0, 3)

1) Assume that the GET argument line was as opt1=val1&opt2=val2&opt3=(a&b) Thus, now you should have in $vars array('opt1'=>'val1','opt2'=>'val2','opt3'=>'(a','b)'=>'') or 2) Assume that the GET argument line was as opt1=val1&opt2=val2&opt3=(a,b) Thus, now you should have in $vars array('opt1'=>'val1','opt2'=>'val2','opt3'=>'(a,b)')