sunnysideup / silverstripe-social_integration

code/control/SocialIntegrationAPIInterface.php

<?php



interface SocialIntegrationAPIInterface

Each interface must be in a namespace of at least one level (a top-level vendor name)

{


//======================================= STATIC METHODS ===============================================

    /**
     * Maximum number of followers/friends that can be retrieved
     * @var Int
     */
        public static function set_number_of_friends_that_can_be_retrieved($n);

For interfaces and abstract methods it is generally a good practice to add a @return annotation even if it is just @return void or @return null, so that implementors know what to do in the overridden method.

    public static function get_number_of_friends_that_can_be_retrieved();

For interfaces and abstract methods it is generally a good practice to add a @return annotation even if it is just @return void or @return null, so that implementors know what to do in the overridden method.

    /**
     * Link to login form
     * @param String $returnURL
     * @return String
     */
    public static function login_url($returnURL = "");


    /**
     * Link to connect
     * @param String $returnURL
     * @return String
     */
    public static function connect_url($returnURL = "", $existingMember = false);

    /**
     * redirects to login prompt, lets the user log in and returns to
     * the returnURL specified.
     * @param String $returnURL
     * @return REDIRECTS!

The doc-type REDIRECTS! could not be parsed: Unknown type name "REDIRECTS!" at position 0. (view supported doc-types)

     */
    public static function redirect_to_login_prompt($returnURL = "");


    /**
     * returns all the data of the currently logged in / connected user.
     *
     * @return Array | Null
     */
    public static function get_current_user();

    /**
     * gets a list of friends
     * @param Int - $Limit, set to -1 to to maximum
     * @param String - $searchString, filter for search string
     * @return Array
     */
    public static function get_list_of_friends($limit = 12, $searchString = "");

    /**
     * Checks if the id provided is a valid member of the class.
     * @return Boolean
     */
    public static function is_valid_user($id);

    /**
     * return last status updates
     * @return Boolean
     */
    public static function get_updates($lastNumber = 12);

    /**
     * make sure to return TRUE as response if the message is sent
     * successfully
     * Sends a message from the current user to someone else in the networkd
     * @param Int $userID - Facebook user id.

There is no parameter named $userID. Was it maybe removed?

     * @param String $message - Message you are sending
     * @param String $link - Link to send with message
     * @return Boolean - return TRUE as success
     */
    public static function send_message($to, $message, $link = "", $otherVariables = array());


    public function test($request);

For interfaces and abstract methods it is generally a good practice to add a @return annotation even if it is just @return void or @return null, so that implementors know what to do in the overridden method.

    public function meondatabase();

For interfaces and abstract methods it is generally a good practice to add a @return annotation even if it is just @return void or @return null, so that implementors know what to do in the overridden method.

}