Legacy RPC Commands =================== .. This document is generated via the `development:generate-documentation` command .. contents:: :depth: 2 :backlinks: none :local: .. _RpcHandler_status: _RpcHandler_status ------------------ .. _RpcCommand_status_type: ``type`` """""""" **Default**: ``"formatted"`` .. _RpcHandler_file_info: _RpcHandler_file_info --------------------- .. _RpcCommand_file_info_path: ``path`` """""""" **Default**: ``null`` .. _RpcHandler_references: _RpcHandler_references ---------------------- .. _RpcCommand_references_mode: ``mode`` """""""" **Default**: ``"find"`` .. _RpcCommand_references_filesystem: ``filesystem`` """""""""""""" **Default**: ``"git"`` .. _RpcCommand_references_replacement: ``replacement`` """"""""""""""" **Default**: ``null`` .. _RpcCommand_references_path: ``path`` """""""" **Default**: ``null`` .. _RpcCommand_references_offset: ``offset`` """""""""" **Default**: ``null`` .. _RpcCommand_references_source: ``source`` """""""""" **Default**: ``null`` .. _RpcHandler_copy_class: _RpcHandler_copy_class ---------------------- .. _RpcCommand_copy_class_dest_path: ``dest_path`` """"""""""""" **Default**: ``null`` .. _RpcCommand_copy_class_source_path: ``source_path`` """"""""""""""" **Default**: ``null`` .. _RpcHandler_move_class: _RpcHandler_move_class ---------------------- .. _RpcCommand_move_class_dest_path: ``dest_path`` """"""""""""" **Default**: ``null`` .. _RpcCommand_move_class_confirmed: ``confirmed`` """"""""""""" **Default**: ``null`` .. _RpcCommand_move_class_move_related: ``move_related`` """""""""""""""" **Default**: ``null`` .. _RpcCommand_move_class_source_path: ``source_path`` """"""""""""""" **Default**: ``null`` .. _RpcHandler_class_inflect: _RpcHandler_class_inflect ------------------------- .. _RpcCommand_class_inflect_new_path: ``new_path`` """""""""""" **Default**: ``null`` .. _RpcCommand_class_inflect_variant: ``variant`` """"""""""" **Default**: ``null`` .. _RpcCommand_class_inflect_overwrite_existing: ``overwrite_existing`` """""""""""""""""""""" **Default**: ``null`` .. _RpcCommand_class_inflect_current_path: ``current_path`` """""""""""""""" **Default**: ``null`` .. _RpcHandler_class_new: _RpcHandler_class_new --------------------- .. _RpcCommand_class_new_new_path: ``new_path`` """""""""""" **Default**: ``null`` .. _RpcCommand_class_new_variant: ``variant`` """"""""""" **Default**: ``null`` .. _RpcCommand_class_new_overwrite_existing: ``overwrite_existing`` """""""""""""""""""""" **Default**: ``null`` .. _RpcCommand_class_new_current_path: ``current_path`` """""""""""""""" **Default**: ``null`` .. _RpcHandler_transform: _RpcHandler_transform --------------------- .. _RpcCommand_transform_transform: ``transform`` """"""""""""" **Default**: ``null`` .. _RpcCommand_transform_path: ``path`` """""""" **Default**: ``null`` .. _RpcCommand_transform_source: ``source`` """""""""" **Default**: ``null`` .. _RpcHandler_extract_constant: _RpcHandler_extract_constant ---------------------------- .. _RpcCommand_extract_constant_constant_name: ``constant_name`` """"""""""""""""" **Default**: ``null`` .. _RpcCommand_extract_constant_constant_name_suggestion: ``constant_name_suggestion`` """""""""""""""""""""""""""" **Default**: ``null`` .. _RpcCommand_extract_constant_path: ``path`` """""""" **Default**: ``null`` .. _RpcCommand_extract_constant_offset: ``offset`` """""""""" **Default**: ``null`` .. _RpcCommand_extract_constant_source: ``source`` """""""""" **Default**: ``null`` .. _RpcHandler_extract_method: _RpcHandler_extract_method -------------------------- .. _RpcCommand_extract_method_method_name: ``method_name`` """"""""""""""" **Default**: ``null`` .. _RpcCommand_extract_method_offset_start: ``offset_start`` """""""""""""""" **Default**: ``null`` .. _RpcCommand_extract_method_offset_end: ``offset_end`` """""""""""""" **Default**: ``null`` .. _RpcCommand_extract_method_source: ``source`` """""""""" **Default**: ``null`` .. _RpcCommand_extract_method_path: ``path`` """""""" **Default**: ``null`` .. _RpcHandler_generate_accessor: _RpcHandler_generate_accessor ----------------------------- .. _RpcCommand_generate_accessor_names: ``names`` """"""""" **Default**: ``null`` .. _RpcCommand_generate_accessor_path: ``path`` """""""" **Default**: ``null`` .. _RpcCommand_generate_accessor_source: ``source`` """""""""" **Default**: ``null`` .. _RpcCommand_generate_accessor_offset: ``offset`` """""""""" **Default**: ``null`` .. _RpcHandler_generate_mutator: _RpcHandler_generate_mutator ---------------------------- .. _RpcCommand_generate_mutator_names: ``names`` """"""""" **Default**: ``null`` .. _RpcCommand_generate_mutator_path: ``path`` """""""" **Default**: ``null`` .. _RpcCommand_generate_mutator_source: ``source`` """""""""" **Default**: ``null`` .. _RpcCommand_generate_mutator_offset: ``offset`` """""""""" **Default**: ``null`` .. _RpcHandler_generate_method: _RpcHandler_generate_method --------------------------- .. _RpcCommand_generate_method_path: ``path`` """""""" **Default**: ``null`` .. _RpcCommand_generate_method_source: ``source`` """""""""" **Default**: ``null`` .. _RpcCommand_generate_method_offset: ``offset`` """""""""" **Default**: ``null`` .. _RpcHandler_import_class: _RpcHandler_import_class ------------------------ .. _RpcCommand_import_class_qualified_name: ``qualified_name`` """""""""""""""""" **Default**: ``null`` .. _RpcCommand_import_class_alias: ``alias`` """"""""" **Default**: ``null`` .. _RpcCommand_import_class_offset: ``offset`` """""""""" **Default**: ``null`` .. _RpcCommand_import_class_source: ``source`` """""""""" **Default**: ``null`` .. _RpcCommand_import_class_path: ``path`` """""""" **Default**: ``null`` .. _RpcHandler_rename_variable: _RpcHandler_rename_variable --------------------------- .. _RpcCommand_rename_variable_name: ``name`` """""""" **Default**: ``null`` .. _RpcCommand_rename_variable_name_suggestion: ``name_suggestion`` """"""""""""""""""" **Default**: ``null`` .. _RpcCommand_rename_variable_scope: ``scope`` """"""""" **Default**: ``null`` .. _RpcCommand_rename_variable_path: ``path`` """""""" **Default**: ``null`` .. _RpcCommand_rename_variable_source: ``source`` """""""""" **Default**: ``null`` .. _RpcCommand_rename_variable_offset: ``offset`` """""""""" **Default**: ``null`` .. _RpcHandler_change_visibility: _RpcHandler_change_visibility ----------------------------- .. _RpcCommand_change_visibility_path: ``path`` """""""" **Default**: ``null`` .. _RpcCommand_change_visibility_source: ``source`` """""""""" **Default**: ``null`` .. _RpcCommand_change_visibility_offset: ``offset`` """""""""" Type: integer **Default**: ``null`` .. _RpcHandler_override_method: _RpcHandler_override_method --------------------------- .. _RpcCommand_override_method_method_name: ``method_name`` """"""""""""""" **Default**: ``null`` .. _RpcCommand_override_method_class_name: ``class_name`` """""""""""""" **Default**: ``null`` .. _RpcCommand_override_method_path: ``path`` """""""" **Default**: ``null`` .. _RpcCommand_override_method_source: ``source`` """""""""" **Default**: ``null`` .. _RpcHandler_extract_expression: _RpcHandler_extract_expression ------------------------------ .. _RpcCommand_extract_expression_variable_name: ``variable_name`` """"""""""""""""" **Default**: ``null`` .. _RpcCommand_extract_expression_offset_start: ``offset_start`` """""""""""""""" **Default**: ``null`` .. _RpcCommand_extract_expression_path: ``path`` """""""" **Default**: ``null`` .. _RpcCommand_extract_expression_source: ``source`` """""""""" **Default**: ``null`` .. _RpcCommand_extract_expression_offset_end: ``offset_end`` """""""""""""" **Default**: ``null`` .. _RpcHandler_import_missing_classes: _RpcHandler_import_missing_classes ---------------------------------- .. _RpcCommand_import_missing_classes_path: ``path`` """""""" **Default**: ``null`` .. _RpcCommand_import_missing_classes_source: ``source`` """""""""" **Default**: ``null`` .. _RpcHandler_hover: _RpcHandler_hover ----------------- .. _RpcCommand_hover_source: ``source`` """""""""" **Default**: ``null`` .. _RpcCommand_hover_offset: ``offset`` """""""""" **Default**: ``null`` .. _RpcHandler_complete: _RpcHandler_complete -------------------- .. _RpcCommand_complete_type: ``type`` """""""" **Default**: ``"php"`` .. _RpcCommand_complete_source: ``source`` """""""""" **Default**: ``null`` .. _RpcCommand_complete_offset: ``offset`` """""""""" **Default**: ``null`` .. _RpcHandler_navigate: _RpcHandler_navigate -------------------- .. _RpcCommand_navigate_source_path: ``source_path`` """"""""""""""" **Default**: ``null`` .. _RpcCommand_navigate_destination: ``destination`` """"""""""""""" **Default**: ``null`` .. _RpcCommand_navigate_confirm_create: ``confirm_create`` """""""""""""""""" **Default**: ``null`` .. _RpcHandler_context_menu: _RpcHandler_context_menu ------------------------ .. _RpcCommand_context_menu_action: ``action`` """""""""" **Default**: ``null`` .. _RpcCommand_context_menu_current_path: ``current_path`` """""""""""""""" **Default**: ``null`` .. _RpcCommand_context_menu_source: ``source`` """""""""" **Default**: ``null`` .. _RpcCommand_context_menu_offset: ``offset`` """""""""" **Default**: ``null`` .. _RpcHandler_echo: _RpcHandler_echo ---------------- .. _RpcCommand_echo_message: ``message`` """"""""""" **Default**: ``null`` .. _RpcHandler_class_search: _RpcHandler_class_search ------------------------ .. _RpcCommand_class_search_short_name: ``short_name`` """""""""""""" **Default**: ``null`` .. _RpcHandler_offset_info: _RpcHandler_offset_info ----------------------- .. _RpcCommand_offset_info_offset: ``offset`` """""""""" **Default**: ``null`` .. _RpcCommand_offset_info_source: ``source`` """""""""" **Default**: ``null`` .. _RpcHandler_goto_definition: _RpcHandler_goto_definition --------------------------- .. _RpcCommand_goto_definition_language: ``language`` """""""""""" Type: string Language of the current file **Default**: ``"php"`` .. _RpcCommand_goto_definition_target: ``target`` """""""""" Type: string Where should the reference be opened **Default**: ``"focused_window"`` **Allowed values**: "focused_window", "vsplit", "hsplit", "new_tab" .. _RpcCommand_goto_definition_offset: ``offset`` """""""""" Type: integer Number of character into the buffer **Default**: ``null`` .. _RpcCommand_goto_definition_source: ``source`` """""""""" Content of the current file **Default**: ``null`` .. _RpcCommand_goto_definition_path: ``path`` """""""" Path of the current file **Default**: ``null`` .. _RpcHandler_goto_type: _RpcHandler_goto_type --------------------- .. _RpcCommand_goto_type_language: ``language`` """""""""""" Type: string Language of the current file **Default**: ``"php"`` .. _RpcCommand_goto_type_target: ``target`` """""""""" Type: string Where should the reference be opened **Default**: ``"focused_window"`` **Allowed values**: "focused_window", "vsplit", "hsplit", "new_tab" .. _RpcCommand_goto_type_offset: ``offset`` """""""""" Type: integer Number of character into the buffer **Default**: ``null`` .. _RpcCommand_goto_type_source: ``source`` """""""""" Content of the current file **Default**: ``null`` .. _RpcCommand_goto_type_path: ``path`` """""""" Path of the current file **Default**: ``null`` .. _RpcHandler_goto_implementation: _RpcHandler_goto_implementation ------------------------------- .. _RpcCommand_goto_implementation_language: ``language`` """""""""""" Type: string Language of the current file **Default**: ``"php"`` .. _RpcCommand_goto_implementation_target: ``target`` """""""""" Type: string Where should the reference be opened **Default**: ``"focused_window"`` **Allowed values**: "focused_window", "vsplit", "hsplit", "new_tab" .. _RpcCommand_goto_implementation_offset: ``offset`` """""""""" Type: integer Number of character into the buffer **Default**: ``null`` .. _RpcCommand_goto_implementation_source: ``source`` """""""""" Content of the current file **Default**: ``null`` .. _RpcCommand_goto_implementation_path: ``path`` """""""" Path of the current file **Default**: ``null`` .. _RpcHandler_index: _RpcHandler_index ----------------- .. _RpcCommand_index_watch: ``watch`` """"""""" **Default**: ``false`` .. _RpcCommand_index_interval: ``interval`` """""""""""" Type: integer **Default**: ``5000``