DOCS.txt

PHP libgit2 bindings API documentation
--------------------------------------------------------------------------------
The API is divided (roughly) by the kind of libgit2 object on which the API
function operates (e.g. git_repository, git_reference, ETC.). In most cases the
PHP API uses resource values for the major libgit2 opaque data types.

Since PHP has native exception handling, most API calls are reworked to return
the main result value and throw an exception on error. For example,
git_repository_new() returns a resource to the repository (originally assigned
to the first by-reference parameter). We also rework the structure of some
library calls due to inherent difficulties porting the C interface to PHP
(e.g. when pointers are used). Sometimes this requires adding API routines not
originally in the libgit2 specification.

Please consult the official libgit2 documentation for descriptions of the
behavior of the functions and their arguments. This section only details the PHP
interface.

--------------------------------------------------------------------------------
API Structure Reference

The following structures are represented as resources in the PHP API. They
generally represent opaque structures from the C API (but not necessarily).

Note that the PHP resource type names (which are really just diagnostic in
purpose) are determined by the C++ compiler via 'typeid'.

    git2 type
    ---------

    git_annotated_commit
    git_blame
    git_blob
    git_branch_iterator
    git_commit
    git_config
    git_config_iterator
    git_cred
    git_describe_result
    git_diff
    git_diff_stats
    git_index
    git_index_conflict_iterator
    git_indexer
    git_note
    git_note_iterator
    git_object
    git_odb
    git_odb_object
    git_packbuilder
    git_patch
    git_rebase
    git_refdb
    git_reference
    git_reference_iterator
    git_reflog
    git_refspec
    git_remote
    git_repository
    git_revwalk
    git_signature
    git_status_list
    git_submodule
    git_tag
    git_tree
    git_tree_entry
    git_treebuilder

The following structures are not represented as resources in the PHP
API. Instead a scalar, array or object type is used:

   git2 type                                      PHP type
   ---------                                      --------

    git_blame_hunk                                 array
    git_buf                                        string
    git_cherrypick_options                         array
    git_config_backend                             \GitConfigBackend
    git_config_entry                               array
    git_describe_format_options                    array
    git_describe_options                           array
    git_diff_binary                                array
    git_diff_binary_file                           array
    git_diff_delta                                 array
    git_diff_file                                  array
    git_diff_format_email_options                  array
    git_diff_hunk                                  array
    git_diff_line                                  array
    git_diff_options                               array
    git_index_entry                                array
    git_merge_file_input                           array
    git_merge_file_options                         array
    git_merge_file_result                          array
    git_merge_options                              array
    git_odb_backend                                \GitODBBackend
    git_odb_stream                                 \GitODBStream
    git_odb_writepack                              \GitODBWritepack
    git_oid                                        string
    git_refdb_backend                              \GitRefDBBackend
    git_reflog_entry                               array
    git_revspec                                    array
    git_status_entry                               array
    git_status_options                             array
    git_writestream                                \GitWritestream

For objects, see the later section regarding Classes.

Enumeration types are treated as integers in PHP userspace. A global constant is
generally defined for enumerator. If an enumerator is missing, then it is
acceptable to define it yourself using "define(...)" or by just using the
correct constant value from the git2 headers.

--------------------------------------------------------------------------------
Error Handling

When an underlying libgit2 function fails with an error code, the extension will
throw an exception of type Git2Exception (see declaration below). The error code
returned is accessible via the $code property on the thrown exception.

Example:

  function render_reference($repo,string $refName) {
    try {
      $oid = git_reference_name_to_id($repo,$refName);
      echo "<p>The OID for <code>$refName</code> is <code>$oid</code></p>";
    } catch (\Git2Exception $ex) {
      if ($ex->getCode() == GIT_ENOTFOUND) {
        echo '<p>Not Found</p>';
      }
      else {
        throw $ex;
      }
    }
  }

Declaration of exception class Git2Exception:
  class Git2Exception extends RuntimeException

--------------------------------------------------------------------------------
Function API Reference

Core API routines operate on opaque, resource values. They try to conform to the
original, C library calls they wrap. Most if not all of these functions have the
prefix "git_".

Functions provided by the extension that are not git2 wrappers have the prefix
'git2_*'. These are provided as supplements or additions where appropriate.

----------------------------------------
[misc]
----------------------------------------

git2_version()

    Gets a string representing the php-git2 and libgit2 version.

    Returns string

git_libgit2_version()

    Gets the libgit2 version string. The version string has the form "%1.%2.%3"
    where %1, %2 and %3 are the respective major, minor and revision numbers
    returned from the underlying call to git_libgit2_version().

    Returns string

git_libgit2_features()

    Returns int

----------------------------------------
[git_repository]
----------------------------------------

git_repository_init(string,bool)

    Returns git_repository resource

git_repository_new()

    Returns git_repository resource

git_repository_free(resource)

git_repository_open(string)

    Returns git_repository resource

git_repository_open_bare(string)

    Returns git_repository resource

git_repository__cleanup(resource)

git_repository_detach_head(resource)

    Returns int

git_repository_fetchhead_foreach(resource,callable,mixed)

  Callback signature: void callback(string $refName,string $remoteUrl,string $oid,bool $isMerge,mixed $payload)

git_repository_mergehead_foreach(resource,callable,mixed)

  Callback signature: void callback(string $oid,mixed $payload)

git_repository_discover(string,bool,string)

    Returns string

git_repository_get_namespace(resource)

    Returns string

git_repository_hashfile(resource,string,long,string)

    Returns string

git_repository_path(resource)

    Returns string

git_repository_odb(resource)

    Returns git_odb resource

git_repository_set_odb(resource,resource)

git_repository_set_head(resource,string)

git_repository_set_head_detached(resource,string)

    Returns bool

git_repository_head(resource)

    Returns git_reference resource

git_repository_is_empty(resource)

    Returns bool

git_repository_is_bare(resource)

    Returns bool

git_repository_is_shallow(resource)

    Returns bool

git_repository_head_detached(resource)

    Returns bool

git_repository_head_unborn(resource)

    Returns bool

git_repository_ident(&string,repo)

    ** The returned string is the name. The assigned out-parameter is the
       email. **

    Returns string

git_repository_init_ext(string,array|null)

    The final parameter is an array of options with keys corresponding to the
    git_repository_init_options struct. If you do not specify an option key, it
    will be filled in with the default value supplied via
    git_repository_init_init_options. It may be null if you want to purely use
    the defaults.

    NOTE: the git2 extension does not implement
    git_repository_init_init_options(). Just use an array to pass in init
    options and it will be initialized for you behind-the-scenes.

    Returns git_repository resource

git_repository_message(resource)

    Returns string or false

git_repository_message_remove(resource)

git_repository_open_ext(string|null,int,string)

    Returns git_repository resource

git_repository_reinit_filesystem(resource,bool)

git_repository_set_bare(resource)

git_repository_set_head_detached_from_annotated(resource,resource)

    Returns bool

git_repository_set_ident(resource,string,string)

git_repository_set_namespace(resource,string)

git_repository_set_workdir(resource,string,bool)

git_repository_state(resource)

    Returns int

git_repository_state_cleanup(resource)

git_repository_workdir(resource)

    Returns string

git_repository_wrap_odb(resource)

    Returns git_repository resource

git_repository_config(resource)

    Returns git_config resource

git_repository_config_snapshot(resource)

    Returns git_config resource

git_repository_set_config(resource,resource)

git_repository_index(resource)

    Returns git_index resource

git_repository_set_index(resource,resource)

git_repository_refdb(resource)

    Returns git_refdb resource

git_repository_set_refdb(resource,resource)

----------------------------------------
[git_reference]
----------------------------------------

