Mandrill_Metadata::getList()   A
last analyzed

Complexity

Conditions 1
Paths 1

Size

Total Lines 4
Code Lines 2

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 1
eloc 2
c 0
b 0
f 0
nc 1
nop 0
dl 0
loc 4
rs 10
1
<?php
2
3
class Mandrill_Metadata
4
{
5
6
    private $master;
7
8
    public function __construct(Mandrill $master)
9
    {
10
        $this->master = $master;
11
    }
12
13
    /**
14
     * Get the list of custom metadata fields indexed for the account.
15
     * @return array the custom metadata fields for the account
16
     *     - return[] struct the individual custom metadata field info
17
     *         - name string the unique identifier of the metadata field to update
18
     *         - state string the current state of the metadata field, one of "active", "delete", or "index"
19
     *         - view_template string Mustache template to control how the metadata is rendered in your activity log
20
     */
21
    public function getList()
22
    {
23
        $_params = array();
24
        return $this->master->call('metadata/list', $_params);
25
    }
26
27
    /**
28
     * Add a new custom metadata field to be indexed for the account.
29
     * @param string $name a unique identifier for the metadata field
30
     * @param string $view_template optional Mustache template to control how the metadata is rendered in your activity log
31
     * @return struct the information saved about the new metadata field
0 ignored issues
show
Bug introduced by
The type struct was not found. Maybe you did not declare it correctly or list all dependencies?

The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. excluded_paths: ["lib/*"], you can move it to the dependency path list as follows:

filter:
    dependency_paths: ["lib/*"]

For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths

Loading history...
32
     *     - name string the unique identifier of the metadata field to update
33
     *     - state string the current state of the metadata field, one of "active", "delete", or "index"
34
     *     - view_template string Mustache template to control how the metadata is rendered in your activity log
35
     */
36
    public function add($name, $view_template = null)
37
    {
38
        $_params = array("name" => $name, "view_template" => $view_template);
39
        return $this->master->call('metadata/add', $_params);
40
    }
41
42
    /**
43
     * Update an existing custom metadata field.
44
     * @param string $name the unique identifier of the metadata field to update
45
     * @param string $view_template optional Mustache template to control how the metadata is rendered in your activity log
46
     * @return struct the information for the updated metadata field
47
     *     - name string the unique identifier of the metadata field to update
48
     *     - state string the current state of the metadata field, one of "active", "delete", or "index"
49
     *     - view_template string Mustache template to control how the metadata is rendered in your activity log
50
     */
51
    public function update($name, $view_template)
52
    {
53
        $_params = array("name" => $name, "view_template" => $view_template);
54
        return $this->master->call('metadata/update', $_params);
55
    }
56
57
    /**
58
     * Delete an existing custom metadata field. Deletion isn't instataneous, and /metadata/list will continue to return the field until the asynchronous deletion process is complete.
59
     * @param string $name the unique identifier of the metadata field to update
60
     * @return struct the information for the deleted metadata field
61
     *     - name string the unique identifier of the metadata field to update
62
     *     - state string the current state of the metadata field, one of "active", "delete", or "index"
63
     *     - view_template string Mustache template to control how the metadata is rendered in your activity log
64
     */
65
    public function delete($name)
66
    {
67
        $_params = array("name" => $name);
68
        return $this->master->call('metadata/delete', $_params);
69
    }
70
}
71