Download the PHP package schlaus/tagline without Composer
On this page you can find all versions of the php package schlaus/tagline. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download schlaus/tagline
More information about schlaus/tagline
Files in schlaus/tagline
Package tagline
Short Description Tagline takes a tag and a file, and tells you if the tag is found in the file, and on which line.
License MIT
Homepage https://github.com/schlaus/tagline
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package tagline
Tagline
Tagline takes a tag and a file, and tells you if the tag is found in the file, and on which line. Basically it's a vertical strpos() that works on files.
Install
Via Composer
Usage
The basics
API
The namespace for this package is Schlaus\Tagline\Tagline.
The main function this class provides. Takes in a tag, a target file, and optionally an offset, and looks for the first occurrence of that tag in the file. Returns false is the tag was not found, and throws an InvalidArgumentException if the file could not be read. Otherwise returns the line number the tag was first encountered on, as an integer.
Subsequent calls can be made without specifying a file, as the contents are cached on the first search. To bypass the cache simply specify the file again. This function always returns the first occurrence of the given tag. Use the $offset argument or the Tagline::findNext() method to find other occurrences.
Arguments
$tag- A string to search for$file- The file to search in. Can be provided as one of the following:- A filename as a string
- File contents as a string
- File contents as an array
- A stream resource
- An instance of
SplFileObject
A string is interpreted as a filename if it has no line breaks, even if such a file doesn't exist. This is to help you catch typos and logic errors. If you really want to look for a tag in a single line string, you can force the type interpretation with the fourth argument.
-
$offset- Number of lines to skip from the top of the file $interpretAs- Forces input to be interpreted as a specific type. Can be one of the following:- 'string'
- 'array'
- 'filename'
- 'stream'
- 'fileobject'
Returns the line number of the next occurrence of the tag that was last searched for, or false if no more occurrences are found.
A helper function for converting any supported source into a zero-based line-per-key array. The arguments are the as the second and the fourth argument for Tagline::findTag().
There's comments aplenty in the source, and a rather exhaustive test suite which should help in figuring out how something works if it's not clear from this documentation.
Change log
Please see CHANGELOG for more information what has changed recently.
Testing
Contributing
Please see CONTRIBUTING for details.
License
The MIT License (MIT). Please see http://schlaus.mit-license.org/ for more information.