git_reference_list(resource)

    Returns array of string

git_reference_lookup(resource,string)

    Returns git_reference resource

git_reference_free(resource)

git_reference_peel(resource,long)

    Returns git_reference resource

git_reference_name_to_id(resource,string)

    Returns string

git_reference_create(resource,string,string,bool,string)

    Returns git_reference resource

git_reference_create_matching(resource,string,string,bool,string,string)

    Returns git_reference resource

git_reference_target(resource)

    Returns string

git_reference_target_peel(resource)

    Returns string

git_reference_name(resource)

    Returns string

int git_reference_cmp(resource $ref1,resource $ref2)

    Returns the same return value as underlying library call.

git_reference__alloc(string,string,string)

    Returns git_reference resource

git_reference__alloc_symbolic(string,string)

    Returns git_reference resource

git_reference_delete(resource)

git_reference_dup(resource)

    Returns git_reference resource

git_reference_ensure_log(resource,string)

git_reference_has_log(resource,string)

    Returns bool

git_reference_is_branch(resource)

    Returns bool

git_reference_is_note(resource)

    Returns bool

git_reference_is_remote(resource)

    Returns bool

git_reference_is_tag(resource)

    Returns bool

git_reference_is_valid_name(string)

    Returns bool

git_reference_iterator_new(resource)

    Returns git_reference_iterator resource

git_reference_iterator_glob_new(resource)

    Returns git_reference_iterator resource

git_reference_next(resource)

    Returns git_reference resource or false if iteration is over

git_reference_next_name(resource)

    Returns string or false if iteration is over

git_reference_normalize_name(string,int)

    Returns string

git_reference_owner(resource)

    Returns git_repository resource

git_reference_remove(resource,string)

git_reference_rename(resource,string,bool,string)

    Returns git_reference resource

git_reference_resolve(resource)

    Returns git_reference resource

git_reference_set_target(resource,string,string)

    Returns git_reference resource

git_reference_shorthand(resource)

    Returns string

git_reference_type(resource)

    Returns int

git_reference_foreach(resource,callable,mixed)

    Callback signature: void callback(resource $ref,mixed $payload)

        The callback should throw on error.

git_reference_foreach_name(resource,callable,mixed)

    Callback signature: void callback(string $name,mixed $payload)

        The callback should throw on error.

git_reference_foreach_glob(resource,string,callable,mixed)

git_reference_symbolic_create(resource,string,string,bool,string)

    Returns git_reference resource

git_reference_symbolic_create_matching(resource,string,string,bool,string,string)

    Returns git_reference resource

git_reference_symbolic_set_target(resource,string,string)

    Returns git_reference resource

git_reference_symbolic_target(resource)

    Returns string

----------------------------------------
[git_object]
----------------------------------------
git_object_id(resource)

    Returns string

git_object_lookup(resource,string,int)

    Returns resource

git_object_free(resource)

git_object_peel(resource,int)

    Returns git_object resource

git_object_dup(resource)

    Returns git_object resource

git_object_lookup_bypath(resource,string,int)

    Returns git_object resource

git_object_lookup_prefix(resource,string,int)

    Returns git_object resource

git_object_owner(resource)

    Returns git_repository resource

git_object_short_id(resource)

    Returns string

git_object_string2type(string)

    Returns int

git_object_type(resource)

    Returns int

git_object_type2string(int)

    Returns string

git_object_typeisloose(int)

    Returns bool

----------------------------------------
[git_revwalk]
----------------------------------------
git_revwalk_new(resource)

git_revwalk_push(resource,string)

git_revwalk_next(resource)

    Returns string or false when on iterover

git_revwalk_hide(resource,string)

git_revwalk_sorting(resource,int)

git_revwalk_reset(resource)

git_revwalk_free(resource)

git_revwalk_add_hide_cb(resource,callable,mixed)

    Callback signature: void callback(string $commitId,mixed $payload)

        The function should throw on error.

git_revwalk_hide_glob(resource,string)

git_revwalk_hide_head(resource)

git_revwalk_hide_ref(resource,string)

git_revwalk_push_glob(resource,string)

git_revwalk_push_head(resource)

git_revwalk_push_range(resource,string)

git_revwalk_push_ref(resource,string)

git_revwalk_repository(resource)

git_revwalk_simplify_first_parent(resource)

----------------------------------------
[git_packbuilder]
----------------------------------------

git_packbuilder_new(resource)

    Returns git_packbuilder resource

git_packbuilder_free(resource)

git_packbuilder_hash(resource)

    Returns string

git_packbuilder_insert_commit(resource,string)

git_packbuilder_insert_walk(resource,resource)

git_packbuilder_insert_recur(resource,string,string|null)

git_packbuilder_insert_tree(resource,string)

git_packbuilder_insert(resource,string,string|null)

git_packbuilder_foreach(resource,callable,mixed)

    If the 3rd parameter is a stream and the 2nd parameter is null, then each
    call will write the data to the stream.

    Callback signature: void callback(string $data,int $length,mixed $payload)

        The callback should return false to cancel the transaction.

        The callback should throw on error.

git_packbuilder_set_threads(resource,int)

git_packbuilder_set_callbacks(resource,callable,mixed)

    Callback signature: void callback(int $stage,int $current,int $total,mixed $payload)

        The callback should throw on error.

git_packbuilder_object_count(resource)

    Returns int

git_packbuilder_write(resource,string,int,callable,mixed)

    Callback signature: callback(array $stats)

        The $stats array has properties of the libgit2 git_transfer_progress
        struct.

git_packbuilder_written(resource)

    Returns int

----------------------------------------
[git_indexer]
----------------------------------------

resource git_indexer_new(string $path,int $mode,?resource $odb,?array $options)

    $options: [
        'progress_cb' => callable: void callback(array $stats,mixed $payload),
        'progress_cb_payload' => mixed,
        'verify' => bool,
    ]

    Return git_indexer resource

git_indexer_hash(resource)

    Returns string

git_indexer_append(resource,string)

    ** Transfer progress is stored in the resource. As such it is not passed to
       this function. **

git_indexer_commit(resource)

    ** Transfer progress is stored in the resource. As such it is not passed to
       this function. **

git_indexer_free(resource)

git2_indexer_stats(resource)

    ** To avoid the expense of translating a stats object every time and indexer
       operation is performed, the user may call this to get the indexer
       transfer progress stats at any time. The transfer progress structure is
       stored in the indexer resource object. **

    Returns array, associative array with git_transfer_progress fields

----------------------------------------
[git_odb]
    [git_odb_object]
----------------------------------------

git_odb_new()

    Return git_odb resource

git_odb_free(resource)

git_odb_write_pack(resource,callable,mixed)

    ** The 3rd parameter may be null. **

    Returns object instance of type GitODBWritepack_Internal

git_odb_backend_pack(string)

    Returns object instance of type GitODBBackend

git_odb_backend_loose(string,int,bool,int,int)

    Returns object instance of type GitODBBackend

git_odb_backend_one_pack(string)

    Returns object instance of type GitODBBackend

git_odb_open(string)

    Returns git_odb resource

git_odb_write(resource,string,int)

    Returns string

git_odb_read(resource,string)

    Returns git_odb_object resource

git_odb_read_header(&int,resource,string)

    Returns int (the size of the object)

git_odb_read_prefix(resource,string)

    Returns git_odb_object resource

git_odb_object_free(resource)

git_odb_object_data(resource)

    Returns string

git_odb_object_id(resource)

    Returns string

git_odb_object_size(resource)

    Returns int

git_odb_object_type(resource)

   Returns int

git_odb_object_dup(resource)

    Returns git_odb_object resource

