Elgg / Elgg

mod/profile/classes/ElggPlugin/Profile/AnnotationMigration.php

<?php

namespace ElggPlugin\Profile;

use Elgg\Upgrade\AsynchronousUpgrade;
use Elgg\Upgrade\Result;

/**
 * Copy all profile field metadata to annotations, with each name prefixed with "profile:"
 */
class AnnotationMigration implements AsynchronousUpgrade {

	/**
	 * {@inheritdoc}
	 */
	public function getVersion() {
		return 2017040700;
	}

	/**
	 * {@inheritdoc}
	 */
	public function shouldBeSkipped() {
		return false;
	}

	/**
	 * {@inheritdoc}
	 */
	public function needsIncrementOffset() {
		return true;
	}

	/**
	 * {@inheritdoc}
	 */
	public function countItems() {
		return count($this->getFieldNames());
	}

	/**
	 * {@inheritdoc}
	 */
	public function run(Result $result, $offset) {
		$name = $this->getFieldNames()[$offset];

		$db = elgg()->db;
		$sql = "
			INSERT INTO {$db->prefix}annotations
				  (entity_guid, `name`,    `value`, value_type, owner_guid, access_id, time_created, enabled)
			SELECT entity_guid, :new_name, `value`, value_type, owner_guid, access_id, time_created, enabled
			FROM {$db->prefix}metadata
			WHERE `name` = :old_name
			AND entity_guid IN (
				SELECT guid FROM {$db->prefix}entities WHERE type = 'user'
			)
		";

		try {
			$db->updateData($sql, false, [
				':old_name' => $name,
				':new_name' => "profile:$name",
			]);
			$result->addSuccesses(1);
		} catch (\DatabaseException $e) {
			$result->addError("Profile field '$name' could not be migrated: " . $e->getMessage());
			$result->addFailures(1);
		}
	}

	/**
	 * Get the profile field names
	 *
	 * @return string[]
	 */
	private function getFieldNames() {

Private method name "AnnotationMigration::getFieldNames" must be prefixed with an underscore

		return array_keys(elgg_get_config('profile_fields'));
	}
}