Contents

Code Reference Classes BP_REST_Document_Endpoint BP_REST_Document_Endpoint::update_item()

BP_REST_Document_Endpoint::update_item( WP_REST_Request $request )

Update a document.

Description

Parameters

$request

(Required) Full details about the request.

Return

(WP_REST_Response) | WP_Error

Source

File: bp-document/classes/class-bp-rest-document-endpoint.php

741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
public function update_item( $request ) {
    $id = $request['id'];
 
    $documents = $this->assemble_response_data( array( 'document_ids' => array( $id ) ) );
 
    if ( empty( $documents['documents'] ) ) {
        return new WP_Error(
            'bp_rest_document_invalid_id',
            __( 'Invalid document ID.', 'buddyboss' ),
            array(
                'status' => 404,
            )
        );
    }
 
    $document = end( $documents['documents'] );
 
    $args = array(
        'id'            => $document->id,
        'privacy'       => $document->privacy,
        'attachment_id' => $document->attachment_id,
        'group_id'      => $document->group_id,
        'activity_id'   => $document->activity_id,
        'folder_id'     => $document->folder_id,
        'title'         => $document->title,
    );
 
    if ( isset( $request['group_id'] ) && ! empty( $request['group_id'] ) ) {
        $args['group_id'] = $request['group_id'];
        $args['privacy']  = 'grouponly';
    }
 
    if ( isset( $request['folder_id'] ) && ! empty( $request['folder_id'] ) ) {
        $args['folder_id'] = $request['folder_id'];
        $parent_folder     = new BP_Document_Folder( $args['folder_id'] );
        $args['privacy']   = $parent_folder->privacy;
    }
 
    /**
     * Filter the query arguments for the request.
     *
     * @param array           $args    Key value array of query var to query value.
     * @param WP_REST_Request $request The request sent to the API.
     *
     * @since 0.1.0
     */
    $args = apply_filters( 'bp_rest_document_update_items_query_args', $args, $request );
 
    if ( ! empty( $request['title'] ) ) {
        $document_rename = bp_document_rename_file( $document->id, $document->attachment_id, $request['title'] );
        if ( ! isset( $document_rename['document_id'] ) || $document_rename['document_id'] < 1 ) {
            return new WP_Error(
                'bp_rest_document_rename',
                $document_rename,
                array(
                    'status' => 404,
                )
            );
        }
    }
 
    if (
        empty( $document->folder_id )
        && ( ! isset( $request['folder_id'] ) || empty( $request['folder_id'] ) )
        && isset( $request['privacy'] )
        && ! empty( $request['privacy'] )
    ) {
        bp_document_update_privacy( $document->id, $request['privacy'], 'document' );
    }
 
    $id     = $this->bp_rest_create_document( $args );
    $status = true;
 
    if ( is_wp_error( $id ) ) {
        return $id;
    }
 
    if ( empty( $id ) ) {
        $status = false;
    }
 
    $documents = $this->assemble_response_data( array( 'document_ids' => array( $request['id'] ) ) );
    $document  = current( $documents['documents'] );
 
    $fields_update = $this->update_additional_fields_for_object( $document, $request );
 
    if ( is_wp_error( $fields_update ) ) {
        return $fields_update;
    }
 
    $retval = $this->prepare_response_for_collection(
        $this->prepare_item_for_response( $document, $request )
    );
 
    $response = new WP_REST_Response();
    $response->set_data(
        array(
            'updated' => $status,
            'data'    => $retval,
        )
    );
 
    /**
     * Fires after an document is updated via the REST API.
     *
     * @param WP_REST_Response     $response The response data.
     * @param WP_REST_Request      $request  The request sent to the API.
     *
     * @since 0.1.0
     */
    do_action( 'bp_rest_document_update_item', $response, $request );
 
    return $response;
}

Expand full source code Collapse full source code

Changelog

Changelog
Version Description
0.1.0 Introduced.

Uses

Uses
Uses Description
bp-document/classes/class-bp-rest-document-endpoint.php: BP_REST_Document_Endpoint::assemble_response_data()

Get documents.
bp-document/classes/class-bp-rest-document-endpoint.php: BP_REST_Document_Endpoint::bp_rest_create_document()

Create the Document IDs from Upload IDs.
bp-document/classes/class-bp-rest-document-endpoint.php: BP_REST_Document_Endpoint::prepare_item_for_response()

Prepares document data for return as an object.
bp-document/classes/class-bp-rest-document-endpoint.php: bp_rest_document_update_items_query_args

Filter the query arguments for the request.
bp-document/classes/class-bp-rest-document-endpoint.php: bp_rest_document_update_item

Fires after an document is updated via the REST API.
bp-document/classes/class-bp-document-folder.php: BP_Document_Folder::__construct()

Constructor method.
bp-document/bp-document-functions.php: bp_document_update_privacy()

Update document privacy with nested level.
bp-document/bp-document-functions.php: bp_document_rename_file()

This function will rename the document name.
Show 3 more uses Hide more uses

Questions?

We're always happy to help with code or other questions you might have! Search our developer docs, contact support, or connect with our sales team.