diff --git a/book/getting_started.rst b/book/getting_started.rst index 9014053..674e229 100644 --- a/book/getting_started.rst +++ b/book/getting_started.rst @@ -49,7 +49,7 @@ The shortest self-contained example should output a line with 'value': $repository = $factory->getRepository($parameters); // create the credentials object to authenticate with the repository - $credentials = new \PHPCR\SimpleCredentials('admin','admin'); + $credentials = new \PHPCR\SimpleCredentials('admin', 'admin'); // login to the repository and retrieve the session $session = $repository->login($credentials, 'default'); @@ -77,7 +77,7 @@ Get some data into the repository --------------------------------- We will discuss the import feature in more detail later, but to have some -data, we just import something here. Create an XML file called `test.xml``: +data now for the example, we just import something here. Create an XML file called `test.xml``: .. code-block:: xml diff --git a/book/import_export.rst b/book/import_export.rst index f59fcf6..03253fa 100644 --- a/book/import_export.rst +++ b/book/import_export.rst @@ -15,7 +15,7 @@ an SQL table into a ``csv`` file. You can restore the data from both, but the SQ dump knows every detail about your field types and so on while the CSV just knows the data. -When exporting, you explictly call a method corresponding to the desired +When exporting, you explicitly call a method corresponding to the desired format: .. code-block:: php diff --git a/book/reading_data_and_traversal.rst b/book/reading_data_and_traversal.rst index 408520d..b51ea68 100644 --- a/book/reading_data_and_traversal.rst +++ b/book/reading_data_and_traversal.rst @@ -43,7 +43,7 @@ Reading properties fpassthru($stream); fclose($stream); - // the above in short if you just want to dump a file that is in a binary propery: + // the above in short if you just want to dump a file that is in a binary property: // fpassthru($node->getPropertyValue('binary-prop')); Note: the backend stores the property types. When getting property values, they are returned diff --git a/book/transactions.rst b/book/transactions.rst index d9a2915..7c4f621 100644 --- a/book/transactions.rst +++ b/book/transactions.rst @@ -3,7 +3,7 @@ Transactions The PHPCR API in itself uses some sort of 'transaction' model by only persisting changes on session save. If you need transactions over more than one -save operation or including workspace operations that are dispatched immediatly, +save operation or including workspace operations that are dispatched immediately, you can use transactions. Note that Jackalope does not support the full transactions: diff --git a/phpcr-shell/configuration.rst b/phpcr-shell/configuration.rst index 8c85b01..35fd775 100644 --- a/phpcr-shell/configuration.rst +++ b/phpcr-shell/configuration.rst @@ -13,7 +13,7 @@ commands: PHPCRSH> shell:config:init PHPCRSH> shell:config:reload -At time of writing the only configuration file affected by these commands is +At the time of writing the only configuration file affected by these commands is the ``aliases.yml`` file detailed below. .. _phpcrsh_configuration_aliases: @@ -39,7 +39,7 @@ For example: Are all examples of aliases. -Below is the distribution version of this file at time of writing: +Below is the distribution version of this file at the time of writing: .. code-block:: yaml diff --git a/phpcr-shell/connecting.rst b/phpcr-shell/connecting.rst index eb4cf5d..804a829 100644 --- a/phpcr-shell/connecting.rst +++ b/phpcr-shell/connecting.rst @@ -29,7 +29,7 @@ Doctrine-Dbal General connections """"""""""""""""""" -The following is the minimal required to connect to a MySQL database: +The following is the minimal required parameters to connect to a MySQL database: .. code-block:: bash @@ -39,7 +39,7 @@ Parameters: - **db-name**: Name of database to connect to - **db-user**: Username for database, default ``root`` -- **db-password**: Password for datanase, default empty +- **db-password**: Password for database, default empty - **db-host**: Host for database, default ``localhost`` - **db-path**: Path to sqlite database diff --git a/phpcr-shell/installation.rst b/phpcr-shell/installation.rst index 579f4d9..92cb604 100644 --- a/phpcr-shell/installation.rst +++ b/phpcr-shell/installation.rst @@ -2,7 +2,7 @@ Installation ============ You can install PHPCR Shell either as an embedded application or as a PHAR, or -you can built it your self (for instance if you want the latest version). +you can build it yourself (when you want the latest version). .. _phpcrsh-connecting-installation-as-phar: @@ -12,7 +12,7 @@ Install as a PHAR The latest release can be downloaded from the `Github releases page `_. -After downloading it it is recommended to install it in a path accessible +After downloading it is recommended to install it in a path accessible by the system, for example: .. code-block:: bash @@ -43,7 +43,7 @@ Simply add the shell to your ``composer.json`` file ... require: { ... - "phpcr-shell": "" + "phpcr-shell": "" } ... } @@ -57,7 +57,7 @@ And you can connect directly: Build it from source -------------------- -PHPSH uses the box PHAR building tool, install it `here `_. +PHPCRSH uses the box PHAR building tool, install it `here `_. Build the PHAR: diff --git a/phpcr-shell/interacting.rst b/phpcr-shell/interacting.rst index 1883f5f..2a7cf49 100644 --- a/phpcr-shell/interacting.rst +++ b/phpcr-shell/interacting.rst @@ -1,13 +1,13 @@ Interacting =========== -The PHPCRSH is designed to be a hybrid of a filesystem and RDBMS shell. You can +The PHPCRSH is designed to be a hybrid of a filesystem and an RDBMS shell. You can both navigate the content hierarchy and execute queries. .. note:: PHPCRSH supports "aliases". In this chapter we will use aliases rather than the full - commands, for example "ls" instead of "node:list", "rm" instead of "node:remove" etc. + version of the commands, for example "ls" instead of "node:list", "rm" instead of "node:remove" etc. See the chapter on :ref:`phpcrsh_configuration_aliases` for more information. This chapter aims to highlight some but not all of the features of the shell. For a full @@ -16,7 +16,7 @@ list of features use the ``list`` command. The current path ---------------- -You can navigate the content heriarchy using the :ref:`phpcr_shell_command_shellpathchange` (or `cd` for short). The +You can navigate the content hierarchy using the :ref:`phpcr_shell_command_shellpathchange` (or `cd` for short). The `pwd` command is the alias for :ref:`phpcr_shell_command_shellpathshow` and displays the current working path: .. code-block:: bash @@ -80,7 +80,7 @@ And a depth: | jcr:primaryType | NAME | nt:unstructured | +--------------------------------------------------------------------------+-----------------+-----------------------------------+ -In addtion to listing the actual node content, you can also show the +In addition to listing the actual node content, you can also show the node properties and children which are defined in the schema with the ``-t`` option (**t** for template). The second of the following two examples illustrates this option: @@ -109,7 +109,7 @@ many. Editing nodes ------------- -You can edit nodes simply using your systems default editor (as defined by the ``$EDITOR`` environment +You can edit nodes simply by using your system's default editor (as defined by the ``$EDITOR`` environment variable).