Overview

Namespaces

  • Cz
    • Git

Classes

  • Cz\Git\GitRepository

Interfaces

  • Cz\Git\IGit

Exceptions

  • Cz\Git\GitException
  • Overview
  • Namespace
  • Class
  1:   2:   3:   4:   5:   6:   7:   8:   9:  10:  11:  12:  13:  14:  15:  16:  17:  18:  19:  20:  21:  22:  23:  24:  25:  26:  27:  28:  29:  30:  31:  32:  33:  34:  35:  36:  37:  38:  39:  40:  41:  42:  43:  44:  45:  46:  47:  48:  49:  50:  51:  52:  53:  54:  55:  56:  57:  58:  59:  60:  61:  62:  63:  64:  65:  66:  67:  68:  69:  70:  71:  72:  73:  74:  75:  76:  77:  78:  79:  80:  81:  82:  83:  84:  85:  86:  87:  88:  89:  90:  91:  92:  93:  94:  95:  96:  97:  98:  99: 100: 101: 102: 103: 104: 105: 106: 107: 108: 109: 110: 111: 112: 113: 114: 115: 116: 117: 118: 119: 120: 121: 122: 123: 124: 125: 126: 127: 128: 129: 130: 131: 132: 133: 134: 135: 136: 137: 138: 139: 140: 141: 142: 143: 144: 145: 146: 147: 148: 149: 150: 151: 152: 153: 154: 
<?php
    /** IGit interface
     * 
     * @author      Jan Pecha, <janpecha@email.cz>
     */
    
    namespace Cz\Git;
    
    interface IGit
    {
        /**
         * Creates a tag.
         * @param   string
         * @throws  Cz\Git\GitException
         */
        function createTag($name);
        
        
        
        /**
         * Removes tag.
         * @param   string
         * @throws  Cz\Git\GitException
         */
        function removeTag($name);
        
        
        
        /**
         * Renames tag.
         * @param   string
         * @param   string
         * @throws  Cz\Git\GitException
         */
        function renameTag($oldName, $newName);
        
        
        
        /**
         * Returns list of tags in repo.
         * @return  string[]|NULL  NULL => no tags
         */
        function getTags();
        
        
        
        /**
         * Merges branches.
         * @param   string
         * @param   array|NULL
         * @throws  Cz\Git\GitException
         */
        function merge($branch, $options = NULL);
        
        
        
        /**
         * Creates new branch.
         * @param   string
         * @param   bool
         * @throws  Cz\Git\GitException
         */
        function createBranch($name, $checkout = FALSE);
        
        
        
        /**
         * Removes branch.
         * @param   string
         * @throws  Cz\Git\GitException
         */
        function removeBranch($name);
        
        
        
        /**
         * Gets name of current branch
         * @return  string
         * @throws  Cz\Git\GitException
         */
        function getCurrentBranchName();
        
        
        
        
        /**
         * Returns list of branches in repo.
         * @return  string[]|NULL  NULL => no branches
         */
        function getBranches();
        
        
        
        /**
         * Checkout branch.
         * @param   string
         * @throws  Cz\Git\GitException
         */
        function checkout($name);
        
        
        
        /**
         * Removes file(s).
         * @param   string|string[]
         * @throws  Cz\Git\GitException
         */
        function removeFile($file);
        
        
        
        /**
         * Adds file(s).
         * @param   string|string[]
         * @throws  Cz\Git\GitException
         */
        function addFile($file);
        
        
        
        /**
         * Renames file(s).
         * @param   string|string[]  from: array('from' => 'to', ...) || (from, to)
         * @param   string|NULL
         * @throws  Cz\Git\GitException
         */
        function renameFile($file, $to = NULL);
        
        
        
        /**
         * Commits changes
         * @param   string
         * @param   string[]  param => value
         * @throws  Cz\Git\GitException
         */
        function commit($message, $params = NULL);
        
        
        
        /**
         * Exists changes?
         * @return  bool
         */
        function isChanges();
    }
    
    
    
    class GitException extends \Exception
    {
    }

czproject/git-php version-2 API documentation API documentation generated by ApiGen