[{"data":1,"prerenderedAt":558},["ShallowReactive",2],{"navigation":3,"\u002Fdigging-deeper\u002Fpublic-api":173,"\u002Fdigging-deeper\u002Fpublic-api-surround":553},[4,27,69,103,113,135],{"title":5,"icon":6,"path":7,"stem":8,"children":9,"page":26},"Getting Started","i-heroicons-star","\u002Fgetting-started","1.getting-started",[10,14,18,22],{"title":11,"path":12,"stem":13},"Introduction","\u002Fgetting-started\u002Fintroduction","1.getting-started\u002F1.introduction",{"title":15,"path":16,"stem":17},"Installation","\u002Fgetting-started\u002Finstallation","1.getting-started\u002F2.installation",{"title":19,"path":20,"stem":21},"Quick start","\u002Fgetting-started\u002Fquick-start","1.getting-started\u002F3.quick-start",{"title":23,"path":24,"stem":25},"Upgrade guide","\u002Fgetting-started\u002Fupgrade-guide","1.getting-started\u002F5.upgrade-guide",false,{"title":28,"icon":29,"path":30,"stem":31,"children":32,"page":26},"Essentials","i-heroicons-shield-check","\u002Fessentials","2.essentials",[33,37,41,45,49,53,57,61,65],{"title":34,"path":35,"stem":36},"Controls","\u002Fessentials\u002Fcontrols","2.essentials\u002F1.controls",{"title":38,"path":39,"stem":40},"Perimeters","\u002Fessentials\u002Fperimeters","2.essentials\u002F2.perimeters",{"title":42,"path":43,"stem":44},"Perimeter classes","\u002Fessentials\u002Fperimeter-classes","2.essentials\u002F3.perimeter-classes",{"title":46,"path":47,"stem":48},"Levels","\u002Fessentials\u002Flevels","2.essentials\u002F4.levels",{"title":50,"path":51,"stem":52},"Boundaries","\u002Fessentials\u002Fboundaries","2.essentials\u002F5.boundaries",{"title":54,"path":55,"stem":56},"Parents","\u002Fessentials\u002Fparents","2.essentials\u002F6.parents",{"title":58,"path":59,"stem":60},"Policies","\u002Fessentials\u002Fpolicies","2.essentials\u002F7.policies",{"title":62,"path":63,"stem":64},"Queries","\u002Fessentials\u002Fqueries","2.essentials\u002F8.queries",{"title":66,"path":67,"stem":68},"Readers","\u002Fessentials\u002Freaders","2.essentials\u002F9.readers",{"title":70,"icon":71,"path":72,"stem":73,"children":74,"page":26},"Search","i-heroicons-magnifying-glass","\u002Fsearch","3.search",[75,79,83,87,91,95,99],{"title":76,"path":77,"stem":78},"Search overview","\u002Fsearch\u002Foverview","3.search\u002F1.overview",{"title":80,"path":81,"stem":82},"Engines","\u002Fsearch\u002Fengines","3.search\u002F2.engines",{"title":84,"path":85,"stem":86},"Keeping the keys fresh","\u002Fsearch\u002Fkeeping-the-keys-fresh","3.search\u002F3.keeping-the-keys-fresh",{"title":88,"path":89,"stem":90},"Exceptions and dates","\u002Fsearch\u002Fexceptions-and-dates","3.search\u002F4.exceptions-and-dates",{"title":92,"path":93,"stem":94},"Searching through a parent","\u002Fsearch\u002Fthrough-a-parent","3.search\u002F5.through-a-parent",{"title":96,"path":97,"stem":98},"Search from the browser","\u002Fsearch\u002Ffrom-the-browser","3.search\u002F6.from-the-browser",{"title":100,"path":101,"stem":102},"Your own search client","\u002Fsearch\u002Fyour-own-client","3.search\u002F7.your-own-client",{"title":104,"icon":105,"path":106,"stem":107,"children":108,"page":26},"Integrations","i-heroicons-puzzle-piece","\u002Fintegrations","4.integrations",[109],{"title":110,"path":111,"stem":112},"laravel-rest-api","\u002Fintegrations\u002Flaravel-rest-api","4.integrations\u002F1.laravel-rest-api",{"title":114,"icon":115,"path":116,"stem":117,"children":118,"page":26},"Testing and Tooling","i-heroicons-wrench-screwdriver","\u002Ftesting-and-tooling","5.testing-and-tooling",[119,123,127,131],{"title":120,"path":121,"stem":122},"Testing","\u002Ftesting-and-tooling\u002Ftesting","5.testing-and-tooling\u002F1.testing",{"title":124,"path":125,"stem":126},"access:check","\u002Ftesting-and-tooling\u002Faccess-check","5.testing-and-tooling\u002F2.access-check",{"title":128,"path":129,"stem":130},"Cache and about","\u002Ftesting-and-tooling\u002Fcache-and-about","5.testing-and-tooling\u002F3.cache-and-about",{"title":132,"path":133,"stem":134},"Generators","\u002Ftesting-and-tooling\u002Fgenerators","5.testing-and-tooling\u002F4.generators",{"title":136,"icon":137,"path":138,"stem":139,"children":140,"page":26},"Digging Deeper","i-heroicons-list-bullet","\u002Fdigging-deeper","6.digging-deeper",[141,145,149,153,157,161,165,169],{"title":142,"path":143,"stem":144},"Abilities","\u002Fdigging-deeper\u002Fabilities","6.digging-deeper\u002F1.abilities",{"title":146,"path":147,"stem":148},"Kept decisions","\u002Fdigging-deeper\u002Fdecisions","6.digging-deeper\u002F2.decisions",{"title":150,"path":151,"stem":152},"Batched decisions","\u002Fdigging-deeper\u002Fbatched-decisions","6.digging-deeper\u002F3.batched-decisions",{"title":154,"path":155,"stem":156},"Row checks","\u002Fdigging-deeper\u002Frow-checks","6.digging-deeper\u002F4.row-checks",{"title":158,"path":159,"stem":160},"Several brands","\u002Fdigging-deeper\u002Fseveral-brands","6.digging-deeper\u002F5.several-brands",{"title":162,"path":163,"stem":164},"Row context","\u002Fdigging-deeper\u002Frow-context","6.digging-deeper\u002F6.row-context",{"title":166,"path":167,"stem":168},"What is public in 1.x","\u002Fdigging-deeper\u002Fpublic-api","6.digging-deeper\u002F7.public-api",{"title":170,"path":171,"stem":172},"Use with AI","\u002Fdigging-deeper\u002Fuse-with-ai","6.digging-deeper\u002F8.use-with-ai",{"id":174,"title":166,"body":175,"description":544,"extension":545,"links":546,"meta":547,"navigation":548,"path":167,"seo":549,"sitemap":550,"stem":168,"updatedAt":551,"__hash__":552},"docs\u002F6.digging-deeper\u002F7.public-api.md",{"type":176,"value":177,"toc":536},"minimark",[178,195,200,294,298,316,450,463,467,512],[179,180,181,182,189,190,194],"p",{},"The releases of 1.x follow semantic versioning for what this documentation and the ",[183,184,188],"a",{"href":185,"rel":186},"https:\u002F\u002Fgithub.com\u002FLomkit\u002Flaravel-access-control\u002Fblob\u002F1.x\u002FUPGRADE.md",[187],"nofollow","upgrade guide"," describe, and do not mark ",[191,192,193],"code",{},"@internal",".",[196,197,199],"h2",{"id":198},"covered","Covered",[201,202,203,207,210,237,246,253,262],"ul",{},[204,205,206],"li",{},"The classes, and their public and protected methods, that the documentation shows an application calling, extending, implementing or overriding.",[204,208,209],{},"The exception classes and the classes they extend, thrown in the cases the documentation gives. Their messages, and the way they are built, are not covered.",[204,211,212,213,216,217,216,220,216,223,226,227,230,231,226,234,194],{},"The refusal codes of the policies, ",[191,214,215],{},"unsaved",", ",[191,218,219],{},"no_perimeter",[191,221,222],{},"outside_boundary",[191,224,225],{},"not_found"," and ",[191,228,229],{},"outside_rows",", and the names of the search attributes, ",[191,232,233],{},"_access",[191,235,236],{},"_boundary",[204,238,239,240,242,243,245],{},"The artisan commands, their options, their exit codes and the JSON of ",[191,241,124],{},". A minor release may add problems and notes to ",[191,244,124],{},", so a CI that passed may fail after it, as with the new rules of a linter.",[204,247,248,249,252],{},"The assertions of ",[191,250,251],{},"InteractsWithAccess",", whose signatures do not change in 1.x. A minor release may add checks to them, so a test that passed may fail after it, when the new check reveals a disagreement.",[204,254,255,226,258,261],{},[191,256,257],{},"Access::searchTokens()",[191,259,260],{},"Access::guardSearch()",", with the bodies the guard accepts and the parameters it forces. A release, even a patch, may refuse a parameter or a filter that turns out to widen what a reader finds: the guard fails closed rather than keep an opening.",[204,263,264,216,267,216,270,273,274,216,277,226,280,283,284,287,288,290,291,293],{},[191,265,266],{},"Access::indexKeysOf()",[191,268,269],{},"Access::indexReaderKeys()",[191,271,272],{},"IndexReaderKeys"," with its ",[191,275,276],{},"model()",[191,278,279],{},"isClosed()",[191,281,282],{},"values()",", and the ",[191,285,286],{},"assertIndexKeysAgree()"," assertion, with the behaviour that ",[183,289,100],{"href":101}," gives: both fields for each document and each reader, digests of 32 lowercase hexadecimal characters, never an empty list for an open reader nor in the ",[191,292,233],{}," of a document, and, for a closed reader, one value in each field that is not a digest and that no document carries. The values themselves change as the keys do.",[196,295,297],{"id":296},"the-classes-you-extend","The classes you extend",[179,299,300,301,216,304,226,307,310,311,315],{},"Your application extends ",[191,302,303],{},"Perimeter",[191,305,306],{},"Control",[191,308,309],{},"Boundary",". A minor release may add methods to them, and a method of the same name in your subclass would then clash: ",[312,313,314],"strong",{},"give the methods you add to your subclasses distinctive names."," Their covered members:",[317,318,319,332],"table",{},[320,321,322],"thead",{},[323,324,325,329],"tr",{},[326,327,328],"th",{},"Class",[326,330,331],{},"Covered members",[333,334,335,381,418],"tbody",{},[323,336,337,342],{},[338,339,340],"td",{},[191,341,303],{},[338,343,344,216,347,216,350,216,353,216,356,216,359,216,362,216,365,226,368,371,372,216,375,226,378],{},[191,345,346],{},"new()",[191,348,349],{},"allowed()",[191,351,352],{},"should()",[191,354,355],{},"query()",[191,357,358],{},"searchKeys()",[191,360,361],{},"reindexWhen()",[191,363,364],{},"unrestricted()",[191,366,367],{},"admits()",[191,369,370],{},"checksInMemory()","; the protected hooks ",[191,373,374],{},"allows()",[191,376,377],{},"includes()",[191,379,380],{},"scope()",[323,382,383,387],{},[338,384,385],{},[191,386,306],{},[338,388,389,216,391,216,394,216,397,226,400,403,404,216,407,226,410,413,414,417],{},[191,390,346],{},[191,392,393],{},"abilityFor()",[191,395,396],{},"decide()",[191,398,399],{},"applies()",[191,401,402],{},"reachableKeys()","; the protected ",[191,405,406],{},"perimeters()",[191,408,409],{},"boundary()",[191,411,412],{},"applicablePerimeters()",", and the protected ",[191,415,416],{},"$model"," property, declared by its default value and never assigned elsewhere",[323,419,420,424],{},[338,421,422],{},[191,423,309],{},[338,425,426,216,429,226,432,371,434,216,436,216,438,226,440,442,443,446,447,449],{},[191,427,428],{},"where()",[191,430,431],{},"none()",[191,433,370],{},[191,435,380],{},[191,437,377],{},[191,439,358],{},[191,441,367],{},"; ",[191,444,445],{},"readOnlyWhenNotNull()"," on the boundary that ",[191,448,428],{}," returns",[179,451,452,455,456,226,459,462],{},[191,453,454],{},"ControlledPolicy"," gets no new method in 1.x, since the methods of your policy are named after your abilities: it keeps the seven standard abilities, the protected ",[191,457,458],{},"decideByControl()",[191,460,461],{},"declaredControl()",", and nothing else.",[196,464,466],{"id":465},"not-covered","Not covered",[201,468,469,475,491,501,509],{},[204,470,471,472,474],{},"A class or a method marked ",[191,473,193],{}," may change or disappear in any release, whatever its PHP visibility, and so may a public or protected method that the documentation does not describe. Do not call, extend, implement, override or type against them.",[204,476,477,478,216,481,216,484,226,487,490],{},"The classes behind the artisan commands, the control registry, and the search keys and filters, such as ",[191,479,480],{},"SearchKeyValues",[191,482,483],{},"SearchDocuments",[191,485,486],{},"SearchRules",[191,488,489],{},"SearchFilter",", are internal.",[204,492,493,496,497,500],{},[191,494,495],{},"AccessServiceProvider"," is registered by package discovery: list it in ",[191,498,499],{},"bootstrap\u002Fproviders.php"," if your application turns the discovery off, and do not extend it.",[204,502,503,504,194],{},"Calling the protected hooks of another perimeter from a perimeter class is not supported: call ",[183,505,507],{"href":506},"\u002Fdigging-deeper\u002Frow-checks#which-perimeter-grants-a-row",[191,508,367],{},[204,510,511],{},"The access keys, and their digests in your search indexes, are not an API. They live in your indexes, though: a release that changes them says so in its upgrade notes, with the reindex it needs, even a minor one.",[179,513,514,517,518,521,522,525,526,216,529,226,532,535],{},[191,515,516],{},"ControlledSearchBuilder"," is the builder that ",[191,519,520],{},"search()"," returns on a ",[191,523,524],{},"ControlledSearchable"," model: its ",[191,527,528],{},"controlled()",[191,530,531],{},"controlledFor()",[191,533,534],{},"uncontrolled()"," are public.",{"title":537,"searchDepth":538,"depth":539,"links":540},"",1,2,[541,542,543],{"id":198,"depth":539,"text":199},{"id":296,"depth":539,"text":297},{"id":465,"depth":539,"text":466},"The releases of 1.x follow semantic versioning for what this documentation describes. Learn what that covers, and what may change in any release.","md",null,{},true,{"title":166,"description":544},{"loc":167,"lastmod":551},"2026-11-21T15:24:08+01:00","mEqrzSx204yKfmuQJ8IOHbClPPxkXMshPJtTNel1pUM",[554,556],{"title":162,"path":163,"stem":164,"description":555,"children":-1},"Decide the parent of a ThroughParent in the brand or tenant of each child row with decidedInRowContext() and Access::rowContextUsing(), and test the switch.",{"title":170,"path":171,"stem":172,"description":557,"children":-1},"Give coding assistants the current Laravel Access Control docs: the Laravel Boost skill, llms.txt, Markdown copies of every page, GitMCP and Context7.",1795277182361]