Source of file AllLinks.php
Size: 10,856 Bytes - Last Modified: 2021-12-23T10:47:10+00:00
/var/www/docs.ssmods.com/process/src/src/Api/AllLinks.php
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362 | <?php namespace Sunnysideup\TemplateOverview\Api; use SilverStripe\Admin\CMSMenu; use SilverStripe\Control\Director; use SilverStripe\Core\Injector\Injector; use SilverStripe\ORM\DB; use SilverStripe\Versioned\Versioned; use Sunnysideup\TemplateOverview\Api\Providers\AllLinksArchiveAdmin; use Sunnysideup\TemplateOverview\Api\Providers\AllLinksControllerInfo; use Sunnysideup\TemplateOverview\Api\Providers\AllLinksDataObjects; use Sunnysideup\TemplateOverview\Api\Providers\AllLinksModelAdmin; use Sunnysideup\TemplateOverview\Api\Providers\AllLinksReports; class AllLinks extends AllLinksProviderBase { /** * @var mixed|mixed[] */ public $archiveCMSLinks; /** * @var array */ protected $allNonCMSLinks = []; /** * @var array */ protected $pagesOnFrontEnd = []; /** * @var array */ protected $dataObjectsOnFrontEnd = []; /** * @var array */ protected $otherControllerMethods = []; /** * @var array */ protected $customNonCMSLinks = []; /** * @var array */ protected $templateoverviewtestsLinks = []; /** * @var array */ protected $allCMSLinks = []; /** * @var array */ protected $pagesInCMS = []; /** * @var array */ protected $dataObjectsInCMS = []; /** * @var array */ protected $modelAdmins = []; /** * @var array */ protected $reportLinks = []; /** * @var array */ protected $leftAndMainLnks = []; /** * @var array */ protected $customCMSLinks = []; /** * url snippets that if found in links should exclude the link altogether. * e.g. 'admin/registry'. * * @var array */ private static $exclude_list = []; /** * @var int */ private static $number_of_examples = 1; /** * @var array */ private static $custom_links = [ 'Security/login', 'Security/logout', 'Security/lostpassword', 'Security/lostpassword/passwordsent', ]; /** * @var array */ private static $controller_name_space_filter = []; /** * @param string $link */ public static function is_admin_link($link): bool { return 'admin' === substr(ltrim($link, '/'), 0, 5); } /** * Sanitise a model class' name for inclusion in a link. * * @param string $class * * @return string */ public static function sanitise_class_name($class) { return str_replace('\\', '-', $class); } /** * returns an array of allNonCMSLinks => [] , allCMSLinks => [], otherControllerMethods => []. */ public function getAllLinks(): array { $array1 = $this->Config()->get('custom_links'); $array2 = []; $array2 = $this->getCustomisedLinks(); foreach (array_merge($array1, $array2) as $link) { $link = '/' . ltrim($link, '/') . '/'; if (self::is_admin_link($link)) { $this->customCMSLinks[] = $link; } else { $this->customNonCMSLinks[] = $link; } } $this->pagesOnFrontEnd = $this->ListOfPagesLinks(); $this->dataObjectsOnFrontEnd = $this->ListOfDataObjectsLinks(false); $this->templateoverviewtestsLinks = $this->ListOfAllTemplateoverviewtestsLinks(); $this->allNonCMSLinks = $this->addToArrayOfLinks($this->allNonCMSLinks, $this->pagesOnFrontEnd); $this->allNonCMSLinks = $this->addToArrayOfLinks($this->allNonCMSLinks, $this->dataObjectsOnFrontEnd); $this->allNonCMSLinks = $this->addToArrayOfLinks($this->allNonCMSLinks, $this->customNonCMSLinks); $this->allNonCMSLinks = $this->addToArrayOfLinks($this->allNonCMSLinks, $this->templateoverviewtestsLinks); sort($this->allNonCMSLinks); $this->pagesInCMS = $this->ListOfPagesLinks(true); $this->dataObjectsInCMS = $this->ListOfDataObjectsLinks(true); $this->modelAdmins = $this->ListOfAllModelAdmins(); $this->archiveCMSLinks = $this->ListOfAllArchiveCMSLinks(); $this->leftAndMainLnks = $this->ListOfAllLeftAndMains(); $this->reportLinks = $this->listOfAllReports(); $this->allCMSLinks = $this->addToArrayOfLinks($this->allCMSLinks, $this->pagesInCMS); $this->allCMSLinks = $this->addToArrayOfLinks($this->allCMSLinks, $this->dataObjectsInCMS); $this->allCMSLinks = $this->addToArrayOfLinks($this->allCMSLinks, $this->modelAdmins); $this->allCMSLinks = $this->addToArrayOfLinks($this->allCMSLinks, $this->archiveCMSLinks); $this->allCMSLinks = $this->addToArrayOfLinks($this->allCMSLinks, $this->leftAndMainLnks); $this->allCMSLinks = $this->addToArrayOfLinks($this->allCMSLinks, $this->reportLinks); $this->allCMSLinks = $this->addToArrayOfLinks($this->allCMSLinks, $this->customCMSLinks); sort($this->allCMSLinks); $this->otherControllerMethods = $this->ListOfAllControllerMethods(); return [ 'allNonCMSLinks' => $this->allNonCMSLinks, 'allCMSLinks' => $this->allCMSLinks, 'otherLinks' => $this->otherControllerMethods, ]; } /** * returns a list of all model admin links. * * @return array */ public function ListOfAllModelAdmins() { $obj = Injector::inst()->get(AllLinksModelAdmin::class); $obj->setNumberOfExamples($this->Config()->number_of_examples); return $obj->getAllLinksInner(); } /** * returns a list of all archive links. * * @return array */ public function ListOfAllArchiveCMSLinks() { $obj = Injector::inst()->get(AllLinksArchiveAdmin::class); $obj->setNumberOfExamples($this->Config()->number_of_examples); return $obj->getAllLinksInner(); } public function getCustomisedLinks(): array { $obj = Injector::inst()->get(AllLinksControllerInfo::class); return $obj->getCustomisedLinks(); } public function ListOfAllControllerMethods(): array { $obj = Injector::inst()->get(AllLinksControllerInfo::class); $obj->setValidNameSpaces($this->Config()->controller_name_space_filter); return $obj->getAllLinksInner(); } public function ListOfAllTemplateoverviewtestsLinks(): array { $obj = Injector::inst()->get(AllLinksControllerInfo::class); $list = $obj->getAllLinksInner(); $list = $obj->getLinksAndActions(); return array_keys($list['CustomLinks'] ?? []); } public function ListOfDataObjectsLinks(bool $inCMS): array { $obj = Injector::inst()->get(AllLinksDataObjects::class); $obj->setNumberOfExamples($this->Config()->number_of_examples); return $obj->getAllLinksInner($inCMS); } /** * Takes {@link #$classNames}, gets the URL of the first instance of it * (will exclude extensions of the class) and * appends to the {@link #$urls} list to be checked. * * @param bool $pageInCMS * * @return array */ public function ListOfPagesLinks($pageInCMS = false) { //first() will return null or the object $return = []; $siteTreeClassNames = $this->getListOfAllClasses(); foreach ($siteTreeClassNames as $class) { for ($i = 0; $i < $this->Config()->number_of_examples; ++$i) { $excludedClasses = $this->arrayExcept($siteTreeClassNames, $class); $page = Versioned::get_by_stage($class, Versioned::LIVE) ->exclude(['ClassName' => $excludedClasses]) ->sort(DB::get_conn()->random() . ' ASC') ->first() ; if (null === $page) { $page = Versioned::get_by_stage($class, Versioned::DRAFT) ->exclude(['ClassName' => $excludedClasses]) ->sort(DB::get_conn()->random() . ' ASC') ->first() ; } if (null !== $page) { if ($pageInCMS) { $url = $page->CMSEditLink(); $return[] = $url; $return[] = str_replace('/edit/', '/settings/', $url); $return[] = str_replace('/edit/', '/history/', $url); } else { $url = $page->Link(); $return[] = $url; } } } } return $return; } /** * @return array */ public function ListOfAllLeftAndMains() { //first() will return null or the object $return = []; $list = CMSMenu::get_cms_classes(); foreach ($list as $class) { if ($this->isValidClass($class)) { $obj = Injector::inst()->get($class); if ($obj) { $url = $obj->Link(); if ($url) { $return[] = $url; } } } } return $return; } /** * returns a list of all reports. * * @return array */ public function ListOfAllReports() { $reportsLinks = Injector::inst()->get(AllLinksReports::class); return $reportsLinks->getAllLinksInner(); } /** * Pushes an array of items to an array. * * @param array $array Array to push items to (will overwrite) * @param array $pushArray array of items to push to $array */ protected function addToArrayOfLinks($array, $pushArray): array { $excludeList = $this->Config()->exclude_list; foreach ($pushArray as $pushItem) { //clean if (self::is_admin_link($pushItem)) { $pushItem = str_replace('?stage=Stage', '', $pushItem); } $pushItem = self::sanitise_class_name($pushItem); $pushItem = '/' . Director::makeRelative($pushItem); //is it a file? if (strpos($pushItem, '.') > (strlen($pushItem) - 6)) { $pushItem = rtrim($pushItem, '/'); } if ('' !== $pushItem) { if (! empty($excludeList)) { foreach ($excludeList as $excludeItem) { if (false !== stripos($pushItem, $excludeItem)) { continue 2; } } } if (! in_array($pushItem, $array, true)) { $array[] = $pushItem; } } } return $array; } } |