Column::getCustomView() - Code Metrics - symfony2admingenerator/GeneratorBundle - Measure and Improve Code Quality continuously with Scrutinizer

Column::getCustomView() A
last analyzed 2019-08-07 21:50 UTC

↳ Parent: Column

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	4
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	0

<?php

namespace Admingenerator\GeneratorBundle\Generator;

use Admingenerator\GeneratorBundle\Exception\InvalidOptionException;

/**
 * This class describe a column
 *
 * @author cedric Lombardot
 * @author Piotr Gołębiewski <[email protected]>
 * @author Stéphane Escandell <[email protected]>
 */
use Doctrine\Common\Util\Inflector;

class Column
{
    /**
     * @var string
     */
    protected $name;

    /**
     * @var bool
     */
    protected $sortable = true;

    /**
     * @var string
     */
    protected $sortOn;

    /**
     * @var string
     */
    protected $sortType = 'default';

    /**
     * @var bool
     */
    protected $filterable = false;

    /**
     * @var string
     */
    protected $filterOn;

    /**
     * @var string
     */
    protected $dbType;

    /**
     * If set, formats field for scopes and filters. The formatting is a simple
     * sprintf with one string argument (field name).
     *
     * Example:
     *    for field:  "createdAt"
     *    dbFormat:   "DATE(%s)""
     *    the output will be "DATE(createdAt)"
     *
     * If undefined, the field will not be formatted.
     *
     * Since the functions may vary in different Database types, Admingenerator does not,
     * by default, format fields in any way. It is up to developer to implement this for his fields.
     *
     * Note: this feature was created mainly for Date/DateTime fields.
     */
    protected $dbFormat;

    /**
     * @var string
     */
    protected $customView = null;

    /**
     * @var string
     */
    protected $formType;

    /**
     * @var string
     */
    protected $filterType;

    /**
     * @var array
     */
    protected $formOptions = array();

    /**
     * @var array
     */
    protected $filterOptions = array();

    /**
     * @var string
     */
    protected $getter;

    /**
     * @var string
     */
    protected $label = null;

    /**
     * @var string
     */
    protected $help;

    /**
     * @var string
     */
    protected $localizedDateFormat;

    /**
     * @var string
     */
    protected $localizedTimeFormat;

    /**
     * @var string
     */
    protected $primaryKey = null;

    /**
     * For special columns template
     *
     * @var array
     */
    protected $extras = array();

    /**
     * @var string
     */
    protected $credentials = 'AdmingenAllowed';

    /**
     * @var string
     */
    protected $filtersCredentials = false;

    /**
     * @var string
     */
    protected $gridClass = '';

    /* Used for more verbose error messages */
    protected $debug = array();

    protected $manyToMany = false;

    /**
     * @param string $name
     * @param array  $debug
     */
    public function __construct($name, $debug)
    {
        $this->name     = $name;
        $this->filterOn = $name;
        $this->debug    = $debug;
    }

    public function setProperty($option, $value)
    {
        $setter = 'set'.Inflector::classify($option);

        if (method_exists($this, $setter)) {
            $this->{$setter}($value);
        } else {
            throw new InvalidOptionException($option, $this->name, $this->debug['generator'], $this->debug['builder']);
        }
    }

    public function getName()
    {
        return $this->name;
    }

    public function getGetter()
    {
        return $this->getter ? $this->getter : Inflector::camelize($this->name);
    }

    public function setGetter($getter)
    {
        $this->getter = $getter;
    }

    public function getLabel()
    {
        return false !== $this->label && empty($this->label)
            ? $this->humanize($this->getName())
            : $this->label;
    }

    public function setLabel($label)
    {
        return $this->label = $label;
    }

    public function getHelp()
    {
        return $this->help;
    }

    public function setHelp($help)
    {
        return $this->help = $help;
    }

    public function isSortable()
    {
        return $this->sortable;
    }

    public function isFilterable()
    {
        return $this->filterable;
    }

    public function isReal()
    {
        return $this->dbType != 'virtual';
    }

    public function getSortable()
    {
        return $this->sortable;
    }

    public function setSortable($sortable)
    {
        return $this->sortable = filter_var($sortable, FILTER_VALIDATE_BOOLEAN);
    }

    public function getSortOn()
    {
        return $this->sortOn != "" ? $this->sortOn : $this->name;
    }

    public function setSortOn($sort_on)
    {
        return $this->sortOn = $sort_on;
    }

    public function getFilterable()
    {
        return $this->filterable;
    }

    public function setFilterable($filterable)
    {
        return $this->filterable = filter_var($filterable, FILTER_VALIDATE_BOOLEAN);
    }