GitODBStream git_odb_open_rstream(int &$len,int &$type,resource $odb,string $oid)

    Returns object instance of type GitODBStream

git_odb_open_wstream(resource,int,int)

    Returns object instance of type GitODBStream

git_odb_stream_read(GitODBStream,int)

    ** The 2nd parameter is the length of the buffer to allocate. **

    Returns string

git_odb_stream_write(GitODBStream,string)

git_odb_stream_finalize_write(GitODBStream)

    Returns string

git_odb_add_alternate(resource,GitODBBackend,int)

git_odb_add_disk_alternate(resource,string)

git_odb_add_backend(resource,GitODBBackend,int)

git_odb_exists(resource,string)

    Returns bool

git_odb_exists_prefix(resource,string)

    ** This function throws when not found or ambiguous. It returns a string
       when the object is found. **

    Returns string

void git_odb_expand_ids(resource $odb,array &$ids)

  Note: this function will return results in the $ids parameter. While this
  parameter employs reference semantics, it is not technically passed by
  reference in the implementation.

git_odb_foreach(resource,callable,mixed)

    Callback signature: bool callback(string $oid,mixed $payload)

        To stop iteration, the callback should return false.

        The callback should throw on error.

git_odb_refresh(resource)

git_odb_get_backend(resource,int)

    Returns object of type GitODBBackend

git_odb_num_backends(resource)

    Returns int

git_odb_hash(string,int)

    Returns string

git_odb_hashfile(string,int)

    Returns string

----------------------------------------
[git_commit]
----------------------------------------

git_commit_lookup(resource,string)

    Returns git_commit resource

git_commit_lookup_prefix(resource,string)

    Returns git_commit resource

git_commit_parentcount(resource)

    Returns int

git_commit_parent_id(resource,int)

    Returns string

git_commit_parent(resource,int)

    Returns git_commit resource

git_commit_nth_gen_ancestor(resource,int)

    Returns git_commit resource

git_commit_id(resource)

    Returns string

git_commit_free(resource)

git_commit_owner(resource)

    Returns git_repository resource

git_commit_tree(resource)

    Returns git_tree resource

git_commit_tree_id(resource)

    Returns string

git_commit_time(resource)

    Returns int

git_commit_time_offset(resource)

    Returns int

git_commit_summary(resource)

    Returns string

git_commit_raw_header(resource)

    Returns string

git_commit_body(resource)

    Returns string

git_commit_message(resource)

    Returns string

git_commit_message_encoding(resource)

    Returns string

git_commit_message_raw(resource)

    Returns string

git_commit_author(resource)

    Returns git_signature resource

git_commit_committer(resource)

    Returns git_signature resource

git_commit_create(resource,string|null,resource,resource,string|null,string,resource,array)

    Example:
        $oid = git_commit_create($repo,$ref,$author,$committer,
                                 $encoding,$message,$tree,$parents);

    ** The final parameter should be an array of git_commit resources; the size
       is not previously passed in the PHP userspace version. **

    Returns string containing the new commit's OID

git_commit_create_from_callback(resource,string|null,resource,resource,string|null,string,string,callable,mixed)

    Example
        $oid = git_commit_from_callback($repo,$ref,$author,$committer,$encoding,
                                        $message,$treeId,$callable,$payload);

    Callback signature: string callback(int $idx,mixed $payload)

        This callback is not designed to report errors. If an error occures,
        then the calling function will finish and the error will be logged as a
        warning.

    Returns string containing the new commit's OID

git_commit_create_from_ids(resource,string|null,resource,resource,string|null,string,string,array)

    Example
        $oid = git_commit_from_ids($repo,$ref,$author,$committer,$encoding,
                                   $message,$treeId,$parents)

    ** The array should be a list of strings representing the parent commit
       OIDs. **

    Returns string containing the new commit's OID

git_commit_create_buffer(resource,resource,resource,string|null,string,resource,array)

    Example:
        $data = git_commit_create_buffer($repo,$author,$committer,
                                         $encoding,$message,$tree,$parents);

    ** The final parameter should be an array of git_commit resources; the size
       is not previously passed in the PHP userspace version. **

    Returns string containing the commit object

git_commit_create_with_signature(resource,string,string,string)

    Returns string

git_commit_amend(resource,string|null,resource|null,resource|null,string|null,string|null,resource|null)

    ** The arguments behavior like the C function in that NULL's are disregarded
       when amending the commit. **

    Returns string

git_commit_dup(resource)

    Returns git_commit resource

git_commit_extract_signature(&string,resource,string,string|null)

    ** The signed data is written to the string out parameter. The signature is
       returned. **

    Returns string

git_commit_header_field(resource,string)

    Returns string

----------------------------------------
[git_blob]
----------------------------------------

git_blob_create_frombuffer(resource,string)

    Returns string

git_blob_create_fromdisk(resource,string)

    Returns string

git_blob_create_fromworkdir(resource,string)

    Returns string

git_blob_filtered_content(resource,string,bool)

    Returns string

git_blob_free(resource)

git_blob_id(resource)

    Returns string

git_blob_is_binary(resource)

    Returns bool

git_blob_lookup(resource,string)

    Returns git_blob resource

git_blob_lookup_prefix(resource,string)

    Returns resource

git_blob_owner(resource)

    Returns git_repository resource

git_blob_rawcontent(resource)

    Returns string

git_blob_rawsize(resource)

    Returns int

git_blob_dup(resource)

    Returns git_blob resource

git_blob_create_fromstream(resource,string|null)

    Returns object of type GitWritestream

git_blob_create_fromstream_commit(GitWritestream)

    Returns string

----------------------------------------
[git_tree]
    [git_tree_entry]
----------------------------------------

git_tree_dup(resource)

    Returns git_tree resource

git_tree_entrycount(resource)

    Returns int

git_tree_free(resource)

git_tree_id(resource)

    Returns string

git_tree_lookup(resource,string)

    Returns git_tree resource

git_tree_lookup_prefix(resource,string)

    Returns git_tree resource

git_tree_owner(resource)

    Returns git_repository resource

git_tree_entry_free(resource)

git_tree_entry_byid(resource,string)

    Returns git_tree_entry resource or null

git_tree_entry_byindex(resource,int)

    Returns git_tree_entry resource or null

git_tree_entry_byname(resource,string)

    Returns git_tree_entry resource or null

git_tree_entry_bypath(resource,string)

    Returns git_tree_entry resource

git_tree_entry_dup(resource)

    Returns git_tree_entry resource

git_tree_entry_filemode(resource)

    Returns int

git_tree_entry_filemode_raw(resource)

    Returns int

git_tree_entry_name(resource)

    Returns string

git_tree_entry_cmp(resource,resource)

    Returns int

git_tree_entry_id(resource)

    Returns string

git_tree_entry_type(resource)

    Returns int

git_tree_walk(resource,int,callable,mixed)

    Callback signature: void callback(string $root,resource $entry,mixed $payload)

        The callback should throw on error.

----------------------------------------
[git_signature]
----------------------------------------

git_signature_new(string,string,long,long)

    Returns git_signature resource

git_signature_free(resource)

git_signature_dup(resource)

    Returns git_signature resource

git_signature_default(resource)

    Returns git_signature resource

git_signature_now(string,string)

    Returns git_signature resource

git_signature_from_buffer(string)

    Returns git_signature resource

git2_signature_convert(resource)

    Gets an associative array corresponding to the git_signature structure. The
    associative array has the following keys:

        - name
        - email
        - when.time
        - when.offset

    Returns array

----------------------------------------
[git_treebuilder]
----------------------------------------

git_treebuilder_new(resource,resource|null)

    Returns git_treebuilder resource

git_treebuilder_free(resource)

