1: <?php
2: /**
3: * CakePHP(tm) : Rapid Development Framework (https://cakephp.org)
4: * Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
5: *
6: * Licensed under The MIT License
7: * For full copyright and license information, please see the LICENSE.txt
8: * Redistributions of files must retain the above copyright notice.
9: *
10: * @copyright Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
11: * @link https://cakephp.org CakePHP(tm) Project
12: * @since 3.4.0
13: * @license https://opensource.org/licenses/mit-license.php MIT License
14: */
15: namespace Cake\ORM;
16:
17: /**
18: * Behaviors implementing this interface can participate in entity marshalling.
19: *
20: * This enables behaviors to define behavior for how the properties they provide/manage
21: * should be marshalled.
22: */
23: interface PropertyMarshalInterface
24: {
25: /**
26: * Build a set of properties that should be included in the marshalling process.
27: *
28: * @param \Cake\ORM\Marshaller $marshaller The marhshaller of the table the behavior is attached to.
29: * @param array $map The property map being built.
30: * @param array $options The options array used in the marshalling call.
31: * @return array A map of `[property => callable]` of additional properties to marshal.
32: */
33: public function buildMarshalMap($marshaller, $map, $options);
34: }
35: