Browse Source

PHPDoc, some trailing PHP tags removed

master
Anton Terekhov 12 years ago
parent
commit
1354f3d001
  1. 1
      app/router/Route.php
  2. 1
      classes/Format.class.php
  3. 1
      classes/User.class.php
  4. 1
      exception/ErrorHandler.php
  5. 68
      form/Form.php
  6. 99
      form/FormField.php
  7. 7
      i18n/I18N.php
  8. 1
      model/MongoStatement.php

1
app/router/Route.php

@ -27,6 +27,7 @@ class Route
/** /**
* @param array $request * @param array $request
* @return bool
*/ */
public function match($request) public function match($request)
{ {

1
classes/Format.class.php

@ -229,4 +229,3 @@ class Format
* Оффсет с учетом летнего/зимнего времени * Оффсет с учетом летнего/зимнего времени
*/ */
Format::setTimezoneOffset(date('Z') - ((date('I') ? 60*60 : 0 ))); Format::setTimezoneOffset(date('Z') - ((date('I') ? 60*60 : 0 )));
?>

1
classes/User.class.php

@ -116,4 +116,3 @@ class User
return $model->getById($id); return $model->getById($id);
} }
} }
?>

1
exception/ErrorHandler.php

@ -73,6 +73,7 @@ class ErrorHandler
/** /**
* @param Exception $exception * @param Exception $exception
* @return string
*/ */
static public function showDebug($exception) static public function showDebug($exception)
{ {

68
form/Form.php

@ -13,21 +13,31 @@ abstract class Form
{ {
const SUCCESS = 'success'; const SUCCESS = 'success';
const ERROR = 'error';
const ERROR = 'error';
/**
* @var FormField[]
*/
protected $fields = array(); protected $fields = array();
protected $messages = array(self::SUCCESS => 'Form data valid',
self::ERROR => 'Form data invalid');
/**
* @var array
*/
protected $messages = array(
self::SUCCESS => 'Form data valid',
self::ERROR => 'Form data invalid');
protected $valid = true; protected $valid = true;
public function __construct() public function __construct()
{ {
$this->init(); $this->init();
} }
/** /**
* @param string $name * @param string $name
* @param bool|string $message
* @return FormField * @return FormField
*/ */
protected function addField($name, $message = false) protected function addField($name, $message = false)
@ -35,13 +45,13 @@ abstract class Form
$this->fields[$name] = new FormField($message); $this->fields[$name] = new FormField($message);
return $this->fields[$name]; return $this->fields[$name];
} }
public function isValid($data) public function isValid($data)
{ {
if (!is_array($data)) { if (!is_array($data)) {
throw new InitializationException(__CLASS__ . '::' . __METHOD__ . ' expects an array'); throw new InitializationException(__CLASS__ . '::' . __METHOD__ . ' expects an array');
} }
foreach ($this->fields as $field_name => $field) { foreach ($this->fields as $field_name => $field) {
if (isset($data[$field_name])) { if (isset($data[$field_name])) {
$this->valid &= $field->isValid($data[$field_name], $data); $this->valid &= $field->isValid($data[$field_name], $data);
@ -54,7 +64,7 @@ abstract class Form
} }
return $this->valid; return $this->valid;
} }
public function getMessages() public function getMessages()
{ {
$messages = array(); $messages = array();
@ -65,7 +75,7 @@ abstract class Form
} }
return $messages; return $messages;
} }
public function getValue($key) public function getValue($key)
{ {
if (isset($this->fields[$key])) { if (isset($this->fields[$key])) {
@ -73,7 +83,10 @@ abstract class Form
} }
return false; return false;
} }
/**
* @return array
*/
public function getValues() public function getValues()
{ {
$values = array(); $values = array();
@ -84,7 +97,10 @@ abstract class Form
} }
return $values; return $values;
} }
/**
* @return array
*/
public function getSourceValues() public function getSourceValues()
{ {
$values = array(); $values = array();
@ -93,35 +109,49 @@ abstract class Form
} }
return $values; return $values;
} }
/**
* @return string
*/
public function getMessageType() public function getMessageType()
{ {
return ($this->valid) ? self::SUCCESS : self::ERROR; return ($this->valid) ? self::SUCCESS : self::ERROR;
} }
/**
* @return string
*/
public function getMessage() public function getMessage()
{ {
return $this->messages[$this->getMessageType()]; return $this->messages[$this->getMessageType()];
} }
/**
* @param string $message
* @return Form
*/
public function setSuccessMessage($message) public function setSuccessMessage($message)
{ {
$this->messages[self::SUCCESS] = (string) $message; $this->messages[self::SUCCESS] = (string) $message;
return $this; return $this;
} }
/**
* @param string $message
* @return Form
*/
public function setErrorMessage($message) public function setErrorMessage($message)
{ {
$this->messages[self::ERROR] = (string) $message; $this->messages[self::ERROR] = (string) $message;
return $this; return $this;
} }
protected function fillHelperData() protected function fillHelperData()
{ {
$data['messages'] = $this->getMessages(); $data['messages'] = $this->getMessages();
$data['values'] = $this->getSourceValues(); $data['values'] = $this->getSourceValues();
Session::set(get_class($this), $data); Session::set(get_class($this), $data);
} }
abstract protected function init(); abstract protected function init();
} }

99
form/FormField.php