git_treebuilder_filter(callable,mixed)

    Callback signature:
        bool callback(array $entry,mixed $payload)

        Returns FALSE to filter (i.e. remove) the entry.

git_treebuilder_write(resource)

    Returns string

git_treebuilder_insert(resource,string,string,int)

    ** Note: this function always returns the tree entry. **

    Returns git_tree_entry resource

git_treebuilder_get(resource,string)

    Returns git_tree_entry resource

git_treebuilder_remove(resource,string)

git_treebuilder_clear(resource)

git_treebuilder_entrycount(resource)

    Returns int

----------------------------------------
[git_blame]
----------------------------------------

git_blame_file(resource,string,array|null)

    ** The final parameter is an array of options with keys corresponding to the
       git_blame_options struct. It may be null if you want to use the
       defaults. **

    Returns git_blame resource

git_blame_buffer(resource,string)

    Returns git_blame resource

git_blame_get_hunk_count(resource)

    Returns int

git_blame_get_hunk_byindex(resource,int)

    ** Note: the return array contains a single dimensional representation of
       the hunk data. Example:

        array(15) {
          ["lines_in_hunk"]
          ["final_commit_id"]
          ["final_start_line_number"]
          ["final_signature.name"]
          ["final_signature.email"]
          ["final_signature.when.time"]
          ["final_signature.when.offset"]
          ["orig_commit_id"]
          ["orig_path"]
          ["orig_start_line_number"]
          ["orig_signature.name"]
          ["orig_signature.email"]
          ["orig_signature.when.time"]
          ["orig_signature.when.offset"]
          ["boundary"]
        } **

    Returns array

git_blame_get_hunk_byline(resource,int)

    ** See git_blame_get_hunk_by_index() for an example of what the return
       result looks like. **

    Returns array

git_blame_get_hunk_count(resource)

    Returns int

----------------------------------------
[git_revparse]
----------------------------------------

git_revparse(resource,string)

    ** Note: the return array contains the fields of the revspec
       structure. Example:

        array(3) {
          ["from"]  resource of type git_object (may be null)
          ["to"]    resource of type git_object (may be null)
          ["flags"] int
        } **

    Returns array

git_revparse_ext(&resource,resource,string)

    ** The first argument is an output parameter. A resource of type
       git_reference may be written or null. **

    Returns git_object resource

git_revparse_single(resource,string)

    Returns git_object resource

----------------------------------------
[git_annotated_commit]
----------------------------------------

git_annotated_commit_from_fetchhead(resource,string,string,string)

    Returns git_annotated_commit resource

git_annotated_commit_from_ref(resource,resource)

    Returns git_annotated_commit resource

git_annotated_commit_from_revspec(resource,string)

    Returns git_annotated_commit resource

git_annotated_commit_lookup(resource,string)

    Returns git_annotated_commit resource

git_annotated_commit_id(resource)

    Returns string

git_annotated_commit_free(resource)

----------------------------------------
[git_branch]
----------------------------------------

git_branch_create(resource,string,resource,bool)

    Returns git_reference resource

git_branch_create_from_annotated(resource,string,resource,bool)

    Returns git_reference resource

git_branch_delete(resource)

bool git_branch_is_head(resource $branch)

git_branch_iterator_free(resource)

git_branch_iterator_new(resource,int)

    Returns git_branch_iterator resource

git_branch_next(&int,resource)

    Returns git_reference resource or false at iter over

git_branch_lookup(resource,string,int)

    Returns git_reference resource

git_branch_move(resource,string,bool)

    Returns git_reference resource

git_branch_name(resource)

    Returns string

git_branch_set_upstream(resource,string|null)

git_branch_upstream(resource)

    Returns git_reference resource if found, false otherwise

git_branch_upstream_name(resource,string)

    Returns string if found, false otherwise

git_branch_upstream_remote(resource,string)

    Returns string

----------------------------------------
[git_config]
----------------------------------------

git_config_new()

    Returns git_config resource

git_config_free(resource)

git_config_open_default()

    Returns git_config resource

git_config_open_global(resource)

    Returns git_config resource

git_config_open_level(resource,int)

    Returns git_config resource

git_config_open_ondisk(resource,string)

    Returns git_config resource

git_config_parse_bool(string)

    Returns bool

git_config_parse_int32(string)

    Returns int

git_config_parse_int64(string)

    Returns int

git_config_parse_path(string)

    Returns string

git_config_set_bool(resource,string,bool)

git_config_set_int32(resource,string,int)

git_config_set_int64(resource,string,int)

git_config_set_multivar(resource,string,string,string)

git_config_set_string(resource,string,string)

git_config_get_bool(resource,string)

    Returns bool

git_config_get_entry(resource,string)

    ** Note: returns an array with the following structure:

      array(3) {
        ["name"]
        ["value"]
        ["level"]
      } **

    Returns array

git_config_get_int32(resource,string)

    Returns int

git_config_get_int64(resource,string)

    Returns int

git_config_get_path(resource,string)

    Returns string

git_config_get_string(resource,string)

    Returns string

git_config_get_string_buf(resource,string)

    ** Note: this function is functionally equivalent to
       git_config_get_string(), except that it can encode binary
       strings. However binary strings are typically not stored in git config
       files... **

    Returns string

git_config_delete_entry(resource,string)

git_config_delete_multivar(resource,string,string)

git_config_find_global()

git_config_find_programdata()

git_config_find_system()

git_config_find_xdg()

git_config_snapshot(resource)

    Returns git_config resource

git_config_add_file_ondisk(resource,string,int,bool)

git_config_foreach(resource,callable,mixed)

    Callback signature: bool callback(array $entry,mixed $payload)

        Note: if an iteration of the callback returns TRUE, the operation is
        considered over and iterator stops.

        The callback should throw on error.

git_config_foreach_match(resource,string,callable,mixed)

    ** See notes for git_config_foreach. **

git_config_get_mapped(resource,string,array)

    ** The array must be an indexed array of 3-tuple array elements, with each
       inner 3-tuple array containing the git_configmap fields in the order
       [type,str_match,map_value]. The map_value entry is forced to be an
       integer. **

    Returns int

git_config_get_multivar_foreach(resource,string,string|null,callable,mixed)

    Callback signature: bool callback(array $entry,mixed $payload)

git_config_add_backend(resource,object,int,bool)

git_config_backend_foreach_match(object,string|null,callable,mixed)

    ** See notes for git_config_foreach. **

git_config_iterator_new(resource)

    Returns git_config_iterator resource

git_config_iterator_new(resource,string,string|null)

    Returns git_config_iterator resource

git_config_iterator_glob_new(resource,string)

    Returns git_config_iterator resource

git_config_multivar_iterator_new(resource,string,string|null)

    Returns git_config_iterator resource

git_config_iterator_free(resource)

git_config_next(resource)

    ** See git_config_get_entry() for details on returned value. **

    Returns array

git_config_lookup_map_value(array,string)

    ** The array must be an indexed array of 3-tuple array elements, with each
       inner 3-tuple array containing the git_configmap fields in the order
       [type,str_match,map_value]. The map_value entry is forced to be an
       integer. **

----------------------------------------
[git_clone]
----------------------------------------

git_clone(string,string,array|null)

    ** Note: the last parameter (options) is passed as an array with the keys
       representing the properties of the git_clone_options struct. The
       checkout_opts and fetch_opts properties may be arrays to their respective
       structures. Any properties that are not specified inherit the defaults
       provided via calling git_clone_init_options(). You may specify null to
       use only the defaults. **

    Callback 'repository_cb' signature: callback(string $path,bool $bare,mixed $payload)

        The callback should return git_repository resource.

        The callback should throw on error.

    Returns git_repository resource

