@@ -16,37 +16,37 @@ |
||
| 16 | 16 | { |
| 17 | 17 | |
| 18 | 18 | |
| 19 | - /** |
|
| 20 | - * setCollectionInterface |
|
| 21 | - * |
|
| 22 | - * @access protected |
|
| 23 | - * @param string $collection_interface |
|
| 24 | - */ |
|
| 25 | - protected function setCollectionInterface($collection_interface) |
|
| 26 | - { |
|
| 27 | - $this->collection_interface = ''; |
|
| 28 | - } |
|
| 19 | + /** |
|
| 20 | + * setCollectionInterface |
|
| 21 | + * |
|
| 22 | + * @access protected |
|
| 23 | + * @param string $collection_interface |
|
| 24 | + */ |
|
| 25 | + protected function setCollectionInterface($collection_interface) |
|
| 26 | + { |
|
| 27 | + $this->collection_interface = ''; |
|
| 28 | + } |
|
| 29 | 29 | |
| 30 | 30 | |
| 31 | - /** |
|
| 32 | - * add |
|
| 33 | - * attaches an object to the Collection |
|
| 34 | - * and sets any supplied data associated with the current iterator entry |
|
| 35 | - * by calling EE_Object_Collection::set_identifier() |
|
| 36 | - * |
|
| 37 | - * @access public |
|
| 38 | - * @param mixed $object |
|
| 39 | - * @param mixed $identifier |
|
| 40 | - * @return bool |
|
| 41 | - * @throws InvalidEntityException |
|
| 42 | - */ |
|
| 43 | - public function add($object, $identifier = null) |
|
| 44 | - { |
|
| 45 | - if (! is_object($object)) { |
|
| 46 | - throw new InvalidEntityException($object, 'object'); |
|
| 47 | - } |
|
| 48 | - $this->attach($object); |
|
| 49 | - $this->setIdentifier($object, $identifier); |
|
| 50 | - return $this->contains($object); |
|
| 51 | - } |
|
| 31 | + /** |
|
| 32 | + * add |
|
| 33 | + * attaches an object to the Collection |
|
| 34 | + * and sets any supplied data associated with the current iterator entry |
|
| 35 | + * by calling EE_Object_Collection::set_identifier() |
|
| 36 | + * |
|
| 37 | + * @access public |
|
| 38 | + * @param mixed $object |
|
| 39 | + * @param mixed $identifier |
|
| 40 | + * @return bool |
|
| 41 | + * @throws InvalidEntityException |
|
| 42 | + */ |
|
| 43 | + public function add($object, $identifier = null) |
|
| 44 | + { |
|
| 45 | + if (! is_object($object)) { |
|
| 46 | + throw new InvalidEntityException($object, 'object'); |
|
| 47 | + } |
|
| 48 | + $this->attach($object); |
|
| 49 | + $this->setIdentifier($object, $identifier); |
|
| 50 | + return $this->contains($object); |
|
| 51 | + } |
|
| 52 | 52 | } |
@@ -42,7 +42,7 @@ |
||
| 42 | 42 | */ |
| 43 | 43 | public function add($object, $identifier = null) |
| 44 | 44 | { |
| 45 | - if (! is_object($object)) { |
|
| 45 | + if ( ! is_object($object)) { |
|
| 46 | 46 | throw new InvalidEntityException($object, 'object'); |
| 47 | 47 | } |
| 48 | 48 | $this->attach($object); |
@@ -12,71 +12,71 @@ |
||
| 12 | 12 | abstract class NoticeConverter implements NoticeConverterInterface |
| 13 | 13 | { |
| 14 | 14 | |
| 15 | - /** |
|
| 16 | - * @var NoticesContainerInterface $notices |
|
| 17 | - */ |
|
| 18 | - private $notices; |
|
| 19 | - |
|
| 20 | - /** |
|
| 21 | - * if set to true, then errors will be thrown as exceptions |
|
| 22 | - * |
|
| 23 | - * @var boolean $throw_exceptions |
|
| 24 | - */ |
|
| 25 | - private $throw_exceptions; |
|
| 26 | - |
|
| 27 | - |
|
| 28 | - /** |
|
| 29 | - * NoticeConverter constructor. |
|
| 30 | - * |
|
| 31 | - * @param bool $throw_exceptions |
|
| 32 | - */ |
|
| 33 | - public function __construct($throw_exceptions = false) |
|
| 34 | - { |
|
| 35 | - $this->throw_exceptions = $throw_exceptions; |
|
| 36 | - } |
|
| 37 | - |
|
| 38 | - |
|
| 39 | - /** |
|
| 40 | - * @return NoticesContainerInterface |
|
| 41 | - */ |
|
| 42 | - public function getNotices() |
|
| 43 | - { |
|
| 44 | - return $this->notices; |
|
| 45 | - } |
|
| 46 | - |
|
| 47 | - |
|
| 48 | - /** |
|
| 49 | - * @param NoticesContainerInterface $notices |
|
| 50 | - */ |
|
| 51 | - protected function setNotices(NoticesContainerInterface $notices) |
|
| 52 | - { |
|
| 53 | - $this->notices = $notices; |
|
| 54 | - } |
|
| 55 | - |
|
| 56 | - |
|
| 57 | - /** |
|
| 58 | - * @return bool |
|
| 59 | - */ |
|
| 60 | - public function getThrowExceptions() |
|
| 61 | - { |
|
| 62 | - return $this->throw_exceptions; |
|
| 63 | - } |
|
| 64 | - |
|
| 65 | - |
|
| 66 | - /** |
|
| 67 | - * @param bool $throw_exceptions |
|
| 68 | - */ |
|
| 69 | - public function setThrowExceptions($throw_exceptions) |
|
| 70 | - { |
|
| 71 | - $this->throw_exceptions = filter_var($throw_exceptions, FILTER_VALIDATE_BOOLEAN); |
|
| 72 | - } |
|
| 73 | - |
|
| 74 | - |
|
| 75 | - /** |
|
| 76 | - * @return void; |
|
| 77 | - */ |
|
| 78 | - public function clearNotices() |
|
| 79 | - { |
|
| 80 | - $this->notices = null; |
|
| 81 | - } |
|
| 15 | + /** |
|
| 16 | + * @var NoticesContainerInterface $notices |
|
| 17 | + */ |
|
| 18 | + private $notices; |
|
| 19 | + |
|
| 20 | + /** |
|
| 21 | + * if set to true, then errors will be thrown as exceptions |
|
| 22 | + * |
|
| 23 | + * @var boolean $throw_exceptions |
|
| 24 | + */ |
|
| 25 | + private $throw_exceptions; |
|
| 26 | + |
|
| 27 | + |
|
| 28 | + /** |
|
| 29 | + * NoticeConverter constructor. |
|
| 30 | + * |
|
| 31 | + * @param bool $throw_exceptions |
|
| 32 | + */ |
|
| 33 | + public function __construct($throw_exceptions = false) |
|
| 34 | + { |
|
| 35 | + $this->throw_exceptions = $throw_exceptions; |
|
| 36 | + } |
|
| 37 | + |
|
| 38 | + |
|
| 39 | + /** |
|
| 40 | + * @return NoticesContainerInterface |
|
| 41 | + */ |
|
| 42 | + public function getNotices() |
|
| 43 | + { |
|
| 44 | + return $this->notices; |
|
| 45 | + } |
|
| 46 | + |
|
| 47 | + |
|
| 48 | + /** |
|
| 49 | + * @param NoticesContainerInterface $notices |
|
| 50 | + */ |
|
| 51 | + protected function setNotices(NoticesContainerInterface $notices) |
|
| 52 | + { |
|
| 53 | + $this->notices = $notices; |
|
| 54 | + } |
|
| 55 | + |
|
| 56 | + |
|
| 57 | + /** |
|
| 58 | + * @return bool |
|
| 59 | + */ |
|
| 60 | + public function getThrowExceptions() |
|
| 61 | + { |
|
| 62 | + return $this->throw_exceptions; |
|
| 63 | + } |
|
| 64 | + |
|
| 65 | + |
|
| 66 | + /** |
|
| 67 | + * @param bool $throw_exceptions |
|
| 68 | + */ |
|
| 69 | + public function setThrowExceptions($throw_exceptions) |
|
| 70 | + { |
|
| 71 | + $this->throw_exceptions = filter_var($throw_exceptions, FILTER_VALIDATE_BOOLEAN); |
|
| 72 | + } |
|
| 73 | + |
|
| 74 | + |
|
| 75 | + /** |
|
| 76 | + * @return void; |
|
| 77 | + */ |
|
| 78 | + public function clearNotices() |
|
| 79 | + { |
|
| 80 | + $this->notices = null; |
|
| 81 | + } |
|
| 82 | 82 | } |
@@ -13,119 +13,119 @@ |
||
| 13 | 13 | class AdminNotice |
| 14 | 14 | { |
| 15 | 15 | |
| 16 | - const ERROR = 'notice-error'; |
|
| 17 | - |
|
| 18 | - const WARNING = 'notice-warning'; |
|
| 19 | - |
|
| 20 | - const SUCCESS = 'notice-success'; |
|
| 21 | - |
|
| 22 | - const INFORMATION = 'notice-info'; |
|
| 23 | - |
|
| 24 | - const DISMISSABLE = ' is-dismissible'; |
|
| 25 | - |
|
| 26 | - /** |
|
| 27 | - * generic system notice to be converted into a WP admin notice |
|
| 28 | - * |
|
| 29 | - * @var NoticeInterface $notice |
|
| 30 | - */ |
|
| 31 | - private $notice; |
|
| 32 | - |
|
| 33 | - |
|
| 34 | - /** |
|
| 35 | - * AdminNotice constructor. |
|
| 36 | - * |
|
| 37 | - * @param NoticeInterface $notice |
|
| 38 | - * @param bool $display_now |
|
| 39 | - */ |
|
| 40 | - public function __construct(NoticeInterface $notice, $display_now = true) |
|
| 41 | - { |
|
| 42 | - $this->notice = $notice; |
|
| 43 | - if (! did_action('admin_notices')) { |
|
| 44 | - add_action('admin_notices', array($this, 'displayNotice')); |
|
| 45 | - } elseif ($display_now) { |
|
| 46 | - $this->displayNotice(); |
|
| 47 | - } |
|
| 48 | - } |
|
| 49 | - |
|
| 50 | - |
|
| 51 | - /** |
|
| 52 | - * @return void |
|
| 53 | - */ |
|
| 54 | - public function displayNotice() |
|
| 55 | - { |
|
| 56 | - echo $this->getNotice(); |
|
| 57 | - } |
|
| 58 | - |
|
| 59 | - |
|
| 60 | - /** |
|
| 61 | - * produces something like: |
|
| 62 | - * <div class="notice notice-success is-dismissible event-espresso-admin-notice"> |
|
| 63 | - * <p>YOU DID IT!</p> |
|
| 64 | - * <button type="button" class="notice-dismiss"><span class="screen-reader-text">Dismiss this |
|
| 65 | - * notice.</span></button> |
|
| 66 | - * </div> |
|
| 67 | - * |
|
| 68 | - * @return string |
|
| 69 | - */ |
|
| 70 | - public function getNotice() |
|
| 71 | - { |
|
| 72 | - return sprintf( |
|
| 73 | - '<div class="notice %1$s%2$s event-espresso-admin-notice"><p>%3$s</p></div>', |
|
| 74 | - $this->getType(), |
|
| 75 | - $this->notice->isDismissible() ? AdminNotice::DISMISSABLE : '', |
|
| 76 | - $this->getMessage() |
|
| 77 | - ); |
|
| 78 | - } |
|
| 79 | - |
|
| 80 | - |
|
| 81 | - /** |
|
| 82 | - * @return string |
|
| 83 | - */ |
|
| 84 | - private function getType() |
|
| 85 | - { |
|
| 86 | - switch ($this->notice->type()) { |
|
| 87 | - case Notice::ERROR: |
|
| 88 | - return AdminNotice::ERROR; |
|
| 89 | - break; |
|
| 90 | - case Notice::ATTENTION: |
|
| 91 | - return AdminNotice::WARNING; |
|
| 92 | - break; |
|
| 93 | - case Notice::SUCCESS: |
|
| 94 | - return AdminNotice::SUCCESS; |
|
| 95 | - break; |
|
| 96 | - case Notice::INFORMATION: |
|
| 97 | - default: |
|
| 98 | - return AdminNotice::INFORMATION; |
|
| 99 | - break; |
|
| 100 | - } |
|
| 101 | - } |
|
| 102 | - |
|
| 103 | - |
|
| 104 | - /** |
|
| 105 | - * @return string |
|
| 106 | - */ |
|
| 107 | - protected function getMessage() |
|
| 108 | - { |
|
| 109 | - $message = $this->notice->message(); |
|
| 110 | - if (WP_DEBUG && $this->getType() === AdminNotice::ERROR) { |
|
| 111 | - $message .= '<br/><span class="tiny-text">' . $this->generateErrorCode() . '</span>'; |
|
| 112 | - } |
|
| 113 | - return $message; |
|
| 114 | - } |
|
| 115 | - |
|
| 116 | - |
|
| 117 | - /** |
|
| 118 | - * create error code from filepath, function name, |
|
| 119 | - * and line number where notice was generated |
|
| 120 | - * |
|
| 121 | - * @return string |
|
| 122 | - */ |
|
| 123 | - protected function generateErrorCode() |
|
| 124 | - { |
|
| 125 | - $file = explode('.', basename($this->notice->file())); |
|
| 126 | - $error_code = ! empty($file[0]) ? $file[0] : ''; |
|
| 127 | - $error_code .= ! empty($error_code) ? ' - ' . $this->notice->func() : $this->notice->func(); |
|
| 128 | - $error_code .= ' - ' . $this->notice->line(); |
|
| 129 | - return $error_code; |
|
| 130 | - } |
|
| 16 | + const ERROR = 'notice-error'; |
|
| 17 | + |
|
| 18 | + const WARNING = 'notice-warning'; |
|
| 19 | + |
|
| 20 | + const SUCCESS = 'notice-success'; |
|
| 21 | + |
|
| 22 | + const INFORMATION = 'notice-info'; |
|
| 23 | + |
|
| 24 | + const DISMISSABLE = ' is-dismissible'; |
|
| 25 | + |
|
| 26 | + /** |
|
| 27 | + * generic system notice to be converted into a WP admin notice |
|
| 28 | + * |
|
| 29 | + * @var NoticeInterface $notice |
|
| 30 | + */ |
|
| 31 | + private $notice; |
|
| 32 | + |
|
| 33 | + |
|
| 34 | + /** |
|
| 35 | + * AdminNotice constructor. |
|
| 36 | + * |
|
| 37 | + * @param NoticeInterface $notice |
|
| 38 | + * @param bool $display_now |
|
| 39 | + */ |
|
| 40 | + public function __construct(NoticeInterface $notice, $display_now = true) |
|
| 41 | + { |
|
| 42 | + $this->notice = $notice; |
|
| 43 | + if (! did_action('admin_notices')) { |
|
| 44 | + add_action('admin_notices', array($this, 'displayNotice')); |
|
| 45 | + } elseif ($display_now) { |
|
| 46 | + $this->displayNotice(); |
|
| 47 | + } |
|
| 48 | + } |
|
| 49 | + |
|
| 50 | + |
|
| 51 | + /** |
|
| 52 | + * @return void |
|
| 53 | + */ |
|
| 54 | + public function displayNotice() |
|
| 55 | + { |
|
| 56 | + echo $this->getNotice(); |
|
| 57 | + } |
|
| 58 | + |
|
| 59 | + |
|
| 60 | + /** |
|
| 61 | + * produces something like: |
|
| 62 | + * <div class="notice notice-success is-dismissible event-espresso-admin-notice"> |
|
| 63 | + * <p>YOU DID IT!</p> |
|
| 64 | + * <button type="button" class="notice-dismiss"><span class="screen-reader-text">Dismiss this |
|
| 65 | + * notice.</span></button> |
|
| 66 | + * </div> |
|
| 67 | + * |
|
| 68 | + * @return string |
|
| 69 | + */ |
|
| 70 | + public function getNotice() |
|
| 71 | + { |
|
| 72 | + return sprintf( |
|
| 73 | + '<div class="notice %1$s%2$s event-espresso-admin-notice"><p>%3$s</p></div>', |
|
| 74 | + $this->getType(), |
|
| 75 | + $this->notice->isDismissible() ? AdminNotice::DISMISSABLE : '', |
|
| 76 | + $this->getMessage() |
|
| 77 | + ); |
|
| 78 | + } |
|
| 79 | + |
|
| 80 | + |
|
| 81 | + /** |
|
| 82 | + * @return string |
|
| 83 | + */ |
|
| 84 | + private function getType() |
|
| 85 | + { |
|
| 86 | + switch ($this->notice->type()) { |
|
| 87 | + case Notice::ERROR: |
|
| 88 | + return AdminNotice::ERROR; |
|
| 89 | + break; |
|
| 90 | + case Notice::ATTENTION: |
|
| 91 | + return AdminNotice::WARNING; |
|
| 92 | + break; |
|
| 93 | + case Notice::SUCCESS: |
|
| 94 | + return AdminNotice::SUCCESS; |
|
| 95 | + break; |
|
| 96 | + case Notice::INFORMATION: |
|
| 97 | + default: |
|
| 98 | + return AdminNotice::INFORMATION; |
|
| 99 | + break; |
|
| 100 | + } |
|
| 101 | + } |
|
| 102 | + |
|
| 103 | + |
|
| 104 | + /** |
|
| 105 | + * @return string |
|
| 106 | + */ |
|
| 107 | + protected function getMessage() |
|
| 108 | + { |
|
| 109 | + $message = $this->notice->message(); |
|
| 110 | + if (WP_DEBUG && $this->getType() === AdminNotice::ERROR) { |
|
| 111 | + $message .= '<br/><span class="tiny-text">' . $this->generateErrorCode() . '</span>'; |
|
| 112 | + } |
|
| 113 | + return $message; |
|
| 114 | + } |
|
| 115 | + |
|
| 116 | + |
|
| 117 | + /** |
|
| 118 | + * create error code from filepath, function name, |
|
| 119 | + * and line number where notice was generated |
|
| 120 | + * |
|
| 121 | + * @return string |
|
| 122 | + */ |
|
| 123 | + protected function generateErrorCode() |
|
| 124 | + { |
|
| 125 | + $file = explode('.', basename($this->notice->file())); |
|
| 126 | + $error_code = ! empty($file[0]) ? $file[0] : ''; |
|
| 127 | + $error_code .= ! empty($error_code) ? ' - ' . $this->notice->func() : $this->notice->func(); |
|
| 128 | + $error_code .= ' - ' . $this->notice->line(); |
|
| 129 | + return $error_code; |
|
| 130 | + } |
|
| 131 | 131 | } |
@@ -40,7 +40,7 @@ discard block |
||
| 40 | 40 | public function __construct(NoticeInterface $notice, $display_now = true) |
| 41 | 41 | { |
| 42 | 42 | $this->notice = $notice; |
| 43 | - if (! did_action('admin_notices')) { |
|
| 43 | + if ( ! did_action('admin_notices')) { |
|
| 44 | 44 | add_action('admin_notices', array($this, 'displayNotice')); |
| 45 | 45 | } elseif ($display_now) { |
| 46 | 46 | $this->displayNotice(); |
@@ -108,7 +108,7 @@ discard block |
||
| 108 | 108 | { |
| 109 | 109 | $message = $this->notice->message(); |
| 110 | 110 | if (WP_DEBUG && $this->getType() === AdminNotice::ERROR) { |
| 111 | - $message .= '<br/><span class="tiny-text">' . $this->generateErrorCode() . '</span>'; |
|
| 111 | + $message .= '<br/><span class="tiny-text">'.$this->generateErrorCode().'</span>'; |
|
| 112 | 112 | } |
| 113 | 113 | return $message; |
| 114 | 114 | } |
@@ -124,8 +124,8 @@ discard block |
||
| 124 | 124 | { |
| 125 | 125 | $file = explode('.', basename($this->notice->file())); |
| 126 | 126 | $error_code = ! empty($file[0]) ? $file[0] : ''; |
| 127 | - $error_code .= ! empty($error_code) ? ' - ' . $this->notice->func() : $this->notice->func(); |
|
| 128 | - $error_code .= ' - ' . $this->notice->line(); |
|
| 127 | + $error_code .= ! empty($error_code) ? ' - '.$this->notice->func() : $this->notice->func(); |
|
| 128 | + $error_code .= ' - '.$this->notice->line(); |
|
| 129 | 129 | return $error_code; |
| 130 | 130 | } |
| 131 | 131 | } |
@@ -15,218 +15,218 @@ |
||
| 15 | 15 | { |
| 16 | 16 | |
| 17 | 17 | |
| 18 | - /** |
|
| 19 | - * @var NoticeInterface[] $information |
|
| 20 | - */ |
|
| 21 | - private $information = array(); |
|
| 22 | - |
|
| 23 | - |
|
| 24 | - /** |
|
| 25 | - * @var NoticeInterface[] $attention |
|
| 26 | - */ |
|
| 27 | - private $attention = array(); |
|
| 28 | - |
|
| 29 | - |
|
| 30 | - /** |
|
| 31 | - * @var NoticeInterface[] $error |
|
| 32 | - */ |
|
| 33 | - private $error = array(); |
|
| 34 | - |
|
| 35 | - |
|
| 36 | - /** |
|
| 37 | - * @var NoticeInterface[] $success |
|
| 38 | - */ |
|
| 39 | - private $success = array(); |
|
| 40 | - |
|
| 41 | - |
|
| 42 | - /** |
|
| 43 | - * @param string $notice |
|
| 44 | - * @param bool $dismissible |
|
| 45 | - * @param string $file |
|
| 46 | - * @param string $func |
|
| 47 | - * @param string $line |
|
| 48 | - * @throws InvalidDataTypeException |
|
| 49 | - */ |
|
| 50 | - public function addInformation($notice, $dismissible = true, $file = '', $func = '', $line = '') |
|
| 51 | - { |
|
| 52 | - $this->information[] = new Notice( |
|
| 53 | - Notice::INFORMATION, |
|
| 54 | - $notice, |
|
| 55 | - $dismissible, |
|
| 56 | - $file, |
|
| 57 | - $func, |
|
| 58 | - $line |
|
| 59 | - ); |
|
| 60 | - } |
|
| 61 | - |
|
| 62 | - |
|
| 63 | - /** |
|
| 64 | - * @param string $notice |
|
| 65 | - * @param bool $dismissible |
|
| 66 | - * @param string $file |
|
| 67 | - * @param string $func |
|
| 68 | - * @param string $line |
|
| 69 | - * @throws InvalidDataTypeException |
|
| 70 | - */ |
|
| 71 | - public function addAttention($notice, $dismissible = true, $file = '', $func = '', $line = '') |
|
| 72 | - { |
|
| 73 | - $this->attention[] = new Notice( |
|
| 74 | - Notice::ATTENTION, |
|
| 75 | - $notice, |
|
| 76 | - $dismissible, |
|
| 77 | - $file, |
|
| 78 | - $func, |
|
| 79 | - $line |
|
| 80 | - ); |
|
| 81 | - } |
|
| 82 | - |
|
| 83 | - // phpcs:disable PEAR.Functions.ValidDefaultValue.NotAtEnd |
|
| 84 | - /** |
|
| 85 | - * @param string $notice |
|
| 86 | - * @param bool $dismissible |
|
| 87 | - * @param string $file |
|
| 88 | - * @param string $func |
|
| 89 | - * @param string $line |
|
| 90 | - * @throws InvalidDataTypeException |
|
| 91 | - */ |
|
| 92 | - public function addError($notice, $dismissible = true, $file, $func, $line) |
|
| 93 | - { |
|
| 94 | - $this->error[] = new Notice( |
|
| 95 | - Notice::ERROR, |
|
| 96 | - $notice, |
|
| 97 | - $dismissible, |
|
| 98 | - $file, |
|
| 99 | - $func, |
|
| 100 | - $line |
|
| 101 | - ); |
|
| 102 | - } |
|
| 103 | - |
|
| 104 | - |
|
| 105 | - /** |
|
| 106 | - * @param string $notice |
|
| 107 | - * @param bool $dismissible |
|
| 108 | - * @param string $file |
|
| 109 | - * @param string $func |
|
| 110 | - * @param string $line |
|
| 111 | - * @throws InvalidDataTypeException |
|
| 112 | - */ |
|
| 113 | - public function addSuccess($notice, $dismissible = true, $file = '', $func = '', $line = '') |
|
| 114 | - { |
|
| 115 | - $this->success[] = new Notice( |
|
| 116 | - Notice::SUCCESS, |
|
| 117 | - $notice, |
|
| 118 | - $dismissible, |
|
| 119 | - $file, |
|
| 120 | - $func, |
|
| 121 | - $line |
|
| 122 | - ); |
|
| 123 | - } |
|
| 124 | - |
|
| 125 | - |
|
| 126 | - /** |
|
| 127 | - * @return boolean |
|
| 128 | - */ |
|
| 129 | - public function hasInformation() |
|
| 130 | - { |
|
| 131 | - return ! empty($this->information); |
|
| 132 | - } |
|
| 133 | - |
|
| 134 | - |
|
| 135 | - /** |
|
| 136 | - * @return boolean |
|
| 137 | - */ |
|
| 138 | - public function hasAttention() |
|
| 139 | - { |
|
| 140 | - return ! empty($this->attention); |
|
| 141 | - } |
|
| 142 | - |
|
| 143 | - |
|
| 144 | - /** |
|
| 145 | - * @return boolean |
|
| 146 | - */ |
|
| 147 | - public function hasError() |
|
| 148 | - { |
|
| 149 | - return ! empty($this->error); |
|
| 150 | - } |
|
| 151 | - |
|
| 152 | - |
|
| 153 | - /** |
|
| 154 | - * @return boolean |
|
| 155 | - */ |
|
| 156 | - public function hasSuccess() |
|
| 157 | - { |
|
| 158 | - return ! empty($this->success); |
|
| 159 | - } |
|
| 160 | - |
|
| 161 | - |
|
| 162 | - /** |
|
| 163 | - * @return int |
|
| 164 | - */ |
|
| 165 | - public function countInformation() |
|
| 166 | - { |
|
| 167 | - return count($this->information); |
|
| 168 | - } |
|
| 169 | - |
|
| 170 | - |
|
| 171 | - /** |
|
| 172 | - * @return int |
|
| 173 | - */ |
|
| 174 | - public function countAttention() |
|
| 175 | - { |
|
| 176 | - return count($this->attention); |
|
| 177 | - } |
|
| 178 | - |
|
| 179 | - |
|
| 180 | - /** |
|
| 181 | - * @return int |
|
| 182 | - */ |
|
| 183 | - public function countError() |
|
| 184 | - { |
|
| 185 | - return count($this->error); |
|
| 186 | - } |
|
| 187 | - |
|
| 188 | - |
|
| 189 | - /** |
|
| 190 | - * @return int |
|
| 191 | - */ |
|
| 192 | - public function countSuccess() |
|
| 193 | - { |
|
| 194 | - return count($this->success); |
|
| 195 | - } |
|
| 196 | - |
|
| 197 | - |
|
| 198 | - /** |
|
| 199 | - * @return NoticeInterface[] |
|
| 200 | - */ |
|
| 201 | - public function getInformation() |
|
| 202 | - { |
|
| 203 | - return $this->information; |
|
| 204 | - } |
|
| 205 | - |
|
| 206 | - |
|
| 207 | - /** |
|
| 208 | - * @return NoticeInterface[] |
|
| 209 | - */ |
|
| 210 | - public function getAttention() |
|
| 211 | - { |
|
| 212 | - return $this->attention; |
|
| 213 | - } |
|
| 214 | - |
|
| 215 | - |
|
| 216 | - /** |
|
| 217 | - * @return NoticeInterface[] |
|
| 218 | - */ |
|
| 219 | - public function getError() |
|
| 220 | - { |
|
| 221 | - return $this->error; |
|
| 222 | - } |
|
| 223 | - |
|
| 224 | - |
|
| 225 | - /** |
|
| 226 | - * @return NoticeInterface[] |
|
| 227 | - */ |
|
| 228 | - public function getSuccess() |
|
| 229 | - { |
|
| 230 | - return $this->success; |
|
| 231 | - } |
|
| 18 | + /** |
|
| 19 | + * @var NoticeInterface[] $information |
|
| 20 | + */ |
|
| 21 | + private $information = array(); |
|
| 22 | + |
|
| 23 | + |
|
| 24 | + /** |
|
| 25 | + * @var NoticeInterface[] $attention |
|
| 26 | + */ |
|
| 27 | + private $attention = array(); |
|
| 28 | + |
|
| 29 | + |
|
| 30 | + /** |
|
| 31 | + * @var NoticeInterface[] $error |
|
| 32 | + */ |
|
| 33 | + private $error = array(); |
|
| 34 | + |
|
| 35 | + |
|
| 36 | + /** |
|
| 37 | + * @var NoticeInterface[] $success |
|
| 38 | + */ |
|
| 39 | + private $success = array(); |
|
| 40 | + |
|
| 41 | + |
|
| 42 | + /** |
|
| 43 | + * @param string $notice |
|
| 44 | + * @param bool $dismissible |
|
| 45 | + * @param string $file |
|
| 46 | + * @param string $func |
|
| 47 | + * @param string $line |
|
| 48 | + * @throws InvalidDataTypeException |
|
| 49 | + */ |
|
| 50 | + public function addInformation($notice, $dismissible = true, $file = '', $func = '', $line = '') |
|
| 51 | + { |
|
| 52 | + $this->information[] = new Notice( |
|
| 53 | + Notice::INFORMATION, |
|
| 54 | + $notice, |
|
| 55 | + $dismissible, |
|
| 56 | + $file, |
|
| 57 | + $func, |
|
| 58 | + $line |
|
| 59 | + ); |
|
| 60 | + } |
|
| 61 | + |
|
| 62 | + |
|
| 63 | + /** |
|
| 64 | + * @param string $notice |
|
| 65 | + * @param bool $dismissible |
|
| 66 | + * @param string $file |
|
| 67 | + * @param string $func |
|
| 68 | + * @param string $line |
|
| 69 | + * @throws InvalidDataTypeException |
|
| 70 | + */ |
|
| 71 | + public function addAttention($notice, $dismissible = true, $file = '', $func = '', $line = '') |
|
| 72 | + { |
|
| 73 | + $this->attention[] = new Notice( |
|
| 74 | + Notice::ATTENTION, |
|
| 75 | + $notice, |
|
| 76 | + $dismissible, |
|
| 77 | + $file, |
|
| 78 | + $func, |
|
| 79 | + $line |
|
| 80 | + ); |
|
| 81 | + } |
|
| 82 | + |
|
| 83 | + // phpcs:disable PEAR.Functions.ValidDefaultValue.NotAtEnd |
|
| 84 | + /** |
|
| 85 | + * @param string $notice |
|
| 86 | + * @param bool $dismissible |
|
| 87 | + * @param string $file |
|
| 88 | + * @param string $func |
|
| 89 | + * @param string $line |
|
| 90 | + * @throws InvalidDataTypeException |
|
| 91 | + */ |
|
| 92 | + public function addError($notice, $dismissible = true, $file, $func, $line) |
|
| 93 | + { |
|
| 94 | + $this->error[] = new Notice( |
|
| 95 | + Notice::ERROR, |
|
| 96 | + $notice, |
|
| 97 | + $dismissible, |
|
| 98 | + $file, |
|
| 99 | + $func, |
|
| 100 | + $line |
|
| 101 | + ); |
|
| 102 | + } |
|
| 103 | + |
|
| 104 | + |
|
| 105 | + /** |
|
| 106 | + * @param string $notice |
|
| 107 | + * @param bool $dismissible |
|
| 108 | + * @param string $file |
|
| 109 | + * @param string $func |
|
| 110 | + * @param string $line |
|
| 111 | + * @throws InvalidDataTypeException |
|
| 112 | + */ |
|
| 113 | + public function addSuccess($notice, $dismissible = true, $file = '', $func = '', $line = '') |
|
| 114 | + { |
|
| 115 | + $this->success[] = new Notice( |
|
| 116 | + Notice::SUCCESS, |
|
| 117 | + $notice, |
|
| 118 | + $dismissible, |
|
| 119 | + $file, |
|
| 120 | + $func, |
|
| 121 | + $line |
|
| 122 | + ); |
|
| 123 | + } |
|
| 124 | + |
|
| 125 | + |
|
| 126 | + /** |
|
| 127 | + * @return boolean |
|
| 128 | + */ |
|
| 129 | + public function hasInformation() |
|
| 130 | + { |
|
| 131 | + return ! empty($this->information); |
|
| 132 | + } |
|
| 133 | + |
|
| 134 | + |
|
| 135 | + /** |
|
| 136 | + * @return boolean |
|
| 137 | + */ |
|
| 138 | + public function hasAttention() |
|
| 139 | + { |
|
| 140 | + return ! empty($this->attention); |
|
| 141 | + } |
|
| 142 | + |
|
| 143 | + |
|
| 144 | + /** |
|
| 145 | + * @return boolean |
|
| 146 | + */ |
|
| 147 | + public function hasError() |
|
| 148 | + { |
|
| 149 | + return ! empty($this->error); |
|
| 150 | + } |
|
| 151 | + |
|
| 152 | + |
|
| 153 | + /** |
|
| 154 | + * @return boolean |
|
| 155 | + */ |
|
| 156 | + public function hasSuccess() |
|
| 157 | + { |
|
| 158 | + return ! empty($this->success); |
|
| 159 | + } |
|
| 160 | + |
|
| 161 | + |
|
| 162 | + /** |
|
| 163 | + * @return int |
|
| 164 | + */ |
|
| 165 | + public function countInformation() |
|
| 166 | + { |
|
| 167 | + return count($this->information); |
|
| 168 | + } |
|
| 169 | + |
|
| 170 | + |
|
| 171 | + /** |
|
| 172 | + * @return int |
|
| 173 | + */ |
|
| 174 | + public function countAttention() |
|
| 175 | + { |
|
| 176 | + return count($this->attention); |
|
| 177 | + } |
|
| 178 | + |
|
| 179 | + |
|
| 180 | + /** |
|
| 181 | + * @return int |
|
| 182 | + */ |
|
| 183 | + public function countError() |
|
| 184 | + { |
|
| 185 | + return count($this->error); |
|
| 186 | + } |
|
| 187 | + |
|
| 188 | + |
|
| 189 | + /** |
|
| 190 | + * @return int |
|
| 191 | + */ |
|
| 192 | + public function countSuccess() |
|
| 193 | + { |
|
| 194 | + return count($this->success); |
|
| 195 | + } |
|
| 196 | + |
|
| 197 | + |
|
| 198 | + /** |
|
| 199 | + * @return NoticeInterface[] |
|
| 200 | + */ |
|
| 201 | + public function getInformation() |
|
| 202 | + { |
|
| 203 | + return $this->information; |
|
| 204 | + } |
|
| 205 | + |
|
| 206 | + |
|
| 207 | + /** |
|
| 208 | + * @return NoticeInterface[] |
|
| 209 | + */ |
|
| 210 | + public function getAttention() |
|
| 211 | + { |
|
| 212 | + return $this->attention; |
|
| 213 | + } |
|
| 214 | + |
|
| 215 | + |
|
| 216 | + /** |
|
| 217 | + * @return NoticeInterface[] |
|
| 218 | + */ |
|
| 219 | + public function getError() |
|
| 220 | + { |
|
| 221 | + return $this->error; |
|
| 222 | + } |
|
| 223 | + |
|
| 224 | + |
|
| 225 | + /** |
|
| 226 | + * @return NoticeInterface[] |
|
| 227 | + */ |
|
| 228 | + public function getSuccess() |
|
| 229 | + { |
|
| 230 | + return $this->success; |
|
| 231 | + } |
|
| 232 | 232 | } |
@@ -51,547 +51,547 @@ |
||
| 51 | 51 | class ModelFieldFactory |
| 52 | 52 | { |
| 53 | 53 | |
| 54 | - /** |
|
| 55 | - * @var LoaderInterface $loader |
|
| 56 | - */ |
|
| 57 | - private $loader; |
|
| 58 | - |
|
| 59 | - |
|
| 60 | - /** |
|
| 61 | - * ModelFieldFactory constructor. |
|
| 62 | - * |
|
| 63 | - * @param LoaderInterface $loader |
|
| 64 | - */ |
|
| 65 | - public function __construct(LoaderInterface $loader) |
|
| 66 | - { |
|
| 67 | - $this->loader = $loader; |
|
| 68 | - } |
|
| 69 | - |
|
| 70 | - |
|
| 71 | - /** |
|
| 72 | - * @param string $table_column |
|
| 73 | - * @param string $nice_name |
|
| 74 | - * @param bool $nullable |
|
| 75 | - * @param null $default_value |
|
| 76 | - * @return EE_All_Caps_Text_Field |
|
| 77 | - */ |
|
| 78 | - public function createAllCapsTextField($table_column, $nice_name, $nullable, $default_value = null) |
|
| 79 | - { |
|
| 80 | - return $this->loader->getNew( |
|
| 81 | - 'EE_All_Caps_Text_Field', |
|
| 82 | - array($table_column, $nice_name, $nullable, $default_value) |
|
| 83 | - ); |
|
| 84 | - } |
|
| 85 | - |
|
| 86 | - |
|
| 87 | - /** |
|
| 88 | - * @param string $table_column |
|
| 89 | - * @param string $nice_name |
|
| 90 | - * @param bool $nullable |
|
| 91 | - * @param null $default_value |
|
| 92 | - * @param string $model_name |
|
| 93 | - * @return EE_Any_Foreign_Model_Name_Field |
|
| 94 | - */ |
|
| 95 | - public function createAnyForeignModelNameField( |
|
| 96 | - $table_column, |
|
| 97 | - $nice_name, |
|
| 98 | - $nullable, |
|
| 99 | - $default_value = null, |
|
| 100 | - $model_name |
|
| 101 | - ) { |
|
| 102 | - return $this->loader->getNew( |
|
| 103 | - 'EE_Any_Foreign_Model_Name_Field', |
|
| 104 | - array($table_column, $nice_name, $nullable, $default_value, $model_name) |
|
| 105 | - ); |
|
| 106 | - } |
|
| 107 | - |
|
| 108 | - |
|
| 109 | - /** |
|
| 110 | - * @param string $table_column |
|
| 111 | - * @param string $nice_name |
|
| 112 | - * @param bool $nullable |
|
| 113 | - * @param null $default_value |
|
| 114 | - * @return EE_Boolean_Field |
|
| 115 | - */ |
|
| 116 | - public function createBooleanField($table_column, $nice_name, $nullable, $default_value = null) |
|
| 117 | - { |
|
| 118 | - return $this->loader->getNew( |
|
| 119 | - 'EE_Boolean_Field', |
|
| 120 | - array($table_column, $nice_name, $nullable, $default_value) |
|
| 121 | - ); |
|
| 122 | - } |
|
| 123 | - |
|
| 124 | - |
|
| 125 | - /** |
|
| 126 | - * @param string $table_column |
|
| 127 | - * @param string $nice_name |
|
| 128 | - * @param string $timezone_string |
|
| 129 | - * @param bool $nullable |
|
| 130 | - * @param string $default_value |
|
| 131 | - * @throws EE_Error |
|
| 132 | - * @throws InvalidArgumentException |
|
| 133 | - * @return EE_Datetime_Field |
|
| 134 | - */ |
|
| 135 | - public function createDatetimeField( |
|
| 136 | - $table_column, |
|
| 137 | - $nice_name, |
|
| 138 | - $nullable = false, |
|
| 139 | - $default_value = EE_Datetime_Field::now |
|
| 140 | - ) { |
|
| 141 | - return $this->loader->getNew( |
|
| 142 | - 'EE_Datetime_Field', |
|
| 143 | - array( |
|
| 144 | - $table_column, |
|
| 145 | - $nice_name, |
|
| 146 | - $nullable, |
|
| 147 | - $default_value, |
|
| 148 | - ) |
|
| 149 | - ); |
|
| 150 | - } |
|
| 151 | - |
|
| 152 | - |
|
| 153 | - /** |
|
| 154 | - * @param string $table_column |
|
| 155 | - * @param string $nice_name |
|
| 156 | - * @param bool $nullable |
|
| 157 | - * @param null $default_value |
|
| 158 | - * @return EE_DB_Only_Float_Field |
|
| 159 | - */ |
|
| 160 | - public function createDbOnlyFloatField($table_column, $nice_name, $nullable, $default_value = null) |
|
| 161 | - { |
|
| 162 | - return $this->loader->getNew( |
|
| 163 | - 'EE_DB_Only_Float_Field', |
|
| 164 | - array($table_column, $nice_name, $nullable, $default_value) |
|
| 165 | - ); |
|
| 166 | - } |
|
| 167 | - |
|
| 168 | - |
|
| 169 | - /** |
|
| 170 | - * @param string $table_column |
|
| 171 | - * @param string $nice_name |
|
| 172 | - * @param bool $nullable |
|
| 173 | - * @param null $default_value |
|
| 174 | - * @return EE_DB_Only_Int_Field |
|
| 175 | - */ |
|
| 176 | - public function createDbOnlyIntField($table_column, $nice_name, $nullable, $default_value = null) |
|
| 177 | - { |
|
| 178 | - return $this->loader->getNew( |
|
| 179 | - 'EE_DB_Only_Int_Field', |
|
| 180 | - array($table_column, $nice_name, $nullable, $default_value) |
|
| 181 | - ); |
|
| 182 | - } |
|
| 183 | - |
|
| 184 | - |
|
| 185 | - /** |
|
| 186 | - * @param string $table_column |
|
| 187 | - * @param string $nice_name |
|
| 188 | - * @param bool $nullable |
|
| 189 | - * @param null $default_value |
|
| 190 | - * @return EE_DB_Only_Text_Field |
|
| 191 | - */ |
|
| 192 | - public function createDbOnlyTextField($table_column, $nice_name, $nullable, $default_value = null) |
|
| 193 | - { |
|
| 194 | - return $this->loader->getNew( |
|
| 195 | - 'EE_DB_Only_Text_Field', |
|
| 196 | - array($table_column, $nice_name, $nullable, $default_value) |
|
| 197 | - ); |
|
| 198 | - } |
|
| 199 | - |
|
| 200 | - |
|
| 201 | - /** |
|
| 202 | - * @param string $table_column |
|
| 203 | - * @param string $nice_name |
|
| 204 | - * @param bool $nullable |
|
| 205 | - * @param string $default_value |
|
| 206 | - * @return EE_Email_Field |
|
| 207 | - */ |
|
| 208 | - public function createEmailField($table_column, $nice_name, $nullable = true, $default_value = '') |
|
| 209 | - { |
|
| 210 | - return $this->loader->getNew( |
|
| 211 | - 'EE_Email_Field', |
|
| 212 | - array($table_column, $nice_name, $nullable, $default_value) |
|
| 213 | - ); |
|
| 214 | - } |
|
| 215 | - |
|
| 216 | - |
|
| 217 | - /** |
|
| 218 | - * @param string $table_column |
|
| 219 | - * @param string $nice_name |
|
| 220 | - * @param bool $nullable |
|
| 221 | - * @param null $default_value |
|
| 222 | - * @param array $allowed_enum_values keys are values to be used in the DB, |
|
| 223 | - * values are how they should be displayed |
|
| 224 | - * @return EE_Enum_Integer_Field |
|
| 225 | - */ |
|
| 226 | - public function createEnumIntegerField( |
|
| 227 | - $table_column, |
|
| 228 | - $nice_name, |
|
| 229 | - $nullable, |
|
| 230 | - $default_value = null, |
|
| 231 | - array $allowed_enum_values |
|
| 232 | - ) { |
|
| 233 | - return $this->loader->getNew( |
|
| 234 | - 'EE_Enum_Integer_Field', |
|
| 235 | - array($table_column, $nice_name, $nullable, $default_value, $allowed_enum_values) |
|
| 236 | - ); |
|
| 237 | - } |
|
| 238 | - |
|
| 239 | - |
|
| 240 | - /** |
|
| 241 | - * @param string $table_column |
|
| 242 | - * @param string $nice_name |
|
| 243 | - * @param bool $nullable |
|
| 244 | - * @param null $default_value |
|
| 245 | - * @param array $allowed_enum_values keys are values to be used in the DB, |
|
| 246 | - * values are how they should be displayed |
|
| 247 | - * @return EE_Enum_Text_Field |
|
| 248 | - */ |
|
| 249 | - public function createEnumTextField( |
|
| 250 | - $table_column, |
|
| 251 | - $nice_name, |
|
| 252 | - $nullable, |
|
| 253 | - $default_value, |
|
| 254 | - array $allowed_enum_values |
|
| 255 | - ) { |
|
| 256 | - return $this->loader->getNew( |
|
| 257 | - 'EE_Enum_Text_Field', |
|
| 258 | - array($table_column, $nice_name, $nullable, $default_value, $allowed_enum_values) |
|
| 259 | - ); |
|
| 260 | - } |
|
| 261 | - |
|
| 262 | - |
|
| 263 | - /** |
|
| 264 | - * @param string $table_column |
|
| 265 | - * @param string $nice_name |
|
| 266 | - * @param bool $nullable |
|
| 267 | - * @param null $default_value |
|
| 268 | - * @return EE_Float_Field |
|
| 269 | - */ |
|
| 270 | - public function createFloatField($table_column, $nice_name, $nullable, $default_value = null) |
|
| 271 | - { |
|
| 272 | - return $this->loader->getNew( |
|
| 273 | - 'EE_Float_Field', |
|
| 274 | - array($table_column, $nice_name, $nullable, $default_value) |
|
| 275 | - ); |
|
| 276 | - } |
|
| 277 | - |
|
| 278 | - |
|
| 279 | - /** |
|
| 280 | - * @param string $table_column |
|
| 281 | - * @param string $nice_name |
|
| 282 | - * @param bool $nullable |
|
| 283 | - * @param null $default_value |
|
| 284 | - * @param string $model_name |
|
| 285 | - * @return EE_Foreign_Key_Int_Field |
|
| 286 | - */ |
|
| 287 | - public function createForeignKeyIntField($table_column, $nice_name, $nullable, $default_value, $model_name) |
|
| 288 | - { |
|
| 289 | - return $this->loader->getNew( |
|
| 290 | - 'EE_Foreign_Key_Int_Field', |
|
| 291 | - array($table_column, $nice_name, $nullable, $default_value, $model_name) |
|
| 292 | - ); |
|
| 293 | - } |
|
| 294 | - |
|
| 295 | - |
|
| 296 | - /** |
|
| 297 | - * @param string $table_column |
|
| 298 | - * @param string $nice_name |
|
| 299 | - * @param bool $nullable |
|
| 300 | - * @param null $default_value |
|
| 301 | - * @param string $model_name |
|
| 302 | - * @return EE_Foreign_Key_String_Field |
|
| 303 | - */ |
|
| 304 | - public function createForeignKeyStringField( |
|
| 305 | - $table_column, |
|
| 306 | - $nice_name, |
|
| 307 | - $nullable, |
|
| 308 | - $default_value, |
|
| 309 | - $model_name |
|
| 310 | - ) { |
|
| 311 | - return $this->loader->getNew( |
|
| 312 | - 'EE_Foreign_Key_String_Field', |
|
| 313 | - array($table_column, $nice_name, $nullable, $default_value, $model_name) |
|
| 314 | - ); |
|
| 315 | - } |
|
| 316 | - |
|
| 317 | - |
|
| 318 | - /** |
|
| 319 | - * @param string $table_column |
|
| 320 | - * @param string $nice_name |
|
| 321 | - * @param bool $nullable |
|
| 322 | - * @param null $default_value |
|
| 323 | - * @return EE_Full_HTML_Field |
|
| 324 | - */ |
|
| 325 | - public function createFullHtmlField($table_column, $nice_name, $nullable, $default_value = null) |
|
| 326 | - { |
|
| 327 | - return $this->loader->getNew( |
|
| 328 | - 'EE_Full_HTML_Field', |
|
| 329 | - array($table_column, $nice_name, $nullable, $default_value) |
|
| 330 | - ); |
|
| 331 | - } |
|
| 332 | - |
|
| 333 | - |
|
| 334 | - /** |
|
| 335 | - * @param string $table_column |
|
| 336 | - * @param string $nice_name |
|
| 337 | - * @param bool $nullable |
|
| 338 | - * @param null $default_value |
|
| 339 | - * @return EE_Infinite_Integer_Field |
|
| 340 | - */ |
|
| 341 | - public function createInfiniteIntegerField($table_column, $nice_name, $nullable, $default_value = null) |
|
| 342 | - { |
|
| 343 | - return $this->loader->getNew( |
|
| 344 | - 'EE_Infinite_Integer_Field', |
|
| 345 | - array($table_column, $nice_name, $nullable, $default_value) |
|
| 346 | - ); |
|
| 347 | - } |
|
| 348 | - |
|
| 349 | - |
|
| 350 | - /** |
|
| 351 | - * @param string $table_column |
|
| 352 | - * @param string $nice_name |
|
| 353 | - * @param bool $nullable |
|
| 354 | - * @param integer $default_value |
|
| 355 | - * @return EE_Integer_Field |
|
| 356 | - */ |
|
| 357 | - public function createIntegerField($table_column, $nice_name, $nullable = false, $default_value = 0) |
|
| 358 | - { |
|
| 359 | - return $this->loader->getNew( |
|
| 360 | - 'EE_Integer_Field', |
|
| 361 | - array($table_column, $nice_name, $nullable, $default_value) |
|
| 362 | - ); |
|
| 363 | - } |
|
| 364 | - |
|
| 365 | - |
|
| 366 | - /** |
|
| 367 | - * @param string $table_column |
|
| 368 | - * @param string $nice_name |
|
| 369 | - * @param bool $nullable |
|
| 370 | - * @param null $default_value |
|
| 371 | - * @return EE_Maybe_Serialized_Simple_HTML_Field |
|
| 372 | - */ |
|
| 373 | - public function createMaybeSerializedSimpleHtmlField($table_column, $nice_name, $nullable, $default_value = null) |
|
| 374 | - { |
|
| 375 | - return $this->loader->getNew( |
|
| 376 | - 'EE_Maybe_Serialized_Simple_HTML_Field', |
|
| 377 | - array($table_column, $nice_name, $nullable, $default_value) |
|
| 378 | - ); |
|
| 379 | - } |
|
| 380 | - |
|
| 381 | - |
|
| 382 | - /** |
|
| 383 | - * @param string $table_column |
|
| 384 | - * @param string $nice_name |
|
| 385 | - * @param bool $nullable |
|
| 386 | - * @param null $default_value |
|
| 387 | - * @return EE_Maybe_Serialized_Text_Field |
|
| 388 | - */ |
|
| 389 | - public function createMaybeSerializedTextField($table_column, $nice_name, $nullable, $default_value = null) |
|
| 390 | - { |
|
| 391 | - return $this->loader->getNew( |
|
| 392 | - 'EE_Maybe_Serialized_Text_Field', |
|
| 393 | - array($table_column, $nice_name, $nullable, $default_value) |
|
| 394 | - ); |
|
| 395 | - } |
|
| 396 | - |
|
| 397 | - |
|
| 398 | - /** |
|
| 399 | - * @param string $table_column |
|
| 400 | - * @param string $nice_name |
|
| 401 | - * @param bool $nullable |
|
| 402 | - * @param null $default_value |
|
| 403 | - * @return EE_Money_Field |
|
| 404 | - */ |
|
| 405 | - public function createMoneyField($table_column, $nice_name, $nullable, $default_value = null) |
|
| 406 | - { |
|
| 407 | - return $this->loader->getNew( |
|
| 408 | - 'EE_Money_Field', |
|
| 409 | - array($table_column, $nice_name, $nullable, $default_value) |
|
| 410 | - ); |
|
| 411 | - } |
|
| 412 | - |
|
| 413 | - |
|
| 414 | - /** |
|
| 415 | - * @param string $table_column |
|
| 416 | - * @param string $nice_name |
|
| 417 | - * @param bool $nullable |
|
| 418 | - * @param string $default_value |
|
| 419 | - * @return EE_Plain_Text_Field |
|
| 420 | - */ |
|
| 421 | - public function createPlainTextField($table_column, $nice_name, $nullable = true, $default_value = '') |
|
| 422 | - { |
|
| 423 | - return $this->loader->getNew( |
|
| 424 | - 'EE_Plain_Text_Field', |
|
| 425 | - array($table_column, $nice_name, $nullable, $default_value) |
|
| 426 | - ); |
|
| 427 | - } |
|
| 428 | - |
|
| 429 | - |
|
| 430 | - /** |
|
| 431 | - * @param string $table_column |
|
| 432 | - * @param string $nice_name |
|
| 433 | - * @param bool $nullable |
|
| 434 | - * @param null $default_value |
|
| 435 | - * @return EE_Post_Content_Field |
|
| 436 | - */ |
|
| 437 | - public function createPostContentField($table_column, $nice_name, $nullable, $default_value = null) |
|
| 438 | - { |
|
| 439 | - return $this->loader->getNew( |
|
| 440 | - 'EE_Post_Content_Field', |
|
| 441 | - array($table_column, $nice_name, $nullable, $default_value) |
|
| 442 | - ); |
|
| 443 | - } |
|
| 444 | - |
|
| 445 | - |
|
| 446 | - /** |
|
| 447 | - * @param string $table_column |
|
| 448 | - * @param string $nice_name |
|
| 449 | - * @return EE_Primary_Key_Int_Field |
|
| 450 | - */ |
|
| 451 | - public function createPrimaryKeyIntField($table_column, $nice_name) |
|
| 452 | - { |
|
| 453 | - return $this->loader->getNew('EE_Primary_Key_Int_Field', array($table_column, $nice_name)); |
|
| 454 | - } |
|
| 455 | - |
|
| 456 | - |
|
| 457 | - /** |
|
| 458 | - * @param string $table_column |
|
| 459 | - * @param string $nice_name |
|
| 460 | - * @return EE_Primary_Key_String_Field |
|
| 461 | - */ |
|
| 462 | - public function createPrimaryKeyStringField($table_column, $nice_name) |
|
| 463 | - { |
|
| 464 | - return $this->loader->getNew('EE_Primary_Key_String_Field', array($table_column, $nice_name)); |
|
| 465 | - } |
|
| 466 | - |
|
| 467 | - |
|
| 468 | - /** |
|
| 469 | - * @param string $table_column |
|
| 470 | - * @param string $nice_name |
|
| 471 | - * @param bool $nullable |
|
| 472 | - * @param null $default_value |
|
| 473 | - * @return EE_Serialized_Text_Field |
|
| 474 | - */ |
|
| 475 | - public function createSerializedTextField($table_column, $nice_name, $nullable, $default_value = null) |
|
| 476 | - { |
|
| 477 | - return $this->loader->getNew( |
|
| 478 | - 'EE_Serialized_Text_Field', |
|
| 479 | - array($table_column, $nice_name, $nullable, $default_value) |
|
| 480 | - ); |
|
| 481 | - } |
|
| 482 | - |
|
| 483 | - |
|
| 484 | - /** |
|
| 485 | - * @param string $table_column |
|
| 486 | - * @param string $nice_name |
|
| 487 | - * @param bool $nullable |
|
| 488 | - * @param null $default_value |
|
| 489 | - * @return EE_Simple_HTML_Field |
|
| 490 | - */ |
|
| 491 | - public function createSimpleHtmlField($table_column, $nice_name, $nullable, $default_value = null) |
|
| 492 | - { |
|
| 493 | - return $this->loader->getNew( |
|
| 494 | - 'EE_Simple_HTML_Field', |
|
| 495 | - array($table_column, $nice_name, $nullable, $default_value) |
|
| 496 | - ); |
|
| 497 | - } |
|
| 498 | - |
|
| 499 | - |
|
| 500 | - /** |
|
| 501 | - * @param string $table_column |
|
| 502 | - * @param string $nice_name |
|
| 503 | - * @param bool $nullable |
|
| 504 | - * @param null $default_value |
|
| 505 | - * @return EE_Slug_Field |
|
| 506 | - */ |
|
| 507 | - public function createSlugField($table_column, $nice_name, $nullable = false, $default_value = null) |
|
| 508 | - { |
|
| 509 | - return $this->loader->getNew( |
|
| 510 | - 'EE_Slug_Field', |
|
| 511 | - array($table_column, $nice_name, $nullable, $default_value) |
|
| 512 | - ); |
|
| 513 | - } |
|
| 514 | - |
|
| 515 | - |
|
| 516 | - /** |
|
| 517 | - * @param string $table_column |
|
| 518 | - * @param string $nice_name |
|
| 519 | - * @param bool $nullable |
|
| 520 | - * @param null $default_value |
|
| 521 | - * @return EE_Trashed_Flag_Field |
|
| 522 | - */ |
|
| 523 | - public function createTrashedFlagField($table_column, $nice_name, $nullable, $default_value = null) |
|
| 524 | - { |
|
| 525 | - return $this->loader->getNew( |
|
| 526 | - 'EE_Trashed_Flag_Field', |
|
| 527 | - array($table_column, $nice_name, $nullable, $default_value) |
|
| 528 | - ); |
|
| 529 | - } |
|
| 530 | - |
|
| 531 | - |
|
| 532 | - /** |
|
| 533 | - * @param string $table_column |
|
| 534 | - * @param string $nice_name |
|
| 535 | - * @param bool $nullable |
|
| 536 | - * @param mixed $default_value |
|
| 537 | - * @param array $values If additional stati are to be used other than the default WP |
|
| 538 | - * statuses, then they can be registered via this property. The |
|
| 539 | - * format of the array should be as follows: array( |
|
| 540 | - * 'status_reference' => array( |
|
| 541 | - * 'label' => __('Status Reference Label', 'event_espresso'), |
|
| 542 | - * 'public' => true, // whether this status should |
|
| 543 | - * be shown on the frontend of the site |
|
| 544 | - * 'exclude_from_search' => false, // whether this status should |
|
| 545 | - * be excluded from wp searches |
|
| 546 | - * 'show_in_admin_all_list' => true, // whether this status is |
|
| 547 | - * included in queries for the admin "all" view in list table |
|
| 548 | - * views. |
|
| 549 | - * 'show_in_admin_status_list' => true, // show in the list of |
|
| 550 | - * statuses with post counts at the top of the admin list tables |
|
| 551 | - * (i.e. Status Reference(2) ) |
|
| 552 | - * 'label_count' => _n_noop( |
|
| 553 | - * 'Status Reference <span class="count">(%s)</span>', |
|
| 554 | - * 'Status References <span class="count">(%s)</span>' |
|
| 555 | - * ), // the text to display on |
|
| 556 | - * the admin screen |
|
| 557 | - * ( or you won't see your status count ). |
|
| 558 | - * ) |
|
| 559 | - * ) |
|
| 560 | - * @link http://codex.wordpress.org/Function_Reference/register_post_status for more info |
|
| 561 | - * @return EE_WP_Post_Status_Field |
|
| 562 | - */ |
|
| 563 | - public function createWpPostStatusField( |
|
| 564 | - $table_column, |
|
| 565 | - $nice_name, |
|
| 566 | - $nullable, |
|
| 567 | - $default_value = null, |
|
| 568 | - array $values = array() |
|
| 569 | - ) { |
|
| 570 | - return $this->loader->getNew( |
|
| 571 | - 'EE_WP_Post_Status_Field', |
|
| 572 | - array($table_column, $nice_name, $nullable, $default_value, $values) |
|
| 573 | - ); |
|
| 574 | - } |
|
| 575 | - |
|
| 576 | - |
|
| 577 | - /** |
|
| 578 | - * @param string $post_type |
|
| 579 | - * @return EE_WP_Post_Type_Field |
|
| 580 | - */ |
|
| 581 | - public function createWpPostTypeField($post_type) |
|
| 582 | - { |
|
| 583 | - return $this->loader->getNew('EE_WP_Post_Type_Field', array($post_type)); |
|
| 584 | - } |
|
| 585 | - |
|
| 586 | - |
|
| 587 | - /** |
|
| 588 | - * @param string $table_column |
|
| 589 | - * @param string $nice_name |
|
| 590 | - * @param bool $nullable |
|
| 591 | - * @return EE_WP_User_Field |
|
| 592 | - */ |
|
| 593 | - public function createWpUserField($table_column, $nice_name, $nullable) |
|
| 594 | - { |
|
| 595 | - return $this->loader->getNew('EE_WP_User_Field', array($table_column, $nice_name, $nullable)); |
|
| 596 | - } |
|
| 54 | + /** |
|
| 55 | + * @var LoaderInterface $loader |
|
| 56 | + */ |
|
| 57 | + private $loader; |
|
| 58 | + |
|
| 59 | + |
|
| 60 | + /** |
|
| 61 | + * ModelFieldFactory constructor. |
|
| 62 | + * |
|
| 63 | + * @param LoaderInterface $loader |
|
| 64 | + */ |
|
| 65 | + public function __construct(LoaderInterface $loader) |
|
| 66 | + { |
|
| 67 | + $this->loader = $loader; |
|
| 68 | + } |
|
| 69 | + |
|
| 70 | + |
|
| 71 | + /** |
|
| 72 | + * @param string $table_column |
|
| 73 | + * @param string $nice_name |
|
| 74 | + * @param bool $nullable |
|
| 75 | + * @param null $default_value |
|
| 76 | + * @return EE_All_Caps_Text_Field |
|
| 77 | + */ |
|
| 78 | + public function createAllCapsTextField($table_column, $nice_name, $nullable, $default_value = null) |
|
| 79 | + { |
|
| 80 | + return $this->loader->getNew( |
|
| 81 | + 'EE_All_Caps_Text_Field', |
|
| 82 | + array($table_column, $nice_name, $nullable, $default_value) |
|
| 83 | + ); |
|
| 84 | + } |
|
| 85 | + |
|
| 86 | + |
|
| 87 | + /** |
|
| 88 | + * @param string $table_column |
|
| 89 | + * @param string $nice_name |
|
| 90 | + * @param bool $nullable |
|
| 91 | + * @param null $default_value |
|
| 92 | + * @param string $model_name |
|
| 93 | + * @return EE_Any_Foreign_Model_Name_Field |
|
| 94 | + */ |
|
| 95 | + public function createAnyForeignModelNameField( |
|
| 96 | + $table_column, |
|
| 97 | + $nice_name, |
|
| 98 | + $nullable, |
|
| 99 | + $default_value = null, |
|
| 100 | + $model_name |
|
| 101 | + ) { |
|
| 102 | + return $this->loader->getNew( |
|
| 103 | + 'EE_Any_Foreign_Model_Name_Field', |
|
| 104 | + array($table_column, $nice_name, $nullable, $default_value, $model_name) |
|
| 105 | + ); |
|
| 106 | + } |
|
| 107 | + |
|
| 108 | + |
|
| 109 | + /** |
|
| 110 | + * @param string $table_column |
|
| 111 | + * @param string $nice_name |
|
| 112 | + * @param bool $nullable |
|
| 113 | + * @param null $default_value |
|
| 114 | + * @return EE_Boolean_Field |
|
| 115 | + */ |
|
| 116 | + public function createBooleanField($table_column, $nice_name, $nullable, $default_value = null) |
|
| 117 | + { |
|
| 118 | + return $this->loader->getNew( |
|
| 119 | + 'EE_Boolean_Field', |
|
| 120 | + array($table_column, $nice_name, $nullable, $default_value) |
|
| 121 | + ); |
|
| 122 | + } |
|
| 123 | + |
|
| 124 | + |
|
| 125 | + /** |
|
| 126 | + * @param string $table_column |
|
| 127 | + * @param string $nice_name |
|
| 128 | + * @param string $timezone_string |
|
| 129 | + * @param bool $nullable |
|
| 130 | + * @param string $default_value |
|
| 131 | + * @throws EE_Error |
|
| 132 | + * @throws InvalidArgumentException |
|
| 133 | + * @return EE_Datetime_Field |
|
| 134 | + */ |
|
| 135 | + public function createDatetimeField( |
|
| 136 | + $table_column, |
|
| 137 | + $nice_name, |
|
| 138 | + $nullable = false, |
|
| 139 | + $default_value = EE_Datetime_Field::now |
|
| 140 | + ) { |
|
| 141 | + return $this->loader->getNew( |
|
| 142 | + 'EE_Datetime_Field', |
|
| 143 | + array( |
|
| 144 | + $table_column, |
|
| 145 | + $nice_name, |
|
| 146 | + $nullable, |
|
| 147 | + $default_value, |
|
| 148 | + ) |
|
| 149 | + ); |
|
| 150 | + } |
|
| 151 | + |
|
| 152 | + |
|
| 153 | + /** |
|
| 154 | + * @param string $table_column |
|
| 155 | + * @param string $nice_name |
|
| 156 | + * @param bool $nullable |
|
| 157 | + * @param null $default_value |
|
| 158 | + * @return EE_DB_Only_Float_Field |
|
| 159 | + */ |
|
| 160 | + public function createDbOnlyFloatField($table_column, $nice_name, $nullable, $default_value = null) |
|
| 161 | + { |
|
| 162 | + return $this->loader->getNew( |
|
| 163 | + 'EE_DB_Only_Float_Field', |
|
| 164 | + array($table_column, $nice_name, $nullable, $default_value) |
|
| 165 | + ); |
|
| 166 | + } |
|
| 167 | + |
|
| 168 | + |
|
| 169 | + /** |
|
| 170 | + * @param string $table_column |
|
| 171 | + * @param string $nice_name |
|
| 172 | + * @param bool $nullable |
|
| 173 | + * @param null $default_value |
|
| 174 | + * @return EE_DB_Only_Int_Field |
|
| 175 | + */ |
|
| 176 | + public function createDbOnlyIntField($table_column, $nice_name, $nullable, $default_value = null) |
|
| 177 | + { |
|
| 178 | + return $this->loader->getNew( |
|
| 179 | + 'EE_DB_Only_Int_Field', |
|
| 180 | + array($table_column, $nice_name, $nullable, $default_value) |
|
| 181 | + ); |
|
| 182 | + } |
|
| 183 | + |
|
| 184 | + |
|
| 185 | + /** |
|
| 186 | + * @param string $table_column |
|
| 187 | + * @param string $nice_name |
|
| 188 | + * @param bool $nullable |
|
| 189 | + * @param null $default_value |
|
| 190 | + * @return EE_DB_Only_Text_Field |
|
| 191 | + */ |
|
| 192 | + public function createDbOnlyTextField($table_column, $nice_name, $nullable, $default_value = null) |
|
| 193 | + { |
|
| 194 | + return $this->loader->getNew( |
|
| 195 | + 'EE_DB_Only_Text_Field', |
|
| 196 | + array($table_column, $nice_name, $nullable, $default_value) |
|
| 197 | + ); |
|
| 198 | + } |
|
| 199 | + |
|
| 200 | + |
|
| 201 | + /** |
|
| 202 | + * @param string $table_column |
|
| 203 | + * @param string $nice_name |
|
| 204 | + * @param bool $nullable |
|
| 205 | + * @param string $default_value |
|
| 206 | + * @return EE_Email_Field |
|
| 207 | + */ |
|
| 208 | + public function createEmailField($table_column, $nice_name, $nullable = true, $default_value = '') |
|
| 209 | + { |
|
| 210 | + return $this->loader->getNew( |
|
| 211 | + 'EE_Email_Field', |
|
| 212 | + array($table_column, $nice_name, $nullable, $default_value) |
|
| 213 | + ); |
|
| 214 | + } |
|
| 215 | + |
|
| 216 | + |
|
| 217 | + /** |
|
| 218 | + * @param string $table_column |
|
| 219 | + * @param string $nice_name |
|
| 220 | + * @param bool $nullable |
|
| 221 | + * @param null $default_value |
|
| 222 | + * @param array $allowed_enum_values keys are values to be used in the DB, |
|
| 223 | + * values are how they should be displayed |
|
| 224 | + * @return EE_Enum_Integer_Field |
|
| 225 | + */ |
|
| 226 | + public function createEnumIntegerField( |
|
| 227 | + $table_column, |
|
| 228 | + $nice_name, |
|
| 229 | + $nullable, |
|
| 230 | + $default_value = null, |
|
| 231 | + array $allowed_enum_values |
|
| 232 | + ) { |
|
| 233 | + return $this->loader->getNew( |
|
| 234 | + 'EE_Enum_Integer_Field', |
|
| 235 | + array($table_column, $nice_name, $nullable, $default_value, $allowed_enum_values) |
|
| 236 | + ); |
|
| 237 | + } |
|
| 238 | + |
|
| 239 | + |
|
| 240 | + /** |
|
| 241 | + * @param string $table_column |
|
| 242 | + * @param string $nice_name |
|
| 243 | + * @param bool $nullable |
|
| 244 | + * @param null $default_value |
|
| 245 | + * @param array $allowed_enum_values keys are values to be used in the DB, |
|
| 246 | + * values are how they should be displayed |
|
| 247 | + * @return EE_Enum_Text_Field |
|
| 248 | + */ |
|
| 249 | + public function createEnumTextField( |
|
| 250 | + $table_column, |
|
| 251 | + $nice_name, |
|
| 252 | + $nullable, |
|
| 253 | + $default_value, |
|
| 254 | + array $allowed_enum_values |
|
| 255 | + ) { |
|
| 256 | + return $this->loader->getNew( |
|
| 257 | + 'EE_Enum_Text_Field', |
|
| 258 | + array($table_column, $nice_name, $nullable, $default_value, $allowed_enum_values) |
|
| 259 | + ); |
|
| 260 | + } |
|
| 261 | + |
|
| 262 | + |
|
| 263 | + /** |
|
| 264 | + * @param string $table_column |
|
| 265 | + * @param string $nice_name |
|
| 266 | + * @param bool $nullable |
|
| 267 | + * @param null $default_value |
|
| 268 | + * @return EE_Float_Field |
|
| 269 | + */ |
|
| 270 | + public function createFloatField($table_column, $nice_name, $nullable, $default_value = null) |
|
| 271 | + { |
|
| 272 | + return $this->loader->getNew( |
|
| 273 | + 'EE_Float_Field', |
|
| 274 | + array($table_column, $nice_name, $nullable, $default_value) |
|
| 275 | + ); |
|
| 276 | + } |
|
| 277 | + |
|
| 278 | + |
|
| 279 | + /** |
|
| 280 | + * @param string $table_column |
|
| 281 | + * @param string $nice_name |
|
| 282 | + * @param bool $nullable |
|
| 283 | + * @param null $default_value |
|
| 284 | + * @param string $model_name |
|
| 285 | + * @return EE_Foreign_Key_Int_Field |
|
| 286 | + */ |
|
| 287 | + public function createForeignKeyIntField($table_column, $nice_name, $nullable, $default_value, $model_name) |
|
| 288 | + { |
|
| 289 | + return $this->loader->getNew( |
|
| 290 | + 'EE_Foreign_Key_Int_Field', |
|
| 291 | + array($table_column, $nice_name, $nullable, $default_value, $model_name) |
|
| 292 | + ); |
|
| 293 | + } |
|
| 294 | + |
|
| 295 | + |
|
| 296 | + /** |
|
| 297 | + * @param string $table_column |
|
| 298 | + * @param string $nice_name |
|
| 299 | + * @param bool $nullable |
|
| 300 | + * @param null $default_value |
|
| 301 | + * @param string $model_name |
|
| 302 | + * @return EE_Foreign_Key_String_Field |
|
| 303 | + */ |
|
| 304 | + public function createForeignKeyStringField( |
|
| 305 | + $table_column, |
|
| 306 | + $nice_name, |
|
| 307 | + $nullable, |
|
| 308 | + $default_value, |
|
| 309 | + $model_name |
|
| 310 | + ) { |
|
| 311 | + return $this->loader->getNew( |
|
| 312 | + 'EE_Foreign_Key_String_Field', |
|
| 313 | + array($table_column, $nice_name, $nullable, $default_value, $model_name) |
|
| 314 | + ); |
|
| 315 | + } |
|
| 316 | + |
|
| 317 | + |
|
| 318 | + /** |
|
| 319 | + * @param string $table_column |
|
| 320 | + * @param string $nice_name |
|
| 321 | + * @param bool $nullable |
|
| 322 | + * @param null $default_value |
|
| 323 | + * @return EE_Full_HTML_Field |
|
| 324 | + */ |
|
| 325 | + public function createFullHtmlField($table_column, $nice_name, $nullable, $default_value = null) |
|
| 326 | + { |
|
| 327 | + return $this->loader->getNew( |
|
| 328 | + 'EE_Full_HTML_Field', |
|
| 329 | + array($table_column, $nice_name, $nullable, $default_value) |
|
| 330 | + ); |
|
| 331 | + } |
|
| 332 | + |
|
| 333 | + |
|
| 334 | + /** |
|
| 335 | + * @param string $table_column |
|
| 336 | + * @param string $nice_name |
|
| 337 | + * @param bool $nullable |
|
| 338 | + * @param null $default_value |
|
| 339 | + * @return EE_Infinite_Integer_Field |
|
| 340 | + */ |
|
| 341 | + public function createInfiniteIntegerField($table_column, $nice_name, $nullable, $default_value = null) |
|
| 342 | + { |
|
| 343 | + return $this->loader->getNew( |
|
| 344 | + 'EE_Infinite_Integer_Field', |
|
| 345 | + array($table_column, $nice_name, $nullable, $default_value) |
|
| 346 | + ); |
|
| 347 | + } |
|
| 348 | + |
|
| 349 | + |
|
| 350 | + /** |
|
| 351 | + * @param string $table_column |
|
| 352 | + * @param string $nice_name |
|
| 353 | + * @param bool $nullable |
|
| 354 | + * @param integer $default_value |
|
| 355 | + * @return EE_Integer_Field |
|
| 356 | + */ |
|
| 357 | + public function createIntegerField($table_column, $nice_name, $nullable = false, $default_value = 0) |
|
| 358 | + { |
|
| 359 | + return $this->loader->getNew( |
|
| 360 | + 'EE_Integer_Field', |
|
| 361 | + array($table_column, $nice_name, $nullable, $default_value) |
|
| 362 | + ); |
|
| 363 | + } |
|
| 364 | + |
|
| 365 | + |
|
| 366 | + /** |
|
| 367 | + * @param string $table_column |
|
| 368 | + * @param string $nice_name |
|
| 369 | + * @param bool $nullable |
|
| 370 | + * @param null $default_value |
|
| 371 | + * @return EE_Maybe_Serialized_Simple_HTML_Field |
|
| 372 | + */ |
|
| 373 | + public function createMaybeSerializedSimpleHtmlField($table_column, $nice_name, $nullable, $default_value = null) |
|
| 374 | + { |
|
| 375 | + return $this->loader->getNew( |
|
| 376 | + 'EE_Maybe_Serialized_Simple_HTML_Field', |
|
| 377 | + array($table_column, $nice_name, $nullable, $default_value) |
|
| 378 | + ); |
|
| 379 | + } |
|
| 380 | + |
|
| 381 | + |
|
| 382 | + /** |
|
| 383 | + * @param string $table_column |
|
| 384 | + * @param string $nice_name |
|
| 385 | + * @param bool $nullable |
|
| 386 | + * @param null $default_value |
|
| 387 | + * @return EE_Maybe_Serialized_Text_Field |
|
| 388 | + */ |
|
| 389 | + public function createMaybeSerializedTextField($table_column, $nice_name, $nullable, $default_value = null) |
|
| 390 | + { |
|
| 391 | + return $this->loader->getNew( |
|
| 392 | + 'EE_Maybe_Serialized_Text_Field', |
|
| 393 | + array($table_column, $nice_name, $nullable, $default_value) |
|
| 394 | + ); |
|
| 395 | + } |
|
| 396 | + |
|
| 397 | + |
|
| 398 | + /** |
|
| 399 | + * @param string $table_column |
|
| 400 | + * @param string $nice_name |
|
| 401 | + * @param bool $nullable |
|
| 402 | + * @param null $default_value |
|
| 403 | + * @return EE_Money_Field |
|
| 404 | + */ |
|
| 405 | + public function createMoneyField($table_column, $nice_name, $nullable, $default_value = null) |
|
| 406 | + { |
|
| 407 | + return $this->loader->getNew( |
|
| 408 | + 'EE_Money_Field', |
|
| 409 | + array($table_column, $nice_name, $nullable, $default_value) |
|
| 410 | + ); |
|
| 411 | + } |
|
| 412 | + |
|
| 413 | + |
|
| 414 | + /** |
|
| 415 | + * @param string $table_column |
|
| 416 | + * @param string $nice_name |
|
| 417 | + * @param bool $nullable |
|
| 418 | + * @param string $default_value |
|
| 419 | + * @return EE_Plain_Text_Field |
|
| 420 | + */ |
|
| 421 | + public function createPlainTextField($table_column, $nice_name, $nullable = true, $default_value = '') |
|
| 422 | + { |
|
| 423 | + return $this->loader->getNew( |
|
| 424 | + 'EE_Plain_Text_Field', |
|
| 425 | + array($table_column, $nice_name, $nullable, $default_value) |
|
| 426 | + ); |
|
| 427 | + } |
|
| 428 | + |
|
| 429 | + |
|
| 430 | + /** |
|
| 431 | + * @param string $table_column |
|
| 432 | + * @param string $nice_name |
|
| 433 | + * @param bool $nullable |
|
| 434 | + * @param null $default_value |
|
| 435 | + * @return EE_Post_Content_Field |
|
| 436 | + */ |
|
| 437 | + public function createPostContentField($table_column, $nice_name, $nullable, $default_value = null) |
|
| 438 | + { |
|
| 439 | + return $this->loader->getNew( |
|
| 440 | + 'EE_Post_Content_Field', |
|
| 441 | + array($table_column, $nice_name, $nullable, $default_value) |
|
| 442 | + ); |
|
| 443 | + } |
|
| 444 | + |
|
| 445 | + |
|
| 446 | + /** |
|
| 447 | + * @param string $table_column |
|
| 448 | + * @param string $nice_name |
|
| 449 | + * @return EE_Primary_Key_Int_Field |
|
| 450 | + */ |
|
| 451 | + public function createPrimaryKeyIntField($table_column, $nice_name) |
|
| 452 | + { |
|
| 453 | + return $this->loader->getNew('EE_Primary_Key_Int_Field', array($table_column, $nice_name)); |
|
| 454 | + } |
|
| 455 | + |
|
| 456 | + |
|
| 457 | + /** |
|
| 458 | + * @param string $table_column |
|
| 459 | + * @param string $nice_name |
|
| 460 | + * @return EE_Primary_Key_String_Field |
|
| 461 | + */ |
|
| 462 | + public function createPrimaryKeyStringField($table_column, $nice_name) |
|
| 463 | + { |
|
| 464 | + return $this->loader->getNew('EE_Primary_Key_String_Field', array($table_column, $nice_name)); |
|
| 465 | + } |
|
| 466 | + |
|
| 467 | + |
|
| 468 | + /** |
|
| 469 | + * @param string $table_column |
|
| 470 | + * @param string $nice_name |
|
| 471 | + * @param bool $nullable |
|
| 472 | + * @param null $default_value |
|
| 473 | + * @return EE_Serialized_Text_Field |
|
| 474 | + */ |
|
| 475 | + public function createSerializedTextField($table_column, $nice_name, $nullable, $default_value = null) |
|
| 476 | + { |
|
| 477 | + return $this->loader->getNew( |
|
| 478 | + 'EE_Serialized_Text_Field', |
|
| 479 | + array($table_column, $nice_name, $nullable, $default_value) |
|
| 480 | + ); |
|
| 481 | + } |
|
| 482 | + |
|
| 483 | + |
|
| 484 | + /** |
|
| 485 | + * @param string $table_column |
|
| 486 | + * @param string $nice_name |
|
| 487 | + * @param bool $nullable |
|
| 488 | + * @param null $default_value |
|
| 489 | + * @return EE_Simple_HTML_Field |
|
| 490 | + */ |
|
| 491 | + public function createSimpleHtmlField($table_column, $nice_name, $nullable, $default_value = null) |
|
| 492 | + { |
|
| 493 | + return $this->loader->getNew( |
|
| 494 | + 'EE_Simple_HTML_Field', |
|
| 495 | + array($table_column, $nice_name, $nullable, $default_value) |
|
| 496 | + ); |
|
| 497 | + } |
|
| 498 | + |
|
| 499 | + |
|
| 500 | + /** |
|
| 501 | + * @param string $table_column |
|
| 502 | + * @param string $nice_name |
|
| 503 | + * @param bool $nullable |
|
| 504 | + * @param null $default_value |
|
| 505 | + * @return EE_Slug_Field |
|
| 506 | + */ |
|
| 507 | + public function createSlugField($table_column, $nice_name, $nullable = false, $default_value = null) |
|
| 508 | + { |
|
| 509 | + return $this->loader->getNew( |
|
| 510 | + 'EE_Slug_Field', |
|
| 511 | + array($table_column, $nice_name, $nullable, $default_value) |
|
| 512 | + ); |
|
| 513 | + } |
|
| 514 | + |
|
| 515 | + |
|
| 516 | + /** |
|
| 517 | + * @param string $table_column |
|
| 518 | + * @param string $nice_name |
|
| 519 | + * @param bool $nullable |
|
| 520 | + * @param null $default_value |
|
| 521 | + * @return EE_Trashed_Flag_Field |
|
| 522 | + */ |
|
| 523 | + public function createTrashedFlagField($table_column, $nice_name, $nullable, $default_value = null) |
|
| 524 | + { |
|
| 525 | + return $this->loader->getNew( |
|
| 526 | + 'EE_Trashed_Flag_Field', |
|
| 527 | + array($table_column, $nice_name, $nullable, $default_value) |
|
| 528 | + ); |
|
| 529 | + } |
|
| 530 | + |
|
| 531 | + |
|
| 532 | + /** |
|
| 533 | + * @param string $table_column |
|
| 534 | + * @param string $nice_name |
|
| 535 | + * @param bool $nullable |
|
| 536 | + * @param mixed $default_value |
|
| 537 | + * @param array $values If additional stati are to be used other than the default WP |
|
| 538 | + * statuses, then they can be registered via this property. The |
|
| 539 | + * format of the array should be as follows: array( |
|
| 540 | + * 'status_reference' => array( |
|
| 541 | + * 'label' => __('Status Reference Label', 'event_espresso'), |
|
| 542 | + * 'public' => true, // whether this status should |
|
| 543 | + * be shown on the frontend of the site |
|
| 544 | + * 'exclude_from_search' => false, // whether this status should |
|
| 545 | + * be excluded from wp searches |
|
| 546 | + * 'show_in_admin_all_list' => true, // whether this status is |
|
| 547 | + * included in queries for the admin "all" view in list table |
|
| 548 | + * views. |
|
| 549 | + * 'show_in_admin_status_list' => true, // show in the list of |
|
| 550 | + * statuses with post counts at the top of the admin list tables |
|
| 551 | + * (i.e. Status Reference(2) ) |
|
| 552 | + * 'label_count' => _n_noop( |
|
| 553 | + * 'Status Reference <span class="count">(%s)</span>', |
|
| 554 | + * 'Status References <span class="count">(%s)</span>' |
|
| 555 | + * ), // the text to display on |
|
| 556 | + * the admin screen |
|
| 557 | + * ( or you won't see your status count ). |
|
| 558 | + * ) |
|
| 559 | + * ) |
|
| 560 | + * @link http://codex.wordpress.org/Function_Reference/register_post_status for more info |
|
| 561 | + * @return EE_WP_Post_Status_Field |
|
| 562 | + */ |
|
| 563 | + public function createWpPostStatusField( |
|
| 564 | + $table_column, |
|
| 565 | + $nice_name, |
|
| 566 | + $nullable, |
|
| 567 | + $default_value = null, |
|
| 568 | + array $values = array() |
|
| 569 | + ) { |
|
| 570 | + return $this->loader->getNew( |
|
| 571 | + 'EE_WP_Post_Status_Field', |
|
| 572 | + array($table_column, $nice_name, $nullable, $default_value, $values) |
|
| 573 | + ); |
|
| 574 | + } |
|
| 575 | + |
|
| 576 | + |
|
| 577 | + /** |
|
| 578 | + * @param string $post_type |
|
| 579 | + * @return EE_WP_Post_Type_Field |
|
| 580 | + */ |
|
| 581 | + public function createWpPostTypeField($post_type) |
|
| 582 | + { |
|
| 583 | + return $this->loader->getNew('EE_WP_Post_Type_Field', array($post_type)); |
|
| 584 | + } |
|
| 585 | + |
|
| 586 | + |
|
| 587 | + /** |
|
| 588 | + * @param string $table_column |
|
| 589 | + * @param string $nice_name |
|
| 590 | + * @param bool $nullable |
|
| 591 | + * @return EE_WP_User_Field |
|
| 592 | + */ |
|
| 593 | + public function createWpUserField($table_column, $nice_name, $nullable) |
|
| 594 | + { |
|
| 595 | + return $this->loader->getNew('EE_WP_User_Field', array($table_column, $nice_name, $nullable)); |
|
| 596 | + } |
|
| 597 | 597 | } |
@@ -15,59 +15,59 @@ |
||
| 15 | 15 | class CoffeeMill |
| 16 | 16 | { |
| 17 | 17 | |
| 18 | - /** |
|
| 19 | - * @var CoffeeShop $coffee_shop |
|
| 20 | - */ |
|
| 21 | - private static $coffee_shop; |
|
| 18 | + /** |
|
| 19 | + * @var CoffeeShop $coffee_shop |
|
| 20 | + */ |
|
| 21 | + private static $coffee_shop; |
|
| 22 | 22 | |
| 23 | 23 | |
| 24 | - /** |
|
| 25 | - * @return mixed |
|
| 26 | - */ |
|
| 27 | - public static function getCoffeeShop() |
|
| 28 | - { |
|
| 29 | - return self::$coffee_shop; |
|
| 30 | - } |
|
| 24 | + /** |
|
| 25 | + * @return mixed |
|
| 26 | + */ |
|
| 27 | + public static function getCoffeeShop() |
|
| 28 | + { |
|
| 29 | + return self::$coffee_shop; |
|
| 30 | + } |
|
| 31 | 31 | |
| 32 | 32 | |
| 33 | - /** |
|
| 34 | - * @param CoffeeShop $coffee_shop |
|
| 35 | - */ |
|
| 36 | - public static function setCoffeeShop(CoffeeShop $coffee_shop) |
|
| 37 | - { |
|
| 38 | - self::$coffee_shop = $coffee_shop; |
|
| 39 | - } |
|
| 33 | + /** |
|
| 34 | + * @param CoffeeShop $coffee_shop |
|
| 35 | + */ |
|
| 36 | + public static function setCoffeeShop(CoffeeShop $coffee_shop) |
|
| 37 | + { |
|
| 38 | + self::$coffee_shop = $coffee_shop; |
|
| 39 | + } |
|
| 40 | 40 | |
| 41 | 41 | |
| 42 | - /** |
|
| 43 | - * @param string $identifier |
|
| 44 | - * @param array $arguments |
|
| 45 | - * @param string $type |
|
| 46 | - * @return mixed |
|
| 47 | - * @throws ServiceNotFoundException |
|
| 48 | - */ |
|
| 49 | - public static function createNew($identifier, $arguments = array(), $type = CoffeeMaker::BREW_NEW) |
|
| 50 | - { |
|
| 51 | - return self::$coffee_shop->brew($identifier, $arguments, $type); |
|
| 52 | - } |
|
| 42 | + /** |
|
| 43 | + * @param string $identifier |
|
| 44 | + * @param array $arguments |
|
| 45 | + * @param string $type |
|
| 46 | + * @return mixed |
|
| 47 | + * @throws ServiceNotFoundException |
|
| 48 | + */ |
|
| 49 | + public static function createNew($identifier, $arguments = array(), $type = CoffeeMaker::BREW_NEW) |
|
| 50 | + { |
|
| 51 | + return self::$coffee_shop->brew($identifier, $arguments, $type); |
|
| 52 | + } |
|
| 53 | 53 | |
| 54 | 54 | |
| 55 | - /** |
|
| 56 | - * IMPORTANT!!! |
|
| 57 | - * Usage of this method is discouraged as it promotes service location. |
|
| 58 | - * It's current use is only as a stop gap measure until the CoffeeShop |
|
| 59 | - * Dependency Injection Container can be implemented properly for all classes. |
|
| 60 | - * If it is at all possible, inject your dependencies via your class constructor. |
|
| 61 | - * This method WILL BE DEPRECATED at some point in the near future. |
|
| 62 | - * |
|
| 63 | - * @param string $identifier |
|
| 64 | - * @param array $arguments |
|
| 65 | - * @param string $type |
|
| 66 | - * @return mixed |
|
| 67 | - * @throws ServiceNotFoundException |
|
| 68 | - */ |
|
| 69 | - public static function getService($identifier, $arguments = array(), $type = CoffeeMaker::BREW_SHARED) |
|
| 70 | - { |
|
| 71 | - return self::$coffee_shop->brew($identifier, $arguments, $type); |
|
| 72 | - } |
|
| 55 | + /** |
|
| 56 | + * IMPORTANT!!! |
|
| 57 | + * Usage of this method is discouraged as it promotes service location. |
|
| 58 | + * It's current use is only as a stop gap measure until the CoffeeShop |
|
| 59 | + * Dependency Injection Container can be implemented properly for all classes. |
|
| 60 | + * If it is at all possible, inject your dependencies via your class constructor. |
|
| 61 | + * This method WILL BE DEPRECATED at some point in the near future. |
|
| 62 | + * |
|
| 63 | + * @param string $identifier |
|
| 64 | + * @param array $arguments |
|
| 65 | + * @param string $type |
|
| 66 | + * @return mixed |
|
| 67 | + * @throws ServiceNotFoundException |
|
| 68 | + */ |
|
| 69 | + public static function getService($identifier, $arguments = array(), $type = CoffeeMaker::BREW_SHARED) |
|
| 70 | + { |
|
| 71 | + return self::$coffee_shop->brew($identifier, $arguments, $type); |
|
| 72 | + } |
|
| 73 | 73 | } |
@@ -15,25 +15,25 @@ |
||
| 15 | 15 | class InstantiationException extends BadMethodCallException |
| 16 | 16 | { |
| 17 | 17 | |
| 18 | - /** |
|
| 19 | - * InstantiationException constructor. |
|
| 20 | - * |
|
| 21 | - * @param string $identifier the name of the requested entity or service |
|
| 22 | - * @param string $message |
|
| 23 | - * @param int $code |
|
| 24 | - * @param \Exception $previous |
|
| 25 | - */ |
|
| 26 | - public function __construct($identifier, $message = '', $code = 0, \Exception $previous = null) |
|
| 27 | - { |
|
| 28 | - if (empty($message)) { |
|
| 29 | - $message = sprintf( |
|
| 30 | - __( |
|
| 31 | - 'The "%1$s" class could not be constructed.', |
|
| 32 | - 'event_espresso' |
|
| 33 | - ), |
|
| 34 | - $identifier |
|
| 35 | - ); |
|
| 36 | - } |
|
| 37 | - parent::__construct($message, $code, $previous); |
|
| 38 | - } |
|
| 18 | + /** |
|
| 19 | + * InstantiationException constructor. |
|
| 20 | + * |
|
| 21 | + * @param string $identifier the name of the requested entity or service |
|
| 22 | + * @param string $message |
|
| 23 | + * @param int $code |
|
| 24 | + * @param \Exception $previous |
|
| 25 | + */ |
|
| 26 | + public function __construct($identifier, $message = '', $code = 0, \Exception $previous = null) |
|
| 27 | + { |
|
| 28 | + if (empty($message)) { |
|
| 29 | + $message = sprintf( |
|
| 30 | + __( |
|
| 31 | + 'The "%1$s" class could not be constructed.', |
|
| 32 | + 'event_espresso' |
|
| 33 | + ), |
|
| 34 | + $identifier |
|
| 35 | + ); |
|
| 36 | + } |
|
| 37 | + parent::__construct($message, $code, $previous); |
|
| 38 | + } |
|
| 39 | 39 | } |
@@ -14,26 +14,26 @@ |
||
| 14 | 14 | { |
| 15 | 15 | |
| 16 | 16 | |
| 17 | - /** |
|
| 18 | - * ServiceExistsException constructor |
|
| 19 | - * |
|
| 20 | - * @param string $service_name the name of the requested service |
|
| 21 | - * @param string $message |
|
| 22 | - * @param int $code |
|
| 23 | - * @param \Exception $previous |
|
| 24 | - */ |
|
| 25 | - public function __construct( |
|
| 26 | - $service_name, |
|
| 27 | - $message = '', |
|
| 28 | - $code = 0, |
|
| 29 | - \Exception $previous = null |
|
| 30 | - ) { |
|
| 31 | - if (empty($message)) { |
|
| 32 | - $message = sprintf( |
|
| 33 | - __('The "%1$s" service already exists in the CoffeeShop and can not be added again.', 'event_espresso'), |
|
| 34 | - $service_name |
|
| 35 | - ); |
|
| 36 | - } |
|
| 37 | - parent::__construct($message, $code, $previous); |
|
| 38 | - } |
|
| 17 | + /** |
|
| 18 | + * ServiceExistsException constructor |
|
| 19 | + * |
|
| 20 | + * @param string $service_name the name of the requested service |
|
| 21 | + * @param string $message |
|
| 22 | + * @param int $code |
|
| 23 | + * @param \Exception $previous |
|
| 24 | + */ |
|
| 25 | + public function __construct( |
|
| 26 | + $service_name, |
|
| 27 | + $message = '', |
|
| 28 | + $code = 0, |
|
| 29 | + \Exception $previous = null |
|
| 30 | + ) { |
|
| 31 | + if (empty($message)) { |
|
| 32 | + $message = sprintf( |
|
| 33 | + __('The "%1$s" service already exists in the CoffeeShop and can not be added again.', 'event_espresso'), |
|
| 34 | + $service_name |
|
| 35 | + ); |
|
| 36 | + } |
|
| 37 | + parent::__construct($message, $code, $previous); |
|
| 38 | + } |
|
| 39 | 39 | } |
@@ -12,26 +12,26 @@ |
||
| 12 | 12 | class ServiceNotFoundException extends \RuntimeException |
| 13 | 13 | { |
| 14 | 14 | |
| 15 | - /** |
|
| 16 | - * ServiceNotFoundException constructor |
|
| 17 | - * |
|
| 18 | - * @param string $service_name the name of the requested service |
|
| 19 | - * @param string $message |
|
| 20 | - * @param int $code |
|
| 21 | - * @param \Exception $previous |
|
| 22 | - */ |
|
| 23 | - public function __construct( |
|
| 24 | - $service_name, |
|
| 25 | - $message = '', |
|
| 26 | - $code = 0, |
|
| 27 | - \Exception $previous = null |
|
| 28 | - ) { |
|
| 29 | - if (empty($message)) { |
|
| 30 | - $message = sprintf( |
|
| 31 | - __('The requested service "%1$s" could not found be found in the CoffeeShop.', 'event_espresso'), |
|
| 32 | - $service_name |
|
| 33 | - ); |
|
| 34 | - } |
|
| 35 | - parent::__construct($message, $code, $previous); |
|
| 36 | - } |
|
| 15 | + /** |
|
| 16 | + * ServiceNotFoundException constructor |
|
| 17 | + * |
|
| 18 | + * @param string $service_name the name of the requested service |
|
| 19 | + * @param string $message |
|
| 20 | + * @param int $code |
|
| 21 | + * @param \Exception $previous |
|
| 22 | + */ |
|
| 23 | + public function __construct( |
|
| 24 | + $service_name, |
|
| 25 | + $message = '', |
|
| 26 | + $code = 0, |
|
| 27 | + \Exception $previous = null |
|
| 28 | + ) { |
|
| 29 | + if (empty($message)) { |
|
| 30 | + $message = sprintf( |
|
| 31 | + __('The requested service "%1$s" could not found be found in the CoffeeShop.', 'event_espresso'), |
|
| 32 | + $service_name |
|
| 33 | + ); |
|
| 34 | + } |
|
| 35 | + parent::__construct($message, $code, $previous); |
|
| 36 | + } |
|
| 37 | 37 | } |