@ -1,7 +1,7 @@
<?php <?php
/** /**
* @copyright NetMonsters <team@netmonsters.ru> * @copyright NetMonsters <team@netmonsters.ru>
* @link http://netmonsters.ru
* @link http://netmonsters.ru
* @package Majestic * @package Majestic
* @subpackage form * @subpackage form
* @since 2010-04-25 * @since 2010-04-25
@ -11,51 +11,93 @@
class FormField class FormField
{ {
/**
* @var iValidator[]
*/
protected $validators = array(); protected $validators = array();
/**
* @var iFilter[]
*/
protected $filters = array(); protected $filters = array();
/** /**
* Used instead message of validator if defined. * Used instead message of validator if defined.
*
*
* @var string * @var string
*/ */
protected $default_message = false; protected $default_message = false;
/**
* @var string
*/
protected $message = false; protected $message = false;
/**
* @var mixed
*/
protected $value; protected $value;
/* Flags */ /* Flags */
/**
* @var bool
*/
protected $required = true; protected $required = true;
/**
* @var bool
*/
protected $ignored = false; protected $ignored = false;
/**
* @param bool|string $default_message
*/
public function __construct($default_message = false) public function __construct($default_message = false)
{ {
$this->default_message = $default_message; $this->default_message = $default_message;
} }
/**
* @param bool $flag
* @return FormField
*/
public function setRequired($flag) public function setRequired($flag)
{ {
$this->required = (bool) $flag; $this->required = (bool) $flag;
return $this; return $this;
} }
/**
* @return bool
*/
public function isRequired() public function isRequired()
{ {
return $this->required; return $this->required;
} }
/**
* @param bool $flag
* @return FormField
*/
public function setIgnored($flag) public function setIgnored($flag)
{ {
$this->ignored = (bool) $flag; $this->ignored = (bool) $flag;
return $this; return $this;
} }
/**
* @return bool
*/
public function isIgnored() public function isIgnored()
{ {
return $this->ignored; return $this->ignored;
} }
/**
* @param string[]|iValidator[] $validators
* @return FormField
*/
public function addValidators($validators) public function addValidators($validators)
{ {
foreach ($validators as $validator) { foreach ($validators as $validator) {
@ -63,7 +105,12 @@ class FormField
} }
return $this; return $this;
} }
/**
* @param string|iValidator $validator
* @return FormField
* @throws InitializationException
*/
public function addValidator($validator) public function addValidator($validator)
{ {
if ($validator instanceof iValidator) { if ($validator instanceof iValidator) {
@ -77,7 +124,7 @@ class FormField
$this->validators[$name] = $validator; $this->validators[$name] = $validator;
return $this; return $this;
} }
public function addFilters($filters) public function addFilters($filters)
{ {
foreach ($filters as $filter) { foreach ($filters as $filter) {
@ -85,10 +132,10 @@ class FormField
} }
return $this; return $this;
} }
public function addFilter($filter) public function addFilter($filter)
{ {
if ($filter instanceof iFilter) {
if ($filter instanceof iFilter) {
$name = get_class($filter); $name = get_class($filter);
} elseif (is_string($filter)) { } elseif (is_string($filter)) {
$name = $filter . 'Filter'; $name = $filter . 'Filter';
@ -99,7 +146,7 @@ class FormField
$this->filters[$name] = $filter; $this->filters[$name] = $filter;
return $this; return $this;
} }
public function getValue() public function getValue()
{ {
$value = $this->value; $value = $this->value;
@ -110,10 +157,10 @@ class FormField
} }
return $value; return $value;
} }
/** /**
* $value & $key for array_walk_recursive * $value & $key for array_walk_recursive
*
*
* @param mixed $value * @param mixed $value
* @param mixed $key * @param mixed $key
*/ */
@ -123,24 +170,24 @@ class FormField
$value = $filter->filter($value); $value = $filter->filter($value);
} }
} }
public function getSourceValue() public function getSourceValue()
{ {
return $this->value; return $this->value;
} }
public function isValid($value, $context = null) public function isValid($value, $context = null)
{ {
$this->value = $value; $this->value = $value;
// filtered value here // filtered value here
$value = $this->getValue(); $value = $this->getValue();
$valid = true; $valid = true;
if ((($value === '') || ($value === null)) && !$this->isRequired()) { if ((($value === '') || ($value === null)) && !$this->isRequired()) {
return $valid; return $valid;
} }
foreach ($this->validators as $validator) { foreach ($this->validators as $validator) {
if (is_array($value)) { if (is_array($value)) {
foreach ($value as $val) { foreach ($value as $val) {
@ -158,14 +205,14 @@ class FormField
} elseif ($validator->isValid($value, $context)) { } elseif ($validator->isValid($value, $context)) {
continue; continue;
} }
$valid = false; $valid = false;
$this->message = ($this->default_message) ? $this->default_message : $validator->getMessage(); $this->message = ($this->default_message) ? $this->default_message : $validator->getMessage();
break; break;
} }
return $valid; return $valid;
} }
public function getMessage() public function getMessage()
{ {
return $this->message; return $this->message;

7
i18n/I18N.php

@ -20,10 +20,11 @@ class I18N
static protected $lang = ''; static protected $lang = '';
static protected $locale = ''; static protected $locale = '';
/** /**
* @param mixed $lang default language set
* @throws InitializationException
* @internal mixed $lang default language set
*/ */
static public function init() static public function init()
{ {

1
model/MongoStatement.php

@ -131,6 +131,7 @@ class MongoStatement extends DbStatement
/** /**
* @param MongoDbCommand $request * @param MongoDbCommand $request
* @throws GeneralException
* @return bool * @return bool
*/ */
protected function driverExecute($request) protected function driverExecute($request)

Loading…
Cancel
Save