----------------------------------------
[git_checkout]
----------------------------------------

git_checkout_head(resource,array|null)

    ** Note: the last parameter (options) is passed as an array with the keys
       matching the properties of the git_checkout_options struct. Any
       properties that are not specified inherit the defaults provided via
       calling git_checkout_init_options(). You may specify null to use only the
       defaults. **

git_checkout_tree(resource,resource,array|null)

    ** See notes for git_checkout_head(). **

git_checkout_index(resource,resource,array|null)

    ** See notes for git_checkout_head(). **

----------------------------------------
[git_tag]
----------------------------------------

git_tag_annotation_create(resource,string,resource,resource,string)

    Returns string

git_tag_create(resource,string,resource,resource,string,bool)

    Returns string

git_tag_create_frombuffer(resource,string,bool)

    Returns string

git_tag_create_lightweight(resource,string,resource,bool)

    Returns string

git_tag_lookup(resource,string)

    Returns git_tag resource

git_tag_lookup_prefix(resource,string)

    Returns git_tag resource

git_tag_free(resource)

git_tag_id(resource)

    Returns string

git_tag_target_id(resource)

    Returns string

git_tag_message(resource)

    Returns string

git_tag_name(resource)

    Returns string

git_tag_owner(resource)

    Returns git_repository resource

git_tag_peel(resource)

    Returns git_object resource

git_tag_target(resource)

    Returns git_object resource

git_tag_tagger(resource)

    Returns git_signature resource (or null)

git_tag_target_type(resource)

    Returns int

git_tag_delete(resource,string)

git_tag_dup(resource)

    Returns git_tag resource

git_tag_list(resource)

    Returns array

git_tag_list_match(resource,string)

    Returns array

git_tag_foreach(resource,callable,mixed)

    Callback signature: void callback(string $name,string $oid,mixed $payload)

        The callback should throw on error.

----------------------------------------
[git_diff]
----------------------------------------

Callback signatures for git_diff functions:

    notify_callback: int callback(resource $diff,array $delta,string $matchedPathspec,mixed $payload)

        NOTE: Errors generated by this callback cannot be handled and will be
        logged as warnings.

    progress_callback: bool callback(resource $diff,string $oldPath,string $newPath,mixed $payload)

        NOTE: Errors generated by this callback cannot be handled and will be
        logged as warnings.

        A return value of FALSE aborts the diff

    file_callback: void callback(array $delta,float $progress,mixed $payload)

        The callback should throw on error.

    binary_callback: void callback(array $delta,array $binary,mixed $payload)

        The callback should throw on error.

    hunk_callback: void callback(array $delta,array $hunk,mixed $payload)

        The callback should throw on error.

    line_callback: void callback(array $delta,array $hunk,array $line,mixed $payload)

        The callback should throw on error.

git_diff_free(resource)

git_diff_blob_to_buffer(resource|null,string|null,string|null,string|null,
    array|null,callable,callable,callable,callable,mixed)

git_diff_blobs(resource|null,string|null,resource|null,string|null,array|null,
    callable,callable,callable,callable,mixed)

git_diff_buffers(string|null,string|null,string|null,string|null,array|null,
    callable,callable,callable,callable,mixed)

git_diff_commit_as_email(resource,resource,int,int,int,array|null)

git_diff_from_buffer(string)

    Returns git_diff resource

git_diff_print(resource,int,callable,mixed)

git_diff_get_delta(resource,int)

    Returns array

git_diff_get_perfdata(resource)

    Returns array

git_diff_is_sorted_icase(resource)

    Returns bool

git_diff_foreach(resource,callable,callable,callable,callable,mixed)

git_diff_merge(resource,resource)

git_diff_to_buf(resource,int)

    Returns string

git_diff_tree_to_tree(resource,resource|null,resource|null,array|null)

    Returns git_diff resource

git_diff_tree_to_workdir(resource,resource|null,array|null)

    Returns git_diff resource

git_diff_tree_to_workdir_with_index(resource,resource|null,array|null)

    Returns git_diff resource

git_diff_status_char(int)

    Returns string

git_diff_num_deltas(resource)

    Returns int

git_diff_num_deltas_of_type(resource)

    Returns int

git_diff_find_similar(resource,array)

    The options array has the same property names as the libgit2 type.

git_diff_get_stats(resource)

    Returns git_diff_stats resource

git_diff_stats_free(resource)

git_diff_stats_deletions(resource)

    Returns int

git_diff_stats_insertions(resource)

    Returns int

git_diff_stats_to_buf(resource,int,int)

    Returns string

git_diff_format_email(resource,array)

    ** NOTE: The $opts['author'] option can be either an array like those
       returned from git2_signature_convert() OR a git_signature resource. **

    Returns string

git_diff_tree_to_tree(resource,resource|null,resource|null,array|null)

    Returns git_diff resource

git_diff_index_to_index(resource,resource|null,resource|null,array|null)

    Returns git_diff resource

git_diff_tree_to_index(resource,resource|null,resource|null,array|null)

    Returns git_diff resource

git_diff_index_to_workdir(resource,resource|null,array|null)

    Returns git_diff resource

----------------------------------------
[git_index]
----------------------------------------

git_index_add(resource,array)

git_index_add_all(resource,array,int,callable,mixed)

    Callback signature: void callback(string $path,string $matched_pathspec,mixed $payload)

        The callback should throw on error and return less than zero to stop
        iteration early.

    This function returns FALSE if the scan was aborted (i.e. iteration
    stopped).

    Returns bool

git_index_add_bypath(resource,string)

git_index_add_frombuffer(resource,array,string)

git_index_caps(resource)

    Returns int

git_index_checksum(resource)

    Returns string

git_index_clear(resource)

git_index_conflict_add(resource,array,array,array)

git_index_conflict_cleanup(resource)

git_index_conflict_get(&array,&array,&array,resource,path)

    ** NOTE: This function signature is the same as the C API. It doesn't have a
       return value that we care about. **

git_index_conflict_iterator_free(resource)

git_index_conflict_iterator_new(resource)

    Returns git_index_conflict_iterator resource

git_index_conflict_next(&array,&array,&array,resource)

    ** NOTE: This function signature is the same as the C API. **

    ** The function returns false when iteration is over. **

    Returns bool

git_index_conflict_remove(resource,string)

git_index_entrycount(resource)

    Returns int

git_index_entry_is_conflict(array)

    Returns boolean

git_index_stage(array)

    Returns int

git_index_find(resource,string)

    Returns int

git_index_find_prefix(resource,string)

    Returns int

git_index_free(resource)

git_index_get_byindex(resource,int)

    Returns git_index_entry array, or false if out of bounds

git_index_get_bypath(resource,string,int)

    Returns git_index_entry array, or false if does not exist

git_index_has_conflicts(resource)

    Returns boolean

git_index_new()

    Returns git_index resource

git_index_open(string)

    Returns git_index resource

git_index_owner(resource)

    Returns git_repository resource

git_index_path(resource)

    Returns string

git_index_read(resource,boolean)

git_index_read_tree(resource,resource)

git_index_remove(resource,string,int)

git_index_remove_all(resource,array,callable,mixed)

    ** See git_index_add_all() for callback description. **

    Returns bool

git_index_remove_bypath(resource,string)

git_index_remove_directory(resource,string,int)

git_index_set_caps(resource,int)

git_index_set_version(resource,int)

git_index_update_all(resource,array,callable,mixed)

    ** See git_index_add_all() for callback description. **

    Returns bool

git_index_version(resource)

    Returns int

git_index_write(resource)

git_index_write_tree(resource)

    Returns string

git_index_write_tree_to(resource,resource)

    Returns string

----------------------------------------
[git_trace]
----------------------------------------

