Skip to:
Content

BuddyPress.org


Ignore:
Timestamp:
01/03/2016 06:14:41 AM (9 years ago)
Author:
tw2113
Message:

More cleanup and new phpdocs for functions or methods in the XProfile component.

See #6406.

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/src/bp-xprofile/classes/class-bp-xprofile-profiledata.php

    r10417 r10434  
    1111defined( 'ABSPATH' ) || exit;
    1212
     13/**
     14 * Class for XProfile Profile Data setup.
     15 *
     16 * @since 1.6.0
     17 */
    1318class BP_XProfile_ProfileData {
     19
     20    /**
     21     * XProfile ID.
     22     *
     23     * @var int $id
     24     */
    1425    public $id;
     26
     27    /**
     28     * User ID.
     29     *
     30     * @var int $user_id
     31     */
    1532    public $user_id;
     33
     34    /**
     35     * XProfile field ID.
     36     *
     37     * @var int $field_id
     38     */
    1639    public $field_id;
     40
     41    /**
     42     * XProfile field value.
     43     *
     44     * @var string $value
     45     */
    1746    public $value;
     47
     48    /**
     49     * XProfile field last updated time.
     50     *
     51     * @var string $last_updated
     52     */
    1853    public $last_updated;
    1954
     55    /**
     56     * BP_XProfile_ProfileData constructor.
     57     *
     58     * @param null $field_id Field ID to instantiate.
     59     * @param null $user_id  User ID to instantiate for.
     60     */
    2061    public function __construct( $field_id = null, $user_id = null ) {
    2162        if ( !empty( $field_id ) ) {
    … …  
    2465    }
    2566
     67    /**
     68     * Populates the XProfile profile data.
     69     *
     70     * @param int $field_id Field ID to populate.
     71     * @param int $user_id  User ID to populate for.
     72     */
    2673    public function populate( $field_id, $user_id ) {
    2774        global $wpdb;
    … …  
    111158    }
    112159
     160    /**
     161     * Save the data for the XProfile field.
     162     *
     163     * @return bool
     164     */
    113165    public function save() {
    114166        global $wpdb;
    … …  
    208260     * @param int   $user_id   ID of user whose data is being queried.
    209261     * @param array $field_ids Array of field IDs to query for.
    210      *
    211262     * @return array
    212263     */
    … …  
    274325     *
    275326     * @param int $user_id ID of the user.
    276      *
    277327     * @return array
    278328     */
    … …  
    321371     * @param int $field_id Field ID being queried for.
    322372     * @param int $user_id  User ID associated with field.
    323      *
    324373     * @return int $fielddata_id
    325374     */
    … …  
    352401     * @param int            $field_id ID of the field.
    353402     * @param int|array|null $user_ids ID or IDs of user(s).
    354      *
    355403     * @return string|array Single value if a single user is queried,
    356404     *                      otherwise an array of results.
    … …  
    428476    }
    429477
     478    /**
     479     * Get profile field values by field name and user ID.
     480     *
     481     * @param array|string $fields  Field(s) to get.
     482     * @param int|null     $user_id User ID to get field data for.
     483     * @return array|bool
     484     */
    430485    public static function get_value_byfieldname( $fields, $user_id = null ) {
    431486        global $wpdb;
    … …  
    483538    }
    484539
     540    /**
     541     * Delete field.
     542     *
     543     * @param int $field_id ID of the field to delete.
     544     * @return bool
     545     */
    485546    public static function delete_for_field( $field_id ) {
    486547        global $wpdb;
    … …  
    495556    }
    496557
     558    /**
     559     * Get time for last XProfile field data update by user.
     560     *
     561     * @param int $user_id User ID to get time for.
     562     * @return null|string
     563     */
    497564    public static function get_last_updated( $user_id ) {
    498565        global $wpdb;
    … …  
    505572    }
    506573
     574    /**
     575     * Delete all data for provided user ID.
     576     *
     577     * @param int $user_id User ID to remove data for.
     578     * @return false|int
     579     */
    507580    public static function delete_data_for_user( $user_id ) {
    508581        global $wpdb;
    … …  
    513586    }
    514587
     588    /**
     589     * Get random field type by user ID.
     590     *
     591     * @param int    $user_id          User ID to query for.
     592     * @param string $exclude_fullname SQL portion used to exclude by field ID.
     593     * @return array|null|object
     594     */
    515595    public static function get_random( $user_id, $exclude_fullname ) {
    516596        global $wpdb;
    … …  
    523603    }
    524604
     605    /**
     606     * Get fullname for provided user ID.
     607     *
     608     * @param int $user_id ID of the user to query.
     609     * @return mixed
     610     */
    525611    public static function get_fullname( $user_id = 0 ) {
    526612
Note: See TracChangeset for help on using the changeset viewer.