@@ -20,44 +20,44 @@ |
||
| 20 | 20 | class InternationalDNS extends International |
| 21 | 21 | { |
| 22 | 22 | |
| 23 | - /** |
|
| 24 | - * Validates the email in teh same way as the parent, but also |
|
| 25 | - * verifies the domain exists. |
|
| 26 | - * @param string $email_address |
|
| 27 | - * @return bool |
|
| 28 | - * @throws EmailValidationException |
|
| 29 | - */ |
|
| 30 | - public function validate($email_address) |
|
| 31 | - { |
|
| 32 | - parent::validate($email_address); |
|
| 33 | - $domain = $this->getDomainPartOfEmail( |
|
| 34 | - $email_address, |
|
| 35 | - $this->getAtIndex($email_address) |
|
| 36 | - ); |
|
| 37 | - if (! checkdnsrr($domain, 'MX')) { |
|
| 38 | - // domain not found in MX records |
|
| 39 | - throw new EmailValidationException( |
|
| 40 | - __( |
|
| 41 | - // @codingStandardsIgnoreStart |
|
| 42 | - 'Although the email address provided is formatted correctly, a valid "MX record" could not be located for that address and domain. Please enter a valid email address.', |
|
| 43 | - // @codingStandardsIgnoreEnd |
|
| 44 | - 'event_espresso' |
|
| 45 | - ) |
|
| 46 | - ); |
|
| 47 | - } |
|
| 48 | - if (! checkdnsrr($domain, 'A')) { |
|
| 49 | - // domain not found in A records |
|
| 50 | - throw new EmailValidationException( |
|
| 51 | - __( |
|
| 52 | - // @codingStandardsIgnoreStart |
|
| 53 | - 'Although the email address provided is formatted correctly, a valid "A record" could not be located for that address and domain. Please enter a valid email address.', |
|
| 54 | - // @codingStandardsIgnoreEnd |
|
| 55 | - 'event_espresso' |
|
| 56 | - ) |
|
| 57 | - ); |
|
| 58 | - } |
|
| 59 | - return true; |
|
| 60 | - } |
|
| 23 | + /** |
|
| 24 | + * Validates the email in teh same way as the parent, but also |
|
| 25 | + * verifies the domain exists. |
|
| 26 | + * @param string $email_address |
|
| 27 | + * @return bool |
|
| 28 | + * @throws EmailValidationException |
|
| 29 | + */ |
|
| 30 | + public function validate($email_address) |
|
| 31 | + { |
|
| 32 | + parent::validate($email_address); |
|
| 33 | + $domain = $this->getDomainPartOfEmail( |
|
| 34 | + $email_address, |
|
| 35 | + $this->getAtIndex($email_address) |
|
| 36 | + ); |
|
| 37 | + if (! checkdnsrr($domain, 'MX')) { |
|
| 38 | + // domain not found in MX records |
|
| 39 | + throw new EmailValidationException( |
|
| 40 | + __( |
|
| 41 | + // @codingStandardsIgnoreStart |
|
| 42 | + 'Although the email address provided is formatted correctly, a valid "MX record" could not be located for that address and domain. Please enter a valid email address.', |
|
| 43 | + // @codingStandardsIgnoreEnd |
|
| 44 | + 'event_espresso' |
|
| 45 | + ) |
|
| 46 | + ); |
|
| 47 | + } |
|
| 48 | + if (! checkdnsrr($domain, 'A')) { |
|
| 49 | + // domain not found in A records |
|
| 50 | + throw new EmailValidationException( |
|
| 51 | + __( |
|
| 52 | + // @codingStandardsIgnoreStart |
|
| 53 | + 'Although the email address provided is formatted correctly, a valid "A record" could not be located for that address and domain. Please enter a valid email address.', |
|
| 54 | + // @codingStandardsIgnoreEnd |
|
| 55 | + 'event_espresso' |
|
| 56 | + ) |
|
| 57 | + ); |
|
| 58 | + } |
|
| 59 | + return true; |
|
| 60 | + } |
|
| 61 | 61 | |
| 62 | 62 | |
| 63 | 63 | } |
@@ -34,7 +34,7 @@ discard block |
||
| 34 | 34 | $email_address, |
| 35 | 35 | $this->getAtIndex($email_address) |
| 36 | 36 | ); |
| 37 | - if (! checkdnsrr($domain, 'MX')) { |
|
| 37 | + if ( ! checkdnsrr($domain, 'MX')) { |
|
| 38 | 38 | // domain not found in MX records |
| 39 | 39 | throw new EmailValidationException( |
| 40 | 40 | __( |
@@ -45,7 +45,7 @@ discard block |
||
| 45 | 45 | ) |
| 46 | 46 | ); |
| 47 | 47 | } |
| 48 | - if (! checkdnsrr($domain, 'A')) { |
|
| 48 | + if ( ! checkdnsrr($domain, 'A')) { |
|
| 49 | 49 | // domain not found in A records |
| 50 | 50 | throw new EmailValidationException( |
| 51 | 51 | __( |
@@ -20,28 +20,28 @@ |
||
| 20 | 20 | class International extends Basic |
| 21 | 21 | { |
| 22 | 22 | |
| 23 | - /** |
|
| 24 | - * @param string $email_address |
|
| 25 | - * @return bool |
|
| 26 | - * @throws \EventEspresso\core\domain\services\validation\email\EmailValidationException |
|
| 27 | - */ |
|
| 28 | - public function validate($email_address) |
|
| 29 | - { |
|
| 30 | - parent::validate($email_address); |
|
| 31 | - if (// plz see http://stackoverflow.com/a/24817336 re: the following regex |
|
| 32 | - ! preg_match( |
|
| 33 | - // @codingStandardsIgnoreStart |
|
| 34 | - '/^(?!\.)((?!.*\.{2})[a-zA-Z0-9\x{0080}-\x{00FF}\x{0100}-\x{017F}\x{0180}-\x{024F}\x{0250}-\x{02AF}\x{0300}-\x{036F}\x{0370}-\x{03FF}\x{0400}-\x{04FF}\x{0500}-\x{052F}\x{0530}-\x{058F}\x{0590}-\x{05FF}\x{0600}-\x{06FF}\x{0700}-\x{074F}\x{0750}-\x{077F}\x{0780}-\x{07BF}\x{07C0}-\x{07FF}\x{0900}-\x{097F}\x{0980}-\x{09FF}\x{0A00}-\x{0A7F}\x{0A80}-\x{0AFF}\x{0B00}-\x{0B7F}\x{0B80}-\x{0BFF}\x{0C00}-\x{0C7F}\x{0C80}-\x{0CFF}\x{0D00}-\x{0D7F}\x{0D80}-\x{0DFF}\x{0E00}-\x{0E7F}\x{0E80}-\x{0EFF}\x{0F00}-\x{0FFF}\x{1000}-\x{109F}\x{10A0}-\x{10FF}\x{1100}-\x{11FF}\x{1200}-\x{137F}\x{1380}-\x{139F}\x{13A0}-\x{13FF}\x{1400}-\x{167F}\x{1680}-\x{169F}\x{16A0}-\x{16FF}\x{1700}-\x{171F}\x{1720}-\x{173F}\x{1740}-\x{175F}\x{1760}-\x{177F}\x{1780}-\x{17FF}\x{1800}-\x{18AF}\x{1900}-\x{194F}\x{1950}-\x{197F}\x{1980}-\x{19DF}\x{19E0}-\x{19FF}\x{1A00}-\x{1A1F}\x{1B00}-\x{1B7F}\x{1D00}-\x{1D7F}\x{1D80}-\x{1DBF}\x{1DC0}-\x{1DFF}\x{1E00}-\x{1EFF}\x{1F00}-\x{1FFF}\x{20D0}-\x{20FF}\x{2100}-\x{214F}\x{2C00}-\x{2C5F}\x{2C60}-\x{2C7F}\x{2C80}-\x{2CFF}\x{2D00}-\x{2D2F}\x{2D30}-\x{2D7F}\x{2D80}-\x{2DDF}\x{2F00}-\x{2FDF}\x{2FF0}-\x{2FFF}\x{3040}-\x{309F}\x{30A0}-\x{30FF}\x{3100}-\x{312F}\x{3130}-\x{318F}\x{3190}-\x{319F}\x{31C0}-\x{31EF}\x{31F0}-\x{31FF}\x{3200}-\x{32FF}\x{3300}-\x{33FF}\x{3400}-\x{4DBF}\x{4DC0}-\x{4DFF}\x{4E00}-\x{9FFF}\x{A000}-\x{A48F}\x{A490}-\x{A4CF}\x{A700}-\x{A71F}\x{A800}-\x{A82F}\x{A840}-\x{A87F}\x{AC00}-\x{D7AF}\x{F900}-\x{FAFF}\.!#$%&\'*+-\/=?^_`{|}~\-\d]+)@(?!\.)([a-zA-Z0-9\x{0080}-\x{00FF}\x{0100}-\x{017F}\x{0180}-\x{024F}\x{0250}-\x{02AF}\x{0300}-\x{036F}\x{0370}-\x{03FF}\x{0400}-\x{04FF}\x{0500}-\x{052F}\x{0530}-\x{058F}\x{0590}-\x{05FF}\x{0600}-\x{06FF}\x{0700}-\x{074F}\x{0750}-\x{077F}\x{0780}-\x{07BF}\x{07C0}-\x{07FF}\x{0900}-\x{097F}\x{0980}-\x{09FF}\x{0A00}-\x{0A7F}\x{0A80}-\x{0AFF}\x{0B00}-\x{0B7F}\x{0B80}-\x{0BFF}\x{0C00}-\x{0C7F}\x{0C80}-\x{0CFF}\x{0D00}-\x{0D7F}\x{0D80}-\x{0DFF}\x{0E00}-\x{0E7F}\x{0E80}-\x{0EFF}\x{0F00}-\x{0FFF}\x{1000}-\x{109F}\x{10A0}-\x{10FF}\x{1100}-\x{11FF}\x{1200}-\x{137F}\x{1380}-\x{139F}\x{13A0}-\x{13FF}\x{1400}-\x{167F}\x{1680}-\x{169F}\x{16A0}-\x{16FF}\x{1700}-\x{171F}\x{1720}-\x{173F}\x{1740}-\x{175F}\x{1760}-\x{177F}\x{1780}-\x{17FF}\x{1800}-\x{18AF}\x{1900}-\x{194F}\x{1950}-\x{197F}\x{1980}-\x{19DF}\x{19E0}-\x{19FF}\x{1A00}-\x{1A1F}\x{1B00}-\x{1B7F}\x{1D00}-\x{1D7F}\x{1D80}-\x{1DBF}\x{1DC0}-\x{1DFF}\x{1E00}-\x{1EFF}\x{1F00}-\x{1FFF}\x{20D0}-\x{20FF}\x{2100}-\x{214F}\x{2C00}-\x{2C5F}\x{2C60}-\x{2C7F}\x{2C80}-\x{2CFF}\x{2D00}-\x{2D2F}\x{2D30}-\x{2D7F}\x{2D80}-\x{2DDF}\x{2F00}-\x{2FDF}\x{2FF0}-\x{2FFF}\x{3040}-\x{309F}\x{30A0}-\x{30FF}\x{3100}-\x{312F}\x{3130}-\x{318F}\x{3190}-\x{319F}\x{31C0}-\x{31EF}\x{31F0}-\x{31FF}\x{3200}-\x{32FF}\x{3300}-\x{33FF}\x{3400}-\x{4DBF}\x{4DC0}-\x{4DFF}\x{4E00}-\x{9FFF}\x{A000}-\x{A48F}\x{A490}-\x{A4CF}\x{A700}-\x{A71F}\x{A800}-\x{A82F}\x{A840}-\x{A87F}\x{AC00}-\x{D7AF}\x{F900}-\x{FAFF}\-\.\d]+)((\.([a-zA-Z\x{0080}-\x{00FF}\x{0100}-\x{017F}\x{0180}-\x{024F}\x{0250}-\x{02AF}\x{0300}-\x{036F}\x{0370}-\x{03FF}\x{0400}-\x{04FF}\x{0500}-\x{052F}\x{0530}-\x{058F}\x{0590}-\x{05FF}\x{0600}-\x{06FF}\x{0700}-\x{074F}\x{0750}-\x{077F}\x{0780}-\x{07BF}\x{07C0}-\x{07FF}\x{0900}-\x{097F}\x{0980}-\x{09FF}\x{0A00}-\x{0A7F}\x{0A80}-\x{0AFF}\x{0B00}-\x{0B7F}\x{0B80}-\x{0BFF}\x{0C00}-\x{0C7F}\x{0C80}-\x{0CFF}\x{0D00}-\x{0D7F}\x{0D80}-\x{0DFF}\x{0E00}-\x{0E7F}\x{0E80}-\x{0EFF}\x{0F00}-\x{0FFF}\x{1000}-\x{109F}\x{10A0}-\x{10FF}\x{1100}-\x{11FF}\x{1200}-\x{137F}\x{1380}-\x{139F}\x{13A0}-\x{13FF}\x{1400}-\x{167F}\x{1680}-\x{169F}\x{16A0}-\x{16FF}\x{1700}-\x{171F}\x{1720}-\x{173F}\x{1740}-\x{175F}\x{1760}-\x{177F}\x{1780}-\x{17FF}\x{1800}-\x{18AF}\x{1900}-\x{194F}\x{1950}-\x{197F}\x{1980}-\x{19DF}\x{19E0}-\x{19FF}\x{1A00}-\x{1A1F}\x{1B00}-\x{1B7F}\x{1D00}-\x{1D7F}\x{1D80}-\x{1DBF}\x{1DC0}-\x{1DFF}\x{1E00}-\x{1EFF}\x{1F00}-\x{1FFF}\x{20D0}-\x{20FF}\x{2100}-\x{214F}\x{2C00}-\x{2C5F}\x{2C60}-\x{2C7F}\x{2C80}-\x{2CFF}\x{2D00}-\x{2D2F}\x{2D30}-\x{2D7F}\x{2D80}-\x{2DDF}\x{2F00}-\x{2FDF}\x{2FF0}-\x{2FFF}\x{3040}-\x{309F}\x{30A0}-\x{30FF}\x{3100}-\x{312F}\x{3130}-\x{318F}\x{3190}-\x{319F}\x{31C0}-\x{31EF}\x{31F0}-\x{31FF}\x{3200}-\x{32FF}\x{3300}-\x{33FF}\x{3400}-\x{4DBF}\x{4DC0}-\x{4DFF}\x{4E00}-\x{9FFF}\x{A000}-\x{A48F}\x{A490}-\x{A4CF}\x{A700}-\x{A71F}\x{A800}-\x{A82F}\x{A840}-\x{A87F}\x{AC00}-\x{D7AF}\x{F900}-\x{FAFF}]){2,63})+)$/u', |
|
| 35 | - // @codingStandardsIgnoreEnd |
|
| 36 | - $email_address |
|
| 37 | - ) |
|
| 38 | - ) { |
|
| 39 | - throw new EmailValidationException( |
|
| 40 | - esc_html__('Email address is invalid.', 'event_espresso') |
|
| 41 | - ); |
|
| 42 | - } |
|
| 43 | - return true; |
|
| 44 | - } |
|
| 23 | + /** |
|
| 24 | + * @param string $email_address |
|
| 25 | + * @return bool |
|
| 26 | + * @throws \EventEspresso\core\domain\services\validation\email\EmailValidationException |
|
| 27 | + */ |
|
| 28 | + public function validate($email_address) |
|
| 29 | + { |
|
| 30 | + parent::validate($email_address); |
|
| 31 | + if (// plz see http://stackoverflow.com/a/24817336 re: the following regex |
|
| 32 | + ! preg_match( |
|
| 33 | + // @codingStandardsIgnoreStart |
|
| 34 | + '/^(?!\.)((?!.*\.{2})[a-zA-Z0-9\x{0080}-\x{00FF}\x{0100}-\x{017F}\x{0180}-\x{024F}\x{0250}-\x{02AF}\x{0300}-\x{036F}\x{0370}-\x{03FF}\x{0400}-\x{04FF}\x{0500}-\x{052F}\x{0530}-\x{058F}\x{0590}-\x{05FF}\x{0600}-\x{06FF}\x{0700}-\x{074F}\x{0750}-\x{077F}\x{0780}-\x{07BF}\x{07C0}-\x{07FF}\x{0900}-\x{097F}\x{0980}-\x{09FF}\x{0A00}-\x{0A7F}\x{0A80}-\x{0AFF}\x{0B00}-\x{0B7F}\x{0B80}-\x{0BFF}\x{0C00}-\x{0C7F}\x{0C80}-\x{0CFF}\x{0D00}-\x{0D7F}\x{0D80}-\x{0DFF}\x{0E00}-\x{0E7F}\x{0E80}-\x{0EFF}\x{0F00}-\x{0FFF}\x{1000}-\x{109F}\x{10A0}-\x{10FF}\x{1100}-\x{11FF}\x{1200}-\x{137F}\x{1380}-\x{139F}\x{13A0}-\x{13FF}\x{1400}-\x{167F}\x{1680}-\x{169F}\x{16A0}-\x{16FF}\x{1700}-\x{171F}\x{1720}-\x{173F}\x{1740}-\x{175F}\x{1760}-\x{177F}\x{1780}-\x{17FF}\x{1800}-\x{18AF}\x{1900}-\x{194F}\x{1950}-\x{197F}\x{1980}-\x{19DF}\x{19E0}-\x{19FF}\x{1A00}-\x{1A1F}\x{1B00}-\x{1B7F}\x{1D00}-\x{1D7F}\x{1D80}-\x{1DBF}\x{1DC0}-\x{1DFF}\x{1E00}-\x{1EFF}\x{1F00}-\x{1FFF}\x{20D0}-\x{20FF}\x{2100}-\x{214F}\x{2C00}-\x{2C5F}\x{2C60}-\x{2C7F}\x{2C80}-\x{2CFF}\x{2D00}-\x{2D2F}\x{2D30}-\x{2D7F}\x{2D80}-\x{2DDF}\x{2F00}-\x{2FDF}\x{2FF0}-\x{2FFF}\x{3040}-\x{309F}\x{30A0}-\x{30FF}\x{3100}-\x{312F}\x{3130}-\x{318F}\x{3190}-\x{319F}\x{31C0}-\x{31EF}\x{31F0}-\x{31FF}\x{3200}-\x{32FF}\x{3300}-\x{33FF}\x{3400}-\x{4DBF}\x{4DC0}-\x{4DFF}\x{4E00}-\x{9FFF}\x{A000}-\x{A48F}\x{A490}-\x{A4CF}\x{A700}-\x{A71F}\x{A800}-\x{A82F}\x{A840}-\x{A87F}\x{AC00}-\x{D7AF}\x{F900}-\x{FAFF}\.!#$%&\'*+-\/=?^_`{|}~\-\d]+)@(?!\.)([a-zA-Z0-9\x{0080}-\x{00FF}\x{0100}-\x{017F}\x{0180}-\x{024F}\x{0250}-\x{02AF}\x{0300}-\x{036F}\x{0370}-\x{03FF}\x{0400}-\x{04FF}\x{0500}-\x{052F}\x{0530}-\x{058F}\x{0590}-\x{05FF}\x{0600}-\x{06FF}\x{0700}-\x{074F}\x{0750}-\x{077F}\x{0780}-\x{07BF}\x{07C0}-\x{07FF}\x{0900}-\x{097F}\x{0980}-\x{09FF}\x{0A00}-\x{0A7F}\x{0A80}-\x{0AFF}\x{0B00}-\x{0B7F}\x{0B80}-\x{0BFF}\x{0C00}-\x{0C7F}\x{0C80}-\x{0CFF}\x{0D00}-\x{0D7F}\x{0D80}-\x{0DFF}\x{0E00}-\x{0E7F}\x{0E80}-\x{0EFF}\x{0F00}-\x{0FFF}\x{1000}-\x{109F}\x{10A0}-\x{10FF}\x{1100}-\x{11FF}\x{1200}-\x{137F}\x{1380}-\x{139F}\x{13A0}-\x{13FF}\x{1400}-\x{167F}\x{1680}-\x{169F}\x{16A0}-\x{16FF}\x{1700}-\x{171F}\x{1720}-\x{173F}\x{1740}-\x{175F}\x{1760}-\x{177F}\x{1780}-\x{17FF}\x{1800}-\x{18AF}\x{1900}-\x{194F}\x{1950}-\x{197F}\x{1980}-\x{19DF}\x{19E0}-\x{19FF}\x{1A00}-\x{1A1F}\x{1B00}-\x{1B7F}\x{1D00}-\x{1D7F}\x{1D80}-\x{1DBF}\x{1DC0}-\x{1DFF}\x{1E00}-\x{1EFF}\x{1F00}-\x{1FFF}\x{20D0}-\x{20FF}\x{2100}-\x{214F}\x{2C00}-\x{2C5F}\x{2C60}-\x{2C7F}\x{2C80}-\x{2CFF}\x{2D00}-\x{2D2F}\x{2D30}-\x{2D7F}\x{2D80}-\x{2DDF}\x{2F00}-\x{2FDF}\x{2FF0}-\x{2FFF}\x{3040}-\x{309F}\x{30A0}-\x{30FF}\x{3100}-\x{312F}\x{3130}-\x{318F}\x{3190}-\x{319F}\x{31C0}-\x{31EF}\x{31F0}-\x{31FF}\x{3200}-\x{32FF}\x{3300}-\x{33FF}\x{3400}-\x{4DBF}\x{4DC0}-\x{4DFF}\x{4E00}-\x{9FFF}\x{A000}-\x{A48F}\x{A490}-\x{A4CF}\x{A700}-\x{A71F}\x{A800}-\x{A82F}\x{A840}-\x{A87F}\x{AC00}-\x{D7AF}\x{F900}-\x{FAFF}\-\.\d]+)((\.([a-zA-Z\x{0080}-\x{00FF}\x{0100}-\x{017F}\x{0180}-\x{024F}\x{0250}-\x{02AF}\x{0300}-\x{036F}\x{0370}-\x{03FF}\x{0400}-\x{04FF}\x{0500}-\x{052F}\x{0530}-\x{058F}\x{0590}-\x{05FF}\x{0600}-\x{06FF}\x{0700}-\x{074F}\x{0750}-\x{077F}\x{0780}-\x{07BF}\x{07C0}-\x{07FF}\x{0900}-\x{097F}\x{0980}-\x{09FF}\x{0A00}-\x{0A7F}\x{0A80}-\x{0AFF}\x{0B00}-\x{0B7F}\x{0B80}-\x{0BFF}\x{0C00}-\x{0C7F}\x{0C80}-\x{0CFF}\x{0D00}-\x{0D7F}\x{0D80}-\x{0DFF}\x{0E00}-\x{0E7F}\x{0E80}-\x{0EFF}\x{0F00}-\x{0FFF}\x{1000}-\x{109F}\x{10A0}-\x{10FF}\x{1100}-\x{11FF}\x{1200}-\x{137F}\x{1380}-\x{139F}\x{13A0}-\x{13FF}\x{1400}-\x{167F}\x{1680}-\x{169F}\x{16A0}-\x{16FF}\x{1700}-\x{171F}\x{1720}-\x{173F}\x{1740}-\x{175F}\x{1760}-\x{177F}\x{1780}-\x{17FF}\x{1800}-\x{18AF}\x{1900}-\x{194F}\x{1950}-\x{197F}\x{1980}-\x{19DF}\x{19E0}-\x{19FF}\x{1A00}-\x{1A1F}\x{1B00}-\x{1B7F}\x{1D00}-\x{1D7F}\x{1D80}-\x{1DBF}\x{1DC0}-\x{1DFF}\x{1E00}-\x{1EFF}\x{1F00}-\x{1FFF}\x{20D0}-\x{20FF}\x{2100}-\x{214F}\x{2C00}-\x{2C5F}\x{2C60}-\x{2C7F}\x{2C80}-\x{2CFF}\x{2D00}-\x{2D2F}\x{2D30}-\x{2D7F}\x{2D80}-\x{2DDF}\x{2F00}-\x{2FDF}\x{2FF0}-\x{2FFF}\x{3040}-\x{309F}\x{30A0}-\x{30FF}\x{3100}-\x{312F}\x{3130}-\x{318F}\x{3190}-\x{319F}\x{31C0}-\x{31EF}\x{31F0}-\x{31FF}\x{3200}-\x{32FF}\x{3300}-\x{33FF}\x{3400}-\x{4DBF}\x{4DC0}-\x{4DFF}\x{4E00}-\x{9FFF}\x{A000}-\x{A48F}\x{A490}-\x{A4CF}\x{A700}-\x{A71F}\x{A800}-\x{A82F}\x{A840}-\x{A87F}\x{AC00}-\x{D7AF}\x{F900}-\x{FAFF}]){2,63})+)$/u', |
|
| 35 | + // @codingStandardsIgnoreEnd |
|
| 36 | + $email_address |
|
| 37 | + ) |
|
| 38 | + ) { |
|
| 39 | + throw new EmailValidationException( |
|
| 40 | + esc_html__('Email address is invalid.', 'event_espresso') |
|
| 41 | + ); |
|
| 42 | + } |
|
| 43 | + return true; |
|
| 44 | + } |
|
| 45 | 45 | } |
| 46 | 46 | // End of file International.php |
| 47 | 47 | // Location: core\services\validation/International.php |
@@ -20,117 +20,117 @@ |
||
| 20 | 20 | class Basic implements EmailValidatorInterface |
| 21 | 21 | { |
| 22 | 22 | |
| 23 | - /** |
|
| 24 | - * @param string $email_address |
|
| 25 | - * @return bool |
|
| 26 | - * @throws EmailValidationException |
|
| 27 | - */ |
|
| 28 | - public function validate($email_address) |
|
| 29 | - { |
|
| 30 | - if (! preg_match('/^.+\@\S+$/', $email_address)) { |
|
| 31 | - // email not in correct {string}@{string} format |
|
| 32 | - throw new EmailValidationException( |
|
| 33 | - esc_html__('Email does not have the required @ sign.', 'event_espresso') |
|
| 34 | - ); |
|
| 35 | - } |
|
| 36 | - $atIndex = $this->getAtIndex($email_address); |
|
| 37 | - $local = $this->getLocalPartOfEmail($email_address, $atIndex); |
|
| 38 | - $localLen = strlen($local); |
|
| 39 | - if ($localLen < 1) { |
|
| 40 | - //no local part |
|
| 41 | - throw new EmailValidationException( |
|
| 42 | - esc_html__('Email local-part (before the @) is required.', 'event_espresso') |
|
| 43 | - ); |
|
| 44 | - } |
|
| 45 | - if ($localLen > 64) { |
|
| 46 | - // local part length exceeded |
|
| 47 | - throw new EmailValidationException( |
|
| 48 | - esc_html__('Email local-part (before the @) is too long.', 'event_espresso') |
|
| 49 | - ); |
|
| 50 | - } |
|
| 51 | - if ($local[0] === '.') { |
|
| 52 | - // local part starts with '.' |
|
| 53 | - throw new EmailValidationException( |
|
| 54 | - esc_html__('Email local-part (before the @) must not begin with a period.', 'event_espresso') |
|
| 55 | - ); |
|
| 56 | - } |
|
| 57 | - if ($local[$localLen - 1] === '.') { |
|
| 58 | - // local part starts or ends with '.' |
|
| 59 | - throw new EmailValidationException( |
|
| 60 | - esc_html__('Email local-part (before the @) must not end with a period.', 'event_espresso') |
|
| 61 | - ); |
|
| 62 | - } |
|
| 63 | - if (preg_match('/\\.\\./', $local)) { |
|
| 64 | - // local part has two consecutive dots |
|
| 65 | - throw new EmailValidationException( |
|
| 66 | - esc_html__( |
|
| 67 | - 'Email local-part (before the @) must not have two consecutive periods.', |
|
| 68 | - 'event_espresso' |
|
| 69 | - ) |
|
| 70 | - ); |
|
| 71 | - } |
|
| 72 | - $domain = $this->getDomainPartOfEmail($email_address, $atIndex); |
|
| 73 | - $domainLen = strlen($domain); |
|
| 74 | - if ($domainLen < 1) { |
|
| 75 | - throw new EmailValidationException( |
|
| 76 | - esc_html__('Email domain (after the @) is required.', 'event_espresso') |
|
| 77 | - ); |
|
| 78 | - } |
|
| 79 | - if ($domainLen > 255) { |
|
| 80 | - // domain part length exceeded |
|
| 81 | - throw new EmailValidationException( |
|
| 82 | - esc_html__('Email domain (after the @) is too long.', 'event_espresso') |
|
| 83 | - ); |
|
| 84 | - } |
|
| 85 | - if (preg_match('/\\.\\./', $domain)) { |
|
| 86 | - // domain part has two consecutive dots |
|
| 87 | - throw new EmailValidationException( |
|
| 88 | - esc_html__('Email domain (after the @) must not have two consecutive periods.', 'event_espresso') |
|
| 89 | - ); |
|
| 90 | - } |
|
| 91 | - return true; |
|
| 92 | - } |
|
| 93 | - |
|
| 94 | - |
|
| 95 | - |
|
| 96 | - /** |
|
| 97 | - * returns the location of the @ symbol |
|
| 98 | - * |
|
| 99 | - * @param string $email_address |
|
| 100 | - * @return bool|string |
|
| 101 | - */ |
|
| 102 | - protected function getAtIndex($email_address) |
|
| 103 | - { |
|
| 104 | - return strrpos($email_address, '@'); |
|
| 105 | - } |
|
| 106 | - |
|
| 107 | - |
|
| 108 | - |
|
| 109 | - /** |
|
| 110 | - * Gets the local part of the email |
|
| 111 | - * |
|
| 112 | - * @param string $email_address |
|
| 113 | - * @param bool|int $atIndex |
|
| 114 | - * @return bool|string |
|
| 115 | - */ |
|
| 116 | - protected function getLocalPartOfEmail($email_address, $atIndex) |
|
| 117 | - { |
|
| 118 | - return substr($email_address, 0, $atIndex); |
|
| 119 | - } |
|
| 120 | - |
|
| 121 | - |
|
| 122 | - |
|
| 123 | - /** |
|
| 124 | - * Gets the domain part of the email |
|
| 125 | - * |
|
| 126 | - * @param string $email_address |
|
| 127 | - * @param bool|int $atIndex |
|
| 128 | - * @return bool|string |
|
| 129 | - */ |
|
| 130 | - protected function getDomainPartOfEmail($email_address, $atIndex) |
|
| 131 | - { |
|
| 132 | - return substr($email_address, $atIndex + 1); |
|
| 133 | - } |
|
| 23 | + /** |
|
| 24 | + * @param string $email_address |
|
| 25 | + * @return bool |
|
| 26 | + * @throws EmailValidationException |
|
| 27 | + */ |
|
| 28 | + public function validate($email_address) |
|
| 29 | + { |
|
| 30 | + if (! preg_match('/^.+\@\S+$/', $email_address)) { |
|
| 31 | + // email not in correct {string}@{string} format |
|
| 32 | + throw new EmailValidationException( |
|
| 33 | + esc_html__('Email does not have the required @ sign.', 'event_espresso') |
|
| 34 | + ); |
|
| 35 | + } |
|
| 36 | + $atIndex = $this->getAtIndex($email_address); |
|
| 37 | + $local = $this->getLocalPartOfEmail($email_address, $atIndex); |
|
| 38 | + $localLen = strlen($local); |
|
| 39 | + if ($localLen < 1) { |
|
| 40 | + //no local part |
|
| 41 | + throw new EmailValidationException( |
|
| 42 | + esc_html__('Email local-part (before the @) is required.', 'event_espresso') |
|
| 43 | + ); |
|
| 44 | + } |
|
| 45 | + if ($localLen > 64) { |
|
| 46 | + // local part length exceeded |
|
| 47 | + throw new EmailValidationException( |
|
| 48 | + esc_html__('Email local-part (before the @) is too long.', 'event_espresso') |
|
| 49 | + ); |
|
| 50 | + } |
|
| 51 | + if ($local[0] === '.') { |
|
| 52 | + // local part starts with '.' |
|
| 53 | + throw new EmailValidationException( |
|
| 54 | + esc_html__('Email local-part (before the @) must not begin with a period.', 'event_espresso') |
|
| 55 | + ); |
|
| 56 | + } |
|
| 57 | + if ($local[$localLen - 1] === '.') { |
|
| 58 | + // local part starts or ends with '.' |
|
| 59 | + throw new EmailValidationException( |
|
| 60 | + esc_html__('Email local-part (before the @) must not end with a period.', 'event_espresso') |
|
| 61 | + ); |
|
| 62 | + } |
|
| 63 | + if (preg_match('/\\.\\./', $local)) { |
|
| 64 | + // local part has two consecutive dots |
|
| 65 | + throw new EmailValidationException( |
|
| 66 | + esc_html__( |
|
| 67 | + 'Email local-part (before the @) must not have two consecutive periods.', |
|
| 68 | + 'event_espresso' |
|
| 69 | + ) |
|
| 70 | + ); |
|
| 71 | + } |
|
| 72 | + $domain = $this->getDomainPartOfEmail($email_address, $atIndex); |
|
| 73 | + $domainLen = strlen($domain); |
|
| 74 | + if ($domainLen < 1) { |
|
| 75 | + throw new EmailValidationException( |
|
| 76 | + esc_html__('Email domain (after the @) is required.', 'event_espresso') |
|
| 77 | + ); |
|
| 78 | + } |
|
| 79 | + if ($domainLen > 255) { |
|
| 80 | + // domain part length exceeded |
|
| 81 | + throw new EmailValidationException( |
|
| 82 | + esc_html__('Email domain (after the @) is too long.', 'event_espresso') |
|
| 83 | + ); |
|
| 84 | + } |
|
| 85 | + if (preg_match('/\\.\\./', $domain)) { |
|
| 86 | + // domain part has two consecutive dots |
|
| 87 | + throw new EmailValidationException( |
|
| 88 | + esc_html__('Email domain (after the @) must not have two consecutive periods.', 'event_espresso') |
|
| 89 | + ); |
|
| 90 | + } |
|
| 91 | + return true; |
|
| 92 | + } |
|
| 93 | + |
|
| 94 | + |
|
| 95 | + |
|
| 96 | + /** |
|
| 97 | + * returns the location of the @ symbol |
|
| 98 | + * |
|
| 99 | + * @param string $email_address |
|
| 100 | + * @return bool|string |
|
| 101 | + */ |
|
| 102 | + protected function getAtIndex($email_address) |
|
| 103 | + { |
|
| 104 | + return strrpos($email_address, '@'); |
|
| 105 | + } |
|
| 106 | + |
|
| 107 | + |
|
| 108 | + |
|
| 109 | + /** |
|
| 110 | + * Gets the local part of the email |
|
| 111 | + * |
|
| 112 | + * @param string $email_address |
|
| 113 | + * @param bool|int $atIndex |
|
| 114 | + * @return bool|string |
|
| 115 | + */ |
|
| 116 | + protected function getLocalPartOfEmail($email_address, $atIndex) |
|
| 117 | + { |
|
| 118 | + return substr($email_address, 0, $atIndex); |
|
| 119 | + } |
|
| 120 | + |
|
| 121 | + |
|
| 122 | + |
|
| 123 | + /** |
|
| 124 | + * Gets the domain part of the email |
|
| 125 | + * |
|
| 126 | + * @param string $email_address |
|
| 127 | + * @param bool|int $atIndex |
|
| 128 | + * @return bool|string |
|
| 129 | + */ |
|
| 130 | + protected function getDomainPartOfEmail($email_address, $atIndex) |
|
| 131 | + { |
|
| 132 | + return substr($email_address, $atIndex + 1); |
|
| 133 | + } |
|
| 134 | 134 | } |
| 135 | 135 | // End of file Basic.php |
| 136 | 136 | // Location: core\services\validation/Basic.php |
@@ -27,7 +27,7 @@ |
||
| 27 | 27 | */ |
| 28 | 28 | public function validate($email_address) |
| 29 | 29 | { |
| 30 | - if (! preg_match('/^.+\@\S+$/', $email_address)) { |
|
| 30 | + if ( ! preg_match('/^.+\@\S+$/', $email_address)) { |
|
| 31 | 31 | // email not in correct {string}@{string} format |
| 32 | 32 | throw new EmailValidationException( |
| 33 | 33 | esc_html__('Email does not have the required @ sign.', 'event_espresso') |
@@ -20,22 +20,22 @@ |
||
| 20 | 20 | class WordPress extends Basic |
| 21 | 21 | { |
| 22 | 22 | |
| 23 | - /** |
|
| 24 | - * |
|
| 25 | - * @param string $email_address |
|
| 26 | - * @return boolean |
|
| 27 | - * @throws EmailValidationException |
|
| 28 | - */ |
|
| 29 | - public function validate($email_address) |
|
| 30 | - { |
|
| 31 | - parent::validate($email_address); |
|
| 32 | - if( ! is_email($email_address)){ |
|
| 33 | - throw new EmailValidationException( |
|
| 34 | - esc_html__('The email address provided is not valid.', 'event_espresso') |
|
| 35 | - ); |
|
| 36 | - } |
|
| 37 | - return true; |
|
| 38 | - } |
|
| 23 | + /** |
|
| 24 | + * |
|
| 25 | + * @param string $email_address |
|
| 26 | + * @return boolean |
|
| 27 | + * @throws EmailValidationException |
|
| 28 | + */ |
|
| 29 | + public function validate($email_address) |
|
| 30 | + { |
|
| 31 | + parent::validate($email_address); |
|
| 32 | + if( ! is_email($email_address)){ |
|
| 33 | + throw new EmailValidationException( |
|
| 34 | + esc_html__('The email address provided is not valid.', 'event_espresso') |
|
| 35 | + ); |
|
| 36 | + } |
|
| 37 | + return true; |
|
| 38 | + } |
|
| 39 | 39 | |
| 40 | 40 | |
| 41 | 41 | } |
@@ -29,7 +29,7 @@ |
||
| 29 | 29 | public function validate($email_address) |
| 30 | 30 | { |
| 31 | 31 | parent::validate($email_address); |
| 32 | - if( ! is_email($email_address)){ |
|
| 32 | + if ( ! is_email($email_address)) { |
|
| 33 | 33 | throw new EmailValidationException( |
| 34 | 34 | esc_html__('The email address provided is not valid.', 'event_espresso') |
| 35 | 35 | ); |
@@ -21,69 +21,69 @@ |
||
| 21 | 21 | class EmailValidationService implements EmailValidatorInterface |
| 22 | 22 | { |
| 23 | 23 | |
| 24 | - /** |
|
| 25 | - * @var EE_Registration_Config $registration_config |
|
| 26 | - */ |
|
| 27 | - protected $registration_config; |
|
| 28 | - |
|
| 29 | - /** |
|
| 30 | - * @var Loader $loader |
|
| 31 | - */ |
|
| 32 | - protected $loader; |
|
| 33 | - |
|
| 34 | - |
|
| 35 | - |
|
| 36 | - /** |
|
| 37 | - * EmailValidationService constructor. |
|
| 38 | - * Accepts an \EE_Config as an argument. |
|
| 39 | - * |
|
| 40 | - * @param EE_Registration_Config $config |
|
| 41 | - * @param Loader $loader |
|
| 42 | - */ |
|
| 43 | - public function __construct(EE_Registration_Config $config, Loader $loader) |
|
| 44 | - { |
|
| 45 | - $this->registration_config = $config; |
|
| 46 | - $this->loader = $loader; |
|
| 47 | - } |
|
| 48 | - |
|
| 49 | - |
|
| 50 | - |
|
| 51 | - /** |
|
| 52 | - * Validates the email address. If it's invalid, an EmailValidationException |
|
| 53 | - * is thrown that describes why its invalid. |
|
| 54 | - * |
|
| 55 | - * @param string $email_address |
|
| 56 | - * @return boolean |
|
| 57 | - * @throws EmailValidationException |
|
| 58 | - */ |
|
| 59 | - public function validate($email_address) |
|
| 60 | - { |
|
| 61 | - //pick the correct validator according to the config |
|
| 62 | - switch ($this->registration_config->email_validation_level) { |
|
| 63 | - case 'basic': |
|
| 64 | - $validator = $this->loader->getShared( |
|
| 65 | - 'EventEspresso\core\domain\services\validation\email\strategies\Basic' |
|
| 66 | - ); |
|
| 67 | - break; |
|
| 68 | - case 'i18n': |
|
| 69 | - $validator = $this->loader->getShared( |
|
| 70 | - 'EventEspresso\core\domain\services\validation\email\strategies\International' |
|
| 71 | - ) ; |
|
| 72 | - break; |
|
| 73 | - case 'i18n_dns': |
|
| 74 | - $validator = $this->loader->getShared( |
|
| 75 | - 'EventEspresso\core\domain\services\validation\email\strategies\InternationalDNS' |
|
| 76 | - ) ; |
|
| 77 | - break; |
|
| 78 | - case 'wp_default': |
|
| 79 | - default: |
|
| 80 | - $validator = $this->loader->getShared( |
|
| 81 | - 'EventEspresso\core\domain\services\validation\email\strategies\WordPress' |
|
| 82 | - ) ; |
|
| 83 | - break; |
|
| 84 | - } |
|
| 85 | - return $validator->validate($email_address); |
|
| 86 | - } |
|
| 24 | + /** |
|
| 25 | + * @var EE_Registration_Config $registration_config |
|
| 26 | + */ |
|
| 27 | + protected $registration_config; |
|
| 28 | + |
|
| 29 | + /** |
|
| 30 | + * @var Loader $loader |
|
| 31 | + */ |
|
| 32 | + protected $loader; |
|
| 33 | + |
|
| 34 | + |
|
| 35 | + |
|
| 36 | + /** |
|
| 37 | + * EmailValidationService constructor. |
|
| 38 | + * Accepts an \EE_Config as an argument. |
|
| 39 | + * |
|
| 40 | + * @param EE_Registration_Config $config |
|
| 41 | + * @param Loader $loader |
|
| 42 | + */ |
|
| 43 | + public function __construct(EE_Registration_Config $config, Loader $loader) |
|
| 44 | + { |
|
| 45 | + $this->registration_config = $config; |
|
| 46 | + $this->loader = $loader; |
|
| 47 | + } |
|
| 48 | + |
|
| 49 | + |
|
| 50 | + |
|
| 51 | + /** |
|
| 52 | + * Validates the email address. If it's invalid, an EmailValidationException |
|
| 53 | + * is thrown that describes why its invalid. |
|
| 54 | + * |
|
| 55 | + * @param string $email_address |
|
| 56 | + * @return boolean |
|
| 57 | + * @throws EmailValidationException |
|
| 58 | + */ |
|
| 59 | + public function validate($email_address) |
|
| 60 | + { |
|
| 61 | + //pick the correct validator according to the config |
|
| 62 | + switch ($this->registration_config->email_validation_level) { |
|
| 63 | + case 'basic': |
|
| 64 | + $validator = $this->loader->getShared( |
|
| 65 | + 'EventEspresso\core\domain\services\validation\email\strategies\Basic' |
|
| 66 | + ); |
|
| 67 | + break; |
|
| 68 | + case 'i18n': |
|
| 69 | + $validator = $this->loader->getShared( |
|
| 70 | + 'EventEspresso\core\domain\services\validation\email\strategies\International' |
|
| 71 | + ) ; |
|
| 72 | + break; |
|
| 73 | + case 'i18n_dns': |
|
| 74 | + $validator = $this->loader->getShared( |
|
| 75 | + 'EventEspresso\core\domain\services\validation\email\strategies\InternationalDNS' |
|
| 76 | + ) ; |
|
| 77 | + break; |
|
| 78 | + case 'wp_default': |
|
| 79 | + default: |
|
| 80 | + $validator = $this->loader->getShared( |
|
| 81 | + 'EventEspresso\core\domain\services\validation\email\strategies\WordPress' |
|
| 82 | + ) ; |
|
| 83 | + break; |
|
| 84 | + } |
|
| 85 | + return $validator->validate($email_address); |
|
| 86 | + } |
|
| 87 | 87 | |
| 88 | 88 | |
| 89 | 89 | } |
@@ -68,18 +68,18 @@ |
||
| 68 | 68 | case 'i18n': |
| 69 | 69 | $validator = $this->loader->getShared( |
| 70 | 70 | 'EventEspresso\core\domain\services\validation\email\strategies\International' |
| 71 | - ) ; |
|
| 71 | + ); |
|
| 72 | 72 | break; |
| 73 | 73 | case 'i18n_dns': |
| 74 | 74 | $validator = $this->loader->getShared( |
| 75 | 75 | 'EventEspresso\core\domain\services\validation\email\strategies\InternationalDNS' |
| 76 | - ) ; |
|
| 76 | + ); |
|
| 77 | 77 | break; |
| 78 | 78 | case 'wp_default': |
| 79 | 79 | default: |
| 80 | 80 | $validator = $this->loader->getShared( |
| 81 | 81 | 'EventEspresso\core\domain\services\validation\email\strategies\WordPress' |
| 82 | - ) ; |
|
| 82 | + ); |
|
| 83 | 83 | break; |
| 84 | 84 | } |
| 85 | 85 | return $validator->validate($email_address); |
@@ -18,14 +18,14 @@ |
||
| 18 | 18 | interface EmailValidatorInterface |
| 19 | 19 | { |
| 20 | 20 | |
| 21 | - /** |
|
| 22 | - * Validates the supplied email address. If it is invalid, throws EmailValidationException |
|
| 23 | - * |
|
| 24 | - * @param string $email_address |
|
| 25 | - * @return boolean |
|
| 26 | - * @throws EmailValidationException |
|
| 27 | - */ |
|
| 28 | - public function validate($email_address); |
|
| 21 | + /** |
|
| 22 | + * Validates the supplied email address. If it is invalid, throws EmailValidationException |
|
| 23 | + * |
|
| 24 | + * @param string $email_address |
|
| 25 | + * @return boolean |
|
| 26 | + * @throws EmailValidationException |
|
| 27 | + */ |
|
| 28 | + public function validate($email_address); |
|
| 29 | 29 | |
| 30 | 30 | |
| 31 | 31 | } |
@@ -19,61 +19,61 @@ |
||
| 19 | 19 | class EmailAddress |
| 20 | 20 | { |
| 21 | 21 | |
| 22 | - /** |
|
| 23 | - * @var string $email_address |
|
| 24 | - */ |
|
| 25 | - private $email_address; |
|
| 26 | - |
|
| 27 | - |
|
| 28 | - |
|
| 29 | - /** |
|
| 30 | - * EmailAddress constructor. |
|
| 31 | - * |
|
| 32 | - * @param string $email_address |
|
| 33 | - * @param EmailValidatorInterface $validator |
|
| 34 | - * @throws EmailValidationException |
|
| 35 | - */ |
|
| 36 | - public function __construct($email_address, EmailValidatorInterface $validator) |
|
| 37 | - { |
|
| 38 | - $validator->validate($email_address); |
|
| 39 | - $this->email_address = $email_address; |
|
| 40 | - } |
|
| 41 | - |
|
| 42 | - |
|
| 43 | - |
|
| 44 | - /** |
|
| 45 | - * returns the string value for this EmailAddress |
|
| 46 | - * |
|
| 47 | - * @return string |
|
| 48 | - */ |
|
| 49 | - public function get() |
|
| 50 | - { |
|
| 51 | - return $this->email_address; |
|
| 52 | - } |
|
| 53 | - |
|
| 54 | - |
|
| 55 | - |
|
| 56 | - /** |
|
| 57 | - * compare another EmailAddress to this one to determine if they are the same |
|
| 58 | - * |
|
| 59 | - * @param EmailAddress $address |
|
| 60 | - * @return bool |
|
| 61 | - */ |
|
| 62 | - public function equals(EmailAddress $address) |
|
| 63 | - { |
|
| 64 | - return strtolower((string)$this) === strtolower((string)$address); |
|
| 65 | - } |
|
| 66 | - |
|
| 67 | - |
|
| 68 | - /** |
|
| 69 | - * allows an EmailAddress object to be used as a string |
|
| 70 | - * |
|
| 71 | - * @return string |
|
| 72 | - */ |
|
| 73 | - public function __toString() |
|
| 74 | - { |
|
| 75 | - return $this->email_address; |
|
| 76 | - } |
|
| 22 | + /** |
|
| 23 | + * @var string $email_address |
|
| 24 | + */ |
|
| 25 | + private $email_address; |
|
| 26 | + |
|
| 27 | + |
|
| 28 | + |
|
| 29 | + /** |
|
| 30 | + * EmailAddress constructor. |
|
| 31 | + * |
|
| 32 | + * @param string $email_address |
|
| 33 | + * @param EmailValidatorInterface $validator |
|
| 34 | + * @throws EmailValidationException |
|
| 35 | + */ |
|
| 36 | + public function __construct($email_address, EmailValidatorInterface $validator) |
|
| 37 | + { |
|
| 38 | + $validator->validate($email_address); |
|
| 39 | + $this->email_address = $email_address; |
|
| 40 | + } |
|
| 41 | + |
|
| 42 | + |
|
| 43 | + |
|
| 44 | + /** |
|
| 45 | + * returns the string value for this EmailAddress |
|
| 46 | + * |
|
| 47 | + * @return string |
|
| 48 | + */ |
|
| 49 | + public function get() |
|
| 50 | + { |
|
| 51 | + return $this->email_address; |
|
| 52 | + } |
|
| 53 | + |
|
| 54 | + |
|
| 55 | + |
|
| 56 | + /** |
|
| 57 | + * compare another EmailAddress to this one to determine if they are the same |
|
| 58 | + * |
|
| 59 | + * @param EmailAddress $address |
|
| 60 | + * @return bool |
|
| 61 | + */ |
|
| 62 | + public function equals(EmailAddress $address) |
|
| 63 | + { |
|
| 64 | + return strtolower((string)$this) === strtolower((string)$address); |
|
| 65 | + } |
|
| 66 | + |
|
| 67 | + |
|
| 68 | + /** |
|
| 69 | + * allows an EmailAddress object to be used as a string |
|
| 70 | + * |
|
| 71 | + * @return string |
|
| 72 | + */ |
|
| 73 | + public function __toString() |
|
| 74 | + { |
|
| 75 | + return $this->email_address; |
|
| 76 | + } |
|
| 77 | 77 | |
| 78 | 78 | |
| 79 | 79 | |
@@ -61,7 +61,7 @@ |
||
| 61 | 61 | */ |
| 62 | 62 | public function equals(EmailAddress $address) |
| 63 | 63 | { |
| 64 | - return strtolower((string)$this) === strtolower((string)$address); |
|
| 64 | + return strtolower((string) $this) === strtolower((string) $address); |
|
| 65 | 65 | } |
| 66 | 66 | |
| 67 | 67 | |
@@ -18,72 +18,72 @@ |
||
| 18 | 18 | { |
| 19 | 19 | |
| 20 | 20 | |
| 21 | - /** |
|
| 22 | - * @param string $validation_error_message |
|
| 23 | - */ |
|
| 24 | - public function __construct($validation_error_message = '') |
|
| 25 | - { |
|
| 26 | - if (! $validation_error_message) { |
|
| 27 | - $validation_error_message = esc_html__('Please enter a valid email address.', 'event_espresso'); |
|
| 28 | - } |
|
| 29 | - parent::__construct($validation_error_message); |
|
| 30 | - } |
|
| 21 | + /** |
|
| 22 | + * @param string $validation_error_message |
|
| 23 | + */ |
|
| 24 | + public function __construct($validation_error_message = '') |
|
| 25 | + { |
|
| 26 | + if (! $validation_error_message) { |
|
| 27 | + $validation_error_message = esc_html__('Please enter a valid email address.', 'event_espresso'); |
|
| 28 | + } |
|
| 29 | + parent::__construct($validation_error_message); |
|
| 30 | + } |
|
| 31 | 31 | |
| 32 | 32 | |
| 33 | 33 | |
| 34 | - /** |
|
| 35 | - * just checks the field isn't blank |
|
| 36 | - * |
|
| 37 | - * @param $normalized_value |
|
| 38 | - * @return bool |
|
| 39 | - * @throws InvalidArgumentException |
|
| 40 | - * @throws InvalidInterfaceException |
|
| 41 | - * @throws InvalidDataTypeException |
|
| 42 | - * @throws EE_Validation_Error |
|
| 43 | - */ |
|
| 44 | - public function validate($normalized_value) |
|
| 45 | - { |
|
| 46 | - if ($normalized_value && ! $this->_validate_email($normalized_value)) { |
|
| 47 | - throw new EE_Validation_Error($this->get_validation_error_message(), 'required'); |
|
| 48 | - } |
|
| 49 | - return true; |
|
| 50 | - } |
|
| 34 | + /** |
|
| 35 | + * just checks the field isn't blank |
|
| 36 | + * |
|
| 37 | + * @param $normalized_value |
|
| 38 | + * @return bool |
|
| 39 | + * @throws InvalidArgumentException |
|
| 40 | + * @throws InvalidInterfaceException |
|
| 41 | + * @throws InvalidDataTypeException |
|
| 42 | + * @throws EE_Validation_Error |
|
| 43 | + */ |
|
| 44 | + public function validate($normalized_value) |
|
| 45 | + { |
|
| 46 | + if ($normalized_value && ! $this->_validate_email($normalized_value)) { |
|
| 47 | + throw new EE_Validation_Error($this->get_validation_error_message(), 'required'); |
|
| 48 | + } |
|
| 49 | + return true; |
|
| 50 | + } |
|
| 51 | 51 | |
| 52 | 52 | |
| 53 | 53 | |
| 54 | - /** |
|
| 55 | - * @return array |
|
| 56 | - */ |
|
| 57 | - public function get_jquery_validation_rule_array() |
|
| 58 | - { |
|
| 59 | - return array('email' => true, 'messages' => array('email' => $this->get_validation_error_message())); |
|
| 60 | - } |
|
| 54 | + /** |
|
| 55 | + * @return array |
|
| 56 | + */ |
|
| 57 | + public function get_jquery_validation_rule_array() |
|
| 58 | + { |
|
| 59 | + return array('email' => true, 'messages' => array('email' => $this->get_validation_error_message())); |
|
| 60 | + } |
|
| 61 | 61 | |
| 62 | 62 | |
| 63 | 63 | |
| 64 | - /** |
|
| 65 | - * Validate an email address. |
|
| 66 | - * Provide email address (raw input) |
|
| 67 | - * |
|
| 68 | - * @param $email |
|
| 69 | - * @return bool of whether the email is valid or not |
|
| 70 | - * @throws InvalidArgumentException |
|
| 71 | - * @throws InvalidInterfaceException |
|
| 72 | - * @throws InvalidDataTypeException |
|
| 73 | - * @throws EE_Validation_Error |
|
| 74 | - */ |
|
| 75 | - private function _validate_email($email) |
|
| 76 | - { |
|
| 77 | - try { |
|
| 78 | - EmailAddressFactory::create($email); |
|
| 79 | - } catch (EmailValidationException $e) { |
|
| 80 | - throw new EE_Validation_Error( |
|
| 81 | - $e->getMessage(), |
|
| 82 | - 'invalid_email', |
|
| 83 | - $this->_input, |
|
| 84 | - $e |
|
| 85 | - ); |
|
| 86 | - } |
|
| 87 | - return true; |
|
| 88 | - } |
|
| 64 | + /** |
|
| 65 | + * Validate an email address. |
|
| 66 | + * Provide email address (raw input) |
|
| 67 | + * |
|
| 68 | + * @param $email |
|
| 69 | + * @return bool of whether the email is valid or not |
|
| 70 | + * @throws InvalidArgumentException |
|
| 71 | + * @throws InvalidInterfaceException |
|
| 72 | + * @throws InvalidDataTypeException |
|
| 73 | + * @throws EE_Validation_Error |
|
| 74 | + */ |
|
| 75 | + private function _validate_email($email) |
|
| 76 | + { |
|
| 77 | + try { |
|
| 78 | + EmailAddressFactory::create($email); |
|
| 79 | + } catch (EmailValidationException $e) { |
|
| 80 | + throw new EE_Validation_Error( |
|
| 81 | + $e->getMessage(), |
|
| 82 | + 'invalid_email', |
|
| 83 | + $this->_input, |
|
| 84 | + $e |
|
| 85 | + ); |
|
| 86 | + } |
|
| 87 | + return true; |
|
| 88 | + } |
|
| 89 | 89 | } |
@@ -23,7 +23,7 @@ |
||
| 23 | 23 | */ |
| 24 | 24 | public function __construct($validation_error_message = '') |
| 25 | 25 | { |
| 26 | - if (! $validation_error_message) { |
|
| 26 | + if ( ! $validation_error_message) { |
|
| 27 | 27 | $validation_error_message = esc_html__('Please enter a valid email address.', 'event_espresso'); |
| 28 | 28 | } |
| 29 | 29 | parent::__construct($validation_error_message); |
@@ -272,6 +272,7 @@ |
||
| 272 | 272 | |
| 273 | 273 | /** |
| 274 | 274 | * @param mixed string | EED_Module $module |
| 275 | + * @param string $module |
|
| 275 | 276 | * @throws EE_Error |
| 276 | 277 | * @throws ReflectionException |
| 277 | 278 | */ |
@@ -22,1519 +22,1519 @@ |
||
| 22 | 22 | class EE_Registry implements ResettableInterface |
| 23 | 23 | { |
| 24 | 24 | |
| 25 | - /** |
|
| 26 | - * @var EE_Registry $_instance |
|
| 27 | - */ |
|
| 28 | - private static $_instance; |
|
| 29 | - |
|
| 30 | - /** |
|
| 31 | - * @var EE_Dependency_Map $_dependency_map |
|
| 32 | - */ |
|
| 33 | - protected $_dependency_map; |
|
| 34 | - |
|
| 35 | - /** |
|
| 36 | - * @var array $_class_abbreviations |
|
| 37 | - */ |
|
| 38 | - protected $_class_abbreviations = array(); |
|
| 39 | - |
|
| 40 | - /** |
|
| 41 | - * @var CommandBusInterface $BUS |
|
| 42 | - */ |
|
| 43 | - public $BUS; |
|
| 44 | - |
|
| 45 | - /** |
|
| 46 | - * @var EE_Cart $CART |
|
| 47 | - */ |
|
| 48 | - public $CART; |
|
| 49 | - |
|
| 50 | - /** |
|
| 51 | - * @var EE_Config $CFG |
|
| 52 | - */ |
|
| 53 | - public $CFG; |
|
| 54 | - |
|
| 55 | - /** |
|
| 56 | - * @var EE_Network_Config $NET_CFG |
|
| 57 | - */ |
|
| 58 | - public $NET_CFG; |
|
| 59 | - |
|
| 60 | - /** |
|
| 61 | - * StdClass object for storing library classes in |
|
| 62 | - * |
|
| 63 | - * @var StdClass $LIB |
|
| 64 | - */ |
|
| 65 | - public $LIB; |
|
| 66 | - |
|
| 67 | - /** |
|
| 68 | - * @var EE_Request_Handler $REQ |
|
| 69 | - */ |
|
| 70 | - public $REQ; |
|
| 71 | - |
|
| 72 | - /** |
|
| 73 | - * @var EE_Session $SSN |
|
| 74 | - */ |
|
| 75 | - public $SSN; |
|
| 76 | - |
|
| 77 | - /** |
|
| 78 | - * @since 4.5.0 |
|
| 79 | - * @var EE_Capabilities $CAP |
|
| 80 | - */ |
|
| 81 | - public $CAP; |
|
| 82 | - |
|
| 83 | - /** |
|
| 84 | - * @since 4.9.0 |
|
| 85 | - * @var EE_Message_Resource_Manager $MRM |
|
| 86 | - */ |
|
| 87 | - public $MRM; |
|
| 88 | - |
|
| 89 | - |
|
| 90 | - /** |
|
| 91 | - * @var Registry $AssetsRegistry |
|
| 92 | - */ |
|
| 93 | - public $AssetsRegistry; |
|
| 94 | - |
|
| 95 | - /** |
|
| 96 | - * StdClass object for holding addons which have registered themselves to work with EE core |
|
| 97 | - * |
|
| 98 | - * @var EE_Addon[] $addons |
|
| 99 | - */ |
|
| 100 | - public $addons; |
|
| 101 | - |
|
| 102 | - /** |
|
| 103 | - * keys are 'short names' (eg Event), values are class names (eg 'EEM_Event') |
|
| 104 | - * |
|
| 105 | - * @var EEM_Base[] $models |
|
| 106 | - */ |
|
| 107 | - public $models = array(); |
|
| 108 | - |
|
| 109 | - /** |
|
| 110 | - * @var EED_Module[] $modules |
|
| 111 | - */ |
|
| 112 | - public $modules; |
|
| 113 | - |
|
| 114 | - /** |
|
| 115 | - * @var EES_Shortcode[] $shortcodes |
|
| 116 | - */ |
|
| 117 | - public $shortcodes; |
|
| 118 | - |
|
| 119 | - /** |
|
| 120 | - * @var WP_Widget[] $widgets |
|
| 121 | - */ |
|
| 122 | - public $widgets; |
|
| 123 | - |
|
| 124 | - /** |
|
| 125 | - * this is an array of all implemented model names (i.e. not the parent abstract models, or models |
|
| 126 | - * which don't actually fetch items from the DB in the normal way (ie, are not children of EEM_Base)). |
|
| 127 | - * Keys are model "short names" (eg "Event") as used in model relations, and values are |
|
| 128 | - * classnames (eg "EEM_Event") |
|
| 129 | - * |
|
| 130 | - * @var array $non_abstract_db_models |
|
| 131 | - */ |
|
| 132 | - public $non_abstract_db_models = array(); |
|
| 133 | - |
|
| 134 | - |
|
| 135 | - /** |
|
| 136 | - * internationalization for JS strings |
|
| 137 | - * usage: EE_Registry::i18n_js_strings['string_key'] = esc_html__( 'string to translate.', 'event_espresso' ); |
|
| 138 | - * in js file: var translatedString = eei18n.string_key; |
|
| 139 | - * |
|
| 140 | - * @var array $i18n_js_strings |
|
| 141 | - */ |
|
| 142 | - public static $i18n_js_strings = array(); |
|
| 143 | - |
|
| 144 | - |
|
| 145 | - /** |
|
| 146 | - * $main_file - path to espresso.php |
|
| 147 | - * |
|
| 148 | - * @var array $main_file |
|
| 149 | - */ |
|
| 150 | - public $main_file; |
|
| 151 | - |
|
| 152 | - /** |
|
| 153 | - * array of ReflectionClass objects where the key is the class name |
|
| 154 | - * |
|
| 155 | - * @var ReflectionClass[] $_reflectors |
|
| 156 | - */ |
|
| 157 | - public $_reflectors; |
|
| 158 | - |
|
| 159 | - /** |
|
| 160 | - * boolean flag to indicate whether or not to load/save dependencies from/to the cache |
|
| 161 | - * |
|
| 162 | - * @var boolean $_cache_on |
|
| 163 | - */ |
|
| 164 | - protected $_cache_on = true; |
|
| 165 | - |
|
| 166 | - |
|
| 167 | - |
|
| 168 | - /** |
|
| 169 | - * @singleton method used to instantiate class object |
|
| 170 | - * @param EE_Dependency_Map $dependency_map |
|
| 171 | - * @return EE_Registry instance |
|
| 172 | - * @throws InvalidArgumentException |
|
| 173 | - * @throws InvalidInterfaceException |
|
| 174 | - * @throws InvalidDataTypeException |
|
| 175 | - */ |
|
| 176 | - public static function instance(EE_Dependency_Map $dependency_map = null) |
|
| 177 | - { |
|
| 178 | - // check if class object is instantiated |
|
| 179 | - if (! self::$_instance instanceof EE_Registry) { |
|
| 180 | - self::$_instance = new self($dependency_map); |
|
| 181 | - } |
|
| 182 | - return self::$_instance; |
|
| 183 | - } |
|
| 184 | - |
|
| 185 | - |
|
| 186 | - |
|
| 187 | - /** |
|
| 188 | - * protected constructor to prevent direct creation |
|
| 189 | - * |
|
| 190 | - * @Constructor |
|
| 191 | - * @param EE_Dependency_Map $dependency_map |
|
| 192 | - * @throws InvalidDataTypeException |
|
| 193 | - * @throws InvalidInterfaceException |
|
| 194 | - * @throws InvalidArgumentException |
|
| 195 | - */ |
|
| 196 | - protected function __construct(EE_Dependency_Map $dependency_map) |
|
| 197 | - { |
|
| 198 | - $this->_dependency_map = $dependency_map; |
|
| 199 | - $this->LIB = new stdClass(); |
|
| 200 | - $this->addons = new stdClass(); |
|
| 201 | - $this->modules = new stdClass(); |
|
| 202 | - $this->shortcodes = new stdClass(); |
|
| 203 | - $this->widgets = new stdClass(); |
|
| 204 | - add_action('EE_Load_Espresso_Core__handle_request__initialize_core_loading', array($this, 'initialize')); |
|
| 205 | - } |
|
| 206 | - |
|
| 207 | - |
|
| 208 | - |
|
| 209 | - /** |
|
| 210 | - * initialize |
|
| 211 | - * |
|
| 212 | - * @throws EE_Error |
|
| 213 | - * @throws ReflectionException |
|
| 214 | - */ |
|
| 215 | - public function initialize() |
|
| 216 | - { |
|
| 217 | - $this->_class_abbreviations = apply_filters( |
|
| 218 | - 'FHEE__EE_Registry____construct___class_abbreviations', |
|
| 219 | - array( |
|
| 220 | - 'EE_Config' => 'CFG', |
|
| 221 | - 'EE_Session' => 'SSN', |
|
| 222 | - 'EE_Capabilities' => 'CAP', |
|
| 223 | - 'EE_Cart' => 'CART', |
|
| 224 | - 'EE_Network_Config' => 'NET_CFG', |
|
| 225 | - 'EE_Request_Handler' => 'REQ', |
|
| 226 | - 'EE_Message_Resource_Manager' => 'MRM', |
|
| 227 | - 'EventEspresso\core\services\commands\CommandBus' => 'BUS', |
|
| 228 | - 'EventEspresso\core\services\assets\Registry' => 'AssetsRegistry', |
|
| 229 | - ) |
|
| 230 | - ); |
|
| 231 | - $this->load_core('Base', array(), true); |
|
| 232 | - // add our request and response objects to the cache |
|
| 233 | - $request_loader = $this->_dependency_map->class_loader('EE_Request'); |
|
| 234 | - $this->_set_cached_class( |
|
| 235 | - $request_loader(), |
|
| 236 | - 'EE_Request' |
|
| 237 | - ); |
|
| 238 | - $response_loader = $this->_dependency_map->class_loader('EE_Response'); |
|
| 239 | - $this->_set_cached_class( |
|
| 240 | - $response_loader(), |
|
| 241 | - 'EE_Response' |
|
| 242 | - ); |
|
| 243 | - add_action('AHEE__EE_System__set_hooks_for_core', array($this, 'init')); |
|
| 244 | - } |
|
| 245 | - |
|
| 246 | - |
|
| 247 | - |
|
| 248 | - /** |
|
| 249 | - * @return void |
|
| 250 | - */ |
|
| 251 | - public function init() |
|
| 252 | - { |
|
| 253 | - // Get current page protocol |
|
| 254 | - $protocol = isset($_SERVER['HTTPS']) ? 'https://' : 'http://'; |
|
| 255 | - // Output admin-ajax.php URL with same protocol as current page |
|
| 256 | - self::$i18n_js_strings['ajax_url'] = admin_url('admin-ajax.php', $protocol); |
|
| 257 | - self::$i18n_js_strings['wp_debug'] = defined('WP_DEBUG') ? WP_DEBUG : false; |
|
| 258 | - } |
|
| 259 | - |
|
| 260 | - |
|
| 261 | - |
|
| 262 | - /** |
|
| 263 | - * localize_i18n_js_strings |
|
| 264 | - * |
|
| 265 | - * @return string |
|
| 266 | - */ |
|
| 267 | - public static function localize_i18n_js_strings() |
|
| 268 | - { |
|
| 269 | - $i18n_js_strings = (array)self::$i18n_js_strings; |
|
| 270 | - foreach ($i18n_js_strings as $key => $value) { |
|
| 271 | - if (is_scalar($value)) { |
|
| 272 | - $i18n_js_strings[$key] = html_entity_decode((string)$value, ENT_QUOTES, 'UTF-8'); |
|
| 273 | - } |
|
| 274 | - } |
|
| 275 | - return '/* <![CDATA[ */ var eei18n = ' . wp_json_encode($i18n_js_strings) . '; /* ]]> */'; |
|
| 276 | - } |
|
| 277 | - |
|
| 278 | - |
|
| 279 | - |
|
| 280 | - /** |
|
| 281 | - * @param mixed string | EED_Module $module |
|
| 282 | - * @throws EE_Error |
|
| 283 | - * @throws ReflectionException |
|
| 284 | - */ |
|
| 285 | - public function add_module($module) |
|
| 286 | - { |
|
| 287 | - if ($module instanceof EED_Module) { |
|
| 288 | - $module_class = get_class($module); |
|
| 289 | - $this->modules->{$module_class} = $module; |
|
| 290 | - } else { |
|
| 291 | - if (! class_exists('EE_Module_Request_Router')) { |
|
| 292 | - $this->load_core('Module_Request_Router'); |
|
| 293 | - } |
|
| 294 | - EE_Module_Request_Router::module_factory($module); |
|
| 295 | - } |
|
| 296 | - } |
|
| 297 | - |
|
| 298 | - |
|
| 299 | - |
|
| 300 | - /** |
|
| 301 | - * @param string $module_name |
|
| 302 | - * @return mixed EED_Module | NULL |
|
| 303 | - */ |
|
| 304 | - public function get_module($module_name = '') |
|
| 305 | - { |
|
| 306 | - return isset($this->modules->{$module_name}) |
|
| 307 | - ? $this->modules->{$module_name} |
|
| 308 | - : null; |
|
| 309 | - } |
|
| 310 | - |
|
| 311 | - |
|
| 312 | - |
|
| 313 | - /** |
|
| 314 | - * loads core classes - must be singletons |
|
| 315 | - * |
|
| 316 | - * @param string $class_name - simple class name ie: session |
|
| 317 | - * @param mixed $arguments |
|
| 318 | - * @param bool $load_only |
|
| 319 | - * @return mixed |
|
| 320 | - * @throws EE_Error |
|
| 321 | - * @throws ReflectionException |
|
| 322 | - */ |
|
| 323 | - public function load_core($class_name, $arguments = array(), $load_only = false) |
|
| 324 | - { |
|
| 325 | - $core_paths = apply_filters( |
|
| 326 | - 'FHEE__EE_Registry__load_core__core_paths', |
|
| 327 | - array( |
|
| 328 | - EE_CORE, |
|
| 329 | - EE_ADMIN, |
|
| 330 | - EE_CPTS, |
|
| 331 | - EE_CORE . 'data_migration_scripts' . DS, |
|
| 332 | - EE_CORE . 'capabilities' . DS, |
|
| 333 | - EE_CORE . 'request_stack' . DS, |
|
| 334 | - EE_CORE . 'middleware' . DS, |
|
| 335 | - ) |
|
| 336 | - ); |
|
| 337 | - // retrieve instantiated class |
|
| 338 | - return $this->_load( |
|
| 339 | - $core_paths, |
|
| 340 | - 'EE_', |
|
| 341 | - $class_name, |
|
| 342 | - 'core', |
|
| 343 | - $arguments, |
|
| 344 | - false, |
|
| 345 | - true, |
|
| 346 | - $load_only |
|
| 347 | - ); |
|
| 348 | - } |
|
| 349 | - |
|
| 350 | - |
|
| 351 | - |
|
| 352 | - /** |
|
| 353 | - * loads service classes |
|
| 354 | - * |
|
| 355 | - * @param string $class_name - simple class name ie: session |
|
| 356 | - * @param mixed $arguments |
|
| 357 | - * @param bool $load_only |
|
| 358 | - * @return mixed |
|
| 359 | - * @throws EE_Error |
|
| 360 | - * @throws ReflectionException |
|
| 361 | - */ |
|
| 362 | - public function load_service($class_name, $arguments = array(), $load_only = false) |
|
| 363 | - { |
|
| 364 | - $service_paths = apply_filters( |
|
| 365 | - 'FHEE__EE_Registry__load_service__service_paths', |
|
| 366 | - array( |
|
| 367 | - EE_CORE . 'services' . DS, |
|
| 368 | - ) |
|
| 369 | - ); |
|
| 370 | - // retrieve instantiated class |
|
| 371 | - return $this->_load( |
|
| 372 | - $service_paths, |
|
| 373 | - 'EE_', |
|
| 374 | - $class_name, |
|
| 375 | - 'class', |
|
| 376 | - $arguments, |
|
| 377 | - false, |
|
| 378 | - true, |
|
| 379 | - $load_only |
|
| 380 | - ); |
|
| 381 | - } |
|
| 382 | - |
|
| 383 | - |
|
| 384 | - |
|
| 385 | - /** |
|
| 386 | - * loads data_migration_scripts |
|
| 387 | - * |
|
| 388 | - * @param string $class_name - class name for the DMS ie: EE_DMS_Core_4_2_0 |
|
| 389 | - * @param mixed $arguments |
|
| 390 | - * @return EE_Data_Migration_Script_Base|mixed |
|
| 391 | - * @throws EE_Error |
|
| 392 | - * @throws ReflectionException |
|
| 393 | - */ |
|
| 394 | - public function load_dms($class_name, $arguments = array()) |
|
| 395 | - { |
|
| 396 | - // retrieve instantiated class |
|
| 397 | - return $this->_load( |
|
| 398 | - EE_Data_Migration_Manager::instance()->get_data_migration_script_folders(), |
|
| 399 | - 'EE_DMS_', |
|
| 400 | - $class_name, |
|
| 401 | - 'dms', |
|
| 402 | - $arguments, |
|
| 403 | - false, |
|
| 404 | - false |
|
| 405 | - ); |
|
| 406 | - } |
|
| 407 | - |
|
| 408 | - |
|
| 409 | - |
|
| 410 | - /** |
|
| 411 | - * loads object creating classes - must be singletons |
|
| 412 | - * |
|
| 413 | - * @param string $class_name - simple class name ie: attendee |
|
| 414 | - * @param mixed $arguments - an array of arguments to pass to the class |
|
| 415 | - * @param bool $from_db - some classes are instantiated from the db and thus call a different method to |
|
| 416 | - * instantiate |
|
| 417 | - * @param bool $cache if you don't want the class to be stored in the internal cache (non-persistent) then |
|
| 418 | - * set this to FALSE (ie. when instantiating model objects from client in a loop) |
|
| 419 | - * @param bool $load_only whether or not to just load the file and NOT instantiate, or load AND instantiate |
|
| 420 | - * (default) |
|
| 421 | - * @return EE_Base_Class | bool |
|
| 422 | - * @throws EE_Error |
|
| 423 | - * @throws ReflectionException |
|
| 424 | - */ |
|
| 425 | - public function load_class($class_name, $arguments = array(), $from_db = false, $cache = true, $load_only = false) |
|
| 426 | - { |
|
| 427 | - $paths = apply_filters( |
|
| 428 | - 'FHEE__EE_Registry__load_class__paths', array( |
|
| 429 | - EE_CORE, |
|
| 430 | - EE_CLASSES, |
|
| 431 | - EE_BUSINESS, |
|
| 432 | - ) |
|
| 433 | - ); |
|
| 434 | - // retrieve instantiated class |
|
| 435 | - return $this->_load( |
|
| 436 | - $paths, |
|
| 437 | - 'EE_', |
|
| 438 | - $class_name, |
|
| 439 | - 'class', |
|
| 440 | - $arguments, |
|
| 441 | - $from_db, |
|
| 442 | - $cache, |
|
| 443 | - $load_only |
|
| 444 | - ); |
|
| 445 | - } |
|
| 446 | - |
|
| 447 | - |
|
| 448 | - |
|
| 449 | - /** |
|
| 450 | - * loads helper classes - must be singletons |
|
| 451 | - * |
|
| 452 | - * @param string $class_name - simple class name ie: price |
|
| 453 | - * @param mixed $arguments |
|
| 454 | - * @param bool $load_only |
|
| 455 | - * @return EEH_Base | bool |
|
| 456 | - * @throws EE_Error |
|
| 457 | - * @throws ReflectionException |
|
| 458 | - */ |
|
| 459 | - public function load_helper($class_name, $arguments = array(), $load_only = true) |
|
| 460 | - { |
|
| 461 | - // todo: add doing_it_wrong() in a few versions after all addons have had calls to this method removed |
|
| 462 | - $helper_paths = apply_filters('FHEE__EE_Registry__load_helper__helper_paths', array(EE_HELPERS)); |
|
| 463 | - // retrieve instantiated class |
|
| 464 | - return $this->_load( |
|
| 465 | - $helper_paths, |
|
| 466 | - 'EEH_', |
|
| 467 | - $class_name, |
|
| 468 | - 'helper', |
|
| 469 | - $arguments, |
|
| 470 | - false, |
|
| 471 | - true, |
|
| 472 | - $load_only |
|
| 473 | - ); |
|
| 474 | - } |
|
| 475 | - |
|
| 476 | - |
|
| 477 | - |
|
| 478 | - /** |
|
| 479 | - * loads core classes - must be singletons |
|
| 480 | - * |
|
| 481 | - * @param string $class_name - simple class name ie: session |
|
| 482 | - * @param mixed $arguments |
|
| 483 | - * @param bool $load_only |
|
| 484 | - * @param bool $cache whether to cache the object or not. |
|
| 485 | - * @return mixed |
|
| 486 | - * @throws EE_Error |
|
| 487 | - * @throws ReflectionException |
|
| 488 | - */ |
|
| 489 | - public function load_lib($class_name, $arguments = array(), $load_only = false, $cache = true) |
|
| 490 | - { |
|
| 491 | - $paths = array( |
|
| 492 | - EE_LIBRARIES, |
|
| 493 | - EE_LIBRARIES . 'messages' . DS, |
|
| 494 | - EE_LIBRARIES . 'shortcodes' . DS, |
|
| 495 | - EE_LIBRARIES . 'qtips' . DS, |
|
| 496 | - EE_LIBRARIES . 'payment_methods' . DS, |
|
| 497 | - ); |
|
| 498 | - // retrieve instantiated class |
|
| 499 | - return $this->_load( |
|
| 500 | - $paths, |
|
| 501 | - 'EE_', |
|
| 502 | - $class_name, |
|
| 503 | - 'lib', |
|
| 504 | - $arguments, |
|
| 505 | - false, |
|
| 506 | - $cache, |
|
| 507 | - $load_only |
|
| 508 | - ); |
|
| 509 | - } |
|
| 510 | - |
|
| 511 | - |
|
| 512 | - |
|
| 513 | - /** |
|
| 514 | - * loads model classes - must be singletons |
|
| 515 | - * |
|
| 516 | - * @param string $class_name - simple class name ie: price |
|
| 517 | - * @param mixed $arguments |
|
| 518 | - * @param bool $load_only |
|
| 519 | - * @return EEM_Base | bool |
|
| 520 | - * @throws EE_Error |
|
| 521 | - * @throws ReflectionException |
|
| 522 | - */ |
|
| 523 | - public function load_model($class_name, $arguments = array(), $load_only = false) |
|
| 524 | - { |
|
| 525 | - $paths = apply_filters( |
|
| 526 | - 'FHEE__EE_Registry__load_model__paths', array( |
|
| 527 | - EE_MODELS, |
|
| 528 | - EE_CORE, |
|
| 529 | - ) |
|
| 530 | - ); |
|
| 531 | - // retrieve instantiated class |
|
| 532 | - return $this->_load( |
|
| 533 | - $paths, |
|
| 534 | - 'EEM_', |
|
| 535 | - $class_name, |
|
| 536 | - 'model', |
|
| 537 | - $arguments, |
|
| 538 | - false, |
|
| 539 | - true, |
|
| 540 | - $load_only |
|
| 541 | - ); |
|
| 542 | - } |
|
| 543 | - |
|
| 544 | - |
|
| 545 | - |
|
| 546 | - /** |
|
| 547 | - * loads model classes - must be singletons |
|
| 548 | - * |
|
| 549 | - * @param string $class_name - simple class name ie: price |
|
| 550 | - * @param mixed $arguments |
|
| 551 | - * @param bool $load_only |
|
| 552 | - * @return mixed | bool |
|
| 553 | - * @throws EE_Error |
|
| 554 | - * @throws ReflectionException |
|
| 555 | - */ |
|
| 556 | - public function load_model_class($class_name, $arguments = array(), $load_only = true) |
|
| 557 | - { |
|
| 558 | - $paths = array( |
|
| 559 | - EE_MODELS . 'fields' . DS, |
|
| 560 | - EE_MODELS . 'helpers' . DS, |
|
| 561 | - EE_MODELS . 'relations' . DS, |
|
| 562 | - EE_MODELS . 'strategies' . DS, |
|
| 563 | - ); |
|
| 564 | - // retrieve instantiated class |
|
| 565 | - return $this->_load( |
|
| 566 | - $paths, |
|
| 567 | - 'EE_', |
|
| 568 | - $class_name, |
|
| 569 | - '', |
|
| 570 | - $arguments, |
|
| 571 | - false, |
|
| 572 | - true, |
|
| 573 | - $load_only |
|
| 574 | - ); |
|
| 575 | - } |
|
| 576 | - |
|
| 577 | - |
|
| 578 | - |
|
| 579 | - /** |
|
| 580 | - * Determines if $model_name is the name of an actual EE model. |
|
| 581 | - * |
|
| 582 | - * @param string $model_name like Event, Attendee, Question_Group_Question, etc. |
|
| 583 | - * @return boolean |
|
| 584 | - */ |
|
| 585 | - public function is_model_name($model_name) |
|
| 586 | - { |
|
| 587 | - return isset($this->models[$model_name]); |
|
| 588 | - } |
|
| 589 | - |
|
| 590 | - |
|
| 591 | - |
|
| 592 | - /** |
|
| 593 | - * generic class loader |
|
| 594 | - * |
|
| 595 | - * @param string $path_to_file - directory path to file location, not including filename |
|
| 596 | - * @param string $file_name - file name ie: my_file.php, including extension |
|
| 597 | - * @param string $type - file type - core? class? helper? model? |
|
| 598 | - * @param mixed $arguments |
|
| 599 | - * @param bool $load_only |
|
| 600 | - * @return mixed |
|
| 601 | - * @throws EE_Error |
|
| 602 | - * @throws ReflectionException |
|
| 603 | - */ |
|
| 604 | - public function load_file($path_to_file, $file_name, $type = '', $arguments = array(), $load_only = true) |
|
| 605 | - { |
|
| 606 | - // retrieve instantiated class |
|
| 607 | - return $this->_load( |
|
| 608 | - $path_to_file, |
|
| 609 | - '', |
|
| 610 | - $file_name, |
|
| 611 | - $type, |
|
| 612 | - $arguments, |
|
| 613 | - false, |
|
| 614 | - true, |
|
| 615 | - $load_only |
|
| 616 | - ); |
|
| 617 | - } |
|
| 618 | - |
|
| 619 | - |
|
| 620 | - |
|
| 621 | - /** |
|
| 622 | - * @param string $path_to_file - directory path to file location, not including filename |
|
| 623 | - * @param string $class_name - full class name ie: My_Class |
|
| 624 | - * @param string $type - file type - core? class? helper? model? |
|
| 625 | - * @param mixed $arguments |
|
| 626 | - * @param bool $load_only |
|
| 627 | - * @return bool|EE_Addon|object |
|
| 628 | - * @throws EE_Error |
|
| 629 | - * @throws ReflectionException |
|
| 630 | - */ |
|
| 631 | - public function load_addon($path_to_file, $class_name, $type = 'class', $arguments = array(), $load_only = false) |
|
| 632 | - { |
|
| 633 | - // retrieve instantiated class |
|
| 634 | - return $this->_load( |
|
| 635 | - $path_to_file, |
|
| 636 | - 'addon', |
|
| 637 | - $class_name, |
|
| 638 | - $type, |
|
| 639 | - $arguments, |
|
| 640 | - false, |
|
| 641 | - true, |
|
| 642 | - $load_only |
|
| 643 | - ); |
|
| 644 | - } |
|
| 645 | - |
|
| 646 | - |
|
| 647 | - |
|
| 648 | - /** |
|
| 649 | - * instantiates, caches, and automatically resolves dependencies |
|
| 650 | - * for classes that use a Fully Qualified Class Name. |
|
| 651 | - * if the class is not capable of being loaded using PSR-4 autoloading, |
|
| 652 | - * then you need to use one of the existing load_*() methods |
|
| 653 | - * which can resolve the classname and filepath from the passed arguments |
|
| 654 | - * |
|
| 655 | - * @param bool|string $class_name Fully Qualified Class Name |
|
| 656 | - * @param array $arguments an argument, or array of arguments to pass to the class upon instantiation |
|
| 657 | - * @param bool $cache whether to cache the instantiated object for reuse |
|
| 658 | - * @param bool $from_db some classes are instantiated from the db |
|
| 659 | - * and thus call a different method to instantiate |
|
| 660 | - * @param bool $load_only if true, will only load the file, but will NOT instantiate an object |
|
| 661 | - * @param bool|string $addon if true, will cache the object in the EE_Registry->$addons array |
|
| 662 | - * @return bool|null|mixed null = failure to load or instantiate class object. |
|
| 663 | - * object = class loaded and instantiated successfully. |
|
| 664 | - * bool = fail or success when $load_only is true |
|
| 665 | - * @throws EE_Error |
|
| 666 | - * @throws ReflectionException |
|
| 667 | - */ |
|
| 668 | - public function create( |
|
| 669 | - $class_name = false, |
|
| 670 | - $arguments = array(), |
|
| 671 | - $cache = false, |
|
| 672 | - $from_db = false, |
|
| 673 | - $load_only = false, |
|
| 674 | - $addon = false |
|
| 675 | - ) { |
|
| 676 | - $class_name = ltrim($class_name, '\\'); |
|
| 677 | - $class_name = $this->_dependency_map->get_alias($class_name); |
|
| 678 | - $class_exists = $this->loadOrVerifyClassExists($class_name, $arguments); |
|
| 679 | - // if a non-FQCN was passed, then verifyClassExists() might return an object |
|
| 680 | - // or it could return null if the class just could not be found anywhere |
|
| 681 | - if ($class_exists instanceof $class_name || $class_exists === null){ |
|
| 682 | - // either way, return the results |
|
| 683 | - return $class_exists; |
|
| 684 | - } |
|
| 685 | - $class_name = $class_exists; |
|
| 686 | - // if we're only loading the class and it already exists, then let's just return true immediately |
|
| 687 | - if ($load_only) { |
|
| 688 | - return true; |
|
| 689 | - } |
|
| 690 | - $addon = $addon |
|
| 691 | - ? 'addon' |
|
| 692 | - : ''; |
|
| 693 | - // $this->_cache_on is toggled during the recursive loading that can occur with dependency injection |
|
| 694 | - // $cache is controlled by individual calls to separate Registry loader methods like load_class() |
|
| 695 | - // $load_only is also controlled by individual calls to separate Registry loader methods like load_file() |
|
| 696 | - if ($this->_cache_on && $cache && ! $load_only) { |
|
| 697 | - // return object if it's already cached |
|
| 698 | - $cached_class = $this->_get_cached_class($class_name, $addon); |
|
| 699 | - if ($cached_class !== null) { |
|
| 700 | - return $cached_class; |
|
| 701 | - } |
|
| 702 | - } |
|
| 703 | - // obtain the loader method from the dependency map |
|
| 704 | - $loader = $this->_dependency_map->class_loader($class_name); |
|
| 705 | - // instantiate the requested object |
|
| 706 | - if ($loader instanceof Closure) { |
|
| 707 | - $class_obj = $loader($arguments); |
|
| 708 | - } else if ($loader && method_exists($this, $loader)) { |
|
| 709 | - $class_obj = $this->{$loader}($class_name, $arguments); |
|
| 710 | - } else { |
|
| 711 | - $class_obj = $this->_create_object($class_name, $arguments, $addon, $from_db); |
|
| 712 | - } |
|
| 713 | - if (($this->_cache_on && $cache) || $this->get_class_abbreviation($class_name, '')) { |
|
| 714 | - // save it for later... kinda like gum { : $ |
|
| 715 | - $this->_set_cached_class($class_obj, $class_name, $addon, $from_db); |
|
| 716 | - } |
|
| 717 | - $this->_cache_on = true; |
|
| 718 | - return $class_obj; |
|
| 719 | - } |
|
| 720 | - |
|
| 721 | - |
|
| 722 | - |
|
| 723 | - /** |
|
| 724 | - * Recursively checks that a class exists and potentially attempts to load classes with non-FQCNs |
|
| 725 | - * |
|
| 726 | - * @param string $class_name |
|
| 727 | - * @param array $arguments |
|
| 728 | - * @param int $attempt |
|
| 729 | - * @return mixed |
|
| 730 | - */ |
|
| 731 | - private function loadOrVerifyClassExists($class_name, array $arguments, $attempt = 1) { |
|
| 732 | - if (is_object($class_name) || class_exists($class_name)) { |
|
| 733 | - return $class_name; |
|
| 734 | - } |
|
| 735 | - switch ($attempt) { |
|
| 736 | - case 1: |
|
| 737 | - // if it's a FQCN then maybe the class is registered with a preceding \ |
|
| 738 | - $class_name = strpos($class_name, '\\') !== false |
|
| 739 | - ? '\\' . ltrim($class_name, '\\') |
|
| 740 | - : $class_name; |
|
| 741 | - break; |
|
| 742 | - case 2: |
|
| 743 | - // |
|
| 744 | - $loader = $this->_dependency_map->class_loader($class_name); |
|
| 745 | - if ($loader && method_exists($this, $loader)) { |
|
| 746 | - return $this->{$loader}($class_name, $arguments); |
|
| 747 | - } |
|
| 748 | - break; |
|
| 749 | - case 3: |
|
| 750 | - default; |
|
| 751 | - return null; |
|
| 752 | - } |
|
| 753 | - $attempt++; |
|
| 754 | - return $this->loadOrVerifyClassExists($class_name, $arguments, $attempt); |
|
| 755 | - } |
|
| 756 | - |
|
| 757 | - |
|
| 758 | - |
|
| 759 | - /** |
|
| 760 | - * instantiates, caches, and injects dependencies for classes |
|
| 761 | - * |
|
| 762 | - * @param array $file_paths an array of paths to folders to look in |
|
| 763 | - * @param string $class_prefix EE or EEM or... ??? |
|
| 764 | - * @param bool|string $class_name $class name |
|
| 765 | - * @param string $type file type - core? class? helper? model? |
|
| 766 | - * @param mixed $arguments an argument or array of arguments to pass to the class upon instantiation |
|
| 767 | - * @param bool $from_db some classes are instantiated from the db |
|
| 768 | - * and thus call a different method to instantiate |
|
| 769 | - * @param bool $cache whether to cache the instantiated object for reuse |
|
| 770 | - * @param bool $load_only if true, will only load the file, but will NOT instantiate an object |
|
| 771 | - * @return bool|null|object null = failure to load or instantiate class object. |
|
| 772 | - * object = class loaded and instantiated successfully. |
|
| 773 | - * bool = fail or success when $load_only is true |
|
| 774 | - * @throws EE_Error |
|
| 775 | - * @throws ReflectionException |
|
| 776 | - */ |
|
| 777 | - protected function _load( |
|
| 778 | - $file_paths = array(), |
|
| 779 | - $class_prefix = 'EE_', |
|
| 780 | - $class_name = false, |
|
| 781 | - $type = 'class', |
|
| 782 | - $arguments = array(), |
|
| 783 | - $from_db = false, |
|
| 784 | - $cache = true, |
|
| 785 | - $load_only = false |
|
| 786 | - ) { |
|
| 787 | - $class_name = ltrim($class_name, '\\'); |
|
| 788 | - // strip php file extension |
|
| 789 | - $class_name = str_replace('.php', '', trim($class_name)); |
|
| 790 | - // does the class have a prefix ? |
|
| 791 | - if (! empty($class_prefix) && $class_prefix !== 'addon') { |
|
| 792 | - // make sure $class_prefix is uppercase |
|
| 793 | - $class_prefix = strtoupper(trim($class_prefix)); |
|
| 794 | - // add class prefix ONCE!!! |
|
| 795 | - $class_name = $class_prefix . str_replace($class_prefix, '', $class_name); |
|
| 796 | - } |
|
| 797 | - $class_name = $this->_dependency_map->get_alias($class_name); |
|
| 798 | - $class_exists = class_exists($class_name); |
|
| 799 | - // if we're only loading the class and it already exists, then let's just return true immediately |
|
| 800 | - if ($load_only && $class_exists) { |
|
| 801 | - return true; |
|
| 802 | - } |
|
| 803 | - // $this->_cache_on is toggled during the recursive loading that can occur with dependency injection |
|
| 804 | - // $cache is controlled by individual calls to separate Registry loader methods like load_class() |
|
| 805 | - // $load_only is also controlled by individual calls to separate Registry loader methods like load_file() |
|
| 806 | - if ($this->_cache_on && $cache && ! $load_only) { |
|
| 807 | - // return object if it's already cached |
|
| 808 | - $cached_class = $this->_get_cached_class($class_name, $class_prefix); |
|
| 809 | - if ($cached_class !== null) { |
|
| 810 | - return $cached_class; |
|
| 811 | - } |
|
| 812 | - } |
|
| 813 | - // if the class doesn't already exist.. then we need to try and find the file and load it |
|
| 814 | - if (! $class_exists) { |
|
| 815 | - // get full path to file |
|
| 816 | - $path = $this->_resolve_path($class_name, $type, $file_paths); |
|
| 817 | - // load the file |
|
| 818 | - $loaded = $this->_require_file($path, $class_name, $type, $file_paths); |
|
| 819 | - // if loading failed, or we are only loading a file but NOT instantiating an object |
|
| 820 | - if (! $loaded || $load_only) { |
|
| 821 | - // return boolean if only loading, or null if an object was expected |
|
| 822 | - return $load_only |
|
| 823 | - ? $loaded |
|
| 824 | - : null; |
|
| 825 | - } |
|
| 826 | - } |
|
| 827 | - // instantiate the requested object |
|
| 828 | - $class_obj = $this->_create_object($class_name, $arguments, $type, $from_db); |
|
| 829 | - if ($this->_cache_on && $cache) { |
|
| 830 | - // save it for later... kinda like gum { : $ |
|
| 831 | - $this->_set_cached_class($class_obj, $class_name, $class_prefix, $from_db); |
|
| 832 | - } |
|
| 833 | - $this->_cache_on = true; |
|
| 834 | - return $class_obj; |
|
| 835 | - } |
|
| 836 | - |
|
| 837 | - |
|
| 838 | - |
|
| 839 | - /** |
|
| 840 | - * @param string $class_name |
|
| 841 | - * @param string $default have to specify something, but not anything that will conflict |
|
| 842 | - * @return mixed|string |
|
| 843 | - */ |
|
| 844 | - protected function get_class_abbreviation($class_name, $default = 'FANCY_BATMAN_PANTS') |
|
| 845 | - { |
|
| 846 | - return isset($this->_class_abbreviations[$class_name]) |
|
| 847 | - ? $this->_class_abbreviations[$class_name] |
|
| 848 | - : $default; |
|
| 849 | - } |
|
| 850 | - |
|
| 851 | - /** |
|
| 852 | - * attempts to find a cached version of the requested class |
|
| 853 | - * by looking in the following places: |
|
| 854 | - * $this->{$class_abbreviation} ie: $this->CART |
|
| 855 | - * $this->{$class_name} ie: $this->Some_Class |
|
| 856 | - * $this->LIB->{$class_name} ie: $this->LIB->Some_Class |
|
| 857 | - * $this->addon->{$class_name} ie: $this->addon->Some_Addon_Class |
|
| 858 | - * |
|
| 859 | - * @param string $class_name |
|
| 860 | - * @param string $class_prefix |
|
| 861 | - * @return mixed |
|
| 862 | - */ |
|
| 863 | - protected function _get_cached_class($class_name, $class_prefix = '') |
|
| 864 | - { |
|
| 865 | - if ($class_name === 'EE_Registry') { |
|
| 866 | - return $this; |
|
| 867 | - } |
|
| 868 | - $class_abbreviation = $this->get_class_abbreviation($class_name); |
|
| 869 | - $class_name = str_replace('\\', '_', $class_name); |
|
| 870 | - // check if class has already been loaded, and return it if it has been |
|
| 871 | - if (isset($this->{$class_abbreviation})) { |
|
| 872 | - return $this->{$class_abbreviation}; |
|
| 873 | - } |
|
| 874 | - if (isset ($this->{$class_name})) { |
|
| 875 | - return $this->{$class_name}; |
|
| 876 | - } |
|
| 877 | - if (isset ($this->LIB->{$class_name})) { |
|
| 878 | - return $this->LIB->{$class_name}; |
|
| 879 | - } |
|
| 880 | - if ($class_prefix === 'addon' && isset ($this->addons->{$class_name})) { |
|
| 881 | - return $this->addons->{$class_name}; |
|
| 882 | - } |
|
| 883 | - return null; |
|
| 884 | - } |
|
| 885 | - |
|
| 886 | - |
|
| 887 | - |
|
| 888 | - /** |
|
| 889 | - * removes a cached version of the requested class |
|
| 890 | - * |
|
| 891 | - * @param string $class_name |
|
| 892 | - * @param boolean $addon |
|
| 893 | - * @return boolean |
|
| 894 | - */ |
|
| 895 | - public function clear_cached_class($class_name, $addon = false) |
|
| 896 | - { |
|
| 897 | - $class_abbreviation = $this->get_class_abbreviation($class_name); |
|
| 898 | - $class_name = str_replace('\\', '_', $class_name); |
|
| 899 | - // check if class has already been loaded, and return it if it has been |
|
| 900 | - if (isset($this->{$class_abbreviation})) { |
|
| 901 | - $this->{$class_abbreviation} = null; |
|
| 902 | - return true; |
|
| 903 | - } |
|
| 904 | - if (isset($this->{$class_name})) { |
|
| 905 | - $this->{$class_name} = null; |
|
| 906 | - return true; |
|
| 907 | - } |
|
| 908 | - if (isset($this->LIB->{$class_name})) { |
|
| 909 | - unset($this->LIB->{$class_name}); |
|
| 910 | - return true; |
|
| 911 | - } |
|
| 912 | - if ($addon && isset($this->addons->{$class_name})) { |
|
| 913 | - unset($this->addons->{$class_name}); |
|
| 914 | - return true; |
|
| 915 | - } |
|
| 916 | - return false; |
|
| 917 | - } |
|
| 918 | - |
|
| 919 | - |
|
| 920 | - |
|
| 921 | - /** |
|
| 922 | - * attempts to find a full valid filepath for the requested class. |
|
| 923 | - * loops thru each of the base paths in the $file_paths array and appends : "{classname} . {file type} . php" |
|
| 924 | - * then returns that path if the target file has been found and is readable |
|
| 925 | - * |
|
| 926 | - * @param string $class_name |
|
| 927 | - * @param string $type |
|
| 928 | - * @param array $file_paths |
|
| 929 | - * @return string | bool |
|
| 930 | - */ |
|
| 931 | - protected function _resolve_path($class_name, $type = '', $file_paths = array()) |
|
| 932 | - { |
|
| 933 | - // make sure $file_paths is an array |
|
| 934 | - $file_paths = is_array($file_paths) |
|
| 935 | - ? $file_paths |
|
| 936 | - : array($file_paths); |
|
| 937 | - // cycle thru paths |
|
| 938 | - foreach ($file_paths as $key => $file_path) { |
|
| 939 | - // convert all separators to proper DS, if no filepath, then use EE_CLASSES |
|
| 940 | - $file_path = $file_path |
|
| 941 | - ? str_replace(array('/', '\\'), DS, $file_path) |
|
| 942 | - : EE_CLASSES; |
|
| 943 | - // prep file type |
|
| 944 | - $type = ! empty($type) |
|
| 945 | - ? trim($type, '.') . '.' |
|
| 946 | - : ''; |
|
| 947 | - // build full file path |
|
| 948 | - $file_paths[$key] = rtrim($file_path, DS) . DS . $class_name . '.' . $type . 'php'; |
|
| 949 | - //does the file exist and can be read ? |
|
| 950 | - if (is_readable($file_paths[$key])) { |
|
| 951 | - return $file_paths[$key]; |
|
| 952 | - } |
|
| 953 | - } |
|
| 954 | - return false; |
|
| 955 | - } |
|
| 956 | - |
|
| 957 | - |
|
| 958 | - |
|
| 959 | - /** |
|
| 960 | - * basically just performs a require_once() |
|
| 961 | - * but with some error handling |
|
| 962 | - * |
|
| 963 | - * @param string $path |
|
| 964 | - * @param string $class_name |
|
| 965 | - * @param string $type |
|
| 966 | - * @param array $file_paths |
|
| 967 | - * @return bool |
|
| 968 | - * @throws EE_Error |
|
| 969 | - * @throws ReflectionException |
|
| 970 | - */ |
|
| 971 | - protected function _require_file($path, $class_name, $type = '', $file_paths = array()) |
|
| 972 | - { |
|
| 973 | - // don't give up! you gotta... |
|
| 974 | - try { |
|
| 975 | - //does the file exist and can it be read ? |
|
| 976 | - if (! $path) { |
|
| 977 | - // so sorry, can't find the file |
|
| 978 | - throw new EE_Error ( |
|
| 979 | - sprintf( |
|
| 980 | - esc_html__( |
|
| 981 | - 'The %1$s file %2$s could not be located or is not readable due to file permissions. Please ensure that the following filepath(s) are correct: %3$s', |
|
| 982 | - 'event_espresso' |
|
| 983 | - ), |
|
| 984 | - trim($type, '.'), |
|
| 985 | - $class_name, |
|
| 986 | - '<br />' . implode(',<br />', $file_paths) |
|
| 987 | - ) |
|
| 988 | - ); |
|
| 989 | - } |
|
| 990 | - // get the file |
|
| 991 | - require_once($path); |
|
| 992 | - // if the class isn't already declared somewhere |
|
| 993 | - if (class_exists($class_name, false) === false) { |
|
| 994 | - // so sorry, not a class |
|
| 995 | - throw new EE_Error( |
|
| 996 | - sprintf( |
|
| 997 | - esc_html__('The %s file %s does not appear to contain the %s Class.', 'event_espresso'), |
|
| 998 | - $type, |
|
| 999 | - $path, |
|
| 1000 | - $class_name |
|
| 1001 | - ) |
|
| 1002 | - ); |
|
| 1003 | - } |
|
| 1004 | - } catch (EE_Error $e) { |
|
| 1005 | - $e->get_error(); |
|
| 1006 | - return false; |
|
| 1007 | - } |
|
| 1008 | - return true; |
|
| 1009 | - } |
|
| 1010 | - |
|
| 1011 | - |
|
| 1012 | - |
|
| 1013 | - /** |
|
| 1014 | - * _create_object |
|
| 1015 | - * Attempts to instantiate the requested class via any of the |
|
| 1016 | - * commonly used instantiation methods employed throughout EE. |
|
| 1017 | - * The priority for instantiation is as follows: |
|
| 1018 | - * - abstract classes or any class flagged as "load only" (no instantiation occurs) |
|
| 1019 | - * - model objects via their 'new_instance_from_db' method |
|
| 1020 | - * - model objects via their 'new_instance' method |
|
| 1021 | - * - "singleton" classes" via their 'instance' method |
|
| 1022 | - * - standard instantiable classes via their __constructor |
|
| 1023 | - * Prior to instantiation, if the classname exists in the dependency_map, |
|
| 1024 | - * then the constructor for the requested class will be examined to determine |
|
| 1025 | - * if any dependencies exist, and if they can be injected. |
|
| 1026 | - * If so, then those classes will be added to the array of arguments passed to the constructor |
|
| 1027 | - * |
|
| 1028 | - * @param string $class_name |
|
| 1029 | - * @param array $arguments |
|
| 1030 | - * @param string $type |
|
| 1031 | - * @param bool $from_db |
|
| 1032 | - * @return null|object |
|
| 1033 | - * @throws EE_Error |
|
| 1034 | - * @throws ReflectionException |
|
| 1035 | - */ |
|
| 1036 | - protected function _create_object($class_name, $arguments = array(), $type = '', $from_db = false) |
|
| 1037 | - { |
|
| 1038 | - // create reflection |
|
| 1039 | - $reflector = $this->get_ReflectionClass($class_name); |
|
| 1040 | - // make sure arguments are an array |
|
| 1041 | - $arguments = is_array($arguments) |
|
| 1042 | - ? $arguments |
|
| 1043 | - : array($arguments); |
|
| 1044 | - // and if arguments array is numerically and sequentially indexed, then we want it to remain as is, |
|
| 1045 | - // else wrap it in an additional array so that it doesn't get split into multiple parameters |
|
| 1046 | - $arguments = $this->_array_is_numerically_and_sequentially_indexed($arguments) |
|
| 1047 | - ? $arguments |
|
| 1048 | - : array($arguments); |
|
| 1049 | - // attempt to inject dependencies ? |
|
| 1050 | - if ($this->_dependency_map->has($class_name)) { |
|
| 1051 | - $arguments = $this->_resolve_dependencies($reflector, $class_name, $arguments); |
|
| 1052 | - } |
|
| 1053 | - // instantiate the class if possible |
|
| 1054 | - if ($reflector->isAbstract()) { |
|
| 1055 | - // nothing to instantiate, loading file was enough |
|
| 1056 | - // does not throw an exception so $instantiation_mode is unused |
|
| 1057 | - // $instantiation_mode = "1) no constructor abstract class"; |
|
| 1058 | - return true; |
|
| 1059 | - } |
|
| 1060 | - if (empty($arguments) && $reflector->getConstructor() === null && $reflector->isInstantiable()) { |
|
| 1061 | - // no constructor = static methods only... nothing to instantiate, loading file was enough |
|
| 1062 | - // $instantiation_mode = "2) no constructor but instantiable"; |
|
| 1063 | - return $reflector->newInstance(); |
|
| 1064 | - } |
|
| 1065 | - if ($from_db && method_exists($class_name, 'new_instance_from_db')) { |
|
| 1066 | - // $instantiation_mode = "3) new_instance_from_db()"; |
|
| 1067 | - return call_user_func_array(array($class_name, 'new_instance_from_db'), $arguments); |
|
| 1068 | - } |
|
| 1069 | - if (method_exists($class_name, 'new_instance')) { |
|
| 1070 | - // $instantiation_mode = "4) new_instance()"; |
|
| 1071 | - return call_user_func_array(array($class_name, 'new_instance'), $arguments); |
|
| 1072 | - } |
|
| 1073 | - if (method_exists($class_name, 'instance')) { |
|
| 1074 | - // $instantiation_mode = "5) instance()"; |
|
| 1075 | - return call_user_func_array(array($class_name, 'instance'), $arguments); |
|
| 1076 | - } |
|
| 1077 | - if ($reflector->isInstantiable()) { |
|
| 1078 | - // $instantiation_mode = "6) constructor"; |
|
| 1079 | - return $reflector->newInstanceArgs($arguments); |
|
| 1080 | - } |
|
| 1081 | - // heh ? something's not right ! |
|
| 1082 | - throw new EE_Error( |
|
| 1083 | - sprintf( |
|
| 1084 | - __('The %s file %s could not be instantiated.', 'event_espresso'), |
|
| 1085 | - $type, |
|
| 1086 | - $class_name |
|
| 1087 | - ) |
|
| 1088 | - ); |
|
| 1089 | - } |
|
| 1090 | - |
|
| 1091 | - |
|
| 1092 | - |
|
| 1093 | - /** |
|
| 1094 | - * @see http://stackoverflow.com/questions/173400/how-to-check-if-php-array-is-associative-or-sequential |
|
| 1095 | - * @param array $array |
|
| 1096 | - * @return bool |
|
| 1097 | - */ |
|
| 1098 | - protected function _array_is_numerically_and_sequentially_indexed(array $array) |
|
| 1099 | - { |
|
| 1100 | - return ! empty($array) |
|
| 1101 | - ? array_keys($array) === range(0, count($array) - 1) |
|
| 1102 | - : true; |
|
| 1103 | - } |
|
| 1104 | - |
|
| 1105 | - |
|
| 1106 | - |
|
| 1107 | - /** |
|
| 1108 | - * getReflectionClass |
|
| 1109 | - * checks if a ReflectionClass object has already been generated for a class |
|
| 1110 | - * and returns that instead of creating a new one |
|
| 1111 | - * |
|
| 1112 | - * @param string $class_name |
|
| 1113 | - * @return ReflectionClass |
|
| 1114 | - * @throws ReflectionException |
|
| 1115 | - */ |
|
| 1116 | - public function get_ReflectionClass($class_name) |
|
| 1117 | - { |
|
| 1118 | - if ( |
|
| 1119 | - ! isset($this->_reflectors[$class_name]) |
|
| 1120 | - || ! $this->_reflectors[$class_name] instanceof ReflectionClass |
|
| 1121 | - ) { |
|
| 1122 | - $this->_reflectors[$class_name] = new ReflectionClass($class_name); |
|
| 1123 | - } |
|
| 1124 | - return $this->_reflectors[$class_name]; |
|
| 1125 | - } |
|
| 1126 | - |
|
| 1127 | - |
|
| 1128 | - |
|
| 1129 | - /** |
|
| 1130 | - * _resolve_dependencies |
|
| 1131 | - * examines the constructor for the requested class to determine |
|
| 1132 | - * if any dependencies exist, and if they can be injected. |
|
| 1133 | - * If so, then those classes will be added to the array of arguments passed to the constructor |
|
| 1134 | - * PLZ NOTE: this is achieved by type hinting the constructor params |
|
| 1135 | - * For example: |
|
| 1136 | - * if attempting to load a class "Foo" with the following constructor: |
|
| 1137 | - * __construct( Bar $bar_class, Fighter $grohl_class ) |
|
| 1138 | - * then $bar_class and $grohl_class will be added to the $arguments array, |
|
| 1139 | - * but only IF they are NOT already present in the incoming arguments array, |
|
| 1140 | - * and the correct classes can be loaded |
|
| 1141 | - * |
|
| 1142 | - * @param ReflectionClass $reflector |
|
| 1143 | - * @param string $class_name |
|
| 1144 | - * @param array $arguments |
|
| 1145 | - * @return array |
|
| 1146 | - * @throws EE_Error |
|
| 1147 | - * @throws ReflectionException |
|
| 1148 | - */ |
|
| 1149 | - protected function _resolve_dependencies(ReflectionClass $reflector, $class_name, $arguments = array()) |
|
| 1150 | - { |
|
| 1151 | - // let's examine the constructor |
|
| 1152 | - $constructor = $reflector->getConstructor(); |
|
| 1153 | - // whu? huh? nothing? |
|
| 1154 | - if (! $constructor) { |
|
| 1155 | - return $arguments; |
|
| 1156 | - } |
|
| 1157 | - // get constructor parameters |
|
| 1158 | - $params = $constructor->getParameters(); |
|
| 1159 | - // and the keys for the incoming arguments array so that we can compare existing arguments with what is expected |
|
| 1160 | - $argument_keys = array_keys($arguments); |
|
| 1161 | - // now loop thru all of the constructors expected parameters |
|
| 1162 | - foreach ($params as $index => $param) { |
|
| 1163 | - // is this a dependency for a specific class ? |
|
| 1164 | - $param_class = $param->getClass() |
|
| 1165 | - ? $param->getClass()->name |
|
| 1166 | - : null; |
|
| 1167 | - // BUT WAIT !!! This class may be an alias for something else (or getting replaced at runtime) |
|
| 1168 | - $param_class = $this->_dependency_map->has_alias($param_class, $class_name) |
|
| 1169 | - ? $this->_dependency_map->get_alias($param_class, $class_name) |
|
| 1170 | - : $param_class; |
|
| 1171 | - if ( |
|
| 1172 | - // param is not even a class |
|
| 1173 | - $param_class === null |
|
| 1174 | - // and something already exists in the incoming arguments for this param |
|
| 1175 | - && array_key_exists($index, $argument_keys) |
|
| 1176 | - && array_key_exists($argument_keys[$index], $arguments) |
|
| 1177 | - ) { |
|
| 1178 | - // so let's skip this argument and move on to the next |
|
| 1179 | - continue; |
|
| 1180 | - } |
|
| 1181 | - if ( |
|
| 1182 | - // parameter is type hinted as a class, exists as an incoming argument, AND it's the correct class |
|
| 1183 | - $param_class !== null |
|
| 1184 | - && isset($argument_keys[$index], $arguments[$argument_keys[$index]]) |
|
| 1185 | - && $arguments[$argument_keys[$index]] instanceof $param_class |
|
| 1186 | - ) { |
|
| 1187 | - // skip this argument and move on to the next |
|
| 1188 | - continue; |
|
| 1189 | - } |
|
| 1190 | - if ( |
|
| 1191 | - // parameter is type hinted as a class, and should be injected |
|
| 1192 | - $param_class !== null |
|
| 1193 | - && $this->_dependency_map->has_dependency_for_class($class_name, $param_class) |
|
| 1194 | - ) { |
|
| 1195 | - $arguments = $this->_resolve_dependency( |
|
| 1196 | - $class_name, |
|
| 1197 | - $param_class, |
|
| 1198 | - $arguments, |
|
| 1199 | - $index, |
|
| 1200 | - $argument_keys |
|
| 1201 | - ); |
|
| 1202 | - } else { |
|
| 1203 | - try { |
|
| 1204 | - $arguments[$index] = $param->isDefaultValueAvailable() |
|
| 1205 | - ? $param->getDefaultValue() |
|
| 1206 | - : null; |
|
| 1207 | - } catch (ReflectionException $e) { |
|
| 1208 | - throw new ReflectionException( |
|
| 1209 | - sprintf( |
|
| 1210 | - esc_html__('%1$s for parameter "$%2$s on classname "%3$s"', 'event_espresso'), |
|
| 1211 | - $e->getMessage(), |
|
| 1212 | - $param->getName(), |
|
| 1213 | - $class_name |
|
| 1214 | - ) |
|
| 1215 | - ); |
|
| 1216 | - } |
|
| 1217 | - } |
|
| 1218 | - } |
|
| 1219 | - return $arguments; |
|
| 1220 | - } |
|
| 1221 | - |
|
| 1222 | - |
|
| 1223 | - |
|
| 1224 | - /** |
|
| 1225 | - * @param string $class_name |
|
| 1226 | - * @param string $param_class |
|
| 1227 | - * @param array $arguments |
|
| 1228 | - * @param mixed $index |
|
| 1229 | - * @param array $argument_keys |
|
| 1230 | - * @return array |
|
| 1231 | - * @throws EE_Error |
|
| 1232 | - * @throws ReflectionException |
|
| 1233 | - * @throws InvalidArgumentException |
|
| 1234 | - * @throws InvalidInterfaceException |
|
| 1235 | - * @throws InvalidDataTypeException |
|
| 1236 | - */ |
|
| 1237 | - protected function _resolve_dependency($class_name, $param_class, $arguments, $index, array $argument_keys) |
|
| 1238 | - { |
|
| 1239 | - $dependency = null; |
|
| 1240 | - // should dependency be loaded from cache ? |
|
| 1241 | - $cache_on = $this->_dependency_map->loading_strategy_for_class_dependency( |
|
| 1242 | - $class_name, |
|
| 1243 | - $param_class |
|
| 1244 | - ); |
|
| 1245 | - $cache_on = $cache_on !== EE_Dependency_Map::load_new_object; |
|
| 1246 | - // we might have a dependency... |
|
| 1247 | - // let's MAYBE try and find it in our cache if that's what's been requested |
|
| 1248 | - $cached_class = $cache_on |
|
| 1249 | - ? $this->_get_cached_class($param_class) |
|
| 1250 | - : null; |
|
| 1251 | - // and grab it if it exists |
|
| 1252 | - if ($cached_class instanceof $param_class) { |
|
| 1253 | - $dependency = $cached_class; |
|
| 1254 | - } else if ($param_class !== $class_name) { |
|
| 1255 | - // obtain the loader method from the dependency map |
|
| 1256 | - $loader = $this->_dependency_map->class_loader($param_class); |
|
| 1257 | - // is loader a custom closure ? |
|
| 1258 | - if ($loader instanceof Closure) { |
|
| 1259 | - $dependency = $loader($arguments); |
|
| 1260 | - } else { |
|
| 1261 | - // set the cache on property for the recursive loading call |
|
| 1262 | - $this->_cache_on = $cache_on; |
|
| 1263 | - // if not, then let's try and load it via the registry |
|
| 1264 | - if ($loader && method_exists($this, $loader)) { |
|
| 1265 | - $dependency = $this->{$loader}($param_class); |
|
| 1266 | - } else { |
|
| 1267 | - $dependency = LoaderFactory::getLoader()->load( |
|
| 1268 | - $param_class, |
|
| 1269 | - array(), |
|
| 1270 | - $cache_on |
|
| 1271 | - ); |
|
| 1272 | - } |
|
| 1273 | - } |
|
| 1274 | - } |
|
| 1275 | - // did we successfully find the correct dependency ? |
|
| 1276 | - if ($dependency instanceof $param_class) { |
|
| 1277 | - // then let's inject it into the incoming array of arguments at the correct location |
|
| 1278 | - $arguments[$index] = $dependency; |
|
| 1279 | - } |
|
| 1280 | - return $arguments; |
|
| 1281 | - } |
|
| 1282 | - |
|
| 1283 | - |
|
| 1284 | - |
|
| 1285 | - /** |
|
| 1286 | - * _set_cached_class |
|
| 1287 | - * attempts to cache the instantiated class locally |
|
| 1288 | - * in one of the following places, in the following order: |
|
| 1289 | - * $this->{class_abbreviation} ie: $this->CART |
|
| 1290 | - * $this->{$class_name} ie: $this->Some_Class |
|
| 1291 | - * $this->addon->{$$class_name} ie: $this->addon->Some_Addon_Class |
|
| 1292 | - * $this->LIB->{$class_name} ie: $this->LIB->Some_Class |
|
| 1293 | - * |
|
| 1294 | - * @param object $class_obj |
|
| 1295 | - * @param string $class_name |
|
| 1296 | - * @param string $class_prefix |
|
| 1297 | - * @param bool $from_db |
|
| 1298 | - * @return void |
|
| 1299 | - */ |
|
| 1300 | - protected function _set_cached_class($class_obj, $class_name, $class_prefix = '', $from_db = false) |
|
| 1301 | - { |
|
| 1302 | - if ($class_name === 'EE_Registry' || empty($class_obj)) { |
|
| 1303 | - return; |
|
| 1304 | - } |
|
| 1305 | - // return newly instantiated class |
|
| 1306 | - $class_abbreviation = $this->get_class_abbreviation($class_name, ''); |
|
| 1307 | - if ($class_abbreviation) { |
|
| 1308 | - $this->{$class_abbreviation} = $class_obj; |
|
| 1309 | - return; |
|
| 1310 | - } |
|
| 1311 | - $class_name = str_replace('\\', '_', $class_name); |
|
| 1312 | - if (property_exists($this, $class_name)) { |
|
| 1313 | - $this->{$class_name} = $class_obj; |
|
| 1314 | - return; |
|
| 1315 | - } |
|
| 1316 | - if ($class_prefix === 'addon') { |
|
| 1317 | - $this->addons->{$class_name} = $class_obj; |
|
| 1318 | - return; |
|
| 1319 | - } |
|
| 1320 | - if (! $from_db) { |
|
| 1321 | - $this->LIB->{$class_name} = $class_obj; |
|
| 1322 | - } |
|
| 1323 | - } |
|
| 1324 | - |
|
| 1325 | - |
|
| 1326 | - |
|
| 1327 | - /** |
|
| 1328 | - * call any loader that's been registered in the EE_Dependency_Map::$_class_loaders array |
|
| 1329 | - * |
|
| 1330 | - * @param string $classname PLEASE NOTE: the class name needs to match what's registered |
|
| 1331 | - * in the EE_Dependency_Map::$_class_loaders array, |
|
| 1332 | - * including the class prefix, ie: "EE_", "EEM_", "EEH_", etc |
|
| 1333 | - * @param array $arguments |
|
| 1334 | - * @return object |
|
| 1335 | - */ |
|
| 1336 | - public static function factory($classname, $arguments = array()) |
|
| 1337 | - { |
|
| 1338 | - $loader = self::instance()->_dependency_map->class_loader($classname); |
|
| 1339 | - if ($loader instanceof Closure) { |
|
| 1340 | - return $loader($arguments); |
|
| 1341 | - } |
|
| 1342 | - if (method_exists(self::instance(), $loader)) { |
|
| 1343 | - return self::instance()->{$loader}($classname, $arguments); |
|
| 1344 | - } |
|
| 1345 | - return null; |
|
| 1346 | - } |
|
| 1347 | - |
|
| 1348 | - |
|
| 1349 | - |
|
| 1350 | - /** |
|
| 1351 | - * Gets the addon by its name/slug (not classname. For that, just |
|
| 1352 | - * use the classname as the property name on EE_Config::instance()->addons) |
|
| 1353 | - * |
|
| 1354 | - * @param string $name |
|
| 1355 | - * @return EE_Addon |
|
| 1356 | - */ |
|
| 1357 | - public function get_addon_by_name($name) |
|
| 1358 | - { |
|
| 1359 | - foreach ($this->addons as $addon) { |
|
| 1360 | - if ($addon->name() === $name) { |
|
| 1361 | - return $addon; |
|
| 1362 | - } |
|
| 1363 | - } |
|
| 1364 | - return null; |
|
| 1365 | - } |
|
| 1366 | - |
|
| 1367 | - |
|
| 1368 | - |
|
| 1369 | - /** |
|
| 1370 | - * Gets an array of all the registered addons, where the keys are their names. (ie, what each returns for their |
|
| 1371 | - * name() function) They're already available on EE_Config::instance()->addons as properties, where each property's |
|
| 1372 | - * name is the addon's classname. So if you just want to get the addon by classname, use |
|
| 1373 | - * EE_Config::instance()->addons->{classname} |
|
| 1374 | - * |
|
| 1375 | - * @return EE_Addon[] where the KEYS are the addon's name() |
|
| 1376 | - */ |
|
| 1377 | - public function get_addons_by_name() |
|
| 1378 | - { |
|
| 1379 | - $addons = array(); |
|
| 1380 | - foreach ($this->addons as $addon) { |
|
| 1381 | - $addons[$addon->name()] = $addon; |
|
| 1382 | - } |
|
| 1383 | - return $addons; |
|
| 1384 | - } |
|
| 1385 | - |
|
| 1386 | - |
|
| 1387 | - |
|
| 1388 | - /** |
|
| 1389 | - * Resets the specified model's instance AND makes sure EE_Registry doesn't keep |
|
| 1390 | - * a stale copy of it around |
|
| 1391 | - * |
|
| 1392 | - * @param string $model_name |
|
| 1393 | - * @return \EEM_Base |
|
| 1394 | - * @throws \EE_Error |
|
| 1395 | - */ |
|
| 1396 | - public function reset_model($model_name) |
|
| 1397 | - { |
|
| 1398 | - $model_class_name = strpos($model_name, 'EEM_') !== 0 |
|
| 1399 | - ? "EEM_{$model_name}" |
|
| 1400 | - : $model_name; |
|
| 1401 | - if (! isset($this->LIB->{$model_class_name}) || ! $this->LIB->{$model_class_name} instanceof EEM_Base) { |
|
| 1402 | - return null; |
|
| 1403 | - } |
|
| 1404 | - //get that model reset it and make sure we nuke the old reference to it |
|
| 1405 | - if ($this->LIB->{$model_class_name} instanceof $model_class_name |
|
| 1406 | - && is_callable( |
|
| 1407 | - array($model_class_name, 'reset') |
|
| 1408 | - )) { |
|
| 1409 | - $this->LIB->{$model_class_name} = $this->LIB->{$model_class_name}->reset(); |
|
| 1410 | - } else { |
|
| 1411 | - throw new EE_Error(sprintf(esc_html__('Model %s does not have a method "reset"', 'event_espresso'), $model_name)); |
|
| 1412 | - } |
|
| 1413 | - return $this->LIB->{$model_class_name}; |
|
| 1414 | - } |
|
| 1415 | - |
|
| 1416 | - |
|
| 1417 | - |
|
| 1418 | - /** |
|
| 1419 | - * Resets the registry. |
|
| 1420 | - * The criteria for what gets reset is based on what can be shared between sites on the same request when |
|
| 1421 | - * switch_to_blog is used in a multisite install. Here is a list of things that are NOT reset. |
|
| 1422 | - * - $_dependency_map |
|
| 1423 | - * - $_class_abbreviations |
|
| 1424 | - * - $NET_CFG (EE_Network_Config): The config is shared network wide so no need to reset. |
|
| 1425 | - * - $REQ: Still on the same request so no need to change. |
|
| 1426 | - * - $CAP: There is no site specific state in the EE_Capability class. |
|
| 1427 | - * - $SSN: Although ideally, the session should not be shared between site switches, we can't reset it because only |
|
| 1428 | - * one Session can be active in a single request. Resetting could resolve in "headers already sent" errors. |
|
| 1429 | - * - $addons: In multisite, the state of the addons is something controlled via hooks etc in a normal request. So |
|
| 1430 | - * for now, we won't reset the addons because it could break calls to an add-ons class/methods in the |
|
| 1431 | - * switch or on the restore. |
|
| 1432 | - * - $modules |
|
| 1433 | - * - $shortcodes |
|
| 1434 | - * - $widgets |
|
| 1435 | - * |
|
| 1436 | - * @param boolean $hard [deprecated] |
|
| 1437 | - * @param boolean $reinstantiate whether to create new instances of EE_Registry's singletons too, |
|
| 1438 | - * or just reset without re-instantiating (handy to set to FALSE if you're not |
|
| 1439 | - * sure if you CAN currently reinstantiate the singletons at the moment) |
|
| 1440 | - * @param bool $reset_models Defaults to true. When false, then the models are not reset. This is so |
|
| 1441 | - * client |
|
| 1442 | - * code instead can just change the model context to a different blog id if |
|
| 1443 | - * necessary |
|
| 1444 | - * @return EE_Registry |
|
| 1445 | - * @throws EE_Error |
|
| 1446 | - * @throws ReflectionException |
|
| 1447 | - */ |
|
| 1448 | - public static function reset($hard = false, $reinstantiate = true, $reset_models = true) |
|
| 1449 | - { |
|
| 1450 | - $instance = self::instance(); |
|
| 1451 | - $instance->_cache_on = true; |
|
| 1452 | - // reset some "special" classes |
|
| 1453 | - EEH_Activation::reset(); |
|
| 1454 | - $hard = apply_filters( 'FHEE__EE_Registry__reset__hard', $hard); |
|
| 1455 | - $instance->CFG = EE_Config::reset($hard, $reinstantiate); |
|
| 1456 | - $instance->CART = null; |
|
| 1457 | - $instance->MRM = null; |
|
| 1458 | - $instance->AssetsRegistry = $instance->create('EventEspresso\core\services\assets\Registry'); |
|
| 1459 | - //messages reset |
|
| 1460 | - EED_Messages::reset(); |
|
| 1461 | - //handle of objects cached on LIB |
|
| 1462 | - foreach (array('LIB', 'modules') as $cache) { |
|
| 1463 | - foreach ($instance->{$cache} as $class_name => $class) { |
|
| 1464 | - if (self::_reset_and_unset_object($class, $reset_models)) { |
|
| 1465 | - unset($instance->{$cache}->{$class_name}); |
|
| 1466 | - } |
|
| 1467 | - } |
|
| 1468 | - } |
|
| 1469 | - return $instance; |
|
| 1470 | - } |
|
| 1471 | - |
|
| 1472 | - |
|
| 1473 | - |
|
| 1474 | - /** |
|
| 1475 | - * if passed object implements ResettableInterface, then call it's reset() method |
|
| 1476 | - * if passed object implements InterminableInterface, then return false, |
|
| 1477 | - * to indicate that it should NOT be cleared from the Registry cache |
|
| 1478 | - * |
|
| 1479 | - * @param $object |
|
| 1480 | - * @param bool $reset_models |
|
| 1481 | - * @return bool returns true if cached object should be unset |
|
| 1482 | - */ |
|
| 1483 | - private static function _reset_and_unset_object($object, $reset_models) |
|
| 1484 | - { |
|
| 1485 | - if (! is_object($object)) { |
|
| 1486 | - // don't unset anything that's not an object |
|
| 1487 | - return false; |
|
| 1488 | - } |
|
| 1489 | - if ($object instanceof EED_Module) { |
|
| 1490 | - $object::reset(); |
|
| 1491 | - // don't unset modules |
|
| 1492 | - return false; |
|
| 1493 | - } |
|
| 1494 | - if ($object instanceof ResettableInterface) { |
|
| 1495 | - if ($object instanceof EEM_Base) { |
|
| 1496 | - if ($reset_models) { |
|
| 1497 | - $object->reset(); |
|
| 1498 | - return true; |
|
| 1499 | - } |
|
| 1500 | - return false; |
|
| 1501 | - } |
|
| 1502 | - $object->reset(); |
|
| 1503 | - return true; |
|
| 1504 | - } |
|
| 1505 | - if (! $object instanceof InterminableInterface) { |
|
| 1506 | - return true; |
|
| 1507 | - } |
|
| 1508 | - return false; |
|
| 1509 | - } |
|
| 1510 | - |
|
| 1511 | - |
|
| 1512 | - |
|
| 1513 | - /** |
|
| 1514 | - * Gets all the custom post type models defined |
|
| 1515 | - * |
|
| 1516 | - * @return array keys are model "short names" (Eg "Event") and keys are classnames (eg "EEM_Event") |
|
| 1517 | - */ |
|
| 1518 | - public function cpt_models() |
|
| 1519 | - { |
|
| 1520 | - $cpt_models = array(); |
|
| 1521 | - foreach ($this->non_abstract_db_models as $short_name => $classname) { |
|
| 1522 | - if (is_subclass_of($classname, 'EEM_CPT_Base')) { |
|
| 1523 | - $cpt_models[$short_name] = $classname; |
|
| 1524 | - } |
|
| 1525 | - } |
|
| 1526 | - return $cpt_models; |
|
| 1527 | - } |
|
| 1528 | - |
|
| 1529 | - |
|
| 1530 | - |
|
| 1531 | - /** |
|
| 1532 | - * @return \EE_Config |
|
| 1533 | - */ |
|
| 1534 | - public static function CFG() |
|
| 1535 | - { |
|
| 1536 | - return self::instance()->CFG; |
|
| 1537 | - } |
|
| 25 | + /** |
|
| 26 | + * @var EE_Registry $_instance |
|
| 27 | + */ |
|
| 28 | + private static $_instance; |
|
| 29 | + |
|
| 30 | + /** |
|
| 31 | + * @var EE_Dependency_Map $_dependency_map |
|
| 32 | + */ |
|
| 33 | + protected $_dependency_map; |
|
| 34 | + |
|
| 35 | + /** |
|
| 36 | + * @var array $_class_abbreviations |
|
| 37 | + */ |
|
| 38 | + protected $_class_abbreviations = array(); |
|
| 39 | + |
|
| 40 | + /** |
|
| 41 | + * @var CommandBusInterface $BUS |
|
| 42 | + */ |
|
| 43 | + public $BUS; |
|
| 44 | + |
|
| 45 | + /** |
|
| 46 | + * @var EE_Cart $CART |
|
| 47 | + */ |
|
| 48 | + public $CART; |
|
| 49 | + |
|
| 50 | + /** |
|
| 51 | + * @var EE_Config $CFG |
|
| 52 | + */ |
|
| 53 | + public $CFG; |
|
| 54 | + |
|
| 55 | + /** |
|
| 56 | + * @var EE_Network_Config $NET_CFG |
|
| 57 | + */ |
|
| 58 | + public $NET_CFG; |
|
| 59 | + |
|
| 60 | + /** |
|
| 61 | + * StdClass object for storing library classes in |
|
| 62 | + * |
|
| 63 | + * @var StdClass $LIB |
|
| 64 | + */ |
|
| 65 | + public $LIB; |
|
| 66 | + |
|
| 67 | + /** |
|
| 68 | + * @var EE_Request_Handler $REQ |
|
| 69 | + */ |
|
| 70 | + public $REQ; |
|
| 71 | + |
|
| 72 | + /** |
|
| 73 | + * @var EE_Session $SSN |
|
| 74 | + */ |
|
| 75 | + public $SSN; |
|
| 76 | + |
|
| 77 | + /** |
|
| 78 | + * @since 4.5.0 |
|
| 79 | + * @var EE_Capabilities $CAP |
|
| 80 | + */ |
|
| 81 | + public $CAP; |
|
| 82 | + |
|
| 83 | + /** |
|
| 84 | + * @since 4.9.0 |
|
| 85 | + * @var EE_Message_Resource_Manager $MRM |
|
| 86 | + */ |
|
| 87 | + public $MRM; |
|
| 88 | + |
|
| 89 | + |
|
| 90 | + /** |
|
| 91 | + * @var Registry $AssetsRegistry |
|
| 92 | + */ |
|
| 93 | + public $AssetsRegistry; |
|
| 94 | + |
|
| 95 | + /** |
|
| 96 | + * StdClass object for holding addons which have registered themselves to work with EE core |
|
| 97 | + * |
|
| 98 | + * @var EE_Addon[] $addons |
|
| 99 | + */ |
|
| 100 | + public $addons; |
|
| 101 | + |
|
| 102 | + /** |
|
| 103 | + * keys are 'short names' (eg Event), values are class names (eg 'EEM_Event') |
|
| 104 | + * |
|
| 105 | + * @var EEM_Base[] $models |
|
| 106 | + */ |
|
| 107 | + public $models = array(); |
|
| 108 | + |
|
| 109 | + /** |
|
| 110 | + * @var EED_Module[] $modules |
|
| 111 | + */ |
|
| 112 | + public $modules; |
|
| 113 | + |
|
| 114 | + /** |
|
| 115 | + * @var EES_Shortcode[] $shortcodes |
|
| 116 | + */ |
|
| 117 | + public $shortcodes; |
|
| 118 | + |
|
| 119 | + /** |
|
| 120 | + * @var WP_Widget[] $widgets |
|
| 121 | + */ |
|
| 122 | + public $widgets; |
|
| 123 | + |
|
| 124 | + /** |
|
| 125 | + * this is an array of all implemented model names (i.e. not the parent abstract models, or models |
|
| 126 | + * which don't actually fetch items from the DB in the normal way (ie, are not children of EEM_Base)). |
|
| 127 | + * Keys are model "short names" (eg "Event") as used in model relations, and values are |
|
| 128 | + * classnames (eg "EEM_Event") |
|
| 129 | + * |
|
| 130 | + * @var array $non_abstract_db_models |
|
| 131 | + */ |
|
| 132 | + public $non_abstract_db_models = array(); |
|
| 133 | + |
|
| 134 | + |
|
| 135 | + /** |
|
| 136 | + * internationalization for JS strings |
|
| 137 | + * usage: EE_Registry::i18n_js_strings['string_key'] = esc_html__( 'string to translate.', 'event_espresso' ); |
|
| 138 | + * in js file: var translatedString = eei18n.string_key; |
|
| 139 | + * |
|
| 140 | + * @var array $i18n_js_strings |
|
| 141 | + */ |
|
| 142 | + public static $i18n_js_strings = array(); |
|
| 143 | + |
|
| 144 | + |
|
| 145 | + /** |
|
| 146 | + * $main_file - path to espresso.php |
|
| 147 | + * |
|
| 148 | + * @var array $main_file |
|
| 149 | + */ |
|
| 150 | + public $main_file; |
|
| 151 | + |
|
| 152 | + /** |
|
| 153 | + * array of ReflectionClass objects where the key is the class name |
|
| 154 | + * |
|
| 155 | + * @var ReflectionClass[] $_reflectors |
|
| 156 | + */ |
|
| 157 | + public $_reflectors; |
|
| 158 | + |
|
| 159 | + /** |
|
| 160 | + * boolean flag to indicate whether or not to load/save dependencies from/to the cache |
|
| 161 | + * |
|
| 162 | + * @var boolean $_cache_on |
|
| 163 | + */ |
|
| 164 | + protected $_cache_on = true; |
|
| 165 | + |
|
| 166 | + |
|
| 167 | + |
|
| 168 | + /** |
|
| 169 | + * @singleton method used to instantiate class object |
|
| 170 | + * @param EE_Dependency_Map $dependency_map |
|
| 171 | + * @return EE_Registry instance |
|
| 172 | + * @throws InvalidArgumentException |
|
| 173 | + * @throws InvalidInterfaceException |
|
| 174 | + * @throws InvalidDataTypeException |
|
| 175 | + */ |
|
| 176 | + public static function instance(EE_Dependency_Map $dependency_map = null) |
|
| 177 | + { |
|
| 178 | + // check if class object is instantiated |
|
| 179 | + if (! self::$_instance instanceof EE_Registry) { |
|
| 180 | + self::$_instance = new self($dependency_map); |
|
| 181 | + } |
|
| 182 | + return self::$_instance; |
|
| 183 | + } |
|
| 184 | + |
|
| 185 | + |
|
| 186 | + |
|
| 187 | + /** |
|
| 188 | + * protected constructor to prevent direct creation |
|
| 189 | + * |
|
| 190 | + * @Constructor |
|
| 191 | + * @param EE_Dependency_Map $dependency_map |
|
| 192 | + * @throws InvalidDataTypeException |
|
| 193 | + * @throws InvalidInterfaceException |
|
| 194 | + * @throws InvalidArgumentException |
|
| 195 | + */ |
|
| 196 | + protected function __construct(EE_Dependency_Map $dependency_map) |
|
| 197 | + { |
|
| 198 | + $this->_dependency_map = $dependency_map; |
|
| 199 | + $this->LIB = new stdClass(); |
|
| 200 | + $this->addons = new stdClass(); |
|
| 201 | + $this->modules = new stdClass(); |
|
| 202 | + $this->shortcodes = new stdClass(); |
|
| 203 | + $this->widgets = new stdClass(); |
|
| 204 | + add_action('EE_Load_Espresso_Core__handle_request__initialize_core_loading', array($this, 'initialize')); |
|
| 205 | + } |
|
| 206 | + |
|
| 207 | + |
|
| 208 | + |
|
| 209 | + /** |
|
| 210 | + * initialize |
|
| 211 | + * |
|
| 212 | + * @throws EE_Error |
|
| 213 | + * @throws ReflectionException |
|
| 214 | + */ |
|
| 215 | + public function initialize() |
|
| 216 | + { |
|
| 217 | + $this->_class_abbreviations = apply_filters( |
|
| 218 | + 'FHEE__EE_Registry____construct___class_abbreviations', |
|
| 219 | + array( |
|
| 220 | + 'EE_Config' => 'CFG', |
|
| 221 | + 'EE_Session' => 'SSN', |
|
| 222 | + 'EE_Capabilities' => 'CAP', |
|
| 223 | + 'EE_Cart' => 'CART', |
|
| 224 | + 'EE_Network_Config' => 'NET_CFG', |
|
| 225 | + 'EE_Request_Handler' => 'REQ', |
|
| 226 | + 'EE_Message_Resource_Manager' => 'MRM', |
|
| 227 | + 'EventEspresso\core\services\commands\CommandBus' => 'BUS', |
|
| 228 | + 'EventEspresso\core\services\assets\Registry' => 'AssetsRegistry', |
|
| 229 | + ) |
|
| 230 | + ); |
|
| 231 | + $this->load_core('Base', array(), true); |
|
| 232 | + // add our request and response objects to the cache |
|
| 233 | + $request_loader = $this->_dependency_map->class_loader('EE_Request'); |
|
| 234 | + $this->_set_cached_class( |
|
| 235 | + $request_loader(), |
|
| 236 | + 'EE_Request' |
|
| 237 | + ); |
|
| 238 | + $response_loader = $this->_dependency_map->class_loader('EE_Response'); |
|
| 239 | + $this->_set_cached_class( |
|
| 240 | + $response_loader(), |
|
| 241 | + 'EE_Response' |
|
| 242 | + ); |
|
| 243 | + add_action('AHEE__EE_System__set_hooks_for_core', array($this, 'init')); |
|
| 244 | + } |
|
| 245 | + |
|
| 246 | + |
|
| 247 | + |
|
| 248 | + /** |
|
| 249 | + * @return void |
|
| 250 | + */ |
|
| 251 | + public function init() |
|
| 252 | + { |
|
| 253 | + // Get current page protocol |
|
| 254 | + $protocol = isset($_SERVER['HTTPS']) ? 'https://' : 'http://'; |
|
| 255 | + // Output admin-ajax.php URL with same protocol as current page |
|
| 256 | + self::$i18n_js_strings['ajax_url'] = admin_url('admin-ajax.php', $protocol); |
|
| 257 | + self::$i18n_js_strings['wp_debug'] = defined('WP_DEBUG') ? WP_DEBUG : false; |
|
| 258 | + } |
|
| 259 | + |
|
| 260 | + |
|
| 261 | + |
|
| 262 | + /** |
|
| 263 | + * localize_i18n_js_strings |
|
| 264 | + * |
|
| 265 | + * @return string |
|
| 266 | + */ |
|
| 267 | + public static function localize_i18n_js_strings() |
|
| 268 | + { |
|
| 269 | + $i18n_js_strings = (array)self::$i18n_js_strings; |
|
| 270 | + foreach ($i18n_js_strings as $key => $value) { |
|
| 271 | + if (is_scalar($value)) { |
|
| 272 | + $i18n_js_strings[$key] = html_entity_decode((string)$value, ENT_QUOTES, 'UTF-8'); |
|
| 273 | + } |
|
| 274 | + } |
|
| 275 | + return '/* <![CDATA[ */ var eei18n = ' . wp_json_encode($i18n_js_strings) . '; /* ]]> */'; |
|
| 276 | + } |
|
| 277 | + |
|
| 278 | + |
|
| 279 | + |
|
| 280 | + /** |
|
| 281 | + * @param mixed string | EED_Module $module |
|
| 282 | + * @throws EE_Error |
|
| 283 | + * @throws ReflectionException |
|
| 284 | + */ |
|
| 285 | + public function add_module($module) |
|
| 286 | + { |
|
| 287 | + if ($module instanceof EED_Module) { |
|
| 288 | + $module_class = get_class($module); |
|
| 289 | + $this->modules->{$module_class} = $module; |
|
| 290 | + } else { |
|
| 291 | + if (! class_exists('EE_Module_Request_Router')) { |
|
| 292 | + $this->load_core('Module_Request_Router'); |
|
| 293 | + } |
|
| 294 | + EE_Module_Request_Router::module_factory($module); |
|
| 295 | + } |
|
| 296 | + } |
|
| 297 | + |
|
| 298 | + |
|
| 299 | + |
|
| 300 | + /** |
|
| 301 | + * @param string $module_name |
|
| 302 | + * @return mixed EED_Module | NULL |
|
| 303 | + */ |
|
| 304 | + public function get_module($module_name = '') |
|
| 305 | + { |
|
| 306 | + return isset($this->modules->{$module_name}) |
|
| 307 | + ? $this->modules->{$module_name} |
|
| 308 | + : null; |
|
| 309 | + } |
|
| 310 | + |
|
| 311 | + |
|
| 312 | + |
|
| 313 | + /** |
|
| 314 | + * loads core classes - must be singletons |
|
| 315 | + * |
|
| 316 | + * @param string $class_name - simple class name ie: session |
|
| 317 | + * @param mixed $arguments |
|
| 318 | + * @param bool $load_only |
|
| 319 | + * @return mixed |
|
| 320 | + * @throws EE_Error |
|
| 321 | + * @throws ReflectionException |
|
| 322 | + */ |
|
| 323 | + public function load_core($class_name, $arguments = array(), $load_only = false) |
|
| 324 | + { |
|
| 325 | + $core_paths = apply_filters( |
|
| 326 | + 'FHEE__EE_Registry__load_core__core_paths', |
|
| 327 | + array( |
|
| 328 | + EE_CORE, |
|
| 329 | + EE_ADMIN, |
|
| 330 | + EE_CPTS, |
|
| 331 | + EE_CORE . 'data_migration_scripts' . DS, |
|
| 332 | + EE_CORE . 'capabilities' . DS, |
|
| 333 | + EE_CORE . 'request_stack' . DS, |
|
| 334 | + EE_CORE . 'middleware' . DS, |
|
| 335 | + ) |
|
| 336 | + ); |
|
| 337 | + // retrieve instantiated class |
|
| 338 | + return $this->_load( |
|
| 339 | + $core_paths, |
|
| 340 | + 'EE_', |
|
| 341 | + $class_name, |
|
| 342 | + 'core', |
|
| 343 | + $arguments, |
|
| 344 | + false, |
|
| 345 | + true, |
|
| 346 | + $load_only |
|
| 347 | + ); |
|
| 348 | + } |
|
| 349 | + |
|
| 350 | + |
|
| 351 | + |
|
| 352 | + /** |
|
| 353 | + * loads service classes |
|
| 354 | + * |
|
| 355 | + * @param string $class_name - simple class name ie: session |
|
| 356 | + * @param mixed $arguments |
|
| 357 | + * @param bool $load_only |
|
| 358 | + * @return mixed |
|
| 359 | + * @throws EE_Error |
|
| 360 | + * @throws ReflectionException |
|
| 361 | + */ |
|
| 362 | + public function load_service($class_name, $arguments = array(), $load_only = false) |
|
| 363 | + { |
|
| 364 | + $service_paths = apply_filters( |
|
| 365 | + 'FHEE__EE_Registry__load_service__service_paths', |
|
| 366 | + array( |
|
| 367 | + EE_CORE . 'services' . DS, |
|
| 368 | + ) |
|
| 369 | + ); |
|
| 370 | + // retrieve instantiated class |
|
| 371 | + return $this->_load( |
|
| 372 | + $service_paths, |
|
| 373 | + 'EE_', |
|
| 374 | + $class_name, |
|
| 375 | + 'class', |
|
| 376 | + $arguments, |
|
| 377 | + false, |
|
| 378 | + true, |
|
| 379 | + $load_only |
|
| 380 | + ); |
|
| 381 | + } |
|
| 382 | + |
|
| 383 | + |
|
| 384 | + |
|
| 385 | + /** |
|
| 386 | + * loads data_migration_scripts |
|
| 387 | + * |
|
| 388 | + * @param string $class_name - class name for the DMS ie: EE_DMS_Core_4_2_0 |
|
| 389 | + * @param mixed $arguments |
|
| 390 | + * @return EE_Data_Migration_Script_Base|mixed |
|
| 391 | + * @throws EE_Error |
|
| 392 | + * @throws ReflectionException |
|
| 393 | + */ |
|
| 394 | + public function load_dms($class_name, $arguments = array()) |
|
| 395 | + { |
|
| 396 | + // retrieve instantiated class |
|
| 397 | + return $this->_load( |
|
| 398 | + EE_Data_Migration_Manager::instance()->get_data_migration_script_folders(), |
|
| 399 | + 'EE_DMS_', |
|
| 400 | + $class_name, |
|
| 401 | + 'dms', |
|
| 402 | + $arguments, |
|
| 403 | + false, |
|
| 404 | + false |
|
| 405 | + ); |
|
| 406 | + } |
|
| 407 | + |
|
| 408 | + |
|
| 409 | + |
|
| 410 | + /** |
|
| 411 | + * loads object creating classes - must be singletons |
|
| 412 | + * |
|
| 413 | + * @param string $class_name - simple class name ie: attendee |
|
| 414 | + * @param mixed $arguments - an array of arguments to pass to the class |
|
| 415 | + * @param bool $from_db - some classes are instantiated from the db and thus call a different method to |
|
| 416 | + * instantiate |
|
| 417 | + * @param bool $cache if you don't want the class to be stored in the internal cache (non-persistent) then |
|
| 418 | + * set this to FALSE (ie. when instantiating model objects from client in a loop) |
|
| 419 | + * @param bool $load_only whether or not to just load the file and NOT instantiate, or load AND instantiate |
|
| 420 | + * (default) |
|
| 421 | + * @return EE_Base_Class | bool |
|
| 422 | + * @throws EE_Error |
|
| 423 | + * @throws ReflectionException |
|
| 424 | + */ |
|
| 425 | + public function load_class($class_name, $arguments = array(), $from_db = false, $cache = true, $load_only = false) |
|
| 426 | + { |
|
| 427 | + $paths = apply_filters( |
|
| 428 | + 'FHEE__EE_Registry__load_class__paths', array( |
|
| 429 | + EE_CORE, |
|
| 430 | + EE_CLASSES, |
|
| 431 | + EE_BUSINESS, |
|
| 432 | + ) |
|
| 433 | + ); |
|
| 434 | + // retrieve instantiated class |
|
| 435 | + return $this->_load( |
|
| 436 | + $paths, |
|
| 437 | + 'EE_', |
|
| 438 | + $class_name, |
|
| 439 | + 'class', |
|
| 440 | + $arguments, |
|
| 441 | + $from_db, |
|
| 442 | + $cache, |
|
| 443 | + $load_only |
|
| 444 | + ); |
|
| 445 | + } |
|
| 446 | + |
|
| 447 | + |
|
| 448 | + |
|
| 449 | + /** |
|
| 450 | + * loads helper classes - must be singletons |
|
| 451 | + * |
|
| 452 | + * @param string $class_name - simple class name ie: price |
|
| 453 | + * @param mixed $arguments |
|
| 454 | + * @param bool $load_only |
|
| 455 | + * @return EEH_Base | bool |
|
| 456 | + * @throws EE_Error |
|
| 457 | + * @throws ReflectionException |
|
| 458 | + */ |
|
| 459 | + public function load_helper($class_name, $arguments = array(), $load_only = true) |
|
| 460 | + { |
|
| 461 | + // todo: add doing_it_wrong() in a few versions after all addons have had calls to this method removed |
|
| 462 | + $helper_paths = apply_filters('FHEE__EE_Registry__load_helper__helper_paths', array(EE_HELPERS)); |
|
| 463 | + // retrieve instantiated class |
|
| 464 | + return $this->_load( |
|
| 465 | + $helper_paths, |
|
| 466 | + 'EEH_', |
|
| 467 | + $class_name, |
|
| 468 | + 'helper', |
|
| 469 | + $arguments, |
|
| 470 | + false, |
|
| 471 | + true, |
|
| 472 | + $load_only |
|
| 473 | + ); |
|
| 474 | + } |
|
| 475 | + |
|
| 476 | + |
|
| 477 | + |
|
| 478 | + /** |
|
| 479 | + * loads core classes - must be singletons |
|
| 480 | + * |
|
| 481 | + * @param string $class_name - simple class name ie: session |
|
| 482 | + * @param mixed $arguments |
|
| 483 | + * @param bool $load_only |
|
| 484 | + * @param bool $cache whether to cache the object or not. |
|
| 485 | + * @return mixed |
|
| 486 | + * @throws EE_Error |
|
| 487 | + * @throws ReflectionException |
|
| 488 | + */ |
|
| 489 | + public function load_lib($class_name, $arguments = array(), $load_only = false, $cache = true) |
|
| 490 | + { |
|
| 491 | + $paths = array( |
|
| 492 | + EE_LIBRARIES, |
|
| 493 | + EE_LIBRARIES . 'messages' . DS, |
|
| 494 | + EE_LIBRARIES . 'shortcodes' . DS, |
|
| 495 | + EE_LIBRARIES . 'qtips' . DS, |
|
| 496 | + EE_LIBRARIES . 'payment_methods' . DS, |
|
| 497 | + ); |
|
| 498 | + // retrieve instantiated class |
|
| 499 | + return $this->_load( |
|
| 500 | + $paths, |
|
| 501 | + 'EE_', |
|
| 502 | + $class_name, |
|
| 503 | + 'lib', |
|
| 504 | + $arguments, |
|
| 505 | + false, |
|
| 506 | + $cache, |
|
| 507 | + $load_only |
|
| 508 | + ); |
|
| 509 | + } |
|
| 510 | + |
|
| 511 | + |
|
| 512 | + |
|
| 513 | + /** |
|
| 514 | + * loads model classes - must be singletons |
|
| 515 | + * |
|
| 516 | + * @param string $class_name - simple class name ie: price |
|
| 517 | + * @param mixed $arguments |
|
| 518 | + * @param bool $load_only |
|
| 519 | + * @return EEM_Base | bool |
|
| 520 | + * @throws EE_Error |
|
| 521 | + * @throws ReflectionException |
|
| 522 | + */ |
|
| 523 | + public function load_model($class_name, $arguments = array(), $load_only = false) |
|
| 524 | + { |
|
| 525 | + $paths = apply_filters( |
|
| 526 | + 'FHEE__EE_Registry__load_model__paths', array( |
|
| 527 | + EE_MODELS, |
|
| 528 | + EE_CORE, |
|
| 529 | + ) |
|
| 530 | + ); |
|
| 531 | + // retrieve instantiated class |
|
| 532 | + return $this->_load( |
|
| 533 | + $paths, |
|
| 534 | + 'EEM_', |
|
| 535 | + $class_name, |
|
| 536 | + 'model', |
|
| 537 | + $arguments, |
|
| 538 | + false, |
|
| 539 | + true, |
|
| 540 | + $load_only |
|
| 541 | + ); |
|
| 542 | + } |
|
| 543 | + |
|
| 544 | + |
|
| 545 | + |
|
| 546 | + /** |
|
| 547 | + * loads model classes - must be singletons |
|
| 548 | + * |
|
| 549 | + * @param string $class_name - simple class name ie: price |
|
| 550 | + * @param mixed $arguments |
|
| 551 | + * @param bool $load_only |
|
| 552 | + * @return mixed | bool |
|
| 553 | + * @throws EE_Error |
|
| 554 | + * @throws ReflectionException |
|
| 555 | + */ |
|
| 556 | + public function load_model_class($class_name, $arguments = array(), $load_only = true) |
|
| 557 | + { |
|
| 558 | + $paths = array( |
|
| 559 | + EE_MODELS . 'fields' . DS, |
|
| 560 | + EE_MODELS . 'helpers' . DS, |
|
| 561 | + EE_MODELS . 'relations' . DS, |
|
| 562 | + EE_MODELS . 'strategies' . DS, |
|
| 563 | + ); |
|
| 564 | + // retrieve instantiated class |
|
| 565 | + return $this->_load( |
|
| 566 | + $paths, |
|
| 567 | + 'EE_', |
|
| 568 | + $class_name, |
|
| 569 | + '', |
|
| 570 | + $arguments, |
|
| 571 | + false, |
|
| 572 | + true, |
|
| 573 | + $load_only |
|
| 574 | + ); |
|
| 575 | + } |
|
| 576 | + |
|
| 577 | + |
|
| 578 | + |
|
| 579 | + /** |
|
| 580 | + * Determines if $model_name is the name of an actual EE model. |
|
| 581 | + * |
|
| 582 | + * @param string $model_name like Event, Attendee, Question_Group_Question, etc. |
|
| 583 | + * @return boolean |
|
| 584 | + */ |
|
| 585 | + public function is_model_name($model_name) |
|
| 586 | + { |
|
| 587 | + return isset($this->models[$model_name]); |
|
| 588 | + } |
|
| 589 | + |
|
| 590 | + |
|
| 591 | + |
|
| 592 | + /** |
|
| 593 | + * generic class loader |
|
| 594 | + * |
|
| 595 | + * @param string $path_to_file - directory path to file location, not including filename |
|
| 596 | + * @param string $file_name - file name ie: my_file.php, including extension |
|
| 597 | + * @param string $type - file type - core? class? helper? model? |
|
| 598 | + * @param mixed $arguments |
|
| 599 | + * @param bool $load_only |
|
| 600 | + * @return mixed |
|
| 601 | + * @throws EE_Error |
|
| 602 | + * @throws ReflectionException |
|
| 603 | + */ |
|
| 604 | + public function load_file($path_to_file, $file_name, $type = '', $arguments = array(), $load_only = true) |
|
| 605 | + { |
|
| 606 | + // retrieve instantiated class |
|
| 607 | + return $this->_load( |
|
| 608 | + $path_to_file, |
|
| 609 | + '', |
|
| 610 | + $file_name, |
|
| 611 | + $type, |
|
| 612 | + $arguments, |
|
| 613 | + false, |
|
| 614 | + true, |
|
| 615 | + $load_only |
|
| 616 | + ); |
|
| 617 | + } |
|
| 618 | + |
|
| 619 | + |
|
| 620 | + |
|
| 621 | + /** |
|
| 622 | + * @param string $path_to_file - directory path to file location, not including filename |
|
| 623 | + * @param string $class_name - full class name ie: My_Class |
|
| 624 | + * @param string $type - file type - core? class? helper? model? |
|
| 625 | + * @param mixed $arguments |
|
| 626 | + * @param bool $load_only |
|
| 627 | + * @return bool|EE_Addon|object |
|
| 628 | + * @throws EE_Error |
|
| 629 | + * @throws ReflectionException |
|
| 630 | + */ |
|
| 631 | + public function load_addon($path_to_file, $class_name, $type = 'class', $arguments = array(), $load_only = false) |
|
| 632 | + { |
|
| 633 | + // retrieve instantiated class |
|
| 634 | + return $this->_load( |
|
| 635 | + $path_to_file, |
|
| 636 | + 'addon', |
|
| 637 | + $class_name, |
|
| 638 | + $type, |
|
| 639 | + $arguments, |
|
| 640 | + false, |
|
| 641 | + true, |
|
| 642 | + $load_only |
|
| 643 | + ); |
|
| 644 | + } |
|
| 645 | + |
|
| 646 | + |
|
| 647 | + |
|
| 648 | + /** |
|
| 649 | + * instantiates, caches, and automatically resolves dependencies |
|
| 650 | + * for classes that use a Fully Qualified Class Name. |
|
| 651 | + * if the class is not capable of being loaded using PSR-4 autoloading, |
|
| 652 | + * then you need to use one of the existing load_*() methods |
|
| 653 | + * which can resolve the classname and filepath from the passed arguments |
|
| 654 | + * |
|
| 655 | + * @param bool|string $class_name Fully Qualified Class Name |
|
| 656 | + * @param array $arguments an argument, or array of arguments to pass to the class upon instantiation |
|
| 657 | + * @param bool $cache whether to cache the instantiated object for reuse |
|
| 658 | + * @param bool $from_db some classes are instantiated from the db |
|
| 659 | + * and thus call a different method to instantiate |
|
| 660 | + * @param bool $load_only if true, will only load the file, but will NOT instantiate an object |
|
| 661 | + * @param bool|string $addon if true, will cache the object in the EE_Registry->$addons array |
|
| 662 | + * @return bool|null|mixed null = failure to load or instantiate class object. |
|
| 663 | + * object = class loaded and instantiated successfully. |
|
| 664 | + * bool = fail or success when $load_only is true |
|
| 665 | + * @throws EE_Error |
|
| 666 | + * @throws ReflectionException |
|
| 667 | + */ |
|
| 668 | + public function create( |
|
| 669 | + $class_name = false, |
|
| 670 | + $arguments = array(), |
|
| 671 | + $cache = false, |
|
| 672 | + $from_db = false, |
|
| 673 | + $load_only = false, |
|
| 674 | + $addon = false |
|
| 675 | + ) { |
|
| 676 | + $class_name = ltrim($class_name, '\\'); |
|
| 677 | + $class_name = $this->_dependency_map->get_alias($class_name); |
|
| 678 | + $class_exists = $this->loadOrVerifyClassExists($class_name, $arguments); |
|
| 679 | + // if a non-FQCN was passed, then verifyClassExists() might return an object |
|
| 680 | + // or it could return null if the class just could not be found anywhere |
|
| 681 | + if ($class_exists instanceof $class_name || $class_exists === null){ |
|
| 682 | + // either way, return the results |
|
| 683 | + return $class_exists; |
|
| 684 | + } |
|
| 685 | + $class_name = $class_exists; |
|
| 686 | + // if we're only loading the class and it already exists, then let's just return true immediately |
|
| 687 | + if ($load_only) { |
|
| 688 | + return true; |
|
| 689 | + } |
|
| 690 | + $addon = $addon |
|
| 691 | + ? 'addon' |
|
| 692 | + : ''; |
|
| 693 | + // $this->_cache_on is toggled during the recursive loading that can occur with dependency injection |
|
| 694 | + // $cache is controlled by individual calls to separate Registry loader methods like load_class() |
|
| 695 | + // $load_only is also controlled by individual calls to separate Registry loader methods like load_file() |
|
| 696 | + if ($this->_cache_on && $cache && ! $load_only) { |
|
| 697 | + // return object if it's already cached |
|
| 698 | + $cached_class = $this->_get_cached_class($class_name, $addon); |
|
| 699 | + if ($cached_class !== null) { |
|
| 700 | + return $cached_class; |
|
| 701 | + } |
|
| 702 | + } |
|
| 703 | + // obtain the loader method from the dependency map |
|
| 704 | + $loader = $this->_dependency_map->class_loader($class_name); |
|
| 705 | + // instantiate the requested object |
|
| 706 | + if ($loader instanceof Closure) { |
|
| 707 | + $class_obj = $loader($arguments); |
|
| 708 | + } else if ($loader && method_exists($this, $loader)) { |
|
| 709 | + $class_obj = $this->{$loader}($class_name, $arguments); |
|
| 710 | + } else { |
|
| 711 | + $class_obj = $this->_create_object($class_name, $arguments, $addon, $from_db); |
|
| 712 | + } |
|
| 713 | + if (($this->_cache_on && $cache) || $this->get_class_abbreviation($class_name, '')) { |
|
| 714 | + // save it for later... kinda like gum { : $ |
|
| 715 | + $this->_set_cached_class($class_obj, $class_name, $addon, $from_db); |
|
| 716 | + } |
|
| 717 | + $this->_cache_on = true; |
|
| 718 | + return $class_obj; |
|
| 719 | + } |
|
| 720 | + |
|
| 721 | + |
|
| 722 | + |
|
| 723 | + /** |
|
| 724 | + * Recursively checks that a class exists and potentially attempts to load classes with non-FQCNs |
|
| 725 | + * |
|
| 726 | + * @param string $class_name |
|
| 727 | + * @param array $arguments |
|
| 728 | + * @param int $attempt |
|
| 729 | + * @return mixed |
|
| 730 | + */ |
|
| 731 | + private function loadOrVerifyClassExists($class_name, array $arguments, $attempt = 1) { |
|
| 732 | + if (is_object($class_name) || class_exists($class_name)) { |
|
| 733 | + return $class_name; |
|
| 734 | + } |
|
| 735 | + switch ($attempt) { |
|
| 736 | + case 1: |
|
| 737 | + // if it's a FQCN then maybe the class is registered with a preceding \ |
|
| 738 | + $class_name = strpos($class_name, '\\') !== false |
|
| 739 | + ? '\\' . ltrim($class_name, '\\') |
|
| 740 | + : $class_name; |
|
| 741 | + break; |
|
| 742 | + case 2: |
|
| 743 | + // |
|
| 744 | + $loader = $this->_dependency_map->class_loader($class_name); |
|
| 745 | + if ($loader && method_exists($this, $loader)) { |
|
| 746 | + return $this->{$loader}($class_name, $arguments); |
|
| 747 | + } |
|
| 748 | + break; |
|
| 749 | + case 3: |
|
| 750 | + default; |
|
| 751 | + return null; |
|
| 752 | + } |
|
| 753 | + $attempt++; |
|
| 754 | + return $this->loadOrVerifyClassExists($class_name, $arguments, $attempt); |
|
| 755 | + } |
|
| 756 | + |
|
| 757 | + |
|
| 758 | + |
|
| 759 | + /** |
|
| 760 | + * instantiates, caches, and injects dependencies for classes |
|
| 761 | + * |
|
| 762 | + * @param array $file_paths an array of paths to folders to look in |
|
| 763 | + * @param string $class_prefix EE or EEM or... ??? |
|
| 764 | + * @param bool|string $class_name $class name |
|
| 765 | + * @param string $type file type - core? class? helper? model? |
|
| 766 | + * @param mixed $arguments an argument or array of arguments to pass to the class upon instantiation |
|
| 767 | + * @param bool $from_db some classes are instantiated from the db |
|
| 768 | + * and thus call a different method to instantiate |
|
| 769 | + * @param bool $cache whether to cache the instantiated object for reuse |
|
| 770 | + * @param bool $load_only if true, will only load the file, but will NOT instantiate an object |
|
| 771 | + * @return bool|null|object null = failure to load or instantiate class object. |
|
| 772 | + * object = class loaded and instantiated successfully. |
|
| 773 | + * bool = fail or success when $load_only is true |
|
| 774 | + * @throws EE_Error |
|
| 775 | + * @throws ReflectionException |
|
| 776 | + */ |
|
| 777 | + protected function _load( |
|
| 778 | + $file_paths = array(), |
|
| 779 | + $class_prefix = 'EE_', |
|
| 780 | + $class_name = false, |
|
| 781 | + $type = 'class', |
|
| 782 | + $arguments = array(), |
|
| 783 | + $from_db = false, |
|
| 784 | + $cache = true, |
|
| 785 | + $load_only = false |
|
| 786 | + ) { |
|
| 787 | + $class_name = ltrim($class_name, '\\'); |
|
| 788 | + // strip php file extension |
|
| 789 | + $class_name = str_replace('.php', '', trim($class_name)); |
|
| 790 | + // does the class have a prefix ? |
|
| 791 | + if (! empty($class_prefix) && $class_prefix !== 'addon') { |
|
| 792 | + // make sure $class_prefix is uppercase |
|
| 793 | + $class_prefix = strtoupper(trim($class_prefix)); |
|
| 794 | + // add class prefix ONCE!!! |
|
| 795 | + $class_name = $class_prefix . str_replace($class_prefix, '', $class_name); |
|
| 796 | + } |
|
| 797 | + $class_name = $this->_dependency_map->get_alias($class_name); |
|
| 798 | + $class_exists = class_exists($class_name); |
|
| 799 | + // if we're only loading the class and it already exists, then let's just return true immediately |
|
| 800 | + if ($load_only && $class_exists) { |
|
| 801 | + return true; |
|
| 802 | + } |
|
| 803 | + // $this->_cache_on is toggled during the recursive loading that can occur with dependency injection |
|
| 804 | + // $cache is controlled by individual calls to separate Registry loader methods like load_class() |
|
| 805 | + // $load_only is also controlled by individual calls to separate Registry loader methods like load_file() |
|
| 806 | + if ($this->_cache_on && $cache && ! $load_only) { |
|
| 807 | + // return object if it's already cached |
|
| 808 | + $cached_class = $this->_get_cached_class($class_name, $class_prefix); |
|
| 809 | + if ($cached_class !== null) { |
|
| 810 | + return $cached_class; |
|
| 811 | + } |
|
| 812 | + } |
|
| 813 | + // if the class doesn't already exist.. then we need to try and find the file and load it |
|
| 814 | + if (! $class_exists) { |
|
| 815 | + // get full path to file |
|
| 816 | + $path = $this->_resolve_path($class_name, $type, $file_paths); |
|
| 817 | + // load the file |
|
| 818 | + $loaded = $this->_require_file($path, $class_name, $type, $file_paths); |
|
| 819 | + // if loading failed, or we are only loading a file but NOT instantiating an object |
|
| 820 | + if (! $loaded || $load_only) { |
|
| 821 | + // return boolean if only loading, or null if an object was expected |
|
| 822 | + return $load_only |
|
| 823 | + ? $loaded |
|
| 824 | + : null; |
|
| 825 | + } |
|
| 826 | + } |
|
| 827 | + // instantiate the requested object |
|
| 828 | + $class_obj = $this->_create_object($class_name, $arguments, $type, $from_db); |
|
| 829 | + if ($this->_cache_on && $cache) { |
|
| 830 | + // save it for later... kinda like gum { : $ |
|
| 831 | + $this->_set_cached_class($class_obj, $class_name, $class_prefix, $from_db); |
|
| 832 | + } |
|
| 833 | + $this->_cache_on = true; |
|
| 834 | + return $class_obj; |
|
| 835 | + } |
|
| 836 | + |
|
| 837 | + |
|
| 838 | + |
|
| 839 | + /** |
|
| 840 | + * @param string $class_name |
|
| 841 | + * @param string $default have to specify something, but not anything that will conflict |
|
| 842 | + * @return mixed|string |
|
| 843 | + */ |
|
| 844 | + protected function get_class_abbreviation($class_name, $default = 'FANCY_BATMAN_PANTS') |
|
| 845 | + { |
|
| 846 | + return isset($this->_class_abbreviations[$class_name]) |
|
| 847 | + ? $this->_class_abbreviations[$class_name] |
|
| 848 | + : $default; |
|
| 849 | + } |
|
| 850 | + |
|
| 851 | + /** |
|
| 852 | + * attempts to find a cached version of the requested class |
|
| 853 | + * by looking in the following places: |
|
| 854 | + * $this->{$class_abbreviation} ie: $this->CART |
|
| 855 | + * $this->{$class_name} ie: $this->Some_Class |
|
| 856 | + * $this->LIB->{$class_name} ie: $this->LIB->Some_Class |
|
| 857 | + * $this->addon->{$class_name} ie: $this->addon->Some_Addon_Class |
|
| 858 | + * |
|
| 859 | + * @param string $class_name |
|
| 860 | + * @param string $class_prefix |
|
| 861 | + * @return mixed |
|
| 862 | + */ |
|
| 863 | + protected function _get_cached_class($class_name, $class_prefix = '') |
|
| 864 | + { |
|
| 865 | + if ($class_name === 'EE_Registry') { |
|
| 866 | + return $this; |
|
| 867 | + } |
|
| 868 | + $class_abbreviation = $this->get_class_abbreviation($class_name); |
|
| 869 | + $class_name = str_replace('\\', '_', $class_name); |
|
| 870 | + // check if class has already been loaded, and return it if it has been |
|
| 871 | + if (isset($this->{$class_abbreviation})) { |
|
| 872 | + return $this->{$class_abbreviation}; |
|
| 873 | + } |
|
| 874 | + if (isset ($this->{$class_name})) { |
|
| 875 | + return $this->{$class_name}; |
|
| 876 | + } |
|
| 877 | + if (isset ($this->LIB->{$class_name})) { |
|
| 878 | + return $this->LIB->{$class_name}; |
|
| 879 | + } |
|
| 880 | + if ($class_prefix === 'addon' && isset ($this->addons->{$class_name})) { |
|
| 881 | + return $this->addons->{$class_name}; |
|
| 882 | + } |
|
| 883 | + return null; |
|
| 884 | + } |
|
| 885 | + |
|
| 886 | + |
|
| 887 | + |
|
| 888 | + /** |
|
| 889 | + * removes a cached version of the requested class |
|
| 890 | + * |
|
| 891 | + * @param string $class_name |
|
| 892 | + * @param boolean $addon |
|
| 893 | + * @return boolean |
|
| 894 | + */ |
|
| 895 | + public function clear_cached_class($class_name, $addon = false) |
|
| 896 | + { |
|
| 897 | + $class_abbreviation = $this->get_class_abbreviation($class_name); |
|
| 898 | + $class_name = str_replace('\\', '_', $class_name); |
|
| 899 | + // check if class has already been loaded, and return it if it has been |
|
| 900 | + if (isset($this->{$class_abbreviation})) { |
|
| 901 | + $this->{$class_abbreviation} = null; |
|
| 902 | + return true; |
|
| 903 | + } |
|
| 904 | + if (isset($this->{$class_name})) { |
|
| 905 | + $this->{$class_name} = null; |
|
| 906 | + return true; |
|
| 907 | + } |
|
| 908 | + if (isset($this->LIB->{$class_name})) { |
|
| 909 | + unset($this->LIB->{$class_name}); |
|
| 910 | + return true; |
|
| 911 | + } |
|
| 912 | + if ($addon && isset($this->addons->{$class_name})) { |
|
| 913 | + unset($this->addons->{$class_name}); |
|
| 914 | + return true; |
|
| 915 | + } |
|
| 916 | + return false; |
|
| 917 | + } |
|
| 918 | + |
|
| 919 | + |
|
| 920 | + |
|
| 921 | + /** |
|
| 922 | + * attempts to find a full valid filepath for the requested class. |
|
| 923 | + * loops thru each of the base paths in the $file_paths array and appends : "{classname} . {file type} . php" |
|
| 924 | + * then returns that path if the target file has been found and is readable |
|
| 925 | + * |
|
| 926 | + * @param string $class_name |
|
| 927 | + * @param string $type |
|
| 928 | + * @param array $file_paths |
|
| 929 | + * @return string | bool |
|
| 930 | + */ |
|
| 931 | + protected function _resolve_path($class_name, $type = '', $file_paths = array()) |
|
| 932 | + { |
|
| 933 | + // make sure $file_paths is an array |
|
| 934 | + $file_paths = is_array($file_paths) |
|
| 935 | + ? $file_paths |
|
| 936 | + : array($file_paths); |
|
| 937 | + // cycle thru paths |
|
| 938 | + foreach ($file_paths as $key => $file_path) { |
|
| 939 | + // convert all separators to proper DS, if no filepath, then use EE_CLASSES |
|
| 940 | + $file_path = $file_path |
|
| 941 | + ? str_replace(array('/', '\\'), DS, $file_path) |
|
| 942 | + : EE_CLASSES; |
|
| 943 | + // prep file type |
|
| 944 | + $type = ! empty($type) |
|
| 945 | + ? trim($type, '.') . '.' |
|
| 946 | + : ''; |
|
| 947 | + // build full file path |
|
| 948 | + $file_paths[$key] = rtrim($file_path, DS) . DS . $class_name . '.' . $type . 'php'; |
|
| 949 | + //does the file exist and can be read ? |
|
| 950 | + if (is_readable($file_paths[$key])) { |
|
| 951 | + return $file_paths[$key]; |
|
| 952 | + } |
|
| 953 | + } |
|
| 954 | + return false; |
|
| 955 | + } |
|
| 956 | + |
|
| 957 | + |
|
| 958 | + |
|
| 959 | + /** |
|
| 960 | + * basically just performs a require_once() |
|
| 961 | + * but with some error handling |
|
| 962 | + * |
|
| 963 | + * @param string $path |
|
| 964 | + * @param string $class_name |
|
| 965 | + * @param string $type |
|
| 966 | + * @param array $file_paths |
|
| 967 | + * @return bool |
|
| 968 | + * @throws EE_Error |
|
| 969 | + * @throws ReflectionException |
|
| 970 | + */ |
|
| 971 | + protected function _require_file($path, $class_name, $type = '', $file_paths = array()) |
|
| 972 | + { |
|
| 973 | + // don't give up! you gotta... |
|
| 974 | + try { |
|
| 975 | + //does the file exist and can it be read ? |
|
| 976 | + if (! $path) { |
|
| 977 | + // so sorry, can't find the file |
|
| 978 | + throw new EE_Error ( |
|
| 979 | + sprintf( |
|
| 980 | + esc_html__( |
|
| 981 | + 'The %1$s file %2$s could not be located or is not readable due to file permissions. Please ensure that the following filepath(s) are correct: %3$s', |
|
| 982 | + 'event_espresso' |
|
| 983 | + ), |
|
| 984 | + trim($type, '.'), |
|
| 985 | + $class_name, |
|
| 986 | + '<br />' . implode(',<br />', $file_paths) |
|
| 987 | + ) |
|
| 988 | + ); |
|
| 989 | + } |
|
| 990 | + // get the file |
|
| 991 | + require_once($path); |
|
| 992 | + // if the class isn't already declared somewhere |
|
| 993 | + if (class_exists($class_name, false) === false) { |
|
| 994 | + // so sorry, not a class |
|
| 995 | + throw new EE_Error( |
|
| 996 | + sprintf( |
|
| 997 | + esc_html__('The %s file %s does not appear to contain the %s Class.', 'event_espresso'), |
|
| 998 | + $type, |
|
| 999 | + $path, |
|
| 1000 | + $class_name |
|
| 1001 | + ) |
|
| 1002 | + ); |
|
| 1003 | + } |
|
| 1004 | + } catch (EE_Error $e) { |
|
| 1005 | + $e->get_error(); |
|
| 1006 | + return false; |
|
| 1007 | + } |
|
| 1008 | + return true; |
|
| 1009 | + } |
|
| 1010 | + |
|
| 1011 | + |
|
| 1012 | + |
|
| 1013 | + /** |
|
| 1014 | + * _create_object |
|
| 1015 | + * Attempts to instantiate the requested class via any of the |
|
| 1016 | + * commonly used instantiation methods employed throughout EE. |
|
| 1017 | + * The priority for instantiation is as follows: |
|
| 1018 | + * - abstract classes or any class flagged as "load only" (no instantiation occurs) |
|
| 1019 | + * - model objects via their 'new_instance_from_db' method |
|
| 1020 | + * - model objects via their 'new_instance' method |
|
| 1021 | + * - "singleton" classes" via their 'instance' method |
|
| 1022 | + * - standard instantiable classes via their __constructor |
|
| 1023 | + * Prior to instantiation, if the classname exists in the dependency_map, |
|
| 1024 | + * then the constructor for the requested class will be examined to determine |
|
| 1025 | + * if any dependencies exist, and if they can be injected. |
|
| 1026 | + * If so, then those classes will be added to the array of arguments passed to the constructor |
|
| 1027 | + * |
|
| 1028 | + * @param string $class_name |
|
| 1029 | + * @param array $arguments |
|
| 1030 | + * @param string $type |
|
| 1031 | + * @param bool $from_db |
|
| 1032 | + * @return null|object |
|
| 1033 | + * @throws EE_Error |
|
| 1034 | + * @throws ReflectionException |
|
| 1035 | + */ |
|
| 1036 | + protected function _create_object($class_name, $arguments = array(), $type = '', $from_db = false) |
|
| 1037 | + { |
|
| 1038 | + // create reflection |
|
| 1039 | + $reflector = $this->get_ReflectionClass($class_name); |
|
| 1040 | + // make sure arguments are an array |
|
| 1041 | + $arguments = is_array($arguments) |
|
| 1042 | + ? $arguments |
|
| 1043 | + : array($arguments); |
|
| 1044 | + // and if arguments array is numerically and sequentially indexed, then we want it to remain as is, |
|
| 1045 | + // else wrap it in an additional array so that it doesn't get split into multiple parameters |
|
| 1046 | + $arguments = $this->_array_is_numerically_and_sequentially_indexed($arguments) |
|
| 1047 | + ? $arguments |
|
| 1048 | + : array($arguments); |
|
| 1049 | + // attempt to inject dependencies ? |
|
| 1050 | + if ($this->_dependency_map->has($class_name)) { |
|
| 1051 | + $arguments = $this->_resolve_dependencies($reflector, $class_name, $arguments); |
|
| 1052 | + } |
|
| 1053 | + // instantiate the class if possible |
|
| 1054 | + if ($reflector->isAbstract()) { |
|
| 1055 | + // nothing to instantiate, loading file was enough |
|
| 1056 | + // does not throw an exception so $instantiation_mode is unused |
|
| 1057 | + // $instantiation_mode = "1) no constructor abstract class"; |
|
| 1058 | + return true; |
|
| 1059 | + } |
|
| 1060 | + if (empty($arguments) && $reflector->getConstructor() === null && $reflector->isInstantiable()) { |
|
| 1061 | + // no constructor = static methods only... nothing to instantiate, loading file was enough |
|
| 1062 | + // $instantiation_mode = "2) no constructor but instantiable"; |
|
| 1063 | + return $reflector->newInstance(); |
|
| 1064 | + } |
|
| 1065 | + if ($from_db && method_exists($class_name, 'new_instance_from_db')) { |
|
| 1066 | + // $instantiation_mode = "3) new_instance_from_db()"; |
|
| 1067 | + return call_user_func_array(array($class_name, 'new_instance_from_db'), $arguments); |
|
| 1068 | + } |
|
| 1069 | + if (method_exists($class_name, 'new_instance')) { |
|
| 1070 | + // $instantiation_mode = "4) new_instance()"; |
|
| 1071 | + return call_user_func_array(array($class_name, 'new_instance'), $arguments); |
|
| 1072 | + } |
|
| 1073 | + if (method_exists($class_name, 'instance')) { |
|
| 1074 | + // $instantiation_mode = "5) instance()"; |
|
| 1075 | + return call_user_func_array(array($class_name, 'instance'), $arguments); |
|
| 1076 | + } |
|
| 1077 | + if ($reflector->isInstantiable()) { |
|
| 1078 | + // $instantiation_mode = "6) constructor"; |
|
| 1079 | + return $reflector->newInstanceArgs($arguments); |
|
| 1080 | + } |
|
| 1081 | + // heh ? something's not right ! |
|
| 1082 | + throw new EE_Error( |
|
| 1083 | + sprintf( |
|
| 1084 | + __('The %s file %s could not be instantiated.', 'event_espresso'), |
|
| 1085 | + $type, |
|
| 1086 | + $class_name |
|
| 1087 | + ) |
|
| 1088 | + ); |
|
| 1089 | + } |
|
| 1090 | + |
|
| 1091 | + |
|
| 1092 | + |
|
| 1093 | + /** |
|
| 1094 | + * @see http://stackoverflow.com/questions/173400/how-to-check-if-php-array-is-associative-or-sequential |
|
| 1095 | + * @param array $array |
|
| 1096 | + * @return bool |
|
| 1097 | + */ |
|
| 1098 | + protected function _array_is_numerically_and_sequentially_indexed(array $array) |
|
| 1099 | + { |
|
| 1100 | + return ! empty($array) |
|
| 1101 | + ? array_keys($array) === range(0, count($array) - 1) |
|
| 1102 | + : true; |
|
| 1103 | + } |
|
| 1104 | + |
|
| 1105 | + |
|
| 1106 | + |
|
| 1107 | + /** |
|
| 1108 | + * getReflectionClass |
|
| 1109 | + * checks if a ReflectionClass object has already been generated for a class |
|
| 1110 | + * and returns that instead of creating a new one |
|
| 1111 | + * |
|
| 1112 | + * @param string $class_name |
|
| 1113 | + * @return ReflectionClass |
|
| 1114 | + * @throws ReflectionException |
|
| 1115 | + */ |
|
| 1116 | + public function get_ReflectionClass($class_name) |
|
| 1117 | + { |
|
| 1118 | + if ( |
|
| 1119 | + ! isset($this->_reflectors[$class_name]) |
|
| 1120 | + || ! $this->_reflectors[$class_name] instanceof ReflectionClass |
|
| 1121 | + ) { |
|
| 1122 | + $this->_reflectors[$class_name] = new ReflectionClass($class_name); |
|
| 1123 | + } |
|
| 1124 | + return $this->_reflectors[$class_name]; |
|
| 1125 | + } |
|
| 1126 | + |
|
| 1127 | + |
|
| 1128 | + |
|
| 1129 | + /** |
|
| 1130 | + * _resolve_dependencies |
|
| 1131 | + * examines the constructor for the requested class to determine |
|
| 1132 | + * if any dependencies exist, and if they can be injected. |
|
| 1133 | + * If so, then those classes will be added to the array of arguments passed to the constructor |
|
| 1134 | + * PLZ NOTE: this is achieved by type hinting the constructor params |
|
| 1135 | + * For example: |
|
| 1136 | + * if attempting to load a class "Foo" with the following constructor: |
|
| 1137 | + * __construct( Bar $bar_class, Fighter $grohl_class ) |
|
| 1138 | + * then $bar_class and $grohl_class will be added to the $arguments array, |
|
| 1139 | + * but only IF they are NOT already present in the incoming arguments array, |
|
| 1140 | + * and the correct classes can be loaded |
|
| 1141 | + * |
|
| 1142 | + * @param ReflectionClass $reflector |
|
| 1143 | + * @param string $class_name |
|
| 1144 | + * @param array $arguments |
|
| 1145 | + * @return array |
|
| 1146 | + * @throws EE_Error |
|
| 1147 | + * @throws ReflectionException |
|
| 1148 | + */ |
|
| 1149 | + protected function _resolve_dependencies(ReflectionClass $reflector, $class_name, $arguments = array()) |
|
| 1150 | + { |
|
| 1151 | + // let's examine the constructor |
|
| 1152 | + $constructor = $reflector->getConstructor(); |
|
| 1153 | + // whu? huh? nothing? |
|
| 1154 | + if (! $constructor) { |
|
| 1155 | + return $arguments; |
|
| 1156 | + } |
|
| 1157 | + // get constructor parameters |
|
| 1158 | + $params = $constructor->getParameters(); |
|
| 1159 | + // and the keys for the incoming arguments array so that we can compare existing arguments with what is expected |
|
| 1160 | + $argument_keys = array_keys($arguments); |
|
| 1161 | + // now loop thru all of the constructors expected parameters |
|
| 1162 | + foreach ($params as $index => $param) { |
|
| 1163 | + // is this a dependency for a specific class ? |
|
| 1164 | + $param_class = $param->getClass() |
|
| 1165 | + ? $param->getClass()->name |
|
| 1166 | + : null; |
|
| 1167 | + // BUT WAIT !!! This class may be an alias for something else (or getting replaced at runtime) |
|
| 1168 | + $param_class = $this->_dependency_map->has_alias($param_class, $class_name) |
|
| 1169 | + ? $this->_dependency_map->get_alias($param_class, $class_name) |
|
| 1170 | + : $param_class; |
|
| 1171 | + if ( |
|
| 1172 | + // param is not even a class |
|
| 1173 | + $param_class === null |
|
| 1174 | + // and something already exists in the incoming arguments for this param |
|
| 1175 | + && array_key_exists($index, $argument_keys) |
|
| 1176 | + && array_key_exists($argument_keys[$index], $arguments) |
|
| 1177 | + ) { |
|
| 1178 | + // so let's skip this argument and move on to the next |
|
| 1179 | + continue; |
|
| 1180 | + } |
|
| 1181 | + if ( |
|
| 1182 | + // parameter is type hinted as a class, exists as an incoming argument, AND it's the correct class |
|
| 1183 | + $param_class !== null |
|
| 1184 | + && isset($argument_keys[$index], $arguments[$argument_keys[$index]]) |
|
| 1185 | + && $arguments[$argument_keys[$index]] instanceof $param_class |
|
| 1186 | + ) { |
|
| 1187 | + // skip this argument and move on to the next |
|
| 1188 | + continue; |
|
| 1189 | + } |
|
| 1190 | + if ( |
|
| 1191 | + // parameter is type hinted as a class, and should be injected |
|
| 1192 | + $param_class !== null |
|
| 1193 | + && $this->_dependency_map->has_dependency_for_class($class_name, $param_class) |
|
| 1194 | + ) { |
|
| 1195 | + $arguments = $this->_resolve_dependency( |
|
| 1196 | + $class_name, |
|
| 1197 | + $param_class, |
|
| 1198 | + $arguments, |
|
| 1199 | + $index, |
|
| 1200 | + $argument_keys |
|
| 1201 | + ); |
|
| 1202 | + } else { |
|
| 1203 | + try { |
|
| 1204 | + $arguments[$index] = $param->isDefaultValueAvailable() |
|
| 1205 | + ? $param->getDefaultValue() |
|
| 1206 | + : null; |
|
| 1207 | + } catch (ReflectionException $e) { |
|
| 1208 | + throw new ReflectionException( |
|
| 1209 | + sprintf( |
|
| 1210 | + esc_html__('%1$s for parameter "$%2$s on classname "%3$s"', 'event_espresso'), |
|
| 1211 | + $e->getMessage(), |
|
| 1212 | + $param->getName(), |
|
| 1213 | + $class_name |
|
| 1214 | + ) |
|
| 1215 | + ); |
|
| 1216 | + } |
|
| 1217 | + } |
|
| 1218 | + } |
|
| 1219 | + return $arguments; |
|
| 1220 | + } |
|
| 1221 | + |
|
| 1222 | + |
|
| 1223 | + |
|
| 1224 | + /** |
|
| 1225 | + * @param string $class_name |
|
| 1226 | + * @param string $param_class |
|
| 1227 | + * @param array $arguments |
|
| 1228 | + * @param mixed $index |
|
| 1229 | + * @param array $argument_keys |
|
| 1230 | + * @return array |
|
| 1231 | + * @throws EE_Error |
|
| 1232 | + * @throws ReflectionException |
|
| 1233 | + * @throws InvalidArgumentException |
|
| 1234 | + * @throws InvalidInterfaceException |
|
| 1235 | + * @throws InvalidDataTypeException |
|
| 1236 | + */ |
|
| 1237 | + protected function _resolve_dependency($class_name, $param_class, $arguments, $index, array $argument_keys) |
|
| 1238 | + { |
|
| 1239 | + $dependency = null; |
|
| 1240 | + // should dependency be loaded from cache ? |
|
| 1241 | + $cache_on = $this->_dependency_map->loading_strategy_for_class_dependency( |
|
| 1242 | + $class_name, |
|
| 1243 | + $param_class |
|
| 1244 | + ); |
|
| 1245 | + $cache_on = $cache_on !== EE_Dependency_Map::load_new_object; |
|
| 1246 | + // we might have a dependency... |
|
| 1247 | + // let's MAYBE try and find it in our cache if that's what's been requested |
|
| 1248 | + $cached_class = $cache_on |
|
| 1249 | + ? $this->_get_cached_class($param_class) |
|
| 1250 | + : null; |
|
| 1251 | + // and grab it if it exists |
|
| 1252 | + if ($cached_class instanceof $param_class) { |
|
| 1253 | + $dependency = $cached_class; |
|
| 1254 | + } else if ($param_class !== $class_name) { |
|
| 1255 | + // obtain the loader method from the dependency map |
|
| 1256 | + $loader = $this->_dependency_map->class_loader($param_class); |
|
| 1257 | + // is loader a custom closure ? |
|
| 1258 | + if ($loader instanceof Closure) { |
|
| 1259 | + $dependency = $loader($arguments); |
|
| 1260 | + } else { |
|
| 1261 | + // set the cache on property for the recursive loading call |
|
| 1262 | + $this->_cache_on = $cache_on; |
|
| 1263 | + // if not, then let's try and load it via the registry |
|
| 1264 | + if ($loader && method_exists($this, $loader)) { |
|
| 1265 | + $dependency = $this->{$loader}($param_class); |
|
| 1266 | + } else { |
|
| 1267 | + $dependency = LoaderFactory::getLoader()->load( |
|
| 1268 | + $param_class, |
|
| 1269 | + array(), |
|
| 1270 | + $cache_on |
|
| 1271 | + ); |
|
| 1272 | + } |
|
| 1273 | + } |
|
| 1274 | + } |
|
| 1275 | + // did we successfully find the correct dependency ? |
|
| 1276 | + if ($dependency instanceof $param_class) { |
|
| 1277 | + // then let's inject it into the incoming array of arguments at the correct location |
|
| 1278 | + $arguments[$index] = $dependency; |
|
| 1279 | + } |
|
| 1280 | + return $arguments; |
|
| 1281 | + } |
|
| 1282 | + |
|
| 1283 | + |
|
| 1284 | + |
|
| 1285 | + /** |
|
| 1286 | + * _set_cached_class |
|
| 1287 | + * attempts to cache the instantiated class locally |
|
| 1288 | + * in one of the following places, in the following order: |
|
| 1289 | + * $this->{class_abbreviation} ie: $this->CART |
|
| 1290 | + * $this->{$class_name} ie: $this->Some_Class |
|
| 1291 | + * $this->addon->{$$class_name} ie: $this->addon->Some_Addon_Class |
|
| 1292 | + * $this->LIB->{$class_name} ie: $this->LIB->Some_Class |
|
| 1293 | + * |
|
| 1294 | + * @param object $class_obj |
|
| 1295 | + * @param string $class_name |
|
| 1296 | + * @param string $class_prefix |
|
| 1297 | + * @param bool $from_db |
|
| 1298 | + * @return void |
|
| 1299 | + */ |
|
| 1300 | + protected function _set_cached_class($class_obj, $class_name, $class_prefix = '', $from_db = false) |
|
| 1301 | + { |
|
| 1302 | + if ($class_name === 'EE_Registry' || empty($class_obj)) { |
|
| 1303 | + return; |
|
| 1304 | + } |
|
| 1305 | + // return newly instantiated class |
|
| 1306 | + $class_abbreviation = $this->get_class_abbreviation($class_name, ''); |
|
| 1307 | + if ($class_abbreviation) { |
|
| 1308 | + $this->{$class_abbreviation} = $class_obj; |
|
| 1309 | + return; |
|
| 1310 | + } |
|
| 1311 | + $class_name = str_replace('\\', '_', $class_name); |
|
| 1312 | + if (property_exists($this, $class_name)) { |
|
| 1313 | + $this->{$class_name} = $class_obj; |
|
| 1314 | + return; |
|
| 1315 | + } |
|
| 1316 | + if ($class_prefix === 'addon') { |
|
| 1317 | + $this->addons->{$class_name} = $class_obj; |
|
| 1318 | + return; |
|
| 1319 | + } |
|
| 1320 | + if (! $from_db) { |
|
| 1321 | + $this->LIB->{$class_name} = $class_obj; |
|
| 1322 | + } |
|
| 1323 | + } |
|
| 1324 | + |
|
| 1325 | + |
|
| 1326 | + |
|
| 1327 | + /** |
|
| 1328 | + * call any loader that's been registered in the EE_Dependency_Map::$_class_loaders array |
|
| 1329 | + * |
|
| 1330 | + * @param string $classname PLEASE NOTE: the class name needs to match what's registered |
|
| 1331 | + * in the EE_Dependency_Map::$_class_loaders array, |
|
| 1332 | + * including the class prefix, ie: "EE_", "EEM_", "EEH_", etc |
|
| 1333 | + * @param array $arguments |
|
| 1334 | + * @return object |
|
| 1335 | + */ |
|
| 1336 | + public static function factory($classname, $arguments = array()) |
|
| 1337 | + { |
|
| 1338 | + $loader = self::instance()->_dependency_map->class_loader($classname); |
|
| 1339 | + if ($loader instanceof Closure) { |
|
| 1340 | + return $loader($arguments); |
|
| 1341 | + } |
|
| 1342 | + if (method_exists(self::instance(), $loader)) { |
|
| 1343 | + return self::instance()->{$loader}($classname, $arguments); |
|
| 1344 | + } |
|
| 1345 | + return null; |
|
| 1346 | + } |
|
| 1347 | + |
|
| 1348 | + |
|
| 1349 | + |
|
| 1350 | + /** |
|
| 1351 | + * Gets the addon by its name/slug (not classname. For that, just |
|
| 1352 | + * use the classname as the property name on EE_Config::instance()->addons) |
|
| 1353 | + * |
|
| 1354 | + * @param string $name |
|
| 1355 | + * @return EE_Addon |
|
| 1356 | + */ |
|
| 1357 | + public function get_addon_by_name($name) |
|
| 1358 | + { |
|
| 1359 | + foreach ($this->addons as $addon) { |
|
| 1360 | + if ($addon->name() === $name) { |
|
| 1361 | + return $addon; |
|
| 1362 | + } |
|
| 1363 | + } |
|
| 1364 | + return null; |
|
| 1365 | + } |
|
| 1366 | + |
|
| 1367 | + |
|
| 1368 | + |
|
| 1369 | + /** |
|
| 1370 | + * Gets an array of all the registered addons, where the keys are their names. (ie, what each returns for their |
|
| 1371 | + * name() function) They're already available on EE_Config::instance()->addons as properties, where each property's |
|
| 1372 | + * name is the addon's classname. So if you just want to get the addon by classname, use |
|
| 1373 | + * EE_Config::instance()->addons->{classname} |
|
| 1374 | + * |
|
| 1375 | + * @return EE_Addon[] where the KEYS are the addon's name() |
|
| 1376 | + */ |
|
| 1377 | + public function get_addons_by_name() |
|
| 1378 | + { |
|
| 1379 | + $addons = array(); |
|
| 1380 | + foreach ($this->addons as $addon) { |
|
| 1381 | + $addons[$addon->name()] = $addon; |
|
| 1382 | + } |
|
| 1383 | + return $addons; |
|
| 1384 | + } |
|
| 1385 | + |
|
| 1386 | + |
|
| 1387 | + |
|
| 1388 | + /** |
|
| 1389 | + * Resets the specified model's instance AND makes sure EE_Registry doesn't keep |
|
| 1390 | + * a stale copy of it around |
|
| 1391 | + * |
|
| 1392 | + * @param string $model_name |
|
| 1393 | + * @return \EEM_Base |
|
| 1394 | + * @throws \EE_Error |
|
| 1395 | + */ |
|
| 1396 | + public function reset_model($model_name) |
|
| 1397 | + { |
|
| 1398 | + $model_class_name = strpos($model_name, 'EEM_') !== 0 |
|
| 1399 | + ? "EEM_{$model_name}" |
|
| 1400 | + : $model_name; |
|
| 1401 | + if (! isset($this->LIB->{$model_class_name}) || ! $this->LIB->{$model_class_name} instanceof EEM_Base) { |
|
| 1402 | + return null; |
|
| 1403 | + } |
|
| 1404 | + //get that model reset it and make sure we nuke the old reference to it |
|
| 1405 | + if ($this->LIB->{$model_class_name} instanceof $model_class_name |
|
| 1406 | + && is_callable( |
|
| 1407 | + array($model_class_name, 'reset') |
|
| 1408 | + )) { |
|
| 1409 | + $this->LIB->{$model_class_name} = $this->LIB->{$model_class_name}->reset(); |
|
| 1410 | + } else { |
|
| 1411 | + throw new EE_Error(sprintf(esc_html__('Model %s does not have a method "reset"', 'event_espresso'), $model_name)); |
|
| 1412 | + } |
|
| 1413 | + return $this->LIB->{$model_class_name}; |
|
| 1414 | + } |
|
| 1415 | + |
|
| 1416 | + |
|
| 1417 | + |
|
| 1418 | + /** |
|
| 1419 | + * Resets the registry. |
|
| 1420 | + * The criteria for what gets reset is based on what can be shared between sites on the same request when |
|
| 1421 | + * switch_to_blog is used in a multisite install. Here is a list of things that are NOT reset. |
|
| 1422 | + * - $_dependency_map |
|
| 1423 | + * - $_class_abbreviations |
|
| 1424 | + * - $NET_CFG (EE_Network_Config): The config is shared network wide so no need to reset. |
|
| 1425 | + * - $REQ: Still on the same request so no need to change. |
|
| 1426 | + * - $CAP: There is no site specific state in the EE_Capability class. |
|
| 1427 | + * - $SSN: Although ideally, the session should not be shared between site switches, we can't reset it because only |
|
| 1428 | + * one Session can be active in a single request. Resetting could resolve in "headers already sent" errors. |
|
| 1429 | + * - $addons: In multisite, the state of the addons is something controlled via hooks etc in a normal request. So |
|
| 1430 | + * for now, we won't reset the addons because it could break calls to an add-ons class/methods in the |
|
| 1431 | + * switch or on the restore. |
|
| 1432 | + * - $modules |
|
| 1433 | + * - $shortcodes |
|
| 1434 | + * - $widgets |
|
| 1435 | + * |
|
| 1436 | + * @param boolean $hard [deprecated] |
|
| 1437 | + * @param boolean $reinstantiate whether to create new instances of EE_Registry's singletons too, |
|
| 1438 | + * or just reset without re-instantiating (handy to set to FALSE if you're not |
|
| 1439 | + * sure if you CAN currently reinstantiate the singletons at the moment) |
|
| 1440 | + * @param bool $reset_models Defaults to true. When false, then the models are not reset. This is so |
|
| 1441 | + * client |
|
| 1442 | + * code instead can just change the model context to a different blog id if |
|
| 1443 | + * necessary |
|
| 1444 | + * @return EE_Registry |
|
| 1445 | + * @throws EE_Error |
|
| 1446 | + * @throws ReflectionException |
|
| 1447 | + */ |
|
| 1448 | + public static function reset($hard = false, $reinstantiate = true, $reset_models = true) |
|
| 1449 | + { |
|
| 1450 | + $instance = self::instance(); |
|
| 1451 | + $instance->_cache_on = true; |
|
| 1452 | + // reset some "special" classes |
|
| 1453 | + EEH_Activation::reset(); |
|
| 1454 | + $hard = apply_filters( 'FHEE__EE_Registry__reset__hard', $hard); |
|
| 1455 | + $instance->CFG = EE_Config::reset($hard, $reinstantiate); |
|
| 1456 | + $instance->CART = null; |
|
| 1457 | + $instance->MRM = null; |
|
| 1458 | + $instance->AssetsRegistry = $instance->create('EventEspresso\core\services\assets\Registry'); |
|
| 1459 | + //messages reset |
|
| 1460 | + EED_Messages::reset(); |
|
| 1461 | + //handle of objects cached on LIB |
|
| 1462 | + foreach (array('LIB', 'modules') as $cache) { |
|
| 1463 | + foreach ($instance->{$cache} as $class_name => $class) { |
|
| 1464 | + if (self::_reset_and_unset_object($class, $reset_models)) { |
|
| 1465 | + unset($instance->{$cache}->{$class_name}); |
|
| 1466 | + } |
|
| 1467 | + } |
|
| 1468 | + } |
|
| 1469 | + return $instance; |
|
| 1470 | + } |
|
| 1471 | + |
|
| 1472 | + |
|
| 1473 | + |
|
| 1474 | + /** |
|
| 1475 | + * if passed object implements ResettableInterface, then call it's reset() method |
|
| 1476 | + * if passed object implements InterminableInterface, then return false, |
|
| 1477 | + * to indicate that it should NOT be cleared from the Registry cache |
|
| 1478 | + * |
|
| 1479 | + * @param $object |
|
| 1480 | + * @param bool $reset_models |
|
| 1481 | + * @return bool returns true if cached object should be unset |
|
| 1482 | + */ |
|
| 1483 | + private static function _reset_and_unset_object($object, $reset_models) |
|
| 1484 | + { |
|
| 1485 | + if (! is_object($object)) { |
|
| 1486 | + // don't unset anything that's not an object |
|
| 1487 | + return false; |
|
| 1488 | + } |
|
| 1489 | + if ($object instanceof EED_Module) { |
|
| 1490 | + $object::reset(); |
|
| 1491 | + // don't unset modules |
|
| 1492 | + return false; |
|
| 1493 | + } |
|
| 1494 | + if ($object instanceof ResettableInterface) { |
|
| 1495 | + if ($object instanceof EEM_Base) { |
|
| 1496 | + if ($reset_models) { |
|
| 1497 | + $object->reset(); |
|
| 1498 | + return true; |
|
| 1499 | + } |
|
| 1500 | + return false; |
|
| 1501 | + } |
|
| 1502 | + $object->reset(); |
|
| 1503 | + return true; |
|
| 1504 | + } |
|
| 1505 | + if (! $object instanceof InterminableInterface) { |
|
| 1506 | + return true; |
|
| 1507 | + } |
|
| 1508 | + return false; |
|
| 1509 | + } |
|
| 1510 | + |
|
| 1511 | + |
|
| 1512 | + |
|
| 1513 | + /** |
|
| 1514 | + * Gets all the custom post type models defined |
|
| 1515 | + * |
|
| 1516 | + * @return array keys are model "short names" (Eg "Event") and keys are classnames (eg "EEM_Event") |
|
| 1517 | + */ |
|
| 1518 | + public function cpt_models() |
|
| 1519 | + { |
|
| 1520 | + $cpt_models = array(); |
|
| 1521 | + foreach ($this->non_abstract_db_models as $short_name => $classname) { |
|
| 1522 | + if (is_subclass_of($classname, 'EEM_CPT_Base')) { |
|
| 1523 | + $cpt_models[$short_name] = $classname; |
|
| 1524 | + } |
|
| 1525 | + } |
|
| 1526 | + return $cpt_models; |
|
| 1527 | + } |
|
| 1528 | + |
|
| 1529 | + |
|
| 1530 | + |
|
| 1531 | + /** |
|
| 1532 | + * @return \EE_Config |
|
| 1533 | + */ |
|
| 1534 | + public static function CFG() |
|
| 1535 | + { |
|
| 1536 | + return self::instance()->CFG; |
|
| 1537 | + } |
|
| 1538 | 1538 | |
| 1539 | 1539 | |
| 1540 | 1540 | } |
@@ -176,7 +176,7 @@ discard block |
||
| 176 | 176 | public static function instance(EE_Dependency_Map $dependency_map = null) |
| 177 | 177 | { |
| 178 | 178 | // check if class object is instantiated |
| 179 | - if (! self::$_instance instanceof EE_Registry) { |
|
| 179 | + if ( ! self::$_instance instanceof EE_Registry) { |
|
| 180 | 180 | self::$_instance = new self($dependency_map); |
| 181 | 181 | } |
| 182 | 182 | return self::$_instance; |
@@ -266,13 +266,13 @@ discard block |
||
| 266 | 266 | */ |
| 267 | 267 | public static function localize_i18n_js_strings() |
| 268 | 268 | { |
| 269 | - $i18n_js_strings = (array)self::$i18n_js_strings; |
|
| 269 | + $i18n_js_strings = (array) self::$i18n_js_strings; |
|
| 270 | 270 | foreach ($i18n_js_strings as $key => $value) { |
| 271 | 271 | if (is_scalar($value)) { |
| 272 | - $i18n_js_strings[$key] = html_entity_decode((string)$value, ENT_QUOTES, 'UTF-8'); |
|
| 272 | + $i18n_js_strings[$key] = html_entity_decode((string) $value, ENT_QUOTES, 'UTF-8'); |
|
| 273 | 273 | } |
| 274 | 274 | } |
| 275 | - return '/* <![CDATA[ */ var eei18n = ' . wp_json_encode($i18n_js_strings) . '; /* ]]> */'; |
|
| 275 | + return '/* <![CDATA[ */ var eei18n = '.wp_json_encode($i18n_js_strings).'; /* ]]> */'; |
|
| 276 | 276 | } |
| 277 | 277 | |
| 278 | 278 | |
@@ -288,7 +288,7 @@ discard block |
||
| 288 | 288 | $module_class = get_class($module); |
| 289 | 289 | $this->modules->{$module_class} = $module; |
| 290 | 290 | } else { |
| 291 | - if (! class_exists('EE_Module_Request_Router')) { |
|
| 291 | + if ( ! class_exists('EE_Module_Request_Router')) { |
|
| 292 | 292 | $this->load_core('Module_Request_Router'); |
| 293 | 293 | } |
| 294 | 294 | EE_Module_Request_Router::module_factory($module); |
@@ -328,10 +328,10 @@ discard block |
||
| 328 | 328 | EE_CORE, |
| 329 | 329 | EE_ADMIN, |
| 330 | 330 | EE_CPTS, |
| 331 | - EE_CORE . 'data_migration_scripts' . DS, |
|
| 332 | - EE_CORE . 'capabilities' . DS, |
|
| 333 | - EE_CORE . 'request_stack' . DS, |
|
| 334 | - EE_CORE . 'middleware' . DS, |
|
| 331 | + EE_CORE.'data_migration_scripts'.DS, |
|
| 332 | + EE_CORE.'capabilities'.DS, |
|
| 333 | + EE_CORE.'request_stack'.DS, |
|
| 334 | + EE_CORE.'middleware'.DS, |
|
| 335 | 335 | ) |
| 336 | 336 | ); |
| 337 | 337 | // retrieve instantiated class |
@@ -364,7 +364,7 @@ discard block |
||
| 364 | 364 | $service_paths = apply_filters( |
| 365 | 365 | 'FHEE__EE_Registry__load_service__service_paths', |
| 366 | 366 | array( |
| 367 | - EE_CORE . 'services' . DS, |
|
| 367 | + EE_CORE.'services'.DS, |
|
| 368 | 368 | ) |
| 369 | 369 | ); |
| 370 | 370 | // retrieve instantiated class |
@@ -490,10 +490,10 @@ discard block |
||
| 490 | 490 | { |
| 491 | 491 | $paths = array( |
| 492 | 492 | EE_LIBRARIES, |
| 493 | - EE_LIBRARIES . 'messages' . DS, |
|
| 494 | - EE_LIBRARIES . 'shortcodes' . DS, |
|
| 495 | - EE_LIBRARIES . 'qtips' . DS, |
|
| 496 | - EE_LIBRARIES . 'payment_methods' . DS, |
|
| 493 | + EE_LIBRARIES.'messages'.DS, |
|
| 494 | + EE_LIBRARIES.'shortcodes'.DS, |
|
| 495 | + EE_LIBRARIES.'qtips'.DS, |
|
| 496 | + EE_LIBRARIES.'payment_methods'.DS, |
|
| 497 | 497 | ); |
| 498 | 498 | // retrieve instantiated class |
| 499 | 499 | return $this->_load( |
@@ -556,10 +556,10 @@ discard block |
||
| 556 | 556 | public function load_model_class($class_name, $arguments = array(), $load_only = true) |
| 557 | 557 | { |
| 558 | 558 | $paths = array( |
| 559 | - EE_MODELS . 'fields' . DS, |
|
| 560 | - EE_MODELS . 'helpers' . DS, |
|
| 561 | - EE_MODELS . 'relations' . DS, |
|
| 562 | - EE_MODELS . 'strategies' . DS, |
|
| 559 | + EE_MODELS.'fields'.DS, |
|
| 560 | + EE_MODELS.'helpers'.DS, |
|
| 561 | + EE_MODELS.'relations'.DS, |
|
| 562 | + EE_MODELS.'strategies'.DS, |
|
| 563 | 563 | ); |
| 564 | 564 | // retrieve instantiated class |
| 565 | 565 | return $this->_load( |
@@ -678,7 +678,7 @@ discard block |
||
| 678 | 678 | $class_exists = $this->loadOrVerifyClassExists($class_name, $arguments); |
| 679 | 679 | // if a non-FQCN was passed, then verifyClassExists() might return an object |
| 680 | 680 | // or it could return null if the class just could not be found anywhere |
| 681 | - if ($class_exists instanceof $class_name || $class_exists === null){ |
|
| 681 | + if ($class_exists instanceof $class_name || $class_exists === null) { |
|
| 682 | 682 | // either way, return the results |
| 683 | 683 | return $class_exists; |
| 684 | 684 | } |
@@ -736,7 +736,7 @@ discard block |
||
| 736 | 736 | case 1: |
| 737 | 737 | // if it's a FQCN then maybe the class is registered with a preceding \ |
| 738 | 738 | $class_name = strpos($class_name, '\\') !== false |
| 739 | - ? '\\' . ltrim($class_name, '\\') |
|
| 739 | + ? '\\'.ltrim($class_name, '\\') |
|
| 740 | 740 | : $class_name; |
| 741 | 741 | break; |
| 742 | 742 | case 2: |
@@ -788,11 +788,11 @@ discard block |
||
| 788 | 788 | // strip php file extension |
| 789 | 789 | $class_name = str_replace('.php', '', trim($class_name)); |
| 790 | 790 | // does the class have a prefix ? |
| 791 | - if (! empty($class_prefix) && $class_prefix !== 'addon') { |
|
| 791 | + if ( ! empty($class_prefix) && $class_prefix !== 'addon') { |
|
| 792 | 792 | // make sure $class_prefix is uppercase |
| 793 | 793 | $class_prefix = strtoupper(trim($class_prefix)); |
| 794 | 794 | // add class prefix ONCE!!! |
| 795 | - $class_name = $class_prefix . str_replace($class_prefix, '', $class_name); |
|
| 795 | + $class_name = $class_prefix.str_replace($class_prefix, '', $class_name); |
|
| 796 | 796 | } |
| 797 | 797 | $class_name = $this->_dependency_map->get_alias($class_name); |
| 798 | 798 | $class_exists = class_exists($class_name); |
@@ -811,13 +811,13 @@ discard block |
||
| 811 | 811 | } |
| 812 | 812 | } |
| 813 | 813 | // if the class doesn't already exist.. then we need to try and find the file and load it |
| 814 | - if (! $class_exists) { |
|
| 814 | + if ( ! $class_exists) { |
|
| 815 | 815 | // get full path to file |
| 816 | 816 | $path = $this->_resolve_path($class_name, $type, $file_paths); |
| 817 | 817 | // load the file |
| 818 | 818 | $loaded = $this->_require_file($path, $class_name, $type, $file_paths); |
| 819 | 819 | // if loading failed, or we are only loading a file but NOT instantiating an object |
| 820 | - if (! $loaded || $load_only) { |
|
| 820 | + if ( ! $loaded || $load_only) { |
|
| 821 | 821 | // return boolean if only loading, or null if an object was expected |
| 822 | 822 | return $load_only |
| 823 | 823 | ? $loaded |
@@ -942,10 +942,10 @@ discard block |
||
| 942 | 942 | : EE_CLASSES; |
| 943 | 943 | // prep file type |
| 944 | 944 | $type = ! empty($type) |
| 945 | - ? trim($type, '.') . '.' |
|
| 945 | + ? trim($type, '.').'.' |
|
| 946 | 946 | : ''; |
| 947 | 947 | // build full file path |
| 948 | - $file_paths[$key] = rtrim($file_path, DS) . DS . $class_name . '.' . $type . 'php'; |
|
| 948 | + $file_paths[$key] = rtrim($file_path, DS).DS.$class_name.'.'.$type.'php'; |
|
| 949 | 949 | //does the file exist and can be read ? |
| 950 | 950 | if (is_readable($file_paths[$key])) { |
| 951 | 951 | return $file_paths[$key]; |
@@ -973,9 +973,9 @@ discard block |
||
| 973 | 973 | // don't give up! you gotta... |
| 974 | 974 | try { |
| 975 | 975 | //does the file exist and can it be read ? |
| 976 | - if (! $path) { |
|
| 976 | + if ( ! $path) { |
|
| 977 | 977 | // so sorry, can't find the file |
| 978 | - throw new EE_Error ( |
|
| 978 | + throw new EE_Error( |
|
| 979 | 979 | sprintf( |
| 980 | 980 | esc_html__( |
| 981 | 981 | 'The %1$s file %2$s could not be located or is not readable due to file permissions. Please ensure that the following filepath(s) are correct: %3$s', |
@@ -983,7 +983,7 @@ discard block |
||
| 983 | 983 | ), |
| 984 | 984 | trim($type, '.'), |
| 985 | 985 | $class_name, |
| 986 | - '<br />' . implode(',<br />', $file_paths) |
|
| 986 | + '<br />'.implode(',<br />', $file_paths) |
|
| 987 | 987 | ) |
| 988 | 988 | ); |
| 989 | 989 | } |
@@ -1151,7 +1151,7 @@ discard block |
||
| 1151 | 1151 | // let's examine the constructor |
| 1152 | 1152 | $constructor = $reflector->getConstructor(); |
| 1153 | 1153 | // whu? huh? nothing? |
| 1154 | - if (! $constructor) { |
|
| 1154 | + if ( ! $constructor) { |
|
| 1155 | 1155 | return $arguments; |
| 1156 | 1156 | } |
| 1157 | 1157 | // get constructor parameters |
@@ -1317,7 +1317,7 @@ discard block |
||
| 1317 | 1317 | $this->addons->{$class_name} = $class_obj; |
| 1318 | 1318 | return; |
| 1319 | 1319 | } |
| 1320 | - if (! $from_db) { |
|
| 1320 | + if ( ! $from_db) { |
|
| 1321 | 1321 | $this->LIB->{$class_name} = $class_obj; |
| 1322 | 1322 | } |
| 1323 | 1323 | } |
@@ -1398,7 +1398,7 @@ discard block |
||
| 1398 | 1398 | $model_class_name = strpos($model_name, 'EEM_') !== 0 |
| 1399 | 1399 | ? "EEM_{$model_name}" |
| 1400 | 1400 | : $model_name; |
| 1401 | - if (! isset($this->LIB->{$model_class_name}) || ! $this->LIB->{$model_class_name} instanceof EEM_Base) { |
|
| 1401 | + if ( ! isset($this->LIB->{$model_class_name}) || ! $this->LIB->{$model_class_name} instanceof EEM_Base) { |
|
| 1402 | 1402 | return null; |
| 1403 | 1403 | } |
| 1404 | 1404 | //get that model reset it and make sure we nuke the old reference to it |
@@ -1451,7 +1451,7 @@ discard block |
||
| 1451 | 1451 | $instance->_cache_on = true; |
| 1452 | 1452 | // reset some "special" classes |
| 1453 | 1453 | EEH_Activation::reset(); |
| 1454 | - $hard = apply_filters( 'FHEE__EE_Registry__reset__hard', $hard); |
|
| 1454 | + $hard = apply_filters('FHEE__EE_Registry__reset__hard', $hard); |
|
| 1455 | 1455 | $instance->CFG = EE_Config::reset($hard, $reinstantiate); |
| 1456 | 1456 | $instance->CART = null; |
| 1457 | 1457 | $instance->MRM = null; |
@@ -1482,7 +1482,7 @@ discard block |
||
| 1482 | 1482 | */ |
| 1483 | 1483 | private static function _reset_and_unset_object($object, $reset_models) |
| 1484 | 1484 | { |
| 1485 | - if (! is_object($object)) { |
|
| 1485 | + if ( ! is_object($object)) { |
|
| 1486 | 1486 | // don't unset anything that's not an object |
| 1487 | 1487 | return false; |
| 1488 | 1488 | } |
@@ -1502,7 +1502,7 @@ discard block |
||
| 1502 | 1502 | $object->reset(); |
| 1503 | 1503 | return true; |
| 1504 | 1504 | } |
| 1505 | - if (! $object instanceof InterminableInterface) { |
|
| 1505 | + if ( ! $object instanceof InterminableInterface) { |
|
| 1506 | 1506 | return true; |
| 1507 | 1507 | } |
| 1508 | 1508 | return false; |