git_trace_set(int)

    ** NOTE: this function uses the standard PHP error log to write traces. This
       only works if your libgit2 was built with tracing enabled. **

----------------------------------------
[git_ignore]
----------------------------------------

git_ignore_add_rule(resource,string)

git_ignore_clear_internal_rules(resource)

git_ignore_path_is_ignored(resource,string)

    Returns bool

----------------------------------------
[git_attr]
----------------------------------------

git_attr_add_macro(resource,string,string)

git_attr_cache_flush(resource)

git_attr_foreach(resource,int,string,callable,mixed)

    Callback signature: void callback(string $name,string $value,mixed $payload)

        NOTE: $value may be NULL

        The function should throw on error.

git_attr_get(resource,int,string,string)

    Returns string

git_attr_value(string)

    Returns int

----------------------------------------
[git_status]
----------------------------------------

git_status_byindex(resource,int)

    ** The return array has the following structure: **

        array(3) {
          ["status"]
          ["head_to_index"]
            // git_diff_delta array
          ["index_to_workdir"]
            // git_diff_delta array
        }

    Returns array

git_status_file(resource,string)

    The function returns:

        - int: if the path was successfully found, the return value is an
               integer bitmask containing the status flags
        - null: the path was ambiguous
        - false: the path was not found

    Returns mixed

git_status_foreach(resource,callable,mixed)

    Callback signature: void callback(string $path,int $status_flag,mixed $payload)

        The function should throw on error.

git_status_foreach_ext(resource,array,callable,mixed)

    See notes on git_status_foreach() for callback signature.

git_status_list_entrycount(resource)

    Returns int

git_status_list_free(resource)

git_status_list_get_perfdata(resource)

    Returns array

git_status_list_new(resource,array|null)

    ** Note: The options array is optional. **

    Returns resource

git_status_should_ignore(resource,string)

    Returns bool

----------------------------------------
[git_cherrypick]
----------------------------------------

git_cherrypick(resource,resource,array|null)

git_cherrypick_commit(resource,resource,resource,int,array|null)

    Returns git_index resource

----------------------------------------
[git_merge]
----------------------------------------

git_merge(resource,array,array|null,array|null)

git_merge_analysis(&int,resource,array)

    The git_merge_preference_t value is returned throught the first parameter.

    Returns int (the git_merge_analysis_t value)

git_merge_base(resource,string,string)

    Returns string

git_merge_base_many(resource,array)

    ** NOTE: the 2nd argument is an array of strings **

    Returns string

git_merge_base_octopus(resource,array)

    ** NOTE: the 2nd argument is an array of strings **

    Returns string

git_merge_bases(resource,string,string)

    Returns array

git_merge_bases_many(resource,array)

    ** NOTE: the 2nd argument is an array of strings **

    Returns array

git_merge_commits(resource,resource,resource,array|null)

    Returns git_index resource

git_merge_file(array,array,array,array|null)

    ** NOTE: the git_merge_file_input contains a member "ptr" that encapsulates
       both "ptr" and "size" from the C structure. **

    Returns array (git_merge_file_result)

git_merge_file_from_index(resource,array,array,array,array|null)

    Returns array (git_merge_file_result)

git_merge_trees(resource,resource|null,resource,resource,array|null)

    Returns git_index resource

----------------------------------------
[git_note]
----------------------------------------

git_note_author(resource)

    Returns git_signature resource

git_note_committer(resource)

    Returns git_signature resource

git_note_create(resource,string|null,resource,resource,string,string,bool)

    Returns string

git_note_foreach(resource,string|null,callable,mixed)

git_note_free(resource)

git_note_id(resource)

    Returns string

git_note_iterator_free(resource)

git_note_iterator_new(resource,string|null)

    Returns git_note_iterator resource

git_note_message(resource)

    Returns string

git_note_next(&string,resource)

    ** NOTE: This function returns the note_id directly and assigns the
       annotated_id to the first argument. **

    Returns string

git_note_read(resource,string|null,string)

    Returns git_note resource

git_note_remove(resource,string|null,resource,resource,string)

----------------------------------------
[git_reflog]
----------------------------------------

git_reflog_append(resource,string,resource,string|null)

git_reflog_delete(resource,string)

git_reflog_drop(resource,int,bool)

    Returns bool

git_reflog_entry_byindex(resource,int)

    Return structure:

        - committer
        - id_new
        - id_old
        - message

    Returns array

git_reflog_entrycount(resource)

git_reflog_free(resource)

git_reflog_read(resource,string)

    Returns git_reflog resource

git_reflog_rename(resource,string,string)

git_reflog_write(resource)

----------------------------------------
[git_refdb]
----------------------------------------

git_refdb_backend_fs(resource)

    Returns GitRefDBBackend_Internal object

git_refdb_compress(resource)

git_refdb_free(resource)

git_refdb_new(resource)

    Returns git_refdb resource

git_refdb_open(resource)

    Returns git_refdb resource

git_refdb_set_backend(resource,object)

----------------------------------------
[git_patch]
----------------------------------------

git_patch_free(resource)

resource git_patch_from_blob_and_buffer(?resource $old_blob,?string $old_as_path,?string $buffer,?string $buffer_as_path,?array $options)

    Returns git_patch resource

git_patch_from_blobs(resource|null,string|null,resource|null,string|null,array|null)

    Returns git_patch resource

git_patch_from_buffers(string|null,string|null,string|null,string|null,array|null)

    Returns git_patch resource

git_patch_from_diff(resource,int)

    Returns git_patch_resource

git_patch_get_delta(resource)

    Returns array

git_patch_get_hunk(&int,resource,int)

    The function will assign the lines_in_hunk to the first parameter.

    Returns array

git_patch_get_line_in_hunk(resource,int,int)

    Returns array

git_patch_line_stats(&int,&int,resource)

    The function returns the total_context value.

    The total_additions value is assigned to the first parameter, and the
    total_deletions value is assigned to the second parameter.

    Returns int

git_patch_num_hunks(resource)

    Returns int

git_patch_num_lines_in_hunk(resource,int)

    Returns int or false if invalid hunk index

git_patch_print(resource,callable,mixed)

    Callback signature: void callback(array $delta,array $hunk,array $line,mixed $payload)

        The callback should throw on error.

git_patch_size(resource,bool,bool,bool)

    Returns int

git_patch_to_buf(resource)

    Returns string

----------------------------------------
[git_describe]
----------------------------------------

git_describe_commit(resource,array|null)

    Returns git_describe_result resource

git_describe_format(resource,array|null)

    Returns string

git_describe_result_free(resource)

git_describe_workdir(resource,array|null)

    Returns git_describe_result resource

----------------------------------------
[git_rebase]
----------------------------------------

git_rebase_abort(resource)

    Returns true if successful, false if a rebase is not in progress

git_rebase_commit(&string,resource,resource|null,resource,string|null,string|null)

    Returns int (same as git2 function, still throws on error)

git_rebase_finish(resource,resource|null)

git_rebase_free(resource)

git_rebase_init(resource,resource|null,resource|null,resource|null,array|null)

    Returns git_rebase resource

git_rebase_inmemory_index(resource)

    Returns git_index resource

git_rebase_next(resource)

    Returns array

git_rebase_open(resource,array|null)

    Returns git_rebase resource

git_rebase_operation_byindex(resource,int)

    Returns array

git_rebase_operation_current(resource)

    Returns int

git_rebase_operation_entrycount(resource)

    Returns int

----------------------------------------
[git_reset]
----------------------------------------

git_reset(resource,resource,int,array|null)

git_reset_default(resource,resource|null,array)

git_reset_from_annotated(resource,resource,int,array)

----------------------------------------
[git_revert]
----------------------------------------