    public function getFilterOn()
    {
        return $this->filterOn;
    }

    public function setFilterOn($filterOn)
    {
        return $this->filterOn = $filterOn;
    }

    /**
     * @param string $text
     */
    private function humanize($text)
    {
        return ucfirst(str_replace('_', ' ', $text));
    }

    public function setDbType($dbType)
    {
        $this->dbType = $dbType;
    }

    public function getDbType()
    {
        return $this->dbType;
    }

    public function setDbFormat($dbFormat)
    {
        $this->dbFormat = $dbFormat;
    }

    public function getDbFormat()
    {
        return $this->dbFormat;
    }

    public function setFormType($formType)
    {
        $this->formType = $formType;
    }

    public function getFormType()
    {
        return $this->formType;
    }

    public function setFormOptions($formOptions)
    {
        $this->formOptions = $formOptions;
    }

    public function getFormOptions()
    {
        return $this->formOptions;
    }

    public function setFilterType($filterType)
    {
        $this->filterType = $filterType;
    }

    public function getFilterType()
    {
        return $this->filterType;
    }

    public function setFilterOptions($filterOptions)
    {
        $this->filterOptions = $filterOptions;
    }

    public function getFilterOptions()
    {
        return $this->filterOptions;
    }

    public function setLocalizedDateFormat($localizedDateFormat)
    {
        $this->localizedDateFormat = $localizedDateFormat;
    }

    public function getLocalizedDateFormat()
    {
        return $this->localizedDateFormat;
    }

    public function setLocalizedTimeFormat($localizedTimeFormat)
    {
        $this->localizedTimeFormat = $localizedTimeFormat;
    }

    public function getLocalizedTimeFormat()
    {
        return $this->localizedTimeFormat;
    }

    public function setAddFormOptions(array $additionalOptions = array())
    {
        foreach ($additionalOptions as $name => $option) {
            $this->formOptions[$name] = $this->parseOption($option);
        }
    }

    public function setAddFilterOptions(array $additionalOptions = array())
    {
        foreach ($additionalOptions as $name => $option) {
           $this->filterOptions[$name] = $this->parseOption($option);
        }
    }

    public function setExtras(array $values)
    {
        $this->extras = $values;
    }

    public function getExtras()
    {
        return $this->extras;
    }

    public function setSortType($type)
    {
        $this->sortType = $type;
    }

    public function getSortType()
    {
        return $this->sortType;
    }

    public function getCustomView()
    {
        return $this->customView;
    }

    public function setCustomView($customView)
    {
        $this->customView = $customView;
    }

    public function setPrimaryKey($primaryKey)
    {
        $this->primaryKey = $primaryKey;
    }

    public function getPrimaryKey()
    {
        return $this->primaryKey;
    }

    public function setCredentials($credentials = '')
    {
        return $this->credentials = $credentials;
    }

    public function getCredentials()
    {
        return $this->credentials;
    }

    public function setFiltersCredentials($credentials = '')
    {
        $this->filtersCredentials = $credentials;
    }

    public function getFiltersCredentials()
    {
        if (false === $this->filtersCredentials) {
            return $this->credentials;
        }

        return $this->filtersCredentials;
    }

    public function setGridClass($gridClass)
    {
        $this->gridClass = $gridClass;
    }

    public function getGridClass()
    {
        return $this->gridClass;
    }

    public function setManyToMany($manyToMany)
    {
        $this->manyToMany = $manyToMany;
    }

    public function getManyToMany()
    {
        return $this->manyToMany;
    }

    protected function parseOption($option)
    {
        if (!is_array($option)) {
            return $option;
        }

        foreach ($option as $k => $v) {
            if (preg_match('/^\.(.+)/i', $k, $matches)) {
                // enable to call php function to build your form options
                // Only if key STARTS with a dot (.). Values are used a params for the
                // function. See tests for sample.
                return call_user_func_array($matches[1], $v);
            }
        }

        return $option;
    }
}


