Cavemanon/piratepoet
7
Fork 0
Code Pull Requests Actions Releases 16 Activity

Convert variable names to camel case

Browse Source 
[MAILPOET-1796]
This commit is contained in:
Jan Jakeš
2020-01-09 15:02:58 +01:00
committed by Jan Jakeš
parent f5da704106
commit 54549ff037
687 changed files with 15890 additions and 15887 deletions
Download Patch File Download Diff File Expand all files Collapse all files

238
lib/Models/Subscriber.php
View File

@ -102,23 +102,23 @@ class Subscriber extends Model {
}
public function isWPUser() {
return (bool)$this->wp_user_id;
return (bool)$this->wpUserId;
}
public function isWooCommerceUser() {
return (bool)$this->is_woocommerce_user;
return (bool)$this->isWoocommerceUser;
}
public static function getCurrentWPUser() {
$wp_user = WPFunctions::get()->wpGetCurrentUser();
if (empty($wp_user->ID)) {
$wpUser = WPFunctions::get()->wpGetCurrentUser();
if (empty($wpUser->ID)) {
return false; // Don't look up a subscriber for guests
}
return self::where('wp_user_id', $wp_user->ID)->findOne();
return self::where('wp_user_id', $wpUser->ID)->findOne();
}
public static function filterOutReservedColumns(array $subscriber_data) {
$reserved_columns = [
public static function filterOutReservedColumns(array $subscriberData) {
$reservedColumns = [
'id',
'wp_user_id',
'is_woocommerce_user',
@ -131,11 +131,11 @@ class Subscriber extends Model {
'deleted_at',
'unconfirmed_data',
];
$subscriber_data = array_diff_key(
$subscriber_data,
array_flip($reserved_columns)
$subscriberData = array_diff_key(
$subscriberData,
array_flip($reservedColumns)
);
return $subscriber_data;
return $subscriberData;
}
public static function search($orm, $search = '') {
@ -156,47 +156,47 @@ class Subscriber extends Model {
->whereNull('deleted_at')
->whereIn('type', Segment::getSegmentTypes())
->findMany();
$segment_list = [];
$segment_list[] = [
$segmentList = [];
$segmentList[] = [
'label' => WPFunctions::get()->__('All Lists', 'mailpoet'),
'value' => '',
];
$subscribers_without_segment = self::filter('withoutSegments')
$subscribersWithoutSegment = self::filter('withoutSegments')
->whereNull('deleted_at')
->count();
$subscribers_without_segment_label = sprintf(
$subscribersWithoutSegmentLabel = sprintf(
WPFunctions::get()->__('Subscribers without a list (%s)', 'mailpoet'),
number_format($subscribers_without_segment)
number_format($subscribersWithoutSegment)
);
$segment_list[] = [
'label' => $subscribers_without_segment_label,
$segmentList[] = [
'label' => $subscribersWithoutSegmentLabel,
'value' => 'none',
];
foreach ($segments as $segment) {
$subscribers_count = 0;
$subscribersCount = 0;
$subscribers = $segment->subscribers()
->filter('groupBy', $group);
if ($subscribers) {
$subscribers_count = $subscribers->count();
$subscribersCount = $subscribers->count();
}
$label = sprintf(
'%s (%s)',
$segment->name,
number_format($subscribers_count)
number_format($subscribersCount)
);
$segment_list[] = [
$segmentList[] = [
'label' => $label,
'value' => $segment->id(),
];
}
$filters = [
'segment' => $segment_list,
'segment' => $segmentList,
];
return $filters;
@ -329,9 +329,9 @@ class Subscriber extends Model {
return $orm;
}
public static function getSubscribedInSegments($segment_ids) {
public static function getSubscribedInSegments($segmentIds) {
$subscribers = SubscriberSegment::tableAlias('relation')
->whereIn('relation.segment_id', $segment_ids)
->whereIn('relation.segment_id', $segmentIds)
->where('relation.status', 'subscribed')
->join(
MP_SUBSCRIBERS_TABLE,
@ -349,17 +349,17 @@ class Subscriber extends Model {
* @param string $customer_email
* @return bool|Subscriber
*/
public static function getWooCommerceSegmentSubscriber($customer_email) {
$wc_segment = Segment::getWooCommerceSegment();
public static function getWooCommerceSegmentSubscriber($customerEmail) {
$wcSegment = Segment::getWooCommerceSegment();
return Subscriber::tableAlias('subscribers')
->select('subscribers.*')
->where('subscribers.email', $customer_email)
->where('subscribers.email', $customerEmail)
->join(
MP_SUBSCRIBER_SEGMENT_TABLE,
'relation.subscriber_id = subscribers.id',
'relation'
)
->where('relation.segment_id', $wc_segment->id)
->where('relation.segment_id', $wcSegment->id)
->where('relation.status', Subscriber::STATUS_SUBSCRIBED)
->where('subscribers.status', Subscriber::STATUS_SUBSCRIBED)
->where('subscribers.is_woocommerce_user', 1)
@ -394,9 +394,9 @@ class Subscriber extends Model {
}
// segments
$segment_ids = false;
$segmentIds = false;
if (array_key_exists('segments', $data)) {
$segment_ids = (array)$data['segments'];
$segmentIds = (array)$data['segments'];
unset($data['segments']);
}
@ -406,44 +406,44 @@ class Subscriber extends Model {
}
// get custom fields
list($data, $custom_fields) = self::extractCustomFieldsFromFromObject($data);
list($data, $customFields) = self::extractCustomFieldsFromFromObject($data);
// wipe any unconfirmed data at this point
$data['unconfirmed_data'] = null;
$old_status = false;
$new_status = false;
$oldStatus = false;
$newStatus = false;
if ($subscriber === false) {
$subscriber = self::create();
$subscriber->hydrate($data);
} else {
$old_status = $subscriber->status;
$oldStatus = $subscriber->status;
$subscriber->set($data);
$new_status = $subscriber->status;
$newStatus = $subscriber->status;
}
// Update last_subscribed_at when status changes to subscribed
if ($old_status !== self::STATUS_SUBSCRIBED && $subscriber->status === self::STATUS_SUBSCRIBED) {
if ($oldStatus !== self::STATUS_SUBSCRIBED && $subscriber->status === self::STATUS_SUBSCRIBED) {
$subscriber->set('last_subscribed_at', WPFunctions::get()->currentTime('mysql'));
}
if ($subscriber->save()) {
if (!empty($custom_fields)) {
$subscriber->saveCustomFields($custom_fields);
if (!empty($customFields)) {
$subscriber->saveCustomFields($customFields);
}
// check for status change
if (
($old_status === self::STATUS_SUBSCRIBED)
($oldStatus === self::STATUS_SUBSCRIBED)
&&
($new_status === self::STATUS_UNSUBSCRIBED)
($newStatus === self::STATUS_UNSUBSCRIBED)
) {
// make sure we unsubscribe the user from all segments
SubscriberSegment::unsubscribeFromSegments($subscriber);
} else {
if ($segment_ids !== false) {
SubscriberSegment::resetSubscriptions($subscriber, $segment_ids);
if ($segmentIds !== false) {
SubscriberSegment::resetSubscriptions($subscriber, $segmentIds);
}
}
}
@ -451,17 +451,17 @@ class Subscriber extends Model {
}
public function withCustomFields() {
$custom_fields = CustomField::select('id')->findArray();
if (empty($custom_fields)) return $this;
$customFields = CustomField::select('id')->findArray();
if (empty($customFields)) return $this;
$custom_field_ids = array_column($custom_fields, 'id');
$customFieldIds = array_column($customFields, 'id');
$relations = SubscriberCustomField::select('custom_field_id')
->select('value')
->whereIn('custom_field_id', $custom_field_ids)
->whereIn('custom_field_id', $customFieldIds)
->where('subscriber_id', $this->id())
->findMany();
foreach ($relations as $relation) {
$this->{'cf_' . $relation->custom_field_id} = $relation->value;
$this->{'cf_' . $relation->customFieldId} = $relation->value;
}
return $this;
@ -478,73 +478,73 @@ class Subscriber extends Model {
return $this;
}
public function getCustomField($custom_field_id, $default = null) {
$custom_field = SubscriberCustomField::select('value')
->where('custom_field_id', $custom_field_id)
public function getCustomField($customFieldId, $default = null) {
$customField = SubscriberCustomField::select('value')
->where('custom_field_id', $customFieldId)
->where('subscriber_id', $this->id())
->findOne();
if ($custom_field instanceof SubscriberCustomField) {
return $custom_field->value;
if ($customField instanceof SubscriberCustomField) {
return $customField->value;
} else {
return $default;
}
}
public function saveCustomFields($custom_fields_data = []) {
public function saveCustomFields($customFieldsData = []) {
// get custom field ids
$custom_field_ids = array_keys($custom_fields_data);
$customFieldIds = array_keys($customFieldsData);
// get custom fields
$custom_fields = CustomField::whereIdIn($custom_field_ids)->findMany();
$customFields = CustomField::whereIdIn($customFieldIds)->findMany();
foreach ($custom_fields as $custom_field) {
$value = (isset($custom_fields_data[$custom_field->id])
? $custom_fields_data[$custom_field->id]
foreach ($customFields as $customField) {
$value = (isset($customFieldsData[$customField->id])
? $customFieldsData[$customField->id]
: null
);
// format value
$value = $custom_field->formatValue($value);
$value = $customField->formatValue($value);
$this->setCustomField($custom_field->id, $value);
$this->setCustomField($customField->id, $value);
}
}
public function setCustomField($custom_field_id, $value) {
public function setCustomField($customFieldId, $value) {
return SubscriberCustomField::createOrUpdate([
'subscriber_id' => $this->id(),
'custom_field_id' => $custom_field_id,
'custom_field_id' => $customFieldId,
'value' => $value,
]);
}
public function setUnconfirmedData(array $subscriber_data) {
$subscriber_data = self::filterOutReservedColumns($subscriber_data);
$encoded = json_encode($subscriber_data);
public function setUnconfirmedData(array $subscriberData) {
$subscriberData = self::filterOutReservedColumns($subscriberData);
$encoded = json_encode($subscriberData);
if (is_string($encoded)) {
$this->unconfirmed_data = $encoded;
$this->unconfirmedData = $encoded;
}
}
public function getUnconfirmedData() {
if (!empty($this->unconfirmed_data)) {
$subscriber_data = json_decode($this->unconfirmed_data, true);
$subscriber_data = self::filterOutReservedColumns((array)$subscriber_data);
return $subscriber_data;
if (!empty($this->unconfirmedData)) {
$subscriberData = json_decode($this->unconfirmedData, true);
$subscriberData = self::filterOutReservedColumns((array)$subscriberData);
return $subscriberData;
}
return null;
}
public static function bulkAddToList($orm, $data = []) {
$segment_id = (isset($data['segment_id']) ? (int)$data['segment_id'] : 0);
$segment = Segment::findOne($segment_id);
$segmentId = (isset($data['segment_id']) ? (int)$data['segment_id'] : 0);
$segment = Segment::findOne($segmentId);
if (!$segment instanceof Segment) return false;
$count = parent::bulkAction($orm,
function($subscriber_ids) use($segment) {
function($subscriberIds) use($segment) {
SubscriberSegment::subscribeManyToSegments(
$subscriber_ids, [$segment->id]
$subscriberIds, [$segment->id]
);
}
);
@ -556,16 +556,16 @@ class Subscriber extends Model {
}
public static function bulkMoveToList($orm, $data = []) {
$segment_id = (isset($data['segment_id']) ? (int)$data['segment_id'] : 0);
$segment = Segment::findOne($segment_id);
$segmentId = (isset($data['segment_id']) ? (int)$data['segment_id'] : 0);
$segment = Segment::findOne($segmentId);
if (!$segment instanceof Segment) return false;
$count = parent::bulkAction($orm,
function($subscriber_ids) use($segment) {
SubscriberSegment::deleteManySubscriptions($subscriber_ids);
function($subscriberIds) use($segment) {
SubscriberSegment::deleteManySubscriptions($subscriberIds);
SubscriberSegment::subscribeManyToSegments(
$subscriber_ids, [$segment->id]
$subscriberIds, [$segment->id]
);
}
);
@ -577,16 +577,16 @@ class Subscriber extends Model {
}
public static function bulkRemoveFromList($orm, $data = []) {
$segment_id = (isset($data['segment_id']) ? (int)$data['segment_id'] : 0);
$segment = Segment::findOne($segment_id);
$segmentId = (isset($data['segment_id']) ? (int)$data['segment_id'] : 0);
$segment = Segment::findOne($segmentId);
if (!$segment instanceof Segment) return false;
$count = $orm->count();
parent::bulkAction($orm, function($subscriber_ids) use($segment) {
parent::bulkAction($orm, function($subscriberIds) use($segment) {
SubscriberSegment::deleteManySubscriptions(
$subscriber_ids, [$segment->id]
$subscriberIds, [$segment->id]
);
});
@ -599,8 +599,8 @@ class Subscriber extends Model {
public static function bulkRemoveFromAllLists($orm, $data = []) {
$count = $orm->count();
parent::bulkAction($orm, function($subscriber_ids) {
SubscriberSegment::deleteManySubscriptions($subscriber_ids);
parent::bulkAction($orm, function($subscriberIds) {
SubscriberSegment::deleteManySubscriptions($subscriberIds);
});
return [
@ -625,17 +625,17 @@ class Subscriber extends Model {
}
public static function bulkTrash($orm) {
$count = parent::bulkAction($orm, function($subscriber_ids) {
$count = parent::bulkAction($orm, function($subscriberIds) {
Subscriber::rawExecute(join(' ', [
'UPDATE `' . Subscriber::$_table . '`',
'SET `deleted_at` = NOW()',
'WHERE `id` IN (' .
rtrim(str_repeat('?,', count($subscriber_ids)), ',')
rtrim(str_repeat('?,', count($subscriberIds)), ',')
. ')',
'AND `wp_user_id` IS NULL OR `wp_user_id` = 0',
'AND `is_woocommerce_user` = 0',
]),
$subscriber_ids
$subscriberIds
);
});
@ -643,13 +643,13 @@ class Subscriber extends Model {
}
public static function bulkDelete($orm) {
$count = parent::bulkAction($orm, function($subscriber_ids) {
$count = parent::bulkAction($orm, function($subscriberIds) {
// delete all subscriber/segment relationships
SubscriberSegment::deleteManySubscriptions($subscriber_ids);
SubscriberSegment::deleteManySubscriptions($subscriberIds);
// delete all subscriber/custom field relationships
SubscriberCustomField::deleteManySubscriberRelations($subscriber_ids);
SubscriberCustomField::deleteManySubscriberRelations($subscriberIds);
// delete subscribers (except WP Users)
Subscriber::whereIn('id', $subscriber_ids)
Subscriber::whereIn('id', $subscriberIds)
->whereRaw('`wp_user_id` IS NULL OR `wp_user_id` = 0')
->whereEqual('is_woocommerce_user', 0)
->deleteMany();
@ -716,8 +716,8 @@ class Subscriber extends Model {
);
}
public static function updateMultiple($columns, $subscribers, $updated_at = false) {
$ignore_columns_on_update = [
public static function updateMultiple($columns, $subscribers, $updatedAt = false) {
$ignoreColumnsOnUpdate = [
'wp_user_id',
'is_woocommerce_user',
'email',
@ -726,56 +726,56 @@ class Subscriber extends Model {
'last_subscribed_at',
];
// check if there is anything to update after excluding ignored columns
if (!array_diff($columns, $ignore_columns_on_update)) return;
if (!array_diff($columns, $ignoreColumnsOnUpdate)) return;
$subscribers = array_map('array_values', $subscribers);
$email_position = array_search('email', $columns);
$emailPosition = array_search('email', $columns);
$sql =
function($type) use (
$columns,
$subscribers,
$email_position,
$ignore_columns_on_update
$emailPosition,
$ignoreColumnsOnUpdate
) {
return array_filter(
array_map(function($column_position, $column_name) use (
array_map(function($columnPosition, $columnName) use (
$type,
$subscribers,
$email_position,
$ignore_columns_on_update
$emailPosition,
$ignoreColumnsOnUpdate
) {
if (in_array($column_name, $ignore_columns_on_update)) return;
if (in_array($columnName, $ignoreColumnsOnUpdate)) return;
$query = array_map(
function($subscriber) use ($type, $column_position, $email_position) {
function($subscriber) use ($type, $columnPosition, $emailPosition) {
return ($type === 'values') ?
[
$subscriber[$email_position],
$subscriber[$column_position],
$subscriber[$emailPosition],
$subscriber[$columnPosition],
] :
'WHEN email = ? THEN ?';
}, $subscribers);
return ($type === 'values') ?
Helpers::flattenArray($query) :
$column_name . '= (CASE ' . implode(' ', $query) . ' END)';
$columnName . '= (CASE ' . implode(' ', $query) . ' END)';
}, array_keys($columns), $columns)
);
};
return self::rawExecute(
'UPDATE `' . self::$_table . '` ' .
'SET ' . implode(', ', $sql('statement')) . ' ' .
(($updated_at) ? ', updated_at = "' . $updated_at . '" ' : '') .
(($updatedAt) ? ', updated_at = "' . $updatedAt . '" ' : '') .
', unconfirmed_data = NULL ' .
'WHERE email IN ' .
'(' . rtrim(str_repeat('?,', count($subscribers)), ',') . ')',
array_merge(
Helpers::flattenArray($sql('values')),
array_column($subscribers, $email_position)
array_column($subscribers, $emailPosition)
)
);
}
public static function findSubscribersInSegments(array $subscribers_ids, array $segments_ids) {
return self::getSubscribedInSegments($segments_ids)
->whereIn('subscribers.id', $subscribers_ids)
public static function findSubscribersInSegments(array $subscribersIds, array $segmentsIds) {
return self::getSubscribedInSegments($segmentsIds)
->whereIn('subscribers.id', $subscribersIds)
->select('subscribers.*');
}
@ -789,14 +789,14 @@ class Subscriber extends Model {
public static function setRequiredFieldsDefaultValues($data) {
$settings = SettingsController::getInstance();
$required_field_default_values = [
$requiredFieldDefaultValues = [
'first_name' => '',
'last_name' => '',
'unsubscribe_token' => Security::generateUnsubscribeToken(self::class),
'link_token' => Security::generateRandomString(self::LINK_TOKEN_LENGTH),
'status' => (!$settings->get('signup_confirmation.enabled')) ? self::STATUS_SUBSCRIBED : self::STATUS_UNCONFIRMED,
];
foreach ($required_field_default_values as $field => $value) {
foreach ($requiredFieldDefaultValues as $field => $value) {
if (!isset($data[$field])) {
$data[$field] = $value;
}
@ -805,14 +805,14 @@ class Subscriber extends Model {
}
public static function extractCustomFieldsFromFromObject($data) {
$custom_fields = [];
$customFields = [];
foreach ($data as $key => $value) {
if (strpos($key, 'cf_') === 0) {
$custom_fields[(int)substr($key, 3)] = $value;
$customFields[(int)substr($key, 3)] = $value;
unset($data[$key]);
}
}
return [$data, $custom_fields];
return [$data, $customFields];
}
public function getAllSegmentNamesWithStatus() {
@ -836,9 +836,9 @@ class Subscriber extends Model {
* @see https://kb.mailpoet.com/article/195-add-subscribers-through-your-own-form-or-plugin
* @deprecated
*/
public static function subscribe($subscriber_data = [], $segment_ids = []) {
public static function subscribe($subscriberData = [], $segmentIds = []) {
trigger_error('Calling Subscriber::subscribe() is deprecated and will be removed. Use MailPoet\API\MP\v1\API instead. ', E_USER_DEPRECATED);
$service = ContainerWrapper::getInstance()->get(\MailPoet\Subscribers\SubscriberActions::class);
return $service->subscribe($subscriber_data, $segment_ids);
return $service->subscribe($subscriberData, $segmentIds);
}
}