git_revert(resource,resource,array|null)

git_revert_commit(resource,resource,resource,int,array|null)

    Returns git_index resource

----------------------------------------
[git_stash]
----------------------------------------

Stash apply options callback signature:

    void callback(int $progress,mixed $payload)

        The callback should return false to abort the stash.

        The callback should throw on error.

git_stash_apply(resource,int,array|null)

git_stash_drop(resource,int)

git_stash_foreach(resource,callable,mixed)

    Callback signature:

        void callback(int $index,string $message,string $stash_id,mixed $payload)

            The callback should return false to stop iteration.

            The callback should throw on error.

git_stash_pop(resource,int,array|null)

git_stash_save(resource,resource,string,int)

    Returns int

----------------------------------------
[git_remote]
----------------------------------------

Callback signatures:

    Transport message callback:

        bool callback(string $str,mixed $payload)

            If the function returns non-null and false, then the operation is
            aborted.

    Completion callback:

        void callback(int $type,mixed $payload)

    Credential acquire callback:

        resource callback(string $url,string $username_from_url,
                    int $allowed_types,mixed $payload)

            Returns git_cred resource or NULL to passthrough

    Transport certificate check callback:

        bool callback(array $cert,bool $valid,string $host,mixed $payload)

    Transfer progress callback:

        Same as for git_indexer_new:

                void callback(array $stats,mixed $payload)

    Update tips callback:

        void callback(string $refname,string $a,string $b,mixed $payload)

    Packbuilder progress callback:

        See git_packbuilder notes

        void callback(int $stage,int $current,int $total,mixed $payload)

    Push transfer progress callback:

        void callback(int $current,int $total,int $bytes,mixed $payload)

    Push update reference callback:

        void callback(string $refname,string $status,mixed $payload)

    Push negotiation callback:

        void callback(array $updates,mixed $payload)

    NOTE: the transport callback is not implemented at this time since we do not
    yet implement custom transports.

git_remote_add_fetch(resource,string,string)

git_remote_add_push(resource,string,string)

git_remote_autotag(resource)

    Returns int

git_remote_connect(resource,int,array|null,array|null,array|null)

git_remote_connected(resource)

    Returns bool

git_remote_create(resource,string,string)

    Returns git_remote resource

git_remote_create_anonymous(resource,string)

    Returns git_remote resource

git_remote_create_with_fetchspec(resource,string,string,string)

    Returns git_remote resource

git_remote_default_branch(resource)

    Returns string

git_remote_delete(resource,string)

git_remote_disconnect(resource)

git_remote_download(resource,null|array,array|null)

git_remote_dup(resource)

    Returns git_remote resource

git_remote_fetch(resource,array|null,array|null,string|null)

git_remote_free(resource)

git_remote_get_fetch_refspecs(resource)

    Returns array

git_remote_get_push_refspecs(resource)

    Returns array

git_remote_get_refspec(resource)

    Returns git_refspec resource

git_remote_is_valid_name(string)

    Returns bool

git_remote_list(resource)

    Returns array

git_remote_lookup(resource,string)

    Returns git_remote resource

git_remote_ls(resource)

    Returns array

git_remote_name(resource)

    Returns string

git_remote_owner(resource)

    Returns git_repository resource

git_remote_prune(resource,array|null)

git_remote_prune_refs(resource)

git_remote_push(resource,array|null,array|null)

git_remote_pushurl(resource)

git_remote_refspec_count(resource)

    Returns int

git_remote_rename(resource,string,string)

    Returns array

git_remote_set_autotag(resource,string,int)

git_remote_set_pushurl(resource,string,string)

git_remote_set_url(resource,string,string)

git_remote_stats(resource)

    Returns array

git_remote_stop(resource)

git_remote_update_tips(resource,array|null,bool,int,string|null)

git_remote_upload(resource,array|null,array|null)

git_remote_url(resource)

    Returns string

----------------------------------------
[git_refspec]
----------------------------------------

git_refspec_direction(resource)

    Returns int

git_refspec_dst(resource)

    Returns string

git_refspec_dst_matches(resource,string)

    Returns bool

git_refspec_force(resource)

    Returns bool

git_refspec_rtransform(resource,string)

    Returns string

git_refspec_src(resource)

    Returns string

git_refspec_src_matches(resource,string)

    Returns bool

git_refspec_string(resource)

    Returns string

git_refspec_transform(resource,string)

    Returns string

----------------------------------------
[git_cred]
----------------------------------------

git_cred_default_new()

    Returns git_cred resource

git_cred_free(resource)

git_cred_has_username(resource)

    Returns bool

git_cred_ssh_custom_new()

    ** NOT IMPLEMENTED **

git_cred_ssh_interactive_new()

    ** NOT IMPLEMENTED **

git_cred_ssh_key_from_agent(string)

    Returns git_cred resource

git_cred_ssh_key_memory_new(string,string,string,string)

    Returns git_cred resource

git_cred_ssh_key_new(string,string,string,string)

    Returns git_cred resource

git_cred_username_new(string)

    Returns git_cred resource

git_cred_userpass_plaintext_new(string,string)

    Returns git_cred resource

----------------------------------------
[git_submodule]
----------------------------------------

git_submodule_add_finalize(resource)

git_submodule_add_setup(resource,string,string,bool)

    Returns git_submodule resource

git_submodule_add_to_index(resource,bool)

git_submodule_branch(resource)

    Returns string

git_submodule_fetch_recurse_submodules(resource)

    Returns int

git_submodule_foreach(resource,callable,mixed)

git_submodule_free(resource)

git_submodule_head_id(resource)

    Returns string

git_submodule_ignore(resource)

    Returns int

git_submodule_index_id(resource)

    Returns string

git_submodule_init(resource,bool)

git_submodule_location(resource,string)

    Returns int

git_submodule_lookup(resource,string)

    Returns git_submodule resource

git_submodule_name(resource)

    Returns string

git_submodule_open(resource)

    Returns git_repository resource

git_submodule_owner(resource)

    Returns git_repository resource

git_submodule_path(resource)

    Returns string

git_submodule_reload(resource,bool)

git_submodule_repo_init(resource,bool)

    Returns git_repository resource

git_submodule_resolve_url(resource,string)

    Returns string

git_submodule_set_branch(resource,string,string)

git_submodule_set_fetch_recurse_submodules(resource,string,int)

git_submodule_set_ignore(resource,string,int)

git_submodule_set_update(resource,string,int)

git_submodule_set_url(resource,string,string)

git_submodule_status(resource,string,int)

    Returns int

git_submodule_sync(resource)

git_submodule_update(resource,bool,array|null)

git_submodule_update_strategy(resource)

    Returns int

git_submodule_url(resource)

    Returns string

git_submodule_wd_id(resource)

    Returns string

----------------------------------------
[git_worktree]
----------------------------------------

resource git_worktree_add(resource $repo,string $name,string $path,?array $opts)

void git_worktree_free(resource $wt)

bool git_worktree_is_locked(string &$reason,resource $wt)

bool git_worktree_is_prunable(resource $wt,?array $opts)

array git_worktree_list(resource $repo)

void git_worktree_lock(resource $wt,string $reason)

resource git_worktree_lookup(resource $repo,string $name)

string git_worktree_name(resource $wt)

resource git_worktree_open_from_repository(resource $repo)

string git_worktree_path(resource $wt)

int git_worktree_prune(resource $wt,?array $opts)

int git_worktree_unlock(resource $wt)

void git_worktree_validate(resource $wt)

  This function will throw an exception when the worktree fails to validate.

--------------------------------------------------------------------------------
Class API Reference

