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

====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');