VersionControl_Hg / src / Documentation / API / Docbook / versioncontrol / hg / versioncontrol-hg / --construct.xml

The default branch has multiple heads

<refentry id="package.versioncontrol.hg.versioncontrol-hg.--construct">
 <refnamediv>
  <refname>
   constructor
   <function>VersionControl_Hg::__construct</function>
  </refname>
  <refpurpose>Constructor</refpurpose>
 </refnamediv>
 <refsynopsisdiv>
  <funcsynopsis>
   <funcsynopsisinfo>require_once &apos;/Hg.php&apos;;</funcsynopsisinfo>
   <funcprototype>
    <funcdef>
     void      constructor
     <function>VersionControl_Hg::__construct</function>
    </funcdef>
    <paramdef>
     string
     <parameter>
      <optional>$repository = &null;</optional>
     </parameter>
    </paramdef>
   </funcprototype>
  </funcsynopsis>
 </refsynopsisdiv>
 <refsect1 id="package.versioncontrol.hg.versioncontrol-hg.--construct.desc">
  &title.desc;
  <para>Assumes it will be working on a local filesystem repository</para>
  <para>
   The repository path is optional in the constructor.  It can be set with an explicit setting of the repository&apos;s path.  You can only set the path once since Repository is a singleton;  All subsqeuent attempts will silently fail after one of the below  has been performed:
   <programlisting role="php">
<![CDATA[$hg->setRepository('/path/to/repository');]]>
   </programlisting>
   or
   <programlisting role="php">
<![CDATA[$hg->repository->setPath('/path/to/repository');]]>
   </programlisting>
   or
   <programlisting role="php">
<![CDATA[$hg->repository = '/path/to/repository';]]>
   </programlisting>
  </para>
 </refsect1>
 <refsect1 id="package.versioncontrol.hg.versioncontrol-hg.--construct.param">
  &title.param;
  <para>
   <variablelist>
    <varlistentry>
     <term>
      &type.string;
      <parameter>$repository</parameter>
     </term>
     <listitem>
      <para>Optional path to a mercurial repository.</para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 <refsect1 id="package.versioncontrol.hg.versioncontrol-hg.--construct.throws">
  &title.throws;
  <para>
   <emphasis>throws</emphasis>
   no exceptions thrown
  </para>
 </refsect1>
 <refsect1 id="package.versioncontrol.hg.versioncontrol-hg.--construct.note">
  &title.note;
  &note.notstatic;
</refsect1>
</refentry>
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.