The php-git2 extension provides an abstraction as a PHP class only when it is
useful for subclassing the construct (e.g. in the case of a git_odb_backend) or
when the C API employs struct with pointer-to-function members.

The following classes are provided by the extension:

abstract class GitODBBackend:

    This class has properties/methods that align with the git_odb_backend
    structure. You use it to define your own custom backend.

    properties:

        int $version

        resource $odb

    methods:

        NOTE: All methods should throw on failure.

        NOTE: If a method is not to be implemented, either leave it alone
              (i.e. do not implement it) or have it call trigger_error() with
              E_USER_ERROR. These functions can be called from userspace if you
              know what is available; however they are designed to be defined in
              userspace and called by git2.

        string read(int &$type,string $oid)

            The method should write the object type to the $type out parameter.

        string read_prefix(string &$fullOid,int &$type,string $abbrevOid)

            Will return oid and type as out parameters respectively.

        void read_header(int &$size,int &$type,string $oid)

            Will return size and type as out parameters respectively.

        void write(string $oid,string $data,int $type)

        GitODBStream writestream(int $offset,int $objectType)

        GitODBStream readstream(int &$len_out,int &$type_out,string $oid)

            Return false if object not found.

        bool exists(string $oid)

        bool exists_prefix(string &$fullOid,string $prefix)

        void refresh()

        void for_each(callable $callback,mixed $payload)

            Note: This function is not named canonically with git2 since
                  "foreach" is a reserved word in PHP.

            Callback signature: int callback(string $id,mixed $payload)

            Notes on overriding:

            Some important distinctions apply when overriding due to
            implementation constraints. When the git2 library internally is
            routed to this method by the extension, the payload will be null
            even if some underlying value is assigned. In this case the
            extension takes care of forwarding the payload "behind the scenes"
            since the payload value cannot be converted to a PHP value (plus,
            that operation would be wasteful anyway). The payload value only
            really matters in userspace if userspace initiated the method call
            itself.

            An implementation overriding this method should always pass in the
            payload as the second parameter to the callback so that a userspace
            payload is routed correctly.

            If the callback returns FALSE (exactly), then the implementation
            should stop the iteration.

        GitODBWritepack writepack(resource $odb,callable $func,mixed $payload)

            Callback signature: int callback(array $stats,mixed $payload)

            If the callack returns less than zero, the transfer should be
            canceled.

            NOTE: If this is called from GitODBBackend_Internal, then the object
            will be of type GitODBWritepack_Internal.

final class GitODBBackend_Internal extends GitODBBackend

    This class is used to represent internal ODB backends. It cannot be
    instantiated directly.

abstract class GitODBWritepack:

    This class has properties/methods that align with the git_odb_writepack
    structure.

    properties:

        GitODBBackend $backend

    methods:

        NOTE: Use the following method signatures when creating/using a custom
              subclass of GitODBWritepack. If you are using an instance of type
              GitODBWritepack_Internal, then use the method signatures
              documented for GitODBWritepack_Internal.

        void append(string $data,array &$stats)

        void commit(array &$stats)

final class GitODBWritepack_Internal extends GitODBWritepack

    This class is used to represent an internal ODB writepack. It cannot be
    instantiated directly.

    NOTE: This object maintains its own git_transfer_progress structure
          internally. This object is implicitly passed to the append() and
          commit() methods. You can access a readonly version of this data from
          the $progress property.

    properties:

        (inherited)

        array $progress

    methods:

        NOTE: In this class, the signatures for the append() and commit()
              methods aredifferent since you do not have to pass in the
              git_transfer_progress.

        void append(string $data)

        void commit()

abstract class GitODBStream:

    This class has properties/methods that align with the git_odb_stream
    structure. You use this class to interface with ODB stream's returned by
    libgit2 and to create your own custom ODB streams.

    properties:

        int $mode
        int $declared_size
        int $received_bytes

    methods:

        NOTE: All methods should throw on failure.

        string read(int $bufsz)

            Creates a buffer of the specified size and calls the read() function
            for the stream.

        void write(string $buffer)

        void finalize_write(string $oid)

final class GitODBStream_Internal extends GitODBStream:

    This class is used to represent internal ODB stream objects. It cannot be
    instantiated directly.

final class GitWritestream:

    This class has properties/methods that align with the git_writestream
    structure.

    methods:

        void write(string $buffer)

        void close()

abstract class GitConfigBackend:

    This class has properties/methods that align with the git_config_backend
    structure.

    properties:

        bool $readonly

    methods:

        NOTE: All methods should throw on failure.

        NOTE: If a method is not to be implemented, either leave it alone
              (i.e. do not implement it) or have it call trigger_error() with
              E_USER_ERROR. These functions can be called from userspace if you
              know what is available; however they are designed to be defined in
              userspace and called by git2.

        void open(int $level,resource $repo)

        array get(string $key)

            This method returns array with properties 'name', 'value' and
            'level' corresponding to git_config_entry. If the method fails
            lookup, it should return false or some falsy value (e.g. 0, null).

            If 'level' is not specified in the return array, then level defaults
            to GIT_CONFIG_LEVEL_APP.

        void set(string $key,string $value)

        void set_multivar(string $name,string $regexp,string $value)

        void del(string $name)

        void del_multivar(string $name,string $regexp)

        mixed iterator_new()

            This method should initialize the object for a new
            iteration. Iteration will call the iterator_next() method. This
            method may optionally return a context value to identify the
            iterator. This is largely not useful since git2 config iteration is
            currently only synchronous.

        array iterator_next(mixed $context)

            This method should return the next config value. The return value is
            the same as for the get() method.

            The $context argument holds any value returned from a previous call
            to iterator_new().

            This method must return false when iteration is over.

        GitConfigBackend snapshot()

        void lock()

        void unlock(int success)

abstract class GitRefDBBackend:

    This class has methods and properties that align with the git_refdb_backend
    structure. You can use this class to define your own custom reference
    databases.

    methods:

        bool exists(string $ref_name)

        string lookup(string $ref_name)

            Method should return string OID or symbolic name.

        void iterator_new(string $glob)

            $glob may be NULL

        string iterator_next(string &$name)

            Method should return string OID or symbolic name and assign
            reference name to $name.

            Method should return false when iteration is over.

        void write(resource $ref,bool $force,array $who,string $message,string $old,string $old_target)

            NOTE: $message may be NULL.

        resource rename(string $old_name,string $new_name,bool $force,array $who,string $message)

            NOTE: $message may be NULL.

            Returns git_reference resource

        void del(string $ref_name,string $old_id,string $old_target);

        void compress()

        bool has_log(string $refname)

        void ensure_log(string $refname)

        array reflog_read(string $name)

            NOTE: This method is unimplementable by custom backends until
                  libgit2 exposes proper support for creating/manipulating
                  reflogs.

            Method returns indexed array of reflog entries.

        void reflog_write(resource $reflog)

            Method is passed a git_reflog resource.

        void reflog_rename(string $old_name,string $new_name)

        void reflog_delete(string $name)

        mixed lock(string $refname)

            NOTE: Whatever value is returned from this method is the value
                  subsequently passed as the first argument to the unlock()
                  method.

        void unlock(mixed $payload,bool $success,bool $update_reflog,resource $ref,array $sig,string $message)

final class GitRefDBBackend_Internal extends GitRefDBBackend:

    This class represents internal refdb backends. You use this class to
    interface with refdb backends returned by libgit2, such as from
    git_refdb_backend_fs().

    This class cannot be instantiated directly.

    NOTE: The GitRefDBBackend_Internal does not provide access to the lock()
    and unlock() methods. They will generate a fatal error if called.

    NOTE: The following method signatures listed here represent overloads in
    this derived class.

    resource lookup(string $refname)

        Returns git_reference resource