Overview

Namespaces

  • DcGeneral
    • Clipboard
    • Contao
      • Callback
      • Compatibility
      • DataDefinition
        • Definition
      • Dca
        • Builder
          • Legacy
        • Definition
        • Palette
        • Populator
      • Event
      • View
        • Contao2BackendView
          • Event
    • Controller
    • Data
    • DataDefinition
      • Builder
      • Definition
        • Properties
        • View
          • Panel
      • ModelRelationship
      • Palette
        • Builder
          • Event
        • Condition
          • Palette
          • Property
    • EnvironmentPopulator
    • Event
    • Exception
    • Factory
      • Event
    • Panel
    • View
      • Event

Classes

  • Command
  • CommandCollection
  • CutCommand
  • DefaultListingConfig
  • DefaultModelFormatterConfig
  • DefaultPanelLayout
  • DefaultPanelRow
  • DefaultPanelRowCollection

Interfaces

  • CommandCollectionInterface
  • CommandInterface
  • CutCommandInterface
  • ListingConfigInterface
  • ModelFormatterConfigInterface
  • PanelLayoutInterface
  • PanelRowCollectionInterface
  • PanelRowInterface
  • Overview
  • Namespace
  • Class
  • Tree
  • Deprecated
  • Todo
 1: <?php
 2: /**
 3:  * PHP version 5
 4:  * @package    generalDriver
 5:  * @author     Christian Schiffler <c.schiffler@cyberspectrum.de>
 6:  * @author     Stefan Heimes <stefan_heimes@hotmail.com>
 7:  * @author     Tristan Lins <tristan.lins@bit3.de>
 8:  * @copyright  The MetaModels team.
 9:  * @license    LGPL.
10:  * @filesource
11:  */
12: 
13: namespace DcGeneral\DataDefinition\Definition\View;
14: 
15: /**
16:  * The model formatter format a model and create a string representation.
17:  *
18:  * @package DcGeneral\DataDefinition\Definition\View
19:  */
20: interface ModelFormatterConfigInterface
21: {
22:     /**
23:      * Set the used property names.
24:      *
25:      * @param array $propertyNames The property names.
26:      *
27:      * @return ModelFormatterConfigInterface
28:      */
29:     public function setPropertyNames(array $propertyNames);
30: 
31:     /**
32:      * Return the used property names.
33:      *
34:      * @return array
35:      */
36:     public function getPropertyNames();
37: 
38:     /**
39:      * Set the format string.
40:      *
41:      * @param string $format The format string to use.
42:      *
43:      * @return ModelFormatterConfigInterface
44:      */
45:     public function setFormat($format);
46: 
47:     /**
48:      * Return the format string.
49:      *
50:      * @return string
51:      */
52:     public function getFormat();
53: 
54:     /**
55:      * Set the formatted maximum length.
56:      *
57:      * @param int|null $maxLength The length to use - pass null to clear the cutting.
58:      *
59:      * @return ModelFormatterConfigInterface
60:      */
61:     public function setMaxLength($maxLength);
62: 
63:     /**
64:      * Return the formatted maximum length.
65:      *
66:      * @return int|null
67:      */
68:     public function getMaxLength();
69: }
70: 
contao-community-alliance/dc-general API documentation generated by ApiGen 2.8.0