File: TypeMapper.php

package info (click to toggle)
php-easyrdf 1.0.0-3
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, sid
  • size: 740 kB
  • sloc: php: 7,831; sh: 30; makefile: 8
file content (175 lines) | stat: -rw-r--r-- 5,889 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
<?php
namespace EasyRdf;

/**
 * EasyRdf
 *
 * LICENSE
 *
 * Copyright (c) 2009-2015 Nicholas J Humfrey.  All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution.
 * 3. The name of the author 'Nicholas J Humfrey" may be used to endorse or
 *    promote products derived from this software without specific prior
 *    written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 *
 * @package    EasyRdf
 * @copyright  Copyright (c) 2009-2015 Nicholas J Humfrey
 * @license    https://www.opensource.org/licenses/bsd-license.php
 */

/**
 * Class to map between RDF Types and PHP Classes
 *
 * @package    EasyRdf
 * @copyright  Copyright (c) 2009-2015 Nicholas J Humfrey
 * @license    https://www.opensource.org/licenses/bsd-license.php
 */
class TypeMapper
{
    /** The type map registry */
    private static $map = array();

    /** Default resource class */
    private static $defaultResourceClass = 'EasyRdf\Resource';

    /** Get the registered class for an RDF type
     *
     * If a type is not registered, then this method will return null.
     *
     * @param  string  $type   The RDF type (e.g. foaf:Person)
     *
     * @throws \InvalidArgumentException
     * @return string          The class name (e.g. Model_Foaf_Name)
     */
    public static function get($type)
    {
        if (!is_string($type) or $type == null or $type == '') {
            throw new \InvalidArgumentException(
                "\$type should be a string and cannot be null or empty"
            );
        }

        $type = RdfNamespace::expand($type);
        if (array_key_exists($type, self::$map)) {
            return self::$map[$type];
        } else {
            return null;
        }
    }

    /** Register an RDF type with a PHP Class name
     *
     * @param  string  $type   The RDF type (e.g. foaf:Person)
     * @param  string  $class  The PHP class name (e.g. Model_Foaf_Name)
     *
     * @throws \InvalidArgumentException
     * @return string          The PHP class name
     */
    public static function set($type, $class)
    {
        if (!is_string($type) or $type == null or $type == '') {
            throw new \InvalidArgumentException(
                "\$type should be a string and cannot be null or empty"
            );
        }

        if (!is_string($class) or $class == null or $class == '') {
            throw new \InvalidArgumentException(
                "\$class should be a string and cannot be null or empty"
            );
        }

        $type = RdfNamespace::expand($type);
        return self::$map[$type] = $class;
    }

    /**
      * Delete an existing RDF type mapping.
      *
      * @param  string  $type   The RDF type (e.g. foaf:Person)
      *
      * @throws \InvalidArgumentException
      */
    public static function delete($type)
    {
        if (!is_string($type) or $type == null or $type == '') {
            throw new \InvalidArgumentException(
                "\$type should be a string and cannot be null or empty"
            );
        }

        $type = RdfNamespace::expand($type);
        if (isset(self::$map[$type])) {
            unset(self::$map[$type]);
        }
    }

    /**
     * @return string           The default Resource class
     */
    public static function getDefaultResourceClass()
    {
        return self::$defaultResourceClass;
    }

    /**
     * Sets the default resource class
     *
     * @param  string $class The resource full class name (e.g. \MyCompany\Resource)
     *
     * @throws \InvalidArgumentException
     * @return string           The default Resource class
     */
    public static function setDefaultResourceClass($class)
    {
        if (!is_string($class) or $class == null or $class == '') {
            throw new \InvalidArgumentException(
                "\$class should be a string and cannot be null or empty"
            );
        }

        if (!class_exists($class)) {
            throw new \InvalidArgumentException(
                "Given class should be an existing class"
            );
        }

        $ancestors = class_parents($class);
        if (($class != 'EasyRdf\Resource') && (empty($ancestors) || !in_array('EasyRdf\Resource', $ancestors))) {
            throw new \InvalidArgumentException(
                "Given class should have EasyRdf\\Resource as an ancestor"
            );
        }

        return self::$defaultResourceClass = $class;
    }
}


/*
   Register default set of mapped types
*/

TypeMapper::set('rdf:Alt', 'EasyRdf\Container');
TypeMapper::set('rdf:Bag', 'EasyRdf\Container');
TypeMapper::set('rdf:List', 'EasyRdf\Collection');
TypeMapper::set('rdf:Seq', 'EasyRdf\Container');