BetterBrief / silverstripe-opauth

code/OpauthIdentity.php

<?php

/**
 * OpauthIdentity
 * The SS equivalent of "index.php" and "callback.php" in the Opauth package.
 * @author Will Morgan <@willmorgan>
 * @author Dan Hensby <@dhensby>
 * @copyright Copyright (c) 2013, Better Brief LLP
 */
class OpauthIdentity extends DataObject {

PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions.

	private static
		$db = array(

The visibility should be declared for property $db.

Consider using a different property name as you override a private property of the parent class.

The property $db is not used and could be removed.

It is generally advisable to only define one property per statement.

			'UID' => 'Varchar(255)',
			'Provider' => 'Varchar(45)',
		),
		$has_one = array(

Consider using a different property name as you override a private property of the parent class.

The property $has_one is not used and could be removed.

			'Member' => 'Member',
		),
		$summary_fields = array(

Consider using a different property name as you override a private property of the parent class.

The property $summary_fields is not used and could be removed.

			'Member.Email' => 'MemberEmail',
			'Provider' => 'Provider',
			'UID' => 'UID',
		);

	protected
		/**
		 * @var array source from Opauth
		 */
		$authSource,

It is generally advisable to only define one property per statement.

The visibility should be declared for property $authSource.

		/**
		 * @var array The parsed member record, if any
		 */
		$parsedRecord;

	private
		/**
		 * @var boolean shim for onBeforeCreate
		 */
		$_isCreating = false;

The visibility should be declared for property $_isCreating.

	/**
	 * factory
	 * Returns or creates a fresh OpauthIdentity.
	 * @param array $oaResponse The response object from Opauth.
	 * @return OpauthIdentity instance based on $oaResponse.
	 */
	public static function factory(array $oaResponse) {

		if(empty($oaResponse['auth'])) {
			throw new InvalidArgumentException('The auth key is required to continue.');
		}
		if(empty($oaResponse['auth']['provider'])) {
			throw new InvalidArgumentException('Unable to determine provider.');
		}

		$auth = $oaResponse['auth'];

		$do = OpauthIdentity::get()->filter(
			array(
				'Provider' => $auth['provider'],
				'UID' => $auth['uid'],
			)
		)->first();

		if(!$do || !$do->exists()) {
			$do = new OpauthIdentity();
			$do->Provider = $auth['provider'];

The property Provider does not exist on object<OpauthIdentity>. Since you implemented __set, maybe consider adding a @property annotation.

			$do->UID = $auth['uid'];

The property UID does not exist on object<OpauthIdentity>. Since you implemented __set, maybe consider adding a @property annotation.

		}

		$do->setAuthSource($auth);
		return $do;
	}

	/**
	 * Add an extension point for creation and member linking
	 */
	public function onBeforeWrite() {
		parent::onBeforeWrite();
		if(!$this->isInDb()) {
			$this->_isCreating = true;
			$this->extend('onBeforeCreate');
		}
		if($this->isChanged('MemberID')) {
			$this->extend('onMemberLinked');
		}
	}

	/**
	 * Add an extension point for afterCreate
	 */
	public function onAfterWrite() {
		parent::onAfterWrite();
		if($this->_isCreating === true) {
			$this->_isCreating = false;
			$this->extend('onAfterCreate');
		}
	}

	/**
	 * Finds a member based on this identity. Searches existing records before
	 * creating a new Member object.
	 * Note that this method does not write anything, merely sets everything up.
	 * @param array $usrSettings A map of settings because there are so many.
	 * @return Member
	 */
	public function findOrCreateMember($usrSettings = array()) {

		$defaults = array(
			/**
			 * Link this identity to any newly discovered member.
			 */
			'linkOnMatch' => true,
			/**
			 * True, false, or an array of fields to overwrite if we merge data.
			 * Exception to this rule is overwriteEmail, which takes precedence.
			 */
			'overwriteExistingFields' => false,
			/**
			 * Overwrite the email field if it's different. Effectively changes
			 * the Member login details, so it's set to false for now.
			 */
			'overwriteEmail' => false,
		);

		$settings = array_merge($defaults, $usrSettings);

		if($this->isInDB()) {
			$member = $this->Member();

The method Member() does not exist on OpauthIdentity. Did you maybe mean findOrCreateMember()?

			if($member->exists()) {
				return $member;
			}
		}

		$record = $this->getMemberRecordFromAuth();

		if(empty($record['Email'])) {
			$member = new Member();
		}
		else {
			$member = Member::get()->filter('Email', $record['Email'])->first();

			if(!$member) {
				$member = new Member();
			}
		}

		if($settings['linkOnMatch'] && $member->isInDB()) {
			$this->MemberID = $member->ID;

The property MemberID does not exist on object<OpauthIdentity>. Since you implemented __set, maybe consider adding a @property annotation.

		}

		// If this is a new member, give it everything we have.
		if(!$member->isInDB()) {
			$member->update($record);
		}
		// If not, we update it carefully using the settings described above.
		else {
			$overwrite = $settings['overwriteExistingFields'];
			$overwriteEmail = $settings['overwriteEmail'];
			$fieldsToWrite = array();

			// If overwrite is true, take everything (subtract Email later)
			if($overwrite === true) {
				$fieldsToWrite = $record;
			}
			else if(is_array($overwrite)) {
				$fieldsToWrite = array_intersect_key($record, ArrayLib::valuekey($overwrite));
			}
			// If false then fieldsToWrite remains empty, let's coast it out.

			// Subtract email if setting is not precisely true:
			if($overwriteEmail !== true && isset($fieldsToWrite['Email'])) {
				unset($fieldsToWrite['Email']);
			}

			// Boom, we're so done.
			$member->update($fieldsToWrite);
		}

		return $member;
	}

	/**
	 * @param array $auth
	 */
	public function setAuthSource($auth) {
		$this->authSource = $auth;
		unset($this->parsedRecord);
		return $this;
	}

	/**
	 * @return array
	 */
	public function getAuthSource() {
		return $this->authSource;
	}

	/**
	 * @return array The mapping arrangement from auth response to Member.
	 */
	public function getMemberMapper() {
		$mapper = Config::inst()->get(__CLASS__, 'member_mapper');
		if(!isset($mapper[$this->Provider])) {

The property Provider does not exist on object<OpauthIdentity>. Since you implemented __get, maybe consider adding a @property annotation.

			return array();
		}
		return $mapper[$this->Provider];

The property Provider does not exist on object<OpauthIdentity>. Since you implemented __get, maybe consider adding a @property annotation.

	}

	/**
	 * Use dot notation and/or a parser to retrieve information from a provider.
	 * Examples of simple dot notation:
	 * - 'FirstName' => 'info.first_name'
	 * - 'Surname' => 'info.surname'
	 * Examples of a parser, for example when only a "name" param is present:
	 * - 'FirstName' => array('OpauthResponseHelper', 'get_first_name')
	 * - 'Surname' => array('OpauthResponseHelper', 'get_last_name')
	 * @see OpauthResponseHelper
	 * @return array The data record to add to a member
	 */
	public function getMemberRecordFromAuth() {
		if(empty($this->parsedRecord)) {
			$record = array();
			foreach($this->getMemberMapper() as $memberField => $sourcePath) {
				if(is_array($sourcePath)) {
					$record[$memberField] = call_user_func($sourcePath, $this->authSource);
				}
				else if(is_string($sourcePath)) {
					$record[$memberField] = OpauthResponseHelper::parse_source_path($sourcePath, $this->authSource);
				}
			}
			$this->parsedRecord = $record;
		}
		return $this->parsedRecord;
	}

}