<?php
/**
Copyright 2012-2014 Nick Korbel
This file is part of Booked Scheduler.
Booked Scheduler is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
Booked Scheduler is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with Booked Scheduler. If not, see <http://www.gnu.org/licenses/>.
*/
class CustomAttributeTypes
{
const SINGLE_LINE_TEXTBOX = 1;
const MULTI_LINE_TEXTBOX = 2;
const SELECT_LIST = 3;
const CHECKBOX = 4;
}
class CustomAttributeCategory
{
const RESERVATION = 1;
const USER = 2;
//const GROUP = 3;
const RESOURCE = 4;
const RESOURCE_TYPE = 5;
}
class CustomAttribute
{
/**
* @var int
*/
protected $id;
/**
* @var string
*/
protected $label;
/**
* @var CustomAttributeTypes|int
*/
protected $type;
/**
* @var CustomAttributeCategory|int
*/
protected $category;
/**
* @var string
*/
protected $regex;
/**
* @var bool
*/
protected $required;
/**
* @var int
*/
protected $entityId;
/**
* @var string|null
*/
protected $entityDescription;
/**
* @var string
*/
protected $possibleValues;
/**
* @var int
*/
protected $sortOrder;
/**
* @return int
*/
public function Id()
{
return $this->id;
}
/**
* @return string
*/
public function Label()
{
return $this->label;
}
/**
* @return string
*/
public function PossibleValues()
{
return $this->possibleValues;
}
/**
* @return array|string[]
*/
public function PossibleValueList()
{
return explode(',', $this->possibleValues);
}
/**
* @return string
*/
public function Regex()
{
return $this->regex;
}
/**
* @return bool
*/
public function Required()
{
return $this->required;
}
/**
* @return bool
*/
public function UniquePerEntity()
{
return !empty($this->entityId);
}
/**
* @return int|null
*/
public function EntityId()
{
return empty($this->entityId) ? null : $this->entityId;
}
/**
* @return null|string
*/
public function EntityDescription()
{
return $this->entityDescription;
}
/**
* @return \CustomAttributeCategory|int
*/
public function Category()
{
return $this->category;
}
/**
* @return \CustomAttributeTypes|int
*/
public function Type()
{
return $this->type;
}
/**
* @return int
*/
public function SortOrder()
{
return $this->sortOrder;
}
/**
* @param int $id
* @param string $label
* @param CustomAttributeTypes|int $type
* @param CustomAttributeCategory|int $category
* @param string $regex
* @param bool $required
* @param string $possibleValues
* @param int $sortOrder
* @param int|null $entityId
* @return CustomAttribute
*/
public function __construct($id, $label, $type, $category, $regex, $required, $possibleValues, $sortOrder,$entityId = null)
{
$this->id = $id;
$this->label = $label;
$this->type = $type;
$this->category = $category;
$this->regex = $regex;
$this->required = $required;
$this->entityId = $entityId;
$this->SetSortOrder($sortOrder);
$this->SetPossibleValues($possibleValues);
}
/**
* @static
* @param string $label
* @param CustomAttributeTypes|int $type
* @param CustomAttributeCategory|int $category
* @param string $regex
* @param bool $required
* @param string $possibleValues
* @param int $sortOrder
* @param int|null $entityId
* @return CustomAttribute
*/
public static function Create($label, $type, $category, $regex, $required, $possibleValues, $sortOrder, $entityId = null)
{
return new CustomAttribute(null, $label, $type, $category, $regex, $required, $possibleValues, $sortOrder, $entityId);
}
/**
* @static
* @param $row array
* @return Attribute
*/
public static function FromRow($row)
{
$attribute = new CustomAttribute(
$row[ColumnNames::ATTRIBUTE_ID],
$row[ColumnNames::ATTRIBUTE_LABEL],
$row[ColumnNames::ATTRIBUTE_TYPE],
$row[ColumnNames::ATTRIBUTE_CATEGORY],
$row[ColumnNames::ATTRIBUTE_CONSTRAINT],
$row[ColumnNames::ATTRIBUTE_REQUIRED],
$row[ColumnNames::ATTRIBUTE_POSSIBLE_VALUES],
$row[ColumnNames::ATTRIBUTE_SORT_ORDER],
$row[ColumnNames::ATTRIBUTE_ENTITY_ID],
$row[ColumnNames::ATTRIBUTE_ENTITY_ID]
);
$attribute->WithEntityDescription($row[ColumnNames::ATTRIBUTE_ENTITY_DESCRIPTION]);
return $attribute;
}
/**
* @param $value mixed
* @return bool
*/
public function SatisfiesRequired($value)
{
if (!$this->required)
{
return true;
}
$trimmed = trim($value);
return !empty($trimmed);
}
/**
* @param $value mixed
* @return bool
*/
public function SatisfiesConstraint($value)
{
if (!empty($this->regex))
{
return preg_match($this->regex, $value) > 0;
}
if (!empty($this->possibleValues))
{
if (!$this->required)
{
return true;
}
$list = $this->PossibleValueList();
return in_array($value, $list);
}
return true;
}
/**
* @param string $label
* @param string $regex
* @param bool $required
* @param string $possibleValues
* @param int $sortOrder
* @param int|null $entityId
*/
public function Update($label, $regex, $required, $possibleValues, $sortOrder, $entityId)
{
$this->label = $label;
$this->regex = $regex;
$this->required = $required;
$this->entityId = $entityId;
$this->SetPossibleValues($possibleValues);
$this->SetSortOrder($sortOrder);
}
/**
* @param string $possibleValues
*/
private function SetPossibleValues($possibleValues)
{
if (!empty($possibleValues))
{
$this->possibleValues = preg_replace('/\s*,\s*/', ',', trim($possibleValues));
}
}
/**
* @param int $sortOrder
*/
private function SetSortOrder($sortOrder)
{
$this->sortOrder = intval($sortOrder);
}
/**
* @param string $entityDescription
*/
public function WithEntityDescription($entityDescription)
{
$this->entityDescription = $entityDescription;
}
}
All system for education purposes only. For more tools: Telegram @jackleet