Download the PHP package tilttek/writing-goals without Composer

On this page you can find all versions of the php package tilttek/writing-goals. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

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 PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • 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.
Please rate this library. Is it a good library?

Informations about the package writing-goals

tilttek/writing-goals

An author's writing goals: a plan that bends to the days they actually write, and no streak to break.

tilttek/writing-goals keeps an author's writing goals and tracks them. A goal is a target in words or pages, from a first day to a deadline, both included, over the days of the week the author chooses to write, less the dates they set aside. Its plan follows a curve: the same share each day, more at the start, more at the end, or weights the author draws. Each writing day's quota is what remains shared among the writing days left, in proportion to their weights in the whole plan: a day without writing is not a failure, its share moves to the days after, which keep the curve's shape; a day ahead lowers them. The author logs what they write each day, takes back a count logged too high, or corrects a day. A plan answers what was written, what remains, today's quota and what is left of it, the quota of each writing day to the deadline, the share of the target written, and whether the goal is reached — the application is told once — or past its deadline, which the author extends without losing anything. No streak is counted. Erasing an author removes their goals and their counts.

It is for a writing platform or a community that wants to help authors finish what they start — a novel in a month, a game book over a season — without the pressure of a chain that breaks at the first missed day.

It is a plain PHP library whose dependencies are phil/resource, the opaque reference of an author, psr/clock, the clock the author's today is read from, and psr/event-dispatcher, which tells the application of a goal reached. Authors are references the application gives, member:44: the library never reads a name, an e-mail or a text; the application counts the words and logs the count.

The design is small: a Goal holds its target, its Days, its Unit, its Curve and its WritingDays; a Planner turns a goal and its Progress into a Plan of DailyQuotas; WritingGoals keeps the goals in a GoalStore, logs the counts in a LogStore, and dispatches GoalReached.

Status

Part State
Goal, Day, Unit: a target in words or pages from a first day to a deadline, in the author's timezone Implemented and tested
Curve, CurveShape: linear, front-loaded, back-loaded or custom weights Implemented and tested
WritingDays: the days of the week the author writes, less the dates set aside Implemented and tested
Planner, Plan, DailyQuota: the daily quota recomputed from what remains, in whole numbers adding up to it Implemented and tested
Progress: the counts of each day Implemented and tested
WritingGoals: goals kept, counts logged, taken back and corrected, plans on the author's today, erasure Implemented and tested
GoalReached: the target reached, told to the application Implemented and tested
GoalStore, LogStore and their in-memory implementations, with the contracts any store passes Implemented and tested
Exceptions under one WritingGoalsException interface Implemented and tested

Documentation

Document What it covers
Installation Requirements, installing and wiring the library.
Goals and curves Targets, days, timezones, writing days and the four curves.
Plans and quotas How the daily quota is computed, missed days, days ahead, reaching the goal and the deadline.
Logging Logging, taking back and correcting counts, the goal reached, celebrating and erasure.
Writing a store The two contracts an application's storage implements.
Extension points What an application gives the library: the stores, the clock, the dispatcher.
Exceptions WritingGoalsException and its exceptions, with their messages.
Testing The library's tests and mutation bar, and how to test code that logs counts.
Reference Every type of the library, with its role.

Quick start

Requirements

PHP 8.5 or later.

Contributing

Contributions are welcome on the PHIL monorepo: read the contribution guide and the security policy explains, never in a public issue.

License

MIT, © Philippe Gamache, doing business as Le Gnome Archiviste; a Tilttek project. See LICENSE.


All versions of writing-goals with dependencies

PHP Build Version
Package Version
Requires php Version >=8.5
phil/resource Version ^0.1@dev
psr/clock Version ^1.0
psr/event-dispatcher Version ^1.0
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package tilttek/writing-goals contains the following files

Loading the files please wait ...