編輯“用戶:Dv”（章節(jié)）

==Class Definitions==
This module is divided up into two parts. A GalleryEmbedSynchronization class that contains all the necessary logic for this project, and one interface for integrations to use to communicate with this module. Below you will find the specifications for these classes.

===GalleryEmbedSynchronization===
This class must be instantiated. The first call must be to init() to set up the class. If the integration coder wishes to override any options the user may have selected via a view, they can call the setOptions() method.
====Variables====
array _g2Users
     List of all users in G2 as GalleryUser objects.
array _emAppUsers
     Array of users in emApp in the format of GalleryUser::getMemberData().
array _options
     * Synchronize options will be carried in this variable.
     * 
     * @var array('ignorePasswordMismatches' => bool, 'ignoreLanguageMismatches' => bool,
     *              'allowExternalIdMapAdditions' => bool)
array _conflicts
     * Conflict array. Contains one or more of the following types of arrays.
     * 
     * @var array('type' => CONFLICT_USERDATA, 'g2User' => $g2UserData, 'emAppUser' =>
     *          $emAppUserData)
     * OR
     *      array('type' => CONFLICT_ORPHAN, 'entityId' => $entityId, 'message' => $message)

====Functions====
init()
     * Init function. Sets up class-related options.
     * 
     * @return object GalleryStatus

addConflict($conflictData)
     * Add a conflict to the conflicts array.
     *
     * This function performs basic validation checks before passing on the data to the conflict
     * array. If 'type' == CONFLICT_ORPHAN, will show first param as an id of some sort and second
     * param as an error message in which first param is involved. If 'type' == CONFLICT_USERDATA,
     * will compare them by key/value pairs, because they're two conflicting user arrays.
     *
     * @param array('type' => CONFLICT_USERDATA, 'g2User' => $g2UserData, 'emAppUser' =>
     *          $emAppUserData)
     *        OR
     *        array('type' => CONFLICT_ORPHAN, 'entityId' => $entityId, 'message' => $message)
     * @return object GalleryStatus

getConflictsArray()
     * A function to retrieve all conflicts in $this->_conflicts
     * 
     * @return array(object GalleryStatus, array $this->_conflicts) 

compareUsers($g2User, $emAppUser, $params)
     * Compare a G2 user with an integration app user by user properties.
     * 
     * Set any or all of the array params to true to compare by those properties.
     * If 'case' is true, then compare will be case-sensitive. 'case' is determined within this
     * function by calling UserSynchronizationInterface_1_0::isCompareCaseSensitive().
     * 
     * @param object GalleryUser
     * @param array ('userName' => string the user name, 'fullName' => string full name,
     *              'email' => string user's e-mail, 'language' => string user's language,
     *              'hashedPassword' => string user's hashed password)
     * @param array('byUserName' => bool, 'byEmail' => bool, 'byLanguage' => bool,
     *              'byFullName' => bool, 'byHashedPassword' => bool, 'case' => bool)
     * @return array('userName' => 1, 'email' => 1, etc.) Any conflicts are entered here.

setOptions($params)
     * Set options via this method. Can be used by integration coders to override any user-selected
     * options.
     * 
     * @param array(any options from $this->_options => appropriate value)

synchronizeUsers($isDryRun=true)
     * Synchronize $this->_emAppUsers and $this->_g2Users
     * 
     * @param bool isDryRun determines if we are doing a dry run to check for errors
     * @return array object GalleryStatus a status code
     *         array results array (..., 'g2Users' => $this->_g2Users)
     This function instantiates the following class:
        list($ret, $this->_emApp) =
            GalleryCoreApi::newFactoryInstance('UserSynchronizationInterface_1_0');

===UserSynchronizationInterface_1_0===
This is the interface which the integrator will use to implement integration app-related (emApp-related) tasks such as creating, deleting, and updating users in the emApp.

====Functions====
createUser($g2Data)
     * Create a user in the emApp with the supplied user data and return the id of the new user.
     * @param array new user data ('userName' => string, 'fullName' => string, 'email' => string,
     *                              'language' => string, 'hashedPassword' => string)
     * @return array (object GalleryStatus status code, mixed (string, integer) externalId of new user

updateUser($externalId, $userData)
     * Update a user in the emApp.
     * @param mixed, external user Id
     * @param array new user data ('userName' => string, 'fullName' => string, 'email' => string,
     *                              'language' => string, 'hashedPassword' => string)
     * @return array object GalleryStatus a status code

deleteUser($externalId)
     * Delete a user from the emApp.
     * @param mixed external user Id
     * @return object GalleryStatus a status code

<strike>getUser($externalId)</strike> '''Currently in limbo'''

getGuestUser()
     * Get user properties for emApp's 'guest' user.
     * 
     * @return array object GalleryStatus status code
     *         mixed (string, integer) externalId of user

getSiteAdmin()
     * Get user properties for emApp's admin user.
     * 
     * @return array object GalleryStatus status code
     *         mixed (string, integer) externalId of user

getUsers()
     * Get list of users from emApp.
     * 
     * @return array (object GalleryStatus a status code,
     *                array (mixed id => array('userName' => string, 'email' => string,
     *                      'language' => string, 'hashedPassword' => string,
     *                      'fullName' => string, 'id' => mixed)))

getRequiredUserProperties()
     * Return which user properties are required when creating/comparing users.
     * 
     * @return array ('userName' => bool, 'email' => bool, 'language' => bool,
     *                       'hashedPassword' => bool, 'fullName' => bool)

isCompareCaseSensitive()
     * Will we compare users in a case-sensitive fashion?
     * 
     * @return array (object GalleryStatus status code,
     *         bool isCaseSensitive)