1			<?php
2
3			namespace Admingenerator\GeneratorBundle\Generator;
4
5			use Admingenerator\GeneratorBundle\Exception\InvalidOptionException;
6
7			/**
8			* This class describe a column
9			*
10			* @author cedric Lombardot
11			* @author Piotr Gołębiewski <[email protected]>
12			* @author Stéphane Escandell <[email protected]>
13			*/
14			use Doctrine\Common\Util\Inflector;
15
16			class Column
17			{
18			/**
19			* @var string
20			*/
21			protected $name;
22
23			/**
24			* @var bool
25			*/
26			protected $sortable = true;
27
28			/**
29			* @var string
30			*/
31			protected $sortOn;
32
33			/**
34			* @var string
35			*/
36			protected $sortType = 'default';
37
38			/**
39			* @var bool
40			*/
41			protected $filterable = false;
42
43			/**
44			* @var string
45			*/
46			protected $filterOn;
47
48			/**
49			* @var string
50			*/
51			protected $dbType;
52
53			/**
54			* If set, formats field for scopes and filters. The formatting is a simple
55			* sprintf with one string argument (field name).
56			*
57			* Example:
58			* for field: "createdAt"
59			* dbFormat: "DATE(%s)""
60			* the output will be "DATE(createdAt)"
61			*
62			* If undefined, the field will not be formatted.
63			*
64			* Since the functions may vary in different Database types, Admingenerator does not,
65			* by default, format fields in any way. It is up to developer to implement this for his fields.
66			*
67			* Note: this feature was created mainly for Date/DateTime fields.
68			*/
69			protected $dbFormat;
70
71			/**
72			* @var string
73			*/
74			protected $customView = null;
75
76			/**
77			* @var string
78			*/
79			protected $formType;
80
81			/**
82			* @var string
83			*/
84			protected $filterType;
85
86			/**
87			* @var array
88			*/
89			protected $formOptions = array();
90
91			/**
92			* @var array
93			*/
94			protected $filterOptions = array();
95
96			/**
97			* @var string
98			*/
99			protected $getter;
100
101			/**
102			* @var string
103			*/
104			protected $label = null;
105
106			/**
107			* @var string
108			*/
109			protected $help;
110
111			/**
112			* @var string
113			*/
114			protected $localizedDateFormat;
115
116			/**
117			* @var string
118			*/
119			protected $localizedTimeFormat;
120
121			/**
122			* @var string
123			*/
124			protected $primaryKey = null;
125
126			/**
127			* For special columns template
128			*
129			* @var array
130			*/
131			protected $extras = array();
132
133			/**
134			* @var string
135			*/
136			protected $credentials = 'AdmingenAllowed';
137
138			/**
139			* @var string
140			*/
141			protected $filtersCredentials = false;
142
143			/**
144			* @var string
145			*/
146			protected $gridClass = '';
147
148			/* Used for more verbose error messages */
149			protected $debug = array();
150
151			protected $manyToMany = false;
152
153			/**
154			* @param string $name
155			* @param array $debug
156			*/
157			public function __construct($name, $debug)
158			{
159			$this->name = $name;
160			$this->filterOn = $name;
161			$this->debug = $debug;
162			}
163
164			public function setProperty($option, $value)
165			{
166			$setter = 'set'.Inflector::classify($option);
167
168			if (method_exists($this, $setter)) {
169			$this->{$setter}($value);
170			} else {
171			throw new InvalidOptionException($option, $this->name, $this->debug['generator'], $this->debug['builder']);
172			}
173			}
174
175			public function getName()
176			{
177			return $this->name;
178			}
179
180			public function getGetter()
181			{
182			return $this->getter ? $this->getter : Inflector::camelize($this->name);
183			}
184
185			public function setGetter($getter)
186			{
187			$this->getter = $getter;
188			}
189
190			public function getLabel()
191			{
192			return false !== $this->label && empty($this->label)
193			? $this->humanize($this->getName())
194			: $this->label;
195			}
196
197			public function setLabel($label)
198			{
199			return $this->label = $label;
200			}
201
202			public function getHelp()
203			{
204			return $this->help;
205			}
206
207			public function setHelp($help)
208			{
209			return $this->help = $help;
210			}
211
212			public function isSortable()
213			{
214			return $this->sortable;
215			}
216
217			public function isFilterable()
218			{
219			return $this->filterable;
220			}
221
222			public function isReal()
223			{
224			return $this->dbType != 'virtual';
225			}
226
227			public function getSortable()
228			{
229			return $this->sortable;
230			}
231
232			public function setSortable($sortable)
233			{
234			return $this->sortable = filter_var($sortable, FILTER_VALIDATE_BOOLEAN);
235			}
236
237			public function getSortOn()
238			{
239			return $this->sortOn != "" ? $this->sortOn : $this->name;
240			}
241
242			public function setSortOn($sort_on)
243			{
244			return $this->sortOn = $sort_on;
245			}
246
247			public function getFilterable()
248			{
249			return $this->filterable;
250			}
251
252			public function setFilterable($filterable)
253			{
254			return $this->filterable = filter_var($filterable, FILTER_VALIDATE_BOOLEAN);
255			}
256
257			public function getFilterOn()
258			{
259			return $this->filterOn;
260			}
261
262			public function setFilterOn($filterOn)
263			{
264			return $this->filterOn = $filterOn;
265			}
266
267			/**
268			* @param string $text
269			*/
270			private function humanize($text)
271			{
272			return ucfirst(str_replace('_', ' ', $text));
273			}
274
275			public function setDbType($dbType)
276			{
277			$this->dbType = $dbType;
278			}
279
280			public function getDbType()
281			{
282			return $this->dbType;
283			}
284
285			public function setDbFormat($dbFormat)
286			{
287			$this->dbFormat = $dbFormat;
288			}
289
290			public function getDbFormat()
291			{
292			return $this->dbFormat;
293			}
294
295			public function setFormType($formType)
296			{
297			$this->formType = $formType;
298			}
299
300			public function getFormType()
301			{
302			return $this->formType;
303			}
304
305			public function setFormOptions($formOptions)
306			{
307			$this->formOptions = $formOptions;
308			}
309
310			public function getFormOptions()
311			{
312			return $this->formOptions;
313			}
314
315			public function setFilterType($filterType)
316			{
317			$this->filterType = $filterType;
318			}
319
320			public function getFilterType()
321			{
322			return $this->filterType;
323			}
324
325			public function setFilterOptions($filterOptions)
326			{
327			$this->filterOptions = $filterOptions;
328			}
329
330			public function getFilterOptions()
331			{
332			return $this->filterOptions;
333			}
334
335			public function setLocalizedDateFormat($localizedDateFormat)
336			{
337			$this->localizedDateFormat = $localizedDateFormat;
338			}
339
340			public function getLocalizedDateFormat()
341			{
342			return $this->localizedDateFormat;
343			}
344
345			public function setLocalizedTimeFormat($localizedTimeFormat)
346			{
347			$this->localizedTimeFormat = $localizedTimeFormat;
348			}
349
350			public function getLocalizedTimeFormat()
351			{
352			return $this->localizedTimeFormat;
353			}
354
355			public function setAddFormOptions(array $additionalOptions = array())
356			{
357			foreach ($additionalOptions as $name => $option) {
358			$this->formOptions[$name] = $this->parseOption($option);
359			}
360			}
361
362			public function setAddFilterOptions(array $additionalOptions = array())
363			{
364			foreach ($additionalOptions as $name => $option) {
365			$this->filterOptions[$name] = $this->parseOption($option);
366			}
367			}
368
369			public function setExtras(array $values)
370			{
371			$this->extras = $values;
372			}
373
374			public function getExtras()
375			{
376			return $this->extras;
377			}
378
379			public function setSortType($type)
380			{
381			$this->sortType = $type;
382			}
383
384			public function getSortType()
385			{
386			return $this->sortType;
387			}
388
389			public function getCustomView()
390			{
391			return $this->customView;
392			}
393
394			public function setCustomView($customView)
395			{
396			$this->customView = $customView;
397			}
398
399			public function setPrimaryKey($primaryKey)
400			{
401			$this->primaryKey = $primaryKey;
402			}
403
404			public function getPrimaryKey()
405			{
406			return $this->primaryKey;
407			}
408
409			public function setCredentials($credentials = '')
410			{
411			return $this->credentials = $credentials;
412			}
413
414			public function getCredentials()
415			{
416			return $this->credentials;
417			}
418
419			public function setFiltersCredentials($credentials = '')
420			{
421			$this->filtersCredentials = $credentials;
422			}
423
424			public function getFiltersCredentials()
425			{
426			if (false === $this->filtersCredentials) {
427			return $this->credentials;
428			}
429
430			return $this->filtersCredentials;
431			}
432
433			public function setGridClass($gridClass)
434			{
435			$this->gridClass = $gridClass;
436			}
437
438			public function getGridClass()
439			{
440			return $this->gridClass;
441			}
442
443			public function setManyToMany($manyToMany)
444			{
445			$this->manyToMany = $manyToMany;
446			}
447
448			public function getManyToMany()
449			{
450			return $this->manyToMany;
451			}
452
453			protected function parseOption($option)
454			{
455			if (!is_array($option)) {
456			return $option;
457			}
458
459			foreach ($option as $k => $v) {
460			if (preg_match('/^\.(.+)/i', $k, $matches)) {
461			// enable to call php function to build your form options
462			// Only if key STARTS with a dot (.). Values are used a params for the
463			// function. See tests for sample.
464			return call_user_func_array($matches[1], $v);
465			}
466			}
467
468			return $option;
469			}
470			}
471

symfony2admingenerator / GeneratorBundle

Column::getCustomView() A last analyzed 2019-08-07 21:50 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

Column::getCustomView() A
last analyzed 2019-08-07 21